A lightweight and ultra-fast shadowsocks library written in C++/Qt
Clone or download
Pull request Compare This branch is 231 commits behind shadowsocks:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
debian
lib
shadowsocks-libqss
.gitignore
LICENSE
QtShadowsocks.pro
README.md

README.md

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 shadowsocks-libqss utilises this library. You can check the code to see how to use libQtShadowsocks in your project. shadowsocks-libqss can also be used as a standalone program in both shadowsocks local-side and shadowsocks server-side.

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

Current Status

###Supported Platforms###

  • Microsoft Windows (Vista or above)
  • GNU/Linux
  • *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
  • SERPENT-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)
  • Asynchronous DNS query (v1.6)
  • HTTP proxy(v1.7)
  • Test compatibility on BSD platforms (v1.8)
  • Multiple profiles balance (v1.8)
  • QML module (v1.10)

Please open an issue to request a new feature.

License

Copyright (C) 2014-2015 Symeon Huang

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/.