This repository has been archived by the owner on Dec 3, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 649e3d1
Showing
232 changed files
with
200,669 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
=== Raspberry Pi Car Computer === | ||
|
||
UI component of a Raspberry Pi car computer setup. | ||
|
||
# Prerequisites | ||
The UI acts as a frontend for the [MPD](http://www.musicpd.org/) and [GPSD](http://www.catb.org/gpsd/). So obviously to have the frontend work properly these two daemons must be installed and configured. | ||
|
||
The system uses PHP for getting GPS data so at minimum the PHP5-common, PHP5-cli and PHP5-curl packages must be installed. The application also uses the [HTML5 Filesystem API](http://www.html5rocks.com/en/tutorials/file/filesystem/) for the local storage of album art. This API is poorly supported so either Chromium or Chrome needs to be used for displaying the application. | ||
|
||
# Installation | ||
|
||
* Install all of the required dependencies. | ||
* Edit line 36 & 37 of www/php/services.php replacing the values with your application keys for the [Here.com API](https://developer.here.com/plans/api/consumer-mapping) - Required for speed limit and weather information. | ||
* From the command line run the start.sh script to start a and instance of the internal PHP webserver on port 8000. | ||
* Open Chrome or Chromium and visit the location localhost:8000 to see the application. Keep in mind that it has been designed with the Raspberry Pi Offical touchscreen in mind i.e 800x600. | ||
|
||
# Credits | ||
|
||
This project makes the use of a number of third party Open Source libraries. You are all fantastic thank you for all your hardwork its much appreciated! | ||
|
||
* [Ionic Framework](https://github.com/driftyco/ionic) | ||
* [ng-elif](https://github.com/zachsnow/ng-elif) | ||
* [mpd.js](https://github.com/bobboau/MPD.js) | ||
* [angular-imgcache.js](https://github.com/jBenes/angular-imgcache.js) | ||
* [angular-growl-2](https://github.com/JanStevens/angular-growl-2) | ||
* [websockify](https://github.com/kanaka/websockify) | ||
* [mpd](http://www.catb.org/gpsd/) | ||
* [gpsd](http://www.musicpd.org/) | ||
|
||
# Licence | ||
|
||
Copyright (C) 2015 Anthony Mills | ||
|
||
This program is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU General Public License as published by | ||
the Free Software Foundation, either version 3 of the License, or | ||
(at your option) any later version. | ||
|
||
This program is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU General Public License for more details. | ||
|
||
You should have received a copy of the GNU General Public License | ||
along with this program. If not, see <http://www.gnu.org/licenses/>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#/bin/bash | ||
|
||
# Start websockify and the inbuilt PHP server | ||
websockify/run 8800 localhost:6600 & | ||
cd www | ||
php -S localhost:8000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
*.pyc | ||
*.o | ||
*.so | ||
other/.lein-deps-sum | ||
other/classes | ||
other/lib | ||
other/js/node_modules | ||
.project | ||
.pydevproject | ||
target.cfg | ||
target.cfg.d | ||
.tox | ||
*.egg-info |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
language: python | ||
python: | ||
- 2.6 | ||
- 2.7 | ||
- 3.3 | ||
- 3.4 | ||
|
||
install: pip install -r test-requirements.txt | ||
|
||
script: python setup.py nosetests --verbosity=3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
Changes | ||
======= | ||
|
||
0.7.0 | ||
----- | ||
|
||
* Python 3 support fixes (#140, #155, #159) | ||
* Generic token-parsing plugins support (#162) | ||
* Generic authentication plugins support (#172) | ||
* Fixed frame corruption on big-endian systems (#161) | ||
* Support heartbeats (via PING) and automatic responses to PONG (#169) | ||
* Automatically reject unmasked client frames by default (strict mode) (#174) | ||
* Automatically restart interrupted select calls (#175) | ||
* Make 'run' respect environment settings (including virtualenv) (#176) | ||
|
||
0.6.1 - May 11, 2015 | ||
-------------------- | ||
|
||
* **PATCH RELEASE**: Fixes a bug causing file_only to not be passed properly | ||
|
||
0.6.0 - Feb 18, 2014 | ||
-------------------- | ||
|
||
* **NOTE** : 0.6.0 will break existing code that sub-classes WebsocketProxy | ||
* Refactor to use standard SocketServer RequestHandler design | ||
* Fix zombie process bug on certain systems when using multiprocessing | ||
* Add better unit tests | ||
* Log information via python `logging` module | ||
|
||
0.5.1 - Jun 27, 2013 | ||
-------------------- | ||
|
||
* use upstream einaros/ws (>=0.4.27) with websockify.js | ||
* file_only and no_parent security options for WSRequestHandler | ||
* Update build of web-socket-js (c0855c6cae) | ||
* add include/web-socket-js-project submodule to gimite/web-socket-js | ||
for DSFG compliance. | ||
* drop Hixie protocol support | ||
|
||
0.4.1 - Mar 12, 2013 | ||
-------------------- | ||
|
||
* ***NOTE*** : 0.5.0 will drop Hixie protocol support | ||
* add include/ directory and remove some dev files from source | ||
distribution. | ||
|
||
0.4.0 - Mar 12, 2013 | ||
-------------------- | ||
|
||
* ***NOTE*** : 0.5.0 will drop Hixie protocol support | ||
* use Buffer base64 support in Node.js implementation | ||
|
||
0.3.0 - Jan 15, 2013 | ||
-------------------- | ||
|
||
* refactor into modules: websocket, websocketproxy | ||
* switch to web-socket-js that uses IETF 6455 | ||
* change to MPL 2.0 license for include/*.js | ||
* fix session recording | ||
|
||
0.2.1 - Oct 15, 2012 | ||
-------------------- | ||
|
||
* re-released with updated version number | ||
|
||
0.2.0 - Sep 17, 2012 | ||
-------------------- | ||
|
||
* Binary data support in websock.js | ||
* Target config file/dir and multiple targets with token selector | ||
* IPv6 fixes | ||
* SSL target support | ||
* Proxy to/from unix socket | ||
|
||
|
||
0.1.0 - May 11, 2012 | ||
-------------------- | ||
|
||
* Initial versioned release. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
websockify is licensed under the LGPL version 3 (see docs/LICENSE.GPL-3 and | ||
docs/LICENSE.LGPL-3) with the following exceptions: | ||
|
||
include/websock.js : MPL 2.0 | ||
|
||
include/base64.js : MPL 2.0 | ||
|
||
include/des.js : Various BSD style licenses | ||
|
||
include/web-socket-js/ : New BSD license (3-clause). Source code at | ||
https://github.com/gimite/web-socket-js | ||
|
||
other/kumina.c : Simplified BSD license (2 clause). | ||
Original source at | ||
https://github.com/kumina/wsproxy | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
include CHANGES.txt README.md LICENSE.txt | ||
graft include |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
TARGETS=rebind.so | ||
CFLAGS += -fPIC | ||
|
||
all: $(TARGETS) | ||
|
||
rebind.so: rebind.o | ||
$(CC) $(LDFLAGS) $^ -shared -fPIC -ldl -o $@ | ||
|
||
clean: | ||
rm -f rebind.o rebind.so | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,195 @@ | ||
## websockify: WebSockets support for any application/server | ||
|
||
websockify was formerly named wsproxy and was part of the | ||
[noVNC](https://github.com/kanaka/noVNC) project. | ||
|
||
At the most basic level, websockify just translates WebSockets traffic | ||
to normal socket traffic. Websockify accepts the WebSockets handshake, | ||
parses it, and then begins forwarding traffic between the client and | ||
the target in both directions. | ||
|
||
### News/help/contact | ||
|
||
Notable commits, announcements and news are posted to | ||
<a href="http://www.twitter.com/noVNC">@noVNC</a> | ||
|
||
If you are a websockify developer/integrator/user (or want to be) | ||
please join the <a | ||
href="https://groups.google.com/forum/?fromgroups#!forum/novnc">noVNC/websockify | ||
discussion group</a> | ||
|
||
Bugs and feature requests can be submitted via [github | ||
issues](https://github.com/kanaka/websockify/issues). | ||
|
||
If you want to show appreciation for websockify you could donate to a great | ||
non-profits such as: [Compassion | ||
International](http://www.compassion.com/), [SIL](http://www.sil.org), | ||
[Habitat for Humanity](http://www.habitat.org), [Electronic Frontier | ||
Foundation](https://www.eff.org/), [Against Malaria | ||
Foundation](http://www.againstmalaria.com/), [Nothing But | ||
Nets](http://www.nothingbutnets.net/), etc. Please tweet <a | ||
href="http://www.twitter.com/noVNC">@noVNC</a> if you do. | ||
|
||
### WebSockets binary data | ||
|
||
Starting with websockify 0.5.0, only the HyBi / IETF | ||
6455 WebSocket protocol is supported. | ||
|
||
Websockify negotiates whether to base64 encode traffic to and from the | ||
client via the subprotocol header (Sec-WebSocket-Protocol). The valid | ||
subprotocol values are 'binary' and 'base64' and if the client sends | ||
both then the server (the python implementation) will prefer 'binary'. | ||
The 'binary' subprotocol indicates that the data will be sent raw | ||
using binary WebSocket frames. Some HyBi clients (such as the Flash | ||
fallback and older Chrome and iOS versions) do not support binary data | ||
which is why the negotiation is necessary. | ||
|
||
|
||
### Encrypted WebSocket connections (wss://) | ||
|
||
To encrypt the traffic using the WebSocket 'wss://' URI scheme you need to | ||
generate a certificate and key for Websockify to load. By default, Websockify | ||
loads a certificate file name `self.pem` but the `--cert=CERT` and `--key=KEY` | ||
options can override the file name. You can generate a self-signed certificate | ||
using openssl. When asked for the common name, use the hostname of the server | ||
where the proxy will be running: | ||
|
||
``` | ||
openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem | ||
``` | ||
|
||
For a self-signed certificate to work, you need to make your client/browser | ||
understand it. You can do this by installing it as accepted certificate, or by | ||
using that same certificate for a HTTPS connection to which you navigate first | ||
and approve. Browsers generally don't give you the "trust certificate?" prompt | ||
by opening a WSS socket with invalid certificate, hence you need to have it | ||
acccept it by either of those two methods. | ||
|
||
If you have a commercial/valid SSL certificate with one ore more intermediate | ||
certificates, concat them into one file, server certificate first, then the | ||
intermediate(s) from the CA, etc. Point to this file with the `--cert` option | ||
and then also to the key with `--key`. Finally, use `--ssl-only` as needed. | ||
|
||
|
||
### Websock Javascript library | ||
|
||
|
||
The `include/websock.js` Javascript library library provides a Websock | ||
object that is similar to the standard WebSocket object but Websock | ||
enables communication with raw TCP sockets (i.e. the binary stream) | ||
via websockify. This is accomplished by base64 encoding the data | ||
stream between Websock and websockify. | ||
|
||
Websock has built-in receive queue buffering; the message event | ||
does not contain actual data but is simply a notification that | ||
there is new data available. Several rQ* methods are available to | ||
read binary data off of the receive queue. | ||
|
||
The Websock API is documented on the [websock.js API wiki page](https://github.com/kanaka/websockify/wiki/websock.js) | ||
|
||
See the "Wrap a Program" section below for an example of using Websock | ||
and websockify as a browser telnet client (`wstelnet.html`). | ||
|
||
|
||
### Additional websockify features | ||
|
||
These are not necessary for the basic operation. | ||
|
||
* Daemonizing: When the `-D` option is specified, websockify runs | ||
in the background as a daemon process. | ||
|
||
* SSL (the wss:// WebSockets URI): This is detected automatically by | ||
websockify by sniffing the first byte sent from the client and then | ||
wrapping the socket if the data starts with '\x16' or '\x80' | ||
(indicating SSL). | ||
|
||
* Flash security policy: websockify detects flash security policy | ||
requests (again by sniffing the first packet) and answers with an | ||
appropriate flash security policy response (and then closes the | ||
port). This means no separate flash security policy server is needed | ||
for supporting the flash WebSockets fallback emulator. | ||
|
||
* Session recording: This feature that allows recording of the traffic | ||
sent and received from the client to a file using the `--record` | ||
option. | ||
|
||
* Mini-webserver: websockify can detect and respond to normal web | ||
requests on the same port as the WebSockets proxy and Flash security | ||
policy. This functionality is activate with the `--web DIR` option | ||
where DIR is the root of the web directory to serve. | ||
|
||
* Wrap a program: see the "Wrap a Program" section below. | ||
|
||
|
||
### Implementations of websockify | ||
|
||
The primary implementation of websockify is in python. There are | ||
several alternate implementations in other languages (C, Node.js, | ||
Clojure, Ruby) in the `other/` subdirectory (with varying levels of | ||
functionality). | ||
|
||
In addition there are several other external projects that implement | ||
the websockify "protocol". See the alternate implementation [Feature | ||
Matrix](https://github.com/kanaka/websockify/wiki/Feature_Matrix) for | ||
more information. | ||
|
||
|
||
### Wrap a Program | ||
|
||
In addition to proxying from a source address to a target address | ||
(which may be on a different system), websockify has the ability to | ||
launch a program on the local system and proxy WebSockets traffic to | ||
a normal TCP port owned/bound by the program. | ||
|
||
The is accomplished with a small LD_PRELOAD library (`rebind.so`) | ||
which intercepts bind() system calls by the program. The specified | ||
port is moved to a new localhost/loopback free high port. websockify | ||
then proxies WebSockets traffic directed to the original port to the | ||
new (moved) port of the program. | ||
|
||
The program wrap mode is invoked by replacing the target with `--` | ||
followed by the program command line to wrap. | ||
|
||
`./run 2023 -- PROGRAM ARGS` | ||
|
||
The `--wrap-mode` option can be used to indicate what action to take | ||
when the wrapped program exits or daemonizes. | ||
|
||
Here is an example of using websockify to wrap the vncserver command | ||
(which backgrounds itself) for use with | ||
[noVNC](https://github.com/kanaka/noVNC): | ||
|
||
`./run 5901 --wrap-mode=ignore -- vncserver -geometry 1024x768 :1` | ||
|
||
Here is an example of wrapping telnetd (from krb5-telnetd). telnetd | ||
exits after the connection closes so the wrap mode is set to respawn | ||
the command: | ||
|
||
`sudo ./run 2023 --wrap-mode=respawn -- telnetd -debug 2023` | ||
|
||
The `wstelnet.html` page demonstrates a simple WebSockets based telnet | ||
client (use 'localhost' and '2023' for the host and port | ||
respectively). | ||
|
||
|
||
### Building the Python ssl module (for python 2.5 and older) | ||
|
||
* Install the build dependencies. On Ubuntu use this command: | ||
|
||
`sudo aptitude install python-dev bluetooth-dev` | ||
|
||
* At the top level of the websockify repostory, download, build and | ||
symlink the ssl module: | ||
|
||
`wget --no-check-certificate http://pypi.python.org/packages/source/s/ssl/ssl-1.15.tar.gz` | ||
|
||
`tar xvzf ssl-1.15.tar.gz` | ||
|
||
`cd ssl-1.15` | ||
|
||
`make` | ||
|
||
`cd ../` | ||
|
||
`ln -sf ssl-1.15/build/lib.linux-*/ssl ssl` | ||
|
Oops, something went wrong.