https://github.com/ocfbnj/ss-rs

An unofficial shadowsocks implementation that can work with official shadowsocks.
https://github.com/ocfbnj/ss-rs

proxy rust shadowsocks socks5

Last synced: 2 months ago
JSON representation

An unofficial shadowsocks implementation that can work with official shadowsocks.

• Host: GitHub
• URL: https://github.com/ocfbnj/ss-rs
• Owner: ocfbnj
• License: mit
• Created: 2022-05-21T09:00:22.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-24T09:50:55.000Z (9 months ago)
• Last Synced: 2024-04-24T16:19:19.636Z (8 months ago)
• Topics: proxy, rust, shadowsocks, socks5
• Language: Rust
• Homepage:
• Size: 152 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ss-rs

[![Cargo Build & Test](https://github.com/ocfbnj/ss-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/ocfbnj/ss-rs/actions/workflows/ci.yml)

[![Crates.io](https://img.shields.io/crates/v/ss-rs)](https://crates.io/crates/ss-rs)

An unofficial shadowsocks implementation that can work with official shadowsocks.

## Features

- [x] [SOCKS5](https://datatracker.ietf.org/doc/html/rfc1928) CONNECT command

- [x] [AEAD](https://shadowsocks.org/en/wiki/AEAD-Ciphers.html) ciphers

- [x] Defend against [replay attacks](https://github.com/shadowsocks/shadowsocks-org/issues/44)

- [x] [Access control list](https://github.com/shadowsocks/shadowsocks-rust#acl)

- [x] [SIP003](https://github.com/shadowsocks/shadowsocks-org/issues/28) Plugins

## Get Started

### Server

Start a server listening on port 5421 using `chacha20-ietf-poly1305` AEAD cipher with password `ocfbnj`.

~~~bash

ss-rs -s 0.0.0.0:5421 -k ocfbnj -m chacha20-ietf-poly1305

~~~

### Client

Start a client connecting to the `ocfbnj.cn`.

The client listens on port 1080 for incoming SOCKS5 connections and uses `chacha20-ietf-poly1305` AEAD cipher with password `ocfbnj`.

~~~bash

ss-rs -s ocfbnj.cn:5421 -l localhost:1080 -k ocfbnj -m chacha20-ietf-poly1305

~~~

## How to build

### Prerequisites

- Cargo installed (See [this](https://www.rust-lang.org/learn/get-started)).

### Building with Cargo

1. Clone

    ~~~bash

    git clone https://github.com/ocfbnj/ss-rs

    cd ss-rs

    ~~~

2. Build

    ~~~bash

    cargo b --release

    ~~~

    Now you can find the binary in `./target/release/ss-rs`.

## References

- 

-