Alex Efros
and 1 contributors

NAME

IO::Stream::Proxy::HTTPS - HTTPS proxy plugin for IO::Stream

VERSION

This document describes IO::Stream::Proxy::HTTPS version 1.0.5

SYNOPSIS

    use IO::Stream;
    use IO::Stream::Proxy::HTTPS;

    IO::Stream->new({
        ...
        plugin => [
            ...
            proxy   => IO::Stream::Proxy::HTTPS->new({
                host    => 'my.proxy.com',
                port    => 3128,
                user    => 'me',
                pass    => 'mypass',
            }),
            ...
        ],
    });

DESCRIPTION

This module is plugin for IO::Stream which allow you to route stream through HTTPS (also called CONNECT) proxy.

You may use several IO::Stream::Proxy::HTTPS plugins for single IO::Stream object, effectively creating proxy chain (first proxy plugin will define last proxy in a chain).

EVENTS

When using this plugin event RESOLVED will never be delivered to user because target {host} which user provide to IO::Stream will never be resolved on user side (it will be resolved by HTTPS proxy).

Event CONNECTED will be generated after HTTPS proxy successfully connects to target {host} (and not when socket will connect to HTTPS proxy itself).

INTERFACE

new({ host=>$host, port=>$port })
new({ host=>$host, port=>$port, user=>$user, pass=>$pass })

Connect to proxy $host:$port, optionally using basic authorization.

DIAGNOSTICS

{host}+{port} required

You must provide both {host} and {port} to IO::Stream::Proxy::HTTPS->new().

{user}+{pass} required

You have provided either {user} or {pass} to IO::Stream::Proxy::HTTPS->new() while you have to provide either both or none of them.

{fh} already connected

You have provided {fh} to IO::Stream->new(), but this is not supported by this plugin. Either don't use this plugin or provide {host}+{port} to IO::Stream->new() instead.

CONFIGURATION AND ENVIRONMENT

IO::Stream::Proxy::HTTPS requires no configuration files or environment variables.

DEPENDENCIES

IO::Stream.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to author, or bug-io-stream-proxy-https@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Alex Efros <powerman-asdf@ya.ru>

LICENSE AND COPYRIGHT

Copyright (c) 2008, Alex Efros <powerman-asdf@ya.ru>. All rights reserved.

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.