{
    "info": {
        "author": "Joel Martin",
        "author_email": "github@martintribe.org",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Topic :: Software Development :: Build Tools"
        ],
        "description": "## websockify: WebSockets support for any application/server\n\nwebsockify was formerly named wsproxy and was part of the\n[noVNC](https://github.com/kanaka/noVNC) project.\n\nAt the most basic level, websockify just translates WebSockets traffic\nto normal socket traffic. Websockify accepts the WebSockets handshake,\nparses it, and then begins forwarding traffic between the client and\nthe target in both directions.\n\n### News/help/contact\n\nNotable commits, announcements and news are posted to\n<a href=\"http://www.twitter.com/noVNC\">@noVNC</a>\n\nIf you are a websockify developer/integrator/user (or want to be)\nplease join the <a\nhref=\"https://groups.google.com/forum/?fromgroups#!forum/novnc\">noVNC/websockify\ndiscussion group</a>\n\nBugs and feature requests can be submitted via [github\nissues](https://github.com/kanaka/websockify/issues).\n\nIf you want to show appreciation for websockify you could donate to a great\nnon-profits such as: [Compassion\nInternational](http://www.compassion.com/), [SIL](http://www.sil.org),\n[Habitat for Humanity](http://www.habitat.org), [Electronic Frontier\nFoundation](https://www.eff.org/), [Against Malaria\nFoundation](http://www.againstmalaria.com/), [Nothing But\nNets](http://www.nothingbutnets.net/), etc. Please tweet <a\nhref=\"http://www.twitter.com/noVNC\">@noVNC</a> if you do.\n\n### WebSockets binary data\n\nStarting with websockify 0.5.0, only the HyBi / IETF\n6455 WebSocket protocol is supported.\n\nWebsockify negotiates whether to base64 encode traffic to and from the\nclient via the subprotocol header (Sec-WebSocket-Protocol). The valid\nsubprotocol values are 'binary' and 'base64' and if the client sends\nboth then the server (the python implementation) will prefer 'binary'.\nThe 'binary' subprotocol indicates that the data will be sent raw\nusing binary WebSocket frames. Some HyBi clients (such as the Flash\nfallback and older Chrome and iOS versions) do not support binary data\nwhich is why the negotiation is necessary.\n\n\n### Encrypted WebSocket connections (wss://)\n\nTo encrypt the traffic using the WebSocket 'wss://' URI scheme you\nneed to generate a certificate for websockify to load. By default websockify\nloads a certificate file name `self.pem` but the `--cert=CERT` option can\noverride the file name. You can generate a self-signed certificate using\nopenssl. When asked for the common name, use the hostname of the server where\nthe proxy will be running:\n\n```\nopenssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem\n```\n\n\n### Websock Javascript library\n\n\nThe `include/websock.js` Javascript library library provides a Websock\nobject that is similar to the standard WebSocket object but Websock\nenables communication with raw TCP sockets (i.e. the binary stream)\nvia websockify. This is accomplished by base64 encoding the data\nstream between Websock and websockify.\n\nWebsock has built-in receive queue buffering; the message event\ndoes not contain actual data but is simply a notification that\nthere is new data available. Several rQ* methods are available to\nread binary data off of the receive queue.\n\nThe Websock API is documented on the [websock.js API wiki page](https://github.com/kanaka/websockify/wiki/websock.js)\n\nSee the \"Wrap a Program\" section below for an example of using Websock\nand websockify as a browser telnet client (`wstelnet.html`).\n\n\n### Additional websockify features\n\nThese are not necessary for the basic operation.\n\n* Daemonizing: When the `-D` option is specified, websockify runs\n  in the background as a daemon process.\n\n* SSL (the wss:// WebSockets URI): This is detected automatically by\n  websockify by sniffing the first byte sent from the client and then\n  wrapping the socket if the data starts with '\\x16' or '\\x80'\n  (indicating SSL).\n\n* Flash security policy: websockify detects flash security policy\n  requests (again by sniffing the first packet) and answers with an\n  appropriate flash security policy response (and then closes the\n  port). This means no separate flash security policy server is needed\n  for supporting the flash WebSockets fallback emulator.\n\n* Session recording: This feature that allows recording of the traffic\n  sent and received from the client to a file using the `--record`\n  option.\n\n* Mini-webserver: websockify can detect and respond to normal web\n  requests on the same port as the WebSockets proxy and Flash security\n  policy. This functionality is activate with the `--web DIR` option\n  where DIR is the root of the web directory to serve.\n\n* Wrap a program: see the \"Wrap a Program\" section below.\n\n\n### Implementations of websockify\n\nThe primary implementation of websockify is in python. There are\nseveral alternate implementations in other languages (C, Node.js,\nClojure, Ruby) in the `other/` subdirectory (with varying levels of\nfunctionality).\n\nIn addition there are several other external projects that implement\nthe websockify \"protocol\". See the alternate implementation [Feature\nMatrix](https://github.com/kanaka/websockify/wiki/Feature_Matrix) for\nmore information.\n\n\n### Wrap a Program\n\nIn addition to proxying from a source address to a target address\n(which may be on a different system), websockify has the ability to\nlaunch a program on the local system and proxy WebSockets traffic to\na normal TCP port owned/bound by the program.\n\nThe is accomplished with a small LD_PRELOAD library (`rebind.so`)\nwhich intercepts bind() system calls by the program. The specified\nport is moved to a new localhost/loopback free high port. websockify\nthen proxies WebSockets traffic directed to the original port to the\nnew (moved) port of the program.\n\nThe program wrap mode is invoked by replacing the target with `--`\nfollowed by the program command line to wrap.\n\n    `./run 2023 -- PROGRAM ARGS`\n\nThe `--wrap-mode` option can be used to indicate what action to take\nwhen the wrapped program exits or daemonizes.\n\nHere is an example of using websockify to wrap the vncserver command\n(which backgrounds itself) for use with\n[noVNC](https://github.com/kanaka/noVNC):\n\n    `./run 5901 --wrap-mode=ignore -- vncserver -geometry 1024x768 :1`\n\nHere is an example of wrapping telnetd (from krb5-telnetd). telnetd\nexits after the connection closes so the wrap mode is set to respawn\nthe command:\n\n    `sudo ./run 2023 --wrap-mode=respawn -- telnetd -debug 2023`\n\nThe `wstelnet.html` page demonstrates a simple WebSockets based telnet\nclient (use 'localhost' and '2023' for the host and port\nrespectively).\n\n\n### Building the Python ssl module (for python 2.5 and older)\n\n* Install the build dependencies. On Ubuntu use this command:\n\n    `sudo aptitude install python-dev bluetooth-dev`\n\n* At the top level of the websockify repostory, download, build and\n  symlink the ssl module:\n\n    `wget --no-check-certificate http://pypi.python.org/packages/source/s/ssl/ssl-1.15.tar.gz`\n\n    `tar xvzf ssl-1.15.tar.gz`\n\n    `cd ssl-1.15`\n\n    `make`\n\n    `cd ../`\n\n    `ln -sf ssl-1.15/build/lib.linux-*/ssl ssl`\n\n\nChanges\n=======\n\n0.6.0 - Feb 18, 2014\n--------------------\n\n* **NOTE** : 0.6.0 will break existing code that sub-classes WebsocketProxy\n* Refactor to use standard SocketServer RequestHandler design\n* Fix zombie process bug on certain systems when using multiprocessing\n* Add better unit tests\n* Log information via python `logging` module\n\n0.5.1 - Jun 27, 2013\n--------------------\n\n * use upstream einaros/ws (>=0.4.27) with websockify.js\n * file_only and no_parent security options for WSRequestHandler\n * Update build of web-socket-js (c0855c6cae)\n * add include/web-socket-js-project submodule to gimite/web-socket-js\n   for DSFG compliance.\n * drop Hixie protocol support\n\n0.4.1 - Mar 12, 2013\n--------------------\n\n * ***NOTE*** : 0.5.0 will drop Hixie protocol support\n * add include/ directory and remove some dev files from source\n   distribution.\n\n0.4.0 - Mar 12, 2013\n--------------------\n\n * ***NOTE*** : 0.5.0 will drop Hixie protocol support\n * use Buffer base64 support in Node.js implementation\n\n0.3.0 - Jan 15, 2013\n--------------------\n\n * refactor into modules: websocket, websocketproxy\n * switch to web-socket-js that uses IETF 6455\n * change to MPL 2.0 license for include/*.js\n * fix session recording\n\n0.2.1 - Oct 15, 2012\n--------------------\n\n * re-released with updated version number\n\n0.2.0 - Sep 17, 2012\n--------------------\n\n * Binary data support in websock.js\n * Target config file/dir and multiple targets with token selector\n * IPv6 fixes\n * SSL target support\n * Proxy to/from unix socket\n\n\n0.1.0 - May 11, 2012\n--------------------\n\n * Initial versioned release.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/kanaka/websockify",
        "keywords": "noVNC websockify",
        "license": "LGPLv3",
        "maintainer": null,
        "maintainer_email": null,
        "name": "ak-websockify",
        "package_url": "https://pypi.org/project/ak-websockify/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/ak-websockify/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/kanaka/websockify"
        },
        "release_url": "https://pypi.org/project/ak-websockify/0.6.0.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Appknox forn of Websockify.",
        "version": "0.6.0.1"
    },
    "last_serial": 3153326,
    "releases": {
        "0.6.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "22689cddeb6af2ef6497a351d6b81a08",
                    "sha256": "15f50e1db705e03038bb5ee0c6d808dcc44d49caa8aa3fa01bfc452a52416884"
                },
                "downloads": -1,
                "filename": "ak_websockify-0.6.0.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "22689cddeb6af2ef6497a351d6b81a08",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 214505,
                "upload_time": "2016-02-23T03:46:45",
                "url": "https://files.pythonhosted.org/packages/04/81/a3051eac11bc53eb6cc147b82ff48ee791ddb5d92edc2962c640d2400122/ak_websockify-0.6.0.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ba992b71b68b9fda90ae54433f5c14e3",
                    "sha256": "cc231bc135dc8f2b839c6b09e41c0c8abd2d34d65bb1ff9bd651971960773a98"
                },
                "downloads": -1,
                "filename": "ak-websockify-0.6.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "ba992b71b68b9fda90ae54433f5c14e3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 227071,
                "upload_time": "2016-02-23T03:46:55",
                "url": "https://files.pythonhosted.org/packages/f9/6a/59e9e419a3395609776946dd715bc88e646bb1d0840d7f14abad9fba0971/ak-websockify-0.6.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "22689cddeb6af2ef6497a351d6b81a08",
                "sha256": "15f50e1db705e03038bb5ee0c6d808dcc44d49caa8aa3fa01bfc452a52416884"
            },
            "downloads": -1,
            "filename": "ak_websockify-0.6.0.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "22689cddeb6af2ef6497a351d6b81a08",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 214505,
            "upload_time": "2016-02-23T03:46:45",
            "url": "https://files.pythonhosted.org/packages/04/81/a3051eac11bc53eb6cc147b82ff48ee791ddb5d92edc2962c640d2400122/ak_websockify-0.6.0.1-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "ba992b71b68b9fda90ae54433f5c14e3",
                "sha256": "cc231bc135dc8f2b839c6b09e41c0c8abd2d34d65bb1ff9bd651971960773a98"
            },
            "downloads": -1,
            "filename": "ak-websockify-0.6.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ba992b71b68b9fda90ae54433f5c14e3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 227071,
            "upload_time": "2016-02-23T03:46:55",
            "url": "https://files.pythonhosted.org/packages/f9/6a/59e9e419a3395609776946dd715bc88e646bb1d0840d7f14abad9fba0971/ak-websockify-0.6.0.1.tar.gz"
        }
    ]
}