Browse Source

begin work on protocol matching correct a few docs bits in states

tags/0.0.0
Zane C. B-H 6 months ago
parent
commit
8217f86980
5 changed files with 326 additions and 5 deletions
  1. +1
    -0
      Net-Connection-Match/MANIFEST
  2. +232
    -0
      Net-Connection-Match/lib/Net/Connection/Match/Protos.pm
  3. +5
    -5
      Net-Connection-Match/lib/Net/Connection/Match/States.pm
  4. +13
    -0
      Net-Connection-Match/t/03-load.t
  5. +75
    -0
      Net-Connection-Match/t/Protos.t

+ 1
- 0
Net-Connection-Match/MANIFEST View File

@@ -1,6 +1,7 @@
Changes
lib/Net/Connection/Match.pm
lib/Net/Connection/Match/CIDR.pm
lib/Net/Connection/Match/Protos.pm
lib/Net/Connection/Match/States.pm
Makefile.PL
MANIFEST This list of files

+ 232
- 0
Net-Connection-Match/lib/Net/Connection/Match/Protos.pm View File

@@ -0,0 +1,232 @@
package Net::Connection::Match::Protos;

use 5.006;
use strict;
use warnings;

=head1 NAME

Net::Connection::Match::Protos - Runs a basic state check against a Net::Connection object.

=head1 VERSION

Version 0.0.0

=cut

our $VERSION = '0.0.0';


=head1 SYNOPSIS

use Net::Connection::Match::Protos;
use Net::Connection;
my $connection_args={
foreign_host=>'10.0.0.1',
foreign_port=>'22',
local_host=>'10.0.0.2',
local_port=>'12322',
proto=>'tcp4',
state=>'ESTABLISHED',
};
my $conn=Net::Connection->new( $connection_args );
my %args=(
protos=>[
'tcp4',
'tcp6',
],
);
my $checker=Net::Connection::Match::Protos->new( \%args );
if ( $checker->match( $conn ) ){
print "It matches.\n";
}

=head1 METHODS

=head2 new

This intiates the object.

It takes a hash reference with one key. One key is required and
that is 'protos', which is a array of protocols to match against.

Atleast one state must be present.

If the new method fails, it dies.

my %args=(
protos=>[
'tcp4',
],
);
my $checker=Net::Connection::Match::Protos->new( \%args );

=cut

sub new{
my %args;
if(defined($_[1])){
%args= %{$_[1]};
};

# run some basic checks to make sure we have the minimum stuff required to work
if ( ! defined( $args{states} ) ){
die ('No states key specified in the argument hash');
}
if ( ref( \$args{protos} ) eq 'ARRAY' ){
die ('The states key is not a array');
}
if ( ! defined $args{protos}[0] ){
die ('No states defined in the protos array');
}

my $self = {
protos=>[],
};
bless $self;

# make sure each cidr is valid before returning it
my $protos_int=0;
while( defined( $args{protos}[$protos_int] ) ){
$self->{protos}[$protos_int]=lc( $args{protos}[$protos_int] );

$protos_int++;
}

return $self;
}

=head2 match

Checks if a single Net::Connection object matches the stack.

One argument is taken and that is a Net::Connection object.

The returned value is a boolean.

if ( $checker->match( $conn ) ){
print "The connection matches.\n";
}

=cut

sub match{
my $self=$_[0];
my $object=$_[1];

if ( !defined( $object ) ){
return 0;
}

if ( ref( $object ) ne 'Net::Connection' ){
return 0;
}

my $protos_int=0;
while( defined( $self->{protos}[$protos_int] ) ){
if ( $self->{protos}[$protos_int] eq lc( $object->proto ) ){
return 1;
}

$protos_int++;
}

return 0;
}

=head1 AUTHOR

Zane C. Bowers-Hadley, C<< <vvelox at vvelox.net> >>

=head1 BUGS

Please report any bugs or feature requests to C<bug-net-connection-match at rt.cpan.org>, or through
the web interface at L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Connection-Match>. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.




=head1 SUPPORT

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

perldoc Net::Connection::Match


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Connection-Match>

=item * AnnoCPAN: Annotated CPAN documentation

L<http://annocpan.org/dist/Net-Connection-Match>

=item * CPAN Ratings

L<https://cpanratings.perl.org/d/Net-Connection-Match>

=item * Search CPAN

L<https://metacpan.org/release/Net-Connection-Match>

=back


=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2019 Zane C. Bowers-Hadley.

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:

L<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.


=cut

1; # End of Net::Connection::Match

+ 5
- 5
Net-Connection-Match/lib/Net/Connection/Match/States.pm View File

@@ -6,7 +6,7 @@ use warnings;

=head1 NAME

Net::Connection::Match::State - Runs a basic state check against a Net::Connection object.
Net::Connection::Match::States - Runs a basic state check against a Net::Connection object.

=head1 VERSION

@@ -19,7 +19,7 @@ our $VERSION = '0.0.0';

=head1 SYNOPSIS

use Net::Connection::Match::CIDR;
use Net::Connection::Match::States;
use Net::Connection;
my $connection_args={
@@ -40,7 +40,7 @@ our $VERSION = '0.0.0';
],
);
my $checker=Net::Connection::Match::State->new( \%args );
my $checker=Net::Connection::Match::States->new( \%args );
if ( $checker->match( $conn ) ){
print "It matches.\n";
@@ -53,7 +53,7 @@ our $VERSION = '0.0.0';
This intiates the object.

It takes a hash reference with one key. One key is required and
that is 'state', which is a array of states to match against.
that is 'states', which is a array of states to match against.

Atleast one state must be present.

@@ -83,7 +83,7 @@ sub new{
die ('The states key is not a array');
}
if ( ! defined $args{states}[0] ){
die ('No states defined in the cidrs array');
die ('No states defined in the states array');
}

my $self = {

+ 13
- 0
Net-Connection-Match/t/03-load.t View File

@@ -0,0 +1,13 @@
#!perl -T
use 5.006;
use strict;
use warnings;
use Test::More;

plan tests => 1;

BEGIN {
use_ok( 'Net::Connection::Match::Protos' ) || print "Bail out!\n";
}

diag( "Testing Net::Connection::Match::Protos $Net::Connection::Match::Protos::VERSION, Perl $], $^X" );

+ 75
- 0
Net-Connection-Match/t/Protos.t View File

@@ -0,0 +1,75 @@
#!perl -T
use 5.006;
use strict;
use warnings;
use Test::More;
use Net::Connection;

BEGIN {
use_ok( 'Net::Connection::Match::Protos' ) || print "Bail out!\n";
}

my $connection_args={
foreign_host=>'10.0.0.1',
foreign_port=>'22',
local_host=>'10.0.0.2',
local_port=>'12322',
proto=>'tcp4',
state=>'LISTEN',
};

my %args=(
protos=>[
'tcp4',
],
);
my $checker;

# makes sure we error with empty args
my $worked=0;
eval{
$checker=Net::Connection::Match::Protos->new();
$worked=1;
};
ok( $worked eq '0', 'empty init check') or diag('Calling new with empty args worked');

# makes sure we can init with good args
$worked=0;
eval{
$checker=Net::Connection::Match::Protos->new( \%args );
$worked=1;
};
ok( $worked eq '1', 'init check') or diag('Calling Net::Connection::Match::Protos->new resulted in... '.$@);

# make sure it will not accept null input
my $returned=1;
eval{
$returned=$checker->match;
};
ok( $returned eq '0', 'match undef check') or diag('match accepted undefined input');

# make sure it will not accept a improper ref type
$returned=1;
eval{
$returned=$checker->match($checker);
};
ok( $returned eq '0', 'match improper ref check') or diag('match accepted a ref other than Net::Connection');

# Create a connection with a matching state and see if it matches
my $conn=Net::Connection->new( $connection_args );
$returned=0;
eval{
$returned=$checker->match( $conn );
};
ok( $returned eq '1', 'state match check') or diag('Failed to match a matching good state');

# Create a connection with a non-matching state and make sure it does not match
$connection_args->{proto}='udp4';
$conn=Net::Connection->new( $connection_args );
$returned=1;
eval{
$returned=$checker->match( $conn );
};
ok( $returned eq '0', 'state non-match check') or diag('Matched a state that it should not of');

done_testing(7);

Loading…
Cancel
Save