https://github.com/operatorfoundation/shapeshifter-swift-transports
Shapeshifter Swift Transports is a set of Pluggable Transports implementing the upcoming (currently unpublished) Swift API from the Pluggable Transports 2.1 specification https://OperatorFoundation.org/
https://github.com/operatorfoundation/shapeshifter-swift-transports
Last synced: about 1 year ago
JSON representation
Shapeshifter Swift Transports is a set of Pluggable Transports implementing the upcoming (currently unpublished) Swift API from the Pluggable Transports 2.1 specification https://OperatorFoundation.org/
- Host: GitHub
- URL: https://github.com/operatorfoundation/shapeshifter-swift-transports
- Owner: OperatorFoundation
- License: mit
- Created: 2017-10-24T20:03:18.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2022-06-24T01:25:02.000Z (almost 4 years ago)
- Last Synced: 2025-03-29T13:22:43.934Z (about 1 year ago)
- Language: Swift
- Size: 2.22 MB
- Stars: 3
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shapeshifter-Swift-Transports
Shapeshifter Swift Transports is a set of Pluggable Transports, written in Swift, implementing the upcoming (currently unpublished) Swift API from the Pluggable Transports [2.1 specification](https://github.com/Pluggable-Transports/Pluggable-Transports-spec)
### Shapeshifter Transports
This is the repository for the shapeshifter transports library for the Swift
programming language. If you are looking for a tool which you can install and
use from the command line, take a look at the [dispatcher](https://github.com/OperatorFoundation/shapeshifter-transports) instead.
The transports implement the Pluggable Transports 2.1 draft 1 specification available [here](https://github.com/Pluggable-Transports/Pluggable-Transports-spec/blob/master/releases/PTSpecV2.1Draft1/Pluggable%20Transport%20Specification%20v2.1%20-%20Swift%20Transport%20API%20v1.0%2C%20Draft%201.pdf) Specifically,
they implement the Swift Transports API v2.1 draft 1.
The purpose of the transport library is to provide a set of different
transports. Each transport implements a different method of shapeshifting
network traffic. The goal is for application traffic to be sent over the network
in a shapeshifted form that bypasses network filtering, allowing
the application to work on networks where it would otherwise be blocked or
heavily throttled.
The following transports are currently provided by this library:
#### Wisp
Wisp is a native Swift transport that is compatible with obfs4 servers.
See the [README](https://github.com/OperatorFoundation/Shapeshifter-Swift-Transports/blob/master/Sources/Wisp/README.md) for information on usage.
#### Optmizer
Optimizer is a pluggable transport that uses one of several possible “Strategies” to choose between the transports you provide to create a connection. It is not a standalone transport, but is rather a mechanism for choosing between various transports in order to find the one best suited for the user’s needs.
See the [README](https://github.com/OperatorFoundation/Shapeshifter-Swift-Transports/tree/master/Sources/Optimizer) for information on usage.
#### Protean
Protean is a pluggable transport that allows you to configure your own obfuscation.
See the [README](https://github.com/OperatorFoundation/Shapeshifter-Swift-Transports/tree/master/Sources/Protean) for information on usage.
## Installation
This library can be installed using [Swift Package Manager](https://swift.org/package-manager/). Please see instructions for using an individual transport in that transport's readme.
## Usage
Each transport can be used in place of a Network.Framework Connection. It is necessary to create an instance of a connection factory for the given transport and use that to create your connection. From that point forward the transports are designed to look and behave in your code in the same manner as Network.Framework. Please see the readmes for the individual transports for information on how to get a Connection instance for that transport.