NAME
Net::NSCA::Client::Connection::TLS - Represents the transport layer security on a connection.
VERSION
This documentation refers to Net::NSCA::Client::Connection::TLS version 0.001
SYNOPSIS
use Net::NSCA::Client::Connection::TLS;
# Create a new connection TLS
my $tls = Net::NSCA::Client::Connection::TLS->new(
encryption_type => 'blowfish',
password => $my_secret_password,
);
# Encrypt a packet
my $encrypted_packet = $tls->encrypt(
byte_stream => $data_packet,
iv => $iv_salt,
);
DESCRIPTION
Represents a connection between the NSCA client and server.
CONSTRUCTOR
This is fully object-oriented, and as such before any method can be used, the constructor needs to be called to create an object to work with.
new
This will construct a new object.
- new(%attributes)
-
%attributes
is a HASH where the keys are attributes (specified in the "ATTRIBUTES" section). - new($attributes)
-
$attributes
is a HASHREF where the keys are attributes (specified in the "ATTRIBUTES" section).
ATTRIBUTES
# Set an attribute
$object->attribute_name($new_value);
# Get an attribute
my $value = $object->attribute_name;
encryption_type
This is the type of encryption for this transport layer security object. This will default to "xor".
password
This is the password to use for the encryption.
METHODS
encrypt
This will encrypt a byte stream according to the attributes of the object. This method takes a HASH of arguments with the following keys:
byte_stream
Required
This is the byte stream to encrypt.
iv
Required
This is the initialization vector to use when encrypting the byte stream.
CONSTANTS
TODO: Write this
DEPENDENCIES
Moose 0.89
namespace::clean 0.04
AUTHOR
Douglas Christopher Wilson, <doug at somethingdoug.com>
BUGS AND LIMITATIONS
Please report any bugs or feature requests to bug-net-nsca-client at rt.cpan.org
, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-NSCA-Client. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
I highly encourage the submission of bugs and enhancements to my modules.
LICENSE AND COPYRIGHT
Copyright 2009 Douglas Christopher Wilson.
This program is free software; you can redistribute it and/or modify it under the terms of either:
the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or
the Artistic License version 2.0.