# ptadapter
`ptadapter` is a Python 3
package that interfaces with Pluggable Transports.
Pluggable Transports (PT) are originally created for [Tor] as a modular,
interchangeable (pluggable) method of tunneling and obfuscating
network traffic (transport). This design makes PTs useful not only for
Tor, but many other use cases where traffic obfuscation is desired.
Learn more about Pluggable Transports at the dedicated website,
https://www.pluggabletransports.info/
[Tor]: https://torproject.org/
This package implements Version 1 of the Pluggable Transport
specifications (relevant specs can be found in the `specifications`
directory). Version 2 of the specs is in development: refer to the
website linked above for progress.
(This package also implements Tor's Extended ORPort protocol, which
can be optionally used to receive server connections from PTs.)
**This package REQUIRES Python 3.7 or higher.** It has no 3rd-party
dependencies.
## What's Included
This package implements several Python classes that execute and
communicate with a PT subprocess, allowing connections to be made
through the PT as a client, or received as a server.
The code is built on top of `asyncio`, and uses the familiar
`StreamReader` and `StreamWriter` for connections.
Also included is a ready-made tool that can run PTs as a standalone
tunnel. No coding is necessary to use this.
## What's Required
* Python 3.7 or above.
* The Pluggable Transport to be used, as an executable program. This
may be installed from the repository, built from source, extracted
from the Tor Browser Bundle, etc.
## How to get this package
This package is now uploaded to PyPI, so install it the usual way:
pip install ptadapter
If you don't want to install, you could also
clone this repository or download a source package, and put the
`ptadapter` directory in the working directory or somewhere in your
PYTHONPATH.
## How to use PTs in you own Python program
Start with the [Developer Guide] page in the [Documentation].
[Developer Guide]: https://ptadapter.readthedocs.io/en/latest/dev.html
[Documentation]: https://ptadapter.readthedocs.io/en/latest/index.html
## How to create a standalone PT tunnel
If the package is installed via `pip`, an entry script called
`ptadapter` is created, so run the command below to see usage:
ptadapter --help
Otherwise, run:
python -m ptadapter --help
A configuration file should be provided to the script.
The [console script guide page] in the [Documentation] includes
an example config file with detailed comments; the example config file
can also be found in this repository.
[console script guide page]: https://ptadapter.readthedocs.io/en/latest/console_script.html
Raw data
{
"_id": null,
"home_page": "https://github.com/twisteroidambassador/ptadapter",
"name": "ptadapter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "pluggable-transport obfuscation tcp",
"author": "twisteroid ambassador",
"author_email": "twisteroid.ambassador@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f8/aa/cab2742d759e3e7205b9627f1cc3912d47dc920b0a73c2d29acde53dad5e/ptadapter-3.0.1.tar.gz",
"platform": null,
"description": "# ptadapter\r\n\r\n`ptadapter` is a Python 3\r\npackage that interfaces with Pluggable Transports.\r\n\r\nPluggable Transports (PT) are originally created for [Tor] as a modular,\r\ninterchangeable (pluggable) method of tunneling and obfuscating\r\nnetwork traffic (transport). This design makes PTs useful not only for\r\nTor, but many other use cases where traffic obfuscation is desired.\r\nLearn more about Pluggable Transports at the dedicated website,\r\nhttps://www.pluggabletransports.info/\r\n\r\n[Tor]: https://torproject.org/\r\n\r\nThis package implements Version 1 of the Pluggable Transport\r\nspecifications (relevant specs can be found in the `specifications`\r\ndirectory). Version 2 of the specs is in development: refer to the\r\nwebsite linked above for progress.\r\n\r\n(This package also implements Tor's Extended ORPort protocol, which\r\ncan be optionally used to receive server connections from PTs.)\r\n\r\n**This package REQUIRES Python 3.7 or higher.** It has no 3rd-party\r\ndependencies.\r\n\r\n## What's Included\r\n\r\nThis package implements several Python classes that execute and\r\ncommunicate with a PT subprocess, allowing connections to be made\r\nthrough the PT as a client, or received as a server.\r\nThe code is built on top of `asyncio`, and uses the familiar\r\n`StreamReader` and `StreamWriter` for connections.\r\n\r\nAlso included is a ready-made tool that can run PTs as a standalone\r\ntunnel. No coding is necessary to use this.\r\n\r\n## What's Required\r\n\r\n* Python 3.7 or above.\r\n* The Pluggable Transport to be used, as an executable program. This\r\n may be installed from the repository, built from source, extracted\r\n from the Tor Browser Bundle, etc.\r\n\r\n## How to get this package\r\n\r\nThis package is now uploaded to PyPI, so install it the usual way:\r\n\r\n pip install ptadapter\r\n\r\nIf you don't want to install, you could also\r\nclone this repository or download a source package, and put the\r\n`ptadapter` directory in the working directory or somewhere in your\r\nPYTHONPATH.\r\n\r\n## How to use PTs in you own Python program\r\n\r\nStart with the [Developer Guide] page in the [Documentation]. \r\n\r\n[Developer Guide]: https://ptadapter.readthedocs.io/en/latest/dev.html \r\n[Documentation]: https://ptadapter.readthedocs.io/en/latest/index.html\r\n\r\n## How to create a standalone PT tunnel\r\n\r\nIf the package is installed via `pip`, an entry script called\r\n`ptadapter` is created, so run the command below to see usage:\r\n\r\n ptadapter --help\r\n\r\nOtherwise, run:\r\n\r\n python -m ptadapter --help\r\n\r\nA configuration file should be provided to the script.\r\nThe [console script guide page] in the [Documentation] includes\r\nan example config file with detailed comments; the example config file\r\ncan also be found in this repository.\r\n\r\n[console script guide page]: https://ptadapter.readthedocs.io/en/latest/console_script.html\r\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Pluggable Transports Python interface & standalone tunnels",
"version": "3.0.1",
"project_urls": {
"Documentation": "https://twisteroidambassador.github.io/ptadapter-docs/",
"Homepage": "https://github.com/twisteroidambassador/ptadapter",
"Tracker": "https://github.com/twisteroidambassador/ptadapter/issues"
},
"split_keywords": [
"pluggable-transport",
"obfuscation",
"tcp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7da2c65d9148afd577b8e54eb825e3fedf6e049d0e08c993f88704e97a41095",
"md5": "c13d0a11f66fa730940889eef072f531",
"sha256": "8a00b578552f6fb9e141f551ef01a98258ad80220a2757b9e28597f851fe80a5"
},
"downloads": -1,
"filename": "ptadapter-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c13d0a11f66fa730940889eef072f531",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 33642,
"upload_time": "2024-09-02T06:13:17",
"upload_time_iso_8601": "2024-09-02T06:13:17.198842Z",
"url": "https://files.pythonhosted.org/packages/e7/da/2c65d9148afd577b8e54eb825e3fedf6e049d0e08c993f88704e97a41095/ptadapter-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f8aacab2742d759e3e7205b9627f1cc3912d47dc920b0a73c2d29acde53dad5e",
"md5": "a4790e8b05c544b0c177b8dc34e954b8",
"sha256": "910d6e102726f005ae0d073f1acc2905bab5a0d3e6b43cecb86a3834fae0fd78"
},
"downloads": -1,
"filename": "ptadapter-3.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a4790e8b05c544b0c177b8dc34e954b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 32244,
"upload_time": "2024-09-02T06:13:19",
"upload_time_iso_8601": "2024-09-02T06:13:19.368731Z",
"url": "https://files.pythonhosted.org/packages/f8/aa/cab2742d759e3e7205b9627f1cc3912d47dc920b0a73c2d29acde53dad5e/ptadapter-3.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 06:13:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "twisteroidambassador",
"github_project": "ptadapter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ptadapter"
}
JSON
