libQtShadowsocks

Introduction

libQtShadowsocks is a lightweight library for shadowsocks.

Written in C++ using Qt 5 framework, it aims to provide a developer-friendly shadowsocks library, mainly for Qt applications such as [shadowsocks-qt5] (https://github.com/librehat/shadowsocks-qt5/).

The client utilises this library. You can check the code to see how to use libQtShadowsocks in your project. client (shadowsocks-libQtShadowsocks) can also be used as both Shadowsocks local client and Shadowsocks server.

Check installation wiki page to see how to install this library and/or shadowsocks-libqss.

Current Status

###Supported Platforms###

Microsoft Windows (Vista or above)
Latest GNU/Linux distributions
*BSD (untested)
Mac OS X (untested)

###Supported Methods###

TABLE
AES-128-CFB
AES-192-CFB
AES-256-CFB
BF-CFB
CAMELLIA-128-CFB
CAMELLIA-192-CFB
CAMELLIA-256-CFB
CAST5-CFB
CHACHA20
DES-CFB
IDEA-CFB
RC2-CFB
RC4
RC4-MD5
SALSA20
SEED-CFB

RoadMap

Below features will possibly be implemented in future versions.

~~Traffic statistics (v1.2)~~
~~Server ping (v1.2)~~
~~ChaCha cipher (use bundled ChaCha for botan < 1.11)~~
~~Multiple servers balance (v1.4)~~
Multiple profiles balance (v1.6)
HTTP proxy (v1.6)
Test compatibility on BSD platforms (v1.6)
TCP fast open on Linux platform (v1.8)

Please open an issue to request a new feature.

License

This library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library. If not, see http://www.gnu.org/licenses/.

sfqtsh / libqtshadowsocks Goto Github PK