/ 
Net-OpenVPN-ProxyManager-HMA-0.02
/ Net::OpenVPN::ProxyManager::HMA

NAME

Net::OpenVPN::ProxyManager::HMA - connect to HideMyAss.com (HMA) proxy servers using OpenVPN.

SYNOPSIS

use Net::OpenVPN::ProxyManager::HMA;

my $pm_hma = Net::OpenVPN::ProxyManager::HMA->new;
my $servers = $pm_hma->get_servers({ name => 'usa', proto => 'tcp'});
$pm_hma->connect_to_random_server($servers);

DESCRIPTION

Net::OpenVPN::ProxyManager::HMA is an object oriented module that makes it easier to connected to HMA proxy servers by automatically downloading the latest list of available HMA proxy servers and the OpenVPN connection configuration (this is done at construction of the object).

DEPENDENCIES

To login to the HMA proxy servers, you will need to have an active account with HMA (http://hidemyass.com). I am not affiliated with HMA other than as a customer.

See Net::OpenVPN::ProxyManager::HMA for other dependencies.

METHODS

get_servers

This method returns an arrayhash of HMA servers available (the list is downloaded upon construction - Net::OpenVPN::ProxyManager::HMA->new). If no arguments are passed to this method, it will return the entire arrayhash of available servers (approximately 350).

The method accepts two optional string arguments as key value pairs: -Name, this is a string of the location name. HMA provide a location name string in the format: "Canada, Ontario, Toronto (LOC1 S1)". -Proto, this is the protocol option and can be either TCP or UDP. Many of the HMA servers accept both protocols.

Example my $usa_tcp_servers_arrayhash = $pm_hma->get_servers({name => 'usa', proto => 'tcp'});

connect_to_random_server

This method will invoke the hma_connect method on a random server when this method is called with an arrayhash of servers (as returned by the get_servers method).

Example $pm_hma->connect_to_random_server($arrayhash_of_servers);

hma_connect

The hma_connect method will initialise the OpenVPN program to a server with the HMA configuration. This method requires a hashref containing the attributes of the server (this is the same hashref format that is returned by the get_servers method).

Example my $pm_hma->hma_connect({ 'ip' => '104.202.33.5', 'name' => 'Canada, Ontario, Toronto (LOC1 S1)', 'country_code' => 'ca', 'tcp_flag' => 'TCP', 'udp_flag' => 'UDP', 'norandom_flag' => undefined });

AUTHOR

David Farrell, <davidnmfarrell at gmail.com>

BUGS

Please report any bugs or feature requests to bug-net-openvpn-proxymanager-hma at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-OpenVPN-ProxyManager. 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::OpenVPN::ProxyManager::HMA

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 David Farrell.

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.