The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Net-Shadowsocks-0.7.1
River stage zero No dependents
7 ++
/ Net::Shadowsocks

Net::Shadowsocks

VERSION

Version 0.7.1

SYNOPSIS

    Shadowsocks protocol client and server module.

The following shadowsocks encryption methods are supported:

rc4-md5 aes-128-cbc aes-128-cfb aes-128-ofb aes-256-cbc aes-256-cfb aes-256-ofb

This module also supports rc4-sha and rc6 encryption methods which are not available from other shadowsocks implementations.

Experimental server TCP Fast Open is also supported if available on Mac OS X and Linux.

Please also note that both the stock libmcrypt and stock Mcrypt module do not export CTR mode, So the aes-128-ctr and aes-256-ctr method will not work out of box. You have to use this patched version of libmcrypt and Libmcrypt module from https://osdn.net/projects/mcrypt/ to get it to work.

DESCRIPTION

Net::Shadowsocks is a Perl implementation of the shadowsocks (Chinese: 影梭) protocol client and server , Shadowsocks is a secure transport protocol based on SOCKS Protocol Version 5 (RFC 1928 ).

Design goal of this module is to provide same level of transport security as TLS 1.2, not more,not less. So it does not implement all the encryption methods supported by other Shadowsocks implementations if It is not also a TLS 1.2 cipher. To sum it up:

1. The following encryption methods are supported:

RC4-MD5 RC4-SHA AES-128-CBC AES-128-CFB AES-128-OFB AES-256-CBC AES-256-CFB AES-256-OFB

experimental support of RC6 is also provided.

2.The following ciphers deprecated by Shadowsocks are not supported: bf-cfb chacha20 salsa20

3.The following ciphers not recommended by Shadowsocks are not supported: aes-192-cfb aes-192-ctr camellia-128-cfb camellia-192-cfb camellia-256-cfb chacha20-ietf

4.The following ciphers recommended by Shadowsocks are not supported: aes-128-gcm aes-192-gcm aes-256-gcm chacha20-ietf-poly1305 xchacha20-ietf-poly1305

The following table shows TLS 1.2 cipher suite definitions and equivalent encryptions methods used in this module:

TLS 1.2 Cipher Suite Definitions Cipher Encryption sMethod

TLS_RSA_WITH_RC4_128_MD5 RC4_128 RC4-MD5 TLS_RSA_WITH_RC4_128_SHA RC4_128 RC4-SHA TLS_RSA_WITH_AES_128_CBC_SHA AES_128_CBC AES-128-CBC/CFB/OFB TLS_RSA_WITH_AES_256_CBC_SHA AES_256_CBC AES-256-CBC/CFB/OFB TLS_RSA_WITH_AES_128_CBC_SHA256 AES_128_CBC AES-128-CBC/CFB/OFB TLS_RSA_WITH_AES_256_CBC_SHA256 AES_256_CBC AES-256-CBC/CFB/OFB

Please note TLS 1.2 has removed IDEA and DES cipher suites. and because of CVE-2016-2183, http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-2183 , this module has removed all support for DES and 3DES ciphers.

Please also note that both the stock libmcrypt and stock Mcrypt module do not export CTR mode, So the aes-128-ctr and aes-256-ctr method will not work out of box. You have to use this patched version of libmcrypt and Libmcrypt module from https://osdn.net/projects/mcrypt/ to get it to work.

Project website https://osdn.net/projects/ssperl/

AUTHOR

Li ZHOU, <lzh at cpan.org>

BUGS

Please report any bugs or feature requests to bug-net-shadowsocks at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Shadowsocks. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Net::Shadowsocks

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2017 Li ZHOU.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS " AS IS ' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 110:

=pod directives shouldn't be over one line long! Ignoring all 3 lines of content