fteproxy - GitLite

KO | EN

gitlite — search

#react #ai #llm #go #android #machine-learning #deep-learning #nodejs #macos #windows #awesome #awesome-list #vue #mcp

fteproxy

(★ 155)

programmable proxy for censorship circumvention

파일 탐색기

최종 버전 다운로드 (.zip)

- - codeql.yml
  - publish.yml
  - tests.yml
- dependabot.yml
- - README.md
  - start_client.sh
  - start_server.sh
- - client.py
  - README.md
  - server.py
- - comparison_demo.py
  - http_demo.py
  - README.md
  - words_demo.py
- - README.md
  - secure_chat.py
  - ssh_tunnel.sh
  - web_proxy.sh
- - demo.sh
  - README.md
- - custom_format.py
  - echo_client.py
  - echo_server.py
  - file_transfer.py
  - format_demo.py
  - README.md
  - simple_encoder.py
- README.md
- - 20131224.json
  - 20260110.json
  - __init__.py
- - __init__.py
  - conftest.py
  - test_examples.py
  - test_formats.py
  - test_python3.py
  - test_record_layer.py
  - test_relay.py
  - test_socket_wrapper.py
  - test_system.py
- __init__.py
- __main__.py
- cli.py
- client.py
- conf.py
- network_io.py
- record_layer.py
- relay.py
- server.py
.gitignore
benchmark.py
LICENSE
MANIFEST.in
PERFORMANCE.md
PYPI_README.md
pyproject.toml
README.md
requirements.txt
SECURITY.md
setup.py

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# fteproxy

[![Tests](https://github.com/kpdyer/fteproxy/actions/workflows/tests.yml/badge.svg)](https://github.com/kpdyer/fteproxy/actions/workflows/tests.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![PyPI version](https://img.shields.io/pypi/v/fteproxy.svg)](https://pypi.org/project/fteproxy/)

* Homepage: https://github.com/kpdyer/fteproxy
* Source code: https://github.com/kpdyer/fteproxy
* Publication: https://kpdyer.com/publications/ccs2013-fte.pdf

## Overview

fteproxy provides transport-layer protection to resist keyword filtering, censorship and discriminatory routing policies.
Its job is to relay datastreams, such as web browsing traffic, by encoding the stream into messages that satisfy a user-specified regular expression.

fteproxy is powered by Format-Transforming Encryption [1] and was presented at CCS 2013.

[1] [Protocol Misidentification Made Easy with Format-Transforming Encryption](https://kpdyer.com/publications/ccs2013-fte.pdf), Kevin P. Dyer, Scott E. Coull, Thomas Ristenpart and Thomas Shrimpton

## Requirements

- Python 3.10 or higher

## Installation

### From PyPI

```bash
pip install fteproxy
```

### From Source

```bash
git clone https://github.com/kpdyer/fteproxy.git
cd fteproxy
pip install -r requirements.txt
pip install -e .
```

## Usage

### Architecture

fteproxy operates as a client-server proxy:

```
[Application] <-> [fteproxy client] <--FTE encoded--> [fteproxy server] <-> [Destination]
```

### Start the Server

On the server machine:

```bash
python3 -m fteproxy --mode server --server_ip 0.0.0.0 --server_port 8080 --proxy_ip 127.0.0.1 --proxy_port 8081
```

This listens for FTE-encoded connections on port 8080 and forwards decoded traffic to 127.0.0.1:8081.

### Start the Client

On the client machine:

```bash
python3 -m fteproxy --mode client --client_ip 127.0.0.1 --client_port 8079 --server_ip <server-ip> --server_port 8080
```

This listens for plaintext connections on port 8079 and forwards FTE-encoded traffic to the server.

### Command Line Options

| Option | Description | Default |
|--------|-------------|---------|
| `--mode` | Relay mode: client or server | client |
| `--client_ip` | Client-side listening IP | 127.0.0.1 |
| `--client_port` | Client-side listening port | 8079 |
| `--server_ip` | Server-side listening IP | 127.0.0.1 |
| `--server_port` | Server-side listening port | 8080 |
| `--proxy_ip` | Forwarding-proxy listening IP | 127.0.0.1 |
| `--proxy_port` | Forwarding-proxy listening port | 8081 |
| `--key` | Cryptographic key (64 hex characters) | (default key) |
| `--key-file` | Path to a file containing the key (64 hex characters). Mutually exclusive with `--key`. | |
| `--quiet` | Suppress output | false |
| `--version` | Show version and exit | |

### Supplying the Key from a File

Passing the key with `--key` places it in your shell history and exposes it in
process listings (e.g. `ps aux`). To avoid this, write the key to a file and
point fteproxy at it with `--key-file`:

```bash
# Generate a random 64-hex-character (32-byte) key
python3 -c "import secrets; print(secrets.token_hex(32))" > fteproxy.key
chmod 600 fteproxy.key
```

Then start each side with `--key-file` (the client and server must use the same
key):

```bash
python3 -m fteproxy --mode server --key-file fteproxy.key --server_ip 0.0.0.0 --server_port 8080 --proxy_ip 127.0.0.1 --proxy_port 8081
python3 -m fteproxy --mode client --key-file fteproxy.key --client_ip 127.0.0.1 --client_port 8079 --server_ip <server-ip> --server_port 8080
```

The file must contain exactly 64 hexadecimal characters (a trailing newline is
ignored). `--key` and `--key-file` cannot be used together.

## Testing

```bash
python -m pytest fteproxy/tests/ -v
```

## License

MIT License - see [LICENSE](LICENSE) for details.

## Author

Kevin P. Dyer (kpdyer@gmail.com)