vvelox
/
Net-Connection-Match
mirror of https://github.com/VVelox/Net-Connection-Match.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add username support and test it

This commit is contained in:
Zane C. B-H 2019-08-06 05:19:53 -05:00
parent 19b6bb5021
commit c43094df14
4 changed files with 320 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Net-Connection-Match/Changes
View File

@ -4,6 +4,7 @@ Revision history for Net-Connection-Match
- Misc. POD fixes.
- Add RegexPTR support.
- Add UID support.
- Add username support.
0.1.0 2019-07-31/02:00
- Ports can now match '*'.

228
Net-Connection-Match/lib/Net/Connection/Match/Username.pm Normal file
View File

@ -0,0 +1,228 @@
package Net::Connection::Match::Username;
use 5.006;
use strict;
use warnings;
=head1 NAME
Net::Connection::Match::Username - Runs a username check against a Net::Connection object.
=head1 VERSION
Version 0.0.0
=cut
our $VERSION = '0.0.0';
=head1 SYNOPSIS
use Net::Connection::Match::Username;
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=(
usernames=>[
'root',
'slapd',
],
);
my $checker=Net::Connection::Match::Username->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 'usernames', which is a array of usernames to match.
Atleast one protocol must be present.
If the new method fails, it dies.
my %args=(
usernames=>[
'root',
'slapd',
],
);
my $checker=Net::Connection::Match::Username->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{usernames} ) ){
die ('No usernames key specified in the argument hash');
}
if ( ref( \$args{usernames} ) eq 'ARRAY' ){
die ('The usernames key is not a array');
}
if ( ! defined $args{usernames}[0] ){
die ('No states defined in the protos array');
}
my $self = {
usernames=>$args{usernames},
};
bless $self;
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;
}
# does not have a user.... we won't match
if ( ! defined( $object->username ) ){
return 0;
}
# check for matches
foreach my $username ( @{ $self->{usernames} } ){
if ( $username eq $object->username ){
return 1;
}
}
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

13
Net-Connection-Match/t/08-loat.t Normal file
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::Username' ) || print "Bail out!\n";
}
diag( "Testing Net::Connection::Match::Username $Net::Connection::Match::Username::VERSION, Perl $], $^X" );

78
Net-Connection-Match/t/Username.t Normal file
View File

@ -0,0 +1,78 @@
#!perl -T
use 5.006;
use strict;
use warnings;
use Test::More;
use Net::Connection;
BEGIN {
use_ok( 'Net::Connection::Match::Username' ) || 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',
uid=>0,
username=>'root'
};
my %args=(
usernames=>[
'root',
'foo',
],
);
my $checker;
# makes sure we error with empty args
my $worked=0;
eval{
$checker=Net::Connection::Match::Username->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::Username->new( \%args );
$worked=1;
};
ok( $worked eq '1', 'init check') or diag('Calling Net::Connection::Match::Username->new resulted in... '.$@);
# make sure it will not accept null input
my $returned=1;
eval{
$returned=$checker->match;
};
ok( $returned eq '0', 'proto 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 protocol and see if it matches
my $conn=Net::Connection->new( $connection_args );
$returned=0;
eval{
$returned=$checker->match( $conn );
};
ok( $returned eq '1', 'match check') or diag('Failed to match a matching good connection');
# Create a connection with a non-matching protocol and make sure it does not match
$connection_args->{username}='linda';
$conn=Net::Connection->new( $connection_args );
$returned=1;
eval{
$returned=$checker->match( $conn );
};
ok( $returned eq '0', 'non-match check') or diag('Matched a connection that it should not of');
done_testing(7);