NAME

IO::Socket::Socks::Wrapper - Allow any perl package to work through a socks proxy

SYNOPSIS

        # we can wrap all connections
        use IO::Socket::Socks::Wrapper { # should be before any other `use'
                ProxyAddr => 'localhost',
                ProxyPort => 1080,
                SocksDebug => 1,
                Timeout => 10
        };
        
        # except Net::FTP
        IO::Socket::Socks::Wrapper->import(Net::FTP:: => 0); # direct network access

        # we can wrap connection for separate object
        # if package internally uses IO::Socket for connections (for most this is true)
        
        use v5.10;
        use IO::Socket::Socks::Wrapper 'wrap_connection';
        use Mojo::UserAgent;
        
        my $ua = wrap_connection(Mojo::UserAgent->new, {
                ProxyAddr => 'localhost',
                ProxyPort => 1080,
                SocksDebug => 1
        });
        
        # $ua now uses socks5 proxy for connections
        say $ua->get('http://www.google.com')->success->code;

        # we can wrap connection for separate packages
        # if package inherited from IO::Socket
        # let's wrap Net::FTP and Net::HTTP
        
        use IO::Socket::Socks::Wrapper (
                Net::FTP => {
                        ProxyAddr => '10.0.0.1',
                        ProxyPort => 1080,
                        SocksDebug => 1,
                        Timeout => 15
                },
                Net::FTP::dataconn => {
                        ProxyAddr => '10.0.0.1',
                        ProxyPort => 1080,
                        SocksDebug => 1,
                        Timeout => 15
                },
                Net::HTTP => {
                        ProxyAddr => '10.0.0.2',
                        ProxyPort => 1080,
                        SocksVersion => 4,
                        SocksDebug => 1,
                        Timeout => 15
                }
        );
        use Net::FTP;
        use Net::POP3;
        use LWP; # it uses Net::HTTP for http connections
        use strict;
        
        my $ftp = Net::FTP->new();       # via socks5://10.0.0.1:1080
        my $lwp = LWP::UserAgent->new(); # via socks4://10.0.0.2:1080
        my $pop = Net::POP3->new();      # direct network access
        
        ...
        
        # change proxy for Net::HTTP
        IO::Socket::Socks::Wrapper->import(Net::HTTP:: => {ProxyAddr => '10.0.0.3', ProxyPort => 1080});

        # we can wrap connection for packages that hasn't separate modules
        # let's make more direct LWP::UserAgent wrapping
        
        # we need to associate LWP::Protocol::http::Socket and LWP::Protocol::https::Socket packages
        # with socks proxy
        # this packages do not have separate modules
        # LWP::Protocol::http and LWP::Protocol::https modules includes this packages respectively
        # IO::Socket::Socks::Wrapper should has access to @ISA of each package which want to be wrapped
        # when package == module it can load packages automatically and do its magic
        # but in the case like this loading will fail
        # so, we should load this modules manually
        
        use LWP::Protocol::http;
        use LWP::Protocol::https;
        use IO::Socket::Socks::Wrapper (
                LWP::Protocol::http::Socket => {
                        ProxyAddr => 'localhost',
                        ProxyPort => 1080,
                        SocksDebug => 1,
                        Timeout => 15
                },
                LWP::Protocol::https::Socket => {
                        ProxyAddr => 'localhost',
                        ProxyPort => 1080,
                        SocksDebug => 1,
                        Timeout => 15
                }
        );
        use LWP;
        
        # then use lwp as usual
        my $ua = LWP::UserAgent->new();
        
        # in this case Net::HTTP and Net::HTTPS objects will use direct network access
        # but LWP::UserAgent objects will use socks proxy

        # we can wrap packages that is not inherited from IO::Socket
        # but uses IO::Socket object as internal socket handle
        
        use HTTP::Tiny; # HTTP::Tiny::Handle package is in HTTP::Tiny module
        use IO::Socket::Socks::Wrapper (
                # HTTP::Tiny::Handle::connect sub invokes IO::Socket::INET->new
                # see HTTP::Tiny sourse code
                'HTTP::Tiny::Handle::connect()' => { # parentheses required
                        ProxyAddr => 'localhost',
                        ProxyPort => 1080,
                        SocksVersion => 4,
                        Timeout => 15
                }
        );
        
        # via socks
        my $page = HTTP::Tiny->new->get('http://www.google.com/')->{content};
        
        # disable wrapping for HTTP::Tiny
        IO::Socket::Socks::Wrapper->import('HTTP::Tiny::Handle::connect()' => 0);
        # and get page without socks
        $page = HTTP::Tiny->new->get('http://www.google.com/')->{content};

        # we can wrap packages that uses bult-in connect()
        # Net::Telnet for example
        
        use IO::Socket::Socks::Wrapper (
                Net::Telnet => {
                        _norequire => 1, # should tell do not load it
                                         # because buil-in connect should be overrided
                                         # before package being compiled
                        ProxyAddr => 'localhost',
                        ProxyPort => 1080,
                        SocksDebug => 1
                }
        );
        use Net::Telnet; # and load it after manually

DESCRIPTION

IO::Socket::Socks::Wrapper allows to wrap up the network connections into socks proxy. It can wrap up any network connection, connection from separate packages or even connection from separate object.

METHODS

import( CFG )

import() is invoked when IO::Socket::Socks::Wrapper loaded by `use' command. Later it can be invoked manually to change proxy. Global overriding will not work in the packages that was loaded before calling IO::Socket::Socks::Wrapper->import(). So, for this purposes `use IO::Socket::Socks::Wrapper' with $hashref argument should be before any other `use' statements.

CFG syntax

Global wrapping

Only $hashref should be specified. $hashref is a reference to a hash with key/value pairs same as IO::Socket::Socks constructor options, but without (Connect|Bind|Udp)Addr and (Connect|Bind|Udp)Port. To disable wrapping $hashref could be scalar with false value.

Wrapping package that inherits from IO::Socket

Examples are: Net::FTP, Net::POP3, Net::HTTP

        'pkg' => $hashref

Where pkg is a package name that is responsible for connections. For example if you want to wrap LWP http connections, then module name should be Net::HTTP, for https connections it should be Net::HTTPS or even LWP::Protocol::http::Socket and LWP::Protocol::https::Socket respectively (see examples above). You really need to look at the source code of the package which you want to wrap to determine the name for wrapping. Or use global wrapping which will wrap all that can. Use `SocksDebug' to verify that wrapping works. For $hashref description see above.

Wrapping package that uses built-in connect()

Examples are: Net::Telnet

        'pkg' => $hashref

Syntax is the same as for wrapping package that inherits from IO::Socket except for one point. Replacing of built-in connect() should be performed before package being actually loaded. For this purposes you should specify _norequire key with true value for $hashref CFG. This will prevent package loading, so you need to require this package manually after.

Wrapping package that uses IO::Socket object or class object inherited from IO::Socket as internal socket handle

Examples are: HTTP::Tiny (HTTP::Tiny::Handle::connect)

        'pkg::sub()' => $hashref

Where sub is a name of subroutine contains IO::Socket object creation/connection. Parentheses required. For pkg and $hashref description see above.

Wrapping objects

To wrap object connection you should use wrap_connection($obj, $hashref) subroutine, which may be imported manually. $obj may be any object that uses IO::Socket for tcp connections creation. This subroutine will return new object which you should use. Returned object is object of IO::Socket::Socks::Wrapped class and it has all methods that original object has. You can also use original object as before, but it will create direct connections without proxy. For more details see IO::Socket::Socks::Wrapped documentation. For $hashref description see above.

NOTICE

Default timeout for wrapped connect is timeout value for socket on which we trying to connect. This timeout value checked only for sockets inherited from IO::Socket. For example LWP::UserAgent->new(timeout => 5) creates socket with timeout 5 sec, so no need to additionally specify timeout for IO::Socket::Socks::Wrapper. If socket timeout not specified or socket not inherited from IO::Socket then default timeout will be 180 sec. You can specify your own value using Timeout option. Set it to zero if you don't want to limit connection attempt time.

BUGS

Wrapping doesn't work with impure perl packages. WWW::Curl for example.

SEE ALSO

IO::Socket::Socks, IO::Socket::Socks::Wrapped

COPYRIGHT

Oleg G <oleg@cpan.org>.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.