{ "info": { "author": "Brian Warner", "author_email": "warner-magic-wormhole@lothar.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "License :: OSI Approved :: MIT License", "Topic :: Security :: Cryptography", "Topic :: System :: Networking", "Topic :: System :: Systems Administration", "Topic :: Utilities" ], "description": "# Magic Wormhole Mailbox Server\n[![PyPI](http://img.shields.io/pypi/v/magic-wormhole-mailbox-server.svg)](https://pypi.python.org/pypi/magic-wormhole-mailbox-server)\n[![Build Status](https://travis-ci.org/warner/magic-wormhole-mailbox-server.svg?branch=master)](https://travis-ci.org/warner/magic-wormhole-mailbox-server)\n[![Windows Build Status](https://ci.appveyor.com/api/projects/status/mfnn5rsyfnrq576a/branch/master?svg=true)](https://ci.appveyor.com/project/warner/magic-wormhole-mailbox-server)\n[![codecov.io](https://codecov.io/github/warner/magic-wormhole-mailbox-server/coverage.svg?branch=master)](https://codecov.io/github/warner/magic-wormhole-mailbox-server?branch=master)\n\nThis repository holds the code for the main server that\n[Magic-Wormhole](http://magic-wormhole.io) clients connect to. The server\nperforms store-and-forward delivery for small key-exchange and control\nmessages. Bulk data is sent over a direct TCP connection, or through a\n[transit-relay](https://github.com/warner/magic-wormhole-transit-relay).\n\nClients connect with WebSockets, for low-latency delivery in the happy case\nwhere both clients are attached at the same time. Message are stored to\nenable non-simultaneous clients to make forward progress. The server uses a\nsmall SQLite database for persistence (and clients will reconnect\nautomatically, allowing the server to be rebooted without losing state). An\noptional \"usage DB\" tracks historical activity for status monitoring and\noperational maintenance.\n\n## Installation\n\n```\npip install magic-wormhole-mailbox-server\n```\n\nYou either want to do this into a \"user\" environment (putting the ``twist``\nand ``twistd`` executables in ``~/.local/bin/``) like this:\n\n```\npip install --user magic-wormhole-mailbox-server\n```\n\nor put it into a virtualenv, to avoid modifying the system python's\nlibraries, like this:\n\n```\nvirtualenv venv\nsource venv/bin/activate\npip install magic-wormhole-mailbox-server\n```\n\nYou probably *don't* want to use ``sudo`` when you run ``pip``, since the\ndependencies that get installed may conflict with other python programs on\nyour computer. ``pipsi`` is usually a good way to install into isolated\nenvironments, but unfortunately it doesn't work for\nmagic-wormhole-mailbox-server, because we don't have a dedicated command to\nstart the server (``twist``, described below, comes from the ``twisted``\npackage, and pipsi doesn't expose executables from dependencies).\n\nFor the installation from source, ``clone`` this repo, ``cd`` into the folder,\ncreate and activate a virtualenv, and run ``pip install .``.\n\n## Running A Server\n\nNote that the standard [Magic-Wormhole](http://magic-wormhole.io)\ncommand-line tool is preconfigured to use a mailbox server hosted by the\nproject, so running your own server is only necessary for custom applications\nthat use magic-wormhole as a library.\n\nThe mailbox server is deployed as a twist/twistd plugin. Running a basic\nserver looks like this:\n\n```\ntwist wormhole-mailbox --usage-db=usage.sqlite\n```\n\nUse ``twist wormhole-mailbox --help`` for more details.\n\nIf you use the default ``--port=tcp:4000``, on a machine named\n``example.com``, then clients can reach your server with the following\noption:\n\n```\nwormhole --relay-url=ws://example.com:4000/v1 send FILENAME\n```\n\n## License, Compatibility\n\nThis library is released under the MIT license, see LICENSE for details.\n\nThis library is compatible with python2.7, and python3 (3.5 and higher).\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/warner/magic-wormhole-mailbox-server", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "magic-wormhole-mailbox-server", "package_url": "https://pypi.org/project/magic-wormhole-mailbox-server/", "platform": "", "project_url": "https://pypi.org/project/magic-wormhole-mailbox-server/", "project_urls": { "Homepage": "https://github.com/warner/magic-wormhole-mailbox-server" }, "release_url": "https://pypi.org/project/magic-wormhole-mailbox-server/0.4.1/", "requires_dist": [ "attrs (>=16.3.0)", "autobahn[twisted] (>=0.14.1)", "six", "twisted[tls] (>=17.5.0)", "pywin32; sys_platform==\"win32\"", "mock; extra == 'dev'", "pyflakes; extra == 'dev'", "tox; extra == 'dev'", "treq; extra == 'dev'" ], "requires_python": "", "summary": "Securely transfer data between computers", "version": "0.4.1" }, "last_serial": 5813384, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "2b4cb7e6be2e040b1b108dc070d67ae5", "sha256": "2eb0ea08b4c9b2e862c943dba8c14c3d0596eb34188f846ea7ad3a884b45bb56" }, "downloads": -1, "filename": "magic_wormhole_mailbox_server-0.1.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "2b4cb7e6be2e040b1b108dc070d67ae5", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 40260, "upload_time": "2018-02-20T00:56:13", "url": "https://files.pythonhosted.org/packages/ed/14/6facb2a124e6bd10237c1e4a9fee753be0d582dd9f4ed68255b8a76b199c/magic_wormhole_mailbox_server-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "66fca20cfee0a8f697593e14aef7ac75", "sha256": "6200e3acf58cc553b3b7f450ba74aa08c1a8e8da787b9bcb0d700184082ace29" }, "downloads": -1, "filename": "magic-wormhole-mailbox-server-0.1.0.tar.gz", "has_sig": true, "md5_digest": "66fca20cfee0a8f697593e14aef7ac75", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 58469, "upload_time": "2018-02-20T00:56:16", "url": "https://files.pythonhosted.org/packages/d7/84/0cab51cb117452828b4f6ff526626c43876c9a05dbeff1233c0a41941ae1/magic-wormhole-mailbox-server-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "d1f534df56d9f2bb969d6357861e204a", "sha256": "40ee78d3d0871023726f3c7054217db58644d0e0c23d99b3bc9536de4e741403" }, "downloads": -1, "filename": "magic_wormhole_mailbox_server-0.2.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "d1f534df56d9f2bb969d6357861e204a", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 40930, "upload_time": "2018-06-16T22:30:43", "url": "https://files.pythonhosted.org/packages/13/34/5e3363e76da59144162cfb45702e9576850d1b9d66dbd6d6dc595aad1854/magic_wormhole_mailbox_server-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "777475755af3722ac98ee785802763a0", "sha256": "e212019e6f424a3dc78f254934f4f861a757e44c98e0a3a64018b83af7dd9dd8" }, "downloads": -1, "filename": "magic-wormhole-mailbox-server-0.2.0.tar.gz", "has_sig": true, "md5_digest": "777475755af3722ac98ee785802763a0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 63539, "upload_time": "2018-06-16T22:30:44", "url": "https://files.pythonhosted.org/packages/95/aa/a65e408a861d6f32cc4fc43786ff77c9df21ccf1521e04c223e8149f3ccd/magic-wormhole-mailbox-server-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "962436fa921a2d8e2b8d2b889518182d", "sha256": "2c156dde5df5abcbdc5975f527e108729bacff7bc919b9c603df00a5a3faef46" }, "downloads": -1, "filename": "magic_wormhole_mailbox_server-0.3.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "962436fa921a2d8e2b8d2b889518182d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 45560, "upload_time": "2018-06-24T01:52:09", "url": "https://files.pythonhosted.org/packages/db/e1/eaa1d4211c6c94eaa89efa6d23f0f62c7a22ccd36e48e0ef253dba6b3bd9/magic_wormhole_mailbox_server-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "661f9eba20566236dc9f6095b2594e2a", "sha256": "0fd1595caa676162c9b555ba7bc83b449c3c857d42165cd4e77e0513113beac8" }, "downloads": -1, "filename": "magic-wormhole-mailbox-server-0.3.0.tar.gz", "has_sig": true, "md5_digest": "661f9eba20566236dc9f6095b2594e2a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 64382, "upload_time": "2018-06-24T01:52:11", "url": "https://files.pythonhosted.org/packages/85/e2/f10073bd2df455b27a7c277c44229d5106fd5bba086f165f300bc22a5c73/magic-wormhole-mailbox-server-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "de1038112fb529a94be72df9ec677261", "sha256": "1c5d4c0f9aa25082ca7956d15ee04461d09e2e5586850ad30e2bcf498d7717b8" }, "downloads": -1, "filename": "magic_wormhole_mailbox_server-0.3.1-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "de1038112fb529a94be72df9ec677261", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 45615, "upload_time": "2018-06-24T02:06:52", "url": "https://files.pythonhosted.org/packages/3d/13/e823c55937dd72c54dc0adca25e1d9ede10c6a660a5170a2b5b497b1dbd6/magic_wormhole_mailbox_server-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6ebcd4a5c3c3809b7dcd093b8e71bce8", "sha256": "a5ecbe7bc98414a5838952c4094fea81e9d619f6a75206593ef33287fa82dfe0" }, "downloads": -1, "filename": "magic-wormhole-mailbox-server-0.3.1.tar.gz", "has_sig": true, "md5_digest": "6ebcd4a5c3c3809b7dcd093b8e71bce8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 64459, "upload_time": "2018-06-24T02:06:54", "url": "https://files.pythonhosted.org/packages/0f/d0/af11e71e6a7e55d122e3658064ab5de83004943c587a521a3114521143a3/magic-wormhole-mailbox-server-0.3.1.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "1b39ca9a60846e5e626f06844070eeba", "sha256": "76b68375c961c1d0e23d6a622737efdd51c4d8dde1680725a9c8f8baa71cbf9f" }, "downloads": -1, "filename": "magic_wormhole_mailbox_server-0.4.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "1b39ca9a60846e5e626f06844070eeba", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 45831, "upload_time": "2019-09-11T06:02:27", "url": "https://files.pythonhosted.org/packages/43/ab/43d4f6d6db27f911afab1028a06fad64a078021f1001a872dd20ae3d4889/magic_wormhole_mailbox_server-0.4.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c988341cd34444417c4c3b5ba1f819be", "sha256": "f557669c224c6f16ccd73db0d1a67b12c5f0a252a496dea624f73380cd0c84af" }, "downloads": -1, "filename": "magic-wormhole-mailbox-server-0.4.0.tar.gz", "has_sig": true, "md5_digest": "c988341cd34444417c4c3b5ba1f819be", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 64816, "upload_time": "2019-09-11T06:02:29", "url": "https://files.pythonhosted.org/packages/82/9b/1e04d23181d4b673d3600dd18471a874d7472c6ea852908e68de55064b22/magic-wormhole-mailbox-server-0.4.0.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "249318217e212249ad907d5e46986172", "sha256": "1bf47755dba25dbfce99335f393b8a157515e098de6b5ed25324f679c3a5350e" }, "downloads": -1, "filename": "magic_wormhole_mailbox_server-0.4.1-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "249318217e212249ad907d5e46986172", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 45831, "upload_time": "2019-09-11T07:19:50", "url": "https://files.pythonhosted.org/packages/14/9c/a7196e59d6360ea79162d7284d2beeedfeed8c363bdff4db0d31b0450c1f/magic_wormhole_mailbox_server-0.4.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3da441df1f354a8399a728da3421ac8f", "sha256": "1af10592909caaf519c00e706eac842c5e77f8d4356215fe9c61c7b2258a88fb" }, "downloads": -1, "filename": "magic-wormhole-mailbox-server-0.4.1.tar.gz", "has_sig": true, "md5_digest": "3da441df1f354a8399a728da3421ac8f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 64830, "upload_time": "2019-09-11T07:19:52", "url": "https://files.pythonhosted.org/packages/5b/ba/cbb211bc8f8bfdf7fb620d33331f07bcd889c7a28e7fd8a0de9029bb5a2f/magic-wormhole-mailbox-server-0.4.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "249318217e212249ad907d5e46986172", "sha256": "1bf47755dba25dbfce99335f393b8a157515e098de6b5ed25324f679c3a5350e" }, "downloads": -1, "filename": "magic_wormhole_mailbox_server-0.4.1-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "249318217e212249ad907d5e46986172", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 45831, "upload_time": "2019-09-11T07:19:50", "url": "https://files.pythonhosted.org/packages/14/9c/a7196e59d6360ea79162d7284d2beeedfeed8c363bdff4db0d31b0450c1f/magic_wormhole_mailbox_server-0.4.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3da441df1f354a8399a728da3421ac8f", "sha256": "1af10592909caaf519c00e706eac842c5e77f8d4356215fe9c61c7b2258a88fb" }, "downloads": -1, "filename": "magic-wormhole-mailbox-server-0.4.1.tar.gz", "has_sig": true, "md5_digest": "3da441df1f354a8399a728da3421ac8f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 64830, "upload_time": "2019-09-11T07:19:52", "url": "https://files.pythonhosted.org/packages/5b/ba/cbb211bc8f8bfdf7fb620d33331f07bcd889c7a28e7fd8a0de9029bb5a2f/magic-wormhole-mailbox-server-0.4.1.tar.gz" } ] }