diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3a2814b --- /dev/null +++ b/LICENSE @@ -0,0 +1,379 @@ +This software is copyright (c) 2021 by Dominik Meyer. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--- The GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2021 by Dominik Meyer. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. 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 PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 19yy + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2021 by Dominik Meyer. + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..5ab93a8 --- /dev/null +++ b/dist.ini @@ -0,0 +1,41 @@ +name = Net-ClamAV-Client +author = Domink Meyer +license = Perl_5 +copyright_holder = Dominik Meyer +copyright_year = 2021 + +main_module = lib/Net/ClamAV/Client.pm + +[Readme] +[License] +[MetaYAML] +[ManifestSkip] +[PruneCruft] +[CopyFilesFromBuild] + copy = LICENSE + +[GatherDir] + exclude_filename = LICENSE + +[ExtraTests] +[ExecDir] +[MakeMaker] +[Manifest] + +[MetaResources] +repository.url = https://gitea.federationhq.de/byterazor/Net-ClamAV-Client +repository.type = git +bugtracker.url = https://gitea.federationhq.de/byterazor/Net-ClamAV-Client/issues + +[@Git] +[Git::NextVersion] +first_version = 0.1 ; this is the default +version_by_branch = 1 ; this is the default +[PkgVersion] + +[AutoPrereqs] +[PodWeaver] +[ChangelogFromGit] +[@TestingMania] +disable = Test::CPAN::Changes +[MetaProvides::Package] diff --git a/eicar.com b/eicar.com new file mode 100644 index 0000000..a2463df --- /dev/null +++ b/eicar.com @@ -0,0 +1 @@ +X5O!P%@AP[4\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H* \ No newline at end of file diff --git a/lib/Net/ClamAV/Client.pm b/lib/Net/ClamAV/Client.pm new file mode 100644 index 0000000..79483ab --- /dev/null +++ b/lib/Net/ClamAV/Client.pm @@ -0,0 +1,593 @@ +use strict; +package Net::ClamAV::Client; +# ABSTRACT: A client class for the ClamAV C virus scanner daemon + +use warnings; +use Moose; +use IO::Socket; +use IO::Handle; +use IO::File; +use Net::ClamAV::Exception::Connect; +use Net::ClamAV::Exception::Command; +use Net::ClamAV::Exception::Result; +use Net::ClamAV::Exception::Other; +use Net::ClamAV::Exception::Unsupported; + +=head1 SYNOPSIS + +=head2 Creating a scanner client + + use Net::ClamAV::Client; + + # Use a TCP inet domain socket + my $scanner = Net::ClamAV::Client->new(url => "localhost:3310"); + + # Use a local Unix domain socket: + $scanner = Net::ClamAV::Client->new(url => "/var/run/clamav/clamd.ctl"); + + die("ClamAV daemon not alive") + if not defined($scanner) or not $scanner->ping(); + + +=head2 Daemon maintenance + + my $scanner = Net::ClamAV::Client->new(url => "localhost:3310"); + + my $version = $scanner->version; + # Retrieve the ClamAV version string. + + $scanner->reload(); # Reload the malware pattern database. + + $scanner->quit(); # Terminates the ClamAV daemon. + $scanner->shutdown(); # Likewise. + +=head2 Path scanning + + # Scan a single file or a whole directory structure, + # and stop at the first infected file. For this to work + # the clamd has to run on the local host: + + my $scanner = Net::ClamAV::Client->new(url => "localhost:3310"); + my @results = $scanner->scanLocalPath("/etc/groups"); + +=head2 Path scanning (complete) + + # Scan a single file or a whole directory structure, + # and scan all files without stopping at the first infected one: + my $scanner = Net::ClamAV::Client->new(url => "localhost:3310"); + my @results2 = $scanner->scanLocalPathContinous("/etc/"); + +=head2 Other scanning methods + + my $handle; + my $scanner = Net::ClamAV::Client->new(url => "localhost:3310"); + # Scan a stream, i.e. read from an I/O handle: + my $result = $scanner->scanStream($handle); + + # Scan a scalar value: + my $value; # some file in a scalar + my $result2 = $scanner->scanScalar(\$value); + +=head1 DESCRIPTION + +B is a class acting as a client for a ClamAV C virus +scanner daemon. The daemon may run locally or on a remote system as +B can use both Unix domain sockets and TCP/IP sockets. The +full functionality of the C client/server protocol is supported. + +This Module is based on the B class written by Julian Mehnle +which is not developed anymore but everything has been written from scratch. + +=head1 Methods + +=head2 Constructor + +The following constructor is provided: + +=over + +=item B: RETURNS Net::ClamAV::Client + +Creates a new C object. + +C<%options> is a list of key/value pairs representing any of the following +options: + +=over + +=item B + +A scalar containing the url to the clamd server (e.g. localhost:3310 or /var/run/clamav/clamd.ctl) + +=back + +=back + +=cut + +has 'socket' => (is => 'rw'); +has 'url' => (is => 'rw', required => 1); +has 'runningIDsession' => (is => 'rw', isa=>'Int', default=>0); +has 'streamBlockSize' => (is => 'rw', isa=>'Int', default=>4096); + +sub _connect +{ + my $self = shift; + + if ($self->url() =~/:/) + { + my @url = split /\:/, $self->url(); + + $self->socket(IO::Socket->new( + Domain => IO::Socket::AF_INET, + Type => SOCK_STREAM, + Proto => "tcp", + PeerHost => $url[0], + PeerPort => $url[1] + )) + || throw Net::ClamAV::Exception::Connect("Can't open socket: $@"); + } + else + { + $self->socket(IO::Socket->new( + Domain => IO::Socket::AF_UNIX, + Type => SOCK_STREAM, + Peer => $self->url(), + )) + || throw Net::ClamAV::Exception::Connect("Can't open socket: $@"); + } + + $self->socket()->autoflush(1); +} + + +sub _basicCommand +{ + my $self = shift; + my $command = shift; + + $self->_connect() unless $self->runningIDsession(); + + $self->socket()->send($command); + my $reply = $self->socket()->getline(); + chomp($reply); + + if (length($reply) < 3) + { + throw Net::ClamAV::Exception::Command("unknown reply to command \"$reply\""); + } + + $self->socket()->close() unless $self->runningIDsession(); + return $reply; +} + +sub _multiCommand +{ + my $self = shift; + my $command = shift; + my @reply; + + $self->_connect() unless $self->runningIDsession(); + $self->socket()->send($command); + + while(defined(my $line = $self->socket()->getline())) + { + chomp($line); + if (length($line) < 3) + { + throw Net::ClamAV::Exception::Command("unknown reply to command \"$line\""); + } + + push(@reply,$line); + } + + $self->socket()->close() unless $self->runningIDsession(); + return @reply; +} + +sub _parse_multi_result { + my ($self,@reply) = @_; + my @status; + + for my $r (@reply) + { + if ( $r !~ /^(.*):\s+(OK|(\S+)\s+FOUND)$/ ) + { + throw Net::ClamAV::Exception::Result("Invalid server scanning result \"$r\""); + } + + my $file = $1; + my $res = $2; + + if ($res !~ /OK/) + { + $res = $3; + } + + my $stat = { + file => $file, + result => $res + }; + + push (@status,$stat); + } + + return @status; +} + +sub _parse_result { + my $self = shift; + my $result = shift; + + if ( $result !~ /^(.*):\s+(OK|(\S+)\s+FOUND)$/ ) + { + throw Net::ClamAV::Exception::Result("Invalid server scanning result \"$result\""); + } + + my $file = $1; + my $res = $2; + + if ($res !~ /OK/) + { + $res = $3; + } + + return ($file, $res); +} + + +=head2 Public Instance Methods + +The following public methods are provided: + +=head3 B : RETURNS SCALAR + +Returns B ('PONG') if the ClamAV daemon is alive. Throws a +Net::ClamAV::Exception otherwise. + +=cut +sub ping +{ + my $self = shift; + + my $reply = $self->_basicCommand("PING"); + + throw Net::ClamAV::Exception::Result("No PONG reply") unless $reply eq "PONG"; + + return $reply; +} + +=head3 B : RETURNS SCALAR + +Returns the Version String of the clamd server. Throws a +Net::ClamAV::Exception otherwise. + +=cut +sub version +{ + my $self = shift; + + return $self->_basicCommand("VERSION"); +} + +=head3 B : RETURNS SCALAR + +Reloads the clamd virus databases and returns B ('RELOADING') when successfull. +Throws a Net::ClamAV::Exception otherwise. + +=cut +sub reload +{ + my $self = shift; + + return $self->_basicCommand("RELOAD"); +} + +=head3 B : RETURNS SCALAR + +Shutdowns the clamd server. Throws a Net::ClamAV::Exception +when unseccessfull. + +=cut +sub shutdown +{ + my $self = shift; + + return $self->_basicCommand("SHUTDOWN"); +} + +=head3 B : RETURNS SCALAR + +śame as B + +=cut +sub quit +{ + my $self = shift; + + return $self->shutdown(); +} + +=head3 B : RETURNS HASH + +Scan a file or directory given as path. B The used clamd +has to run on the local host for this method to work. Clamd will +directly access the given path. Make sure the user running clamd +has access rights to it. Scanning stops when the first virus is +found or all files within path has been scanned. + +The Method returns a Hash with attributes B and B. + +my $hash = { + file => "the filename a virus was found in", + result => "the result of file" +}; + +Throws a Net::ClamAV::Exception on error. + +=cut +sub scanLocalPath +{ + my $self = shift; + my $file = shift; + + throw Net::ClamAV::Exception::Other("file \"$file\" not found") unless ( -e $file ); + + my @reply = $self->_multiCommand("nSCAN $file\n"); + my @result= $self->_parse_multi_result(@reply); + + return $result[0]; +} + +=head3 B : RETURNS HASH + +Scan a file or directory given as path and do B stop on first virus found. +B The used clamd has to run on the local host for this method to work. +Clamd will directly access the given path. Make sure the user running clamd +has access rights to it. Scanning stops when the first virus is +found or all files within path has been scanned. + +The Method returns an array of hashes with attributes B and B. + +my $hash = { + file => "the filename a virus was found in", + result => "the result of file" +}; + +Throws a Net::ClamAV::Exception on error. + +=cut +sub scanLocalPathContinous +{ + my $self = shift; + my $file = shift; + + throw Net::ClamAV::Exception::Other("file \"$file\" not found") unless ( -e $file ); + + my @reply = $self->_multiCommand("nCONTSCAN $file\n"); + return $self->_parse_multi_result(@reply); +} + +=head3 B : RETURNS HASH + +Scan a file or directory given as path concurrently. B The used clamd +has to run on the local host for this method to work. Clamd will +directly access the given path. Make sure the user running clamd +has access rights to it. Scanning stops when the first virus is +found or all files within path has been scanned. + +The Method returns an array of hashes with attributes B and B. + +my $hash = { + file => "the filename a virus was found in", + result => "the result of file" +}; + +Throws a Net::ClamAV::Exception on error. + +=cut +sub scanLocalPathMulti +{ + my $self = shift; + my $file = shift; + + throw Net::ClamAV::Exception::Other("file \"$file\" not found") unless ( -e $file ); + + my @reply = $self->_multiCommand("nMULTISCAN $file\n"); + return $self->_parse_multi_result(@reply); +} + +=head3 B : RETURNS HASH + +Scan B file. B The used clamd +has to run on the local host for this method to work. Clamd will +directly access the given path. Make sure the user running clamd +has access rights to it. Scanning stops when the first virus is +found or all files within path has been scanned. + +The Method returns a hashe with attributes B and B. +s +my $hash = { + file => "the filename a virus was found in", + result => "the result of file" +}; + +Throws a Net::ClamAV::Exception on error. + +=cut +sub scanLocalFile +{ + my $self = shift; + my $file = shift; + + return $self->scanLocalPath($file); +} + +=head3 B : RETURNS HASH + +Return the stats of the clamd. B + +Throws a Net::ClamAV::Exception on error. + +=cut +sub stats +{ + throw Net::ClamAV::Exception::Unsupported("stats command not supported"); +} + +=head3 B : RETURNS HASH + +Scans a file given by a file descriptor. B + +Throws a Net::ClamAV::Exception on error. + +=cut +sub scanFileDescriptor +{ + throw Net::ClamAV::Exception::Unsupported("FILDES command not supported"); +} + +=head3 B + +Starts a session with the clamd server within multiple scan commands can +be issued. + +Throws a Net::ClamAV::Exception on error. + +=cut +sub startSession +{ + my $self = shift; + + $self->_connect(); + $self->socket()->send("nIDSESSION\n"); + $self->runningIDsession(1); + +} + +=head3 B : RETURNS SCALAR + +Checks if a session is running with the clamd server. + +Returns 1 if yes, else 0. + +=cut +sub runningSession +{ + my $self = shift; + + return $self->runningIDsession(); +} + +=head3 B + +Ends a session with the clamd server within multiple scan commands can +be issued. + +Throws a Net::ClamAV::Exception on error. + +=cut +sub endSession +{ + my $self = shift; + + $self->socket()->send("nEND\n"); + $self->socket()->close(); + $self->runningIDsession(0); +} + +=head3 B : RETURNS SCALAR + +Scans a file by transmitting it as a stream to the clamd server. +The file is given as a IO::Handle. + +The Method returns a SCALAR with attributes B or B. + +Throws a Net::ClamAV::Exception on error. + +=cut +sub scanStreamFH +{ + my $self = shift; + my $handle = shift; + + throw Net::ClamAV::Exception::Other("no file handle given") unless $handle; + throw Net::ClamAV::Exception::Other("handle is not a IO::Handle") unless ref($handle) eq "IO::Handle"; + + $self->_connect() unless $self->runningIDsession(); + $self->socket()->send("nINSTREAM\n"); + + my $block; + while (my $nr=$handle->read($block, $self->streamBlockSize())) + { + my $size = pack("N",$nr); + $self->socket()->send($size); + $self->socket()->send($block); + } + my $size = pack("N",0); + $self->socket()->send($size); + + my $status=$self->socket()->getline() . "\n"; + + + if ($status!~/^stream:\s*(.*)\s+FOUND/) + { + return; + } + my $ret=$1; + + $self->socket()->close() unless $self->runningIDsession(); + + + return $ret; +} + +=head3 B : RETURNS SCALAR + +Scans a file by transmitting it as a stream to the clamd server. +The file is given as a path. + +The Method returns a SCALAR with attributes B or B. + +Throws a Net::ClamAV::Exception on error. + +=cut +sub scanStreamFile +{ + my $self = shift; + my $file = shift; + + my $fh = IO::File->new($file, "r"); + my $handle = IO::Handle->new_from_fd($fh, "r"); + + my $status = $self->scanStreamFH($handle); + + $handle->close(); + + return $status; +} + +=head3 B : RETURNS SCALAR + +Scans a SCALAR by transmitting it as a stream to the clamd server. +The file is given as a path. + +The Method returns a SCALAR with attributes B or B. + + +Throws a Net::ClamAV::Exception on error. + +=cut +sub scanScalar +{ + my $self = shift; + my $data = shift; + + my $fh = IO::File->new($data, "r"); + my $handle = IO::Handle->new_from_fd($fh, "r"); + + return $self->scanStreamFH($handle); +} + + +1; diff --git a/lib/Net/ClamAV/Exception/Command.pm b/lib/Net/ClamAV/Exception/Command.pm new file mode 100644 index 0000000..d49ca21 --- /dev/null +++ b/lib/Net/ClamAV/Exception/Command.pm @@ -0,0 +1,9 @@ +use strict; +package Net::ClamAV::Exception::Command; +# ABSTRACT: Exception class for command exceptions + +use warnings; +use Moose; +with 'Throwable'; + +1; diff --git a/lib/Net/ClamAV/Exception/Connect.pm b/lib/Net/ClamAV/Exception/Connect.pm new file mode 100644 index 0000000..3c3a879 --- /dev/null +++ b/lib/Net/ClamAV/Exception/Connect.pm @@ -0,0 +1,10 @@ +use strict; +package Net::ClamAV::Exception::Connect; +# ABSTRACT: Exception class for connect exceptions + +use warnings; + +use Moose; +with 'Throwable'; + +1; diff --git a/lib/Net/ClamAV/Exception/Other.pm b/lib/Net/ClamAV/Exception/Other.pm new file mode 100644 index 0000000..1c34857 --- /dev/null +++ b/lib/Net/ClamAV/Exception/Other.pm @@ -0,0 +1,9 @@ +use strict; +package Net::ClamAV::Exception::Other; +# ABSTRACT: Exception class for other exceptions + +use warnings; + +use Moose; +with 'Throwable'; +1; diff --git a/lib/Net/ClamAV/Exception/Result.pm b/lib/Net/ClamAV/Exception/Result.pm new file mode 100644 index 0000000..8a74e60 --- /dev/null +++ b/lib/Net/ClamAV/Exception/Result.pm @@ -0,0 +1,9 @@ +use strict; +package Net::ClamAV::Exception::Result; +# ABSTRACT: Exception class for result exceptions + +use warnings; + +use Moose; +with 'Throwable'; +1; diff --git a/lib/Net/ClamAV/Exception/Unsupported.pm b/lib/Net/ClamAV/Exception/Unsupported.pm new file mode 100644 index 0000000..361721d --- /dev/null +++ b/lib/Net/ClamAV/Exception/Unsupported.pm @@ -0,0 +1,9 @@ +use strict; +package Net::ClamAV::Exception::Unsupported; +# ABSTRACT: Exception class for unsupported exceptions + +use warnings; + +use Moose; +with 'Throwable'; +1; diff --git a/t/author-communication.t b/t/author-communication.t new file mode 100644 index 0000000..2c43202 --- /dev/null +++ b/t/author-communication.t @@ -0,0 +1,206 @@ +#!perl + +BEGIN { + unless ($ENV{AUTHOR_TESTING}) { + print qq{1..0 # SKIP these tests are for testing by the author\n}; + exit + } +} + +use strict; +use warnings; +use Test::More; +use Data::Dumper; +use Try::Tiny; +my $nrTests=0; + +use_ok( 'Net::ClamAV::Client' ); +$nrTests++; + +my $client; + +my $ok = 1; +try { + $client = Net::ClamAV::Client->new(url => "localhost:3311"); + $client->ping(); +} +catch +{ + $ok = 0; +}; + +ok($ok == 0, "Ping without running clamd"); + +$nrTests++; + +$ok = 1; +try { + $client->version(); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "Version without running clamd"); +$nrTests++; + +$ok = 1; +try { + $client->reload(); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "Reload without running clamd"); +$nrTests++; + +$ok = 1; +try { + $client->shutdown(); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "Shutdown without running clamd"); +$nrTests++; + +$ok = 1; +try { + $client->quit(); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "Quit without running clamd"); +$nrTests++; + +$ok = 1; +try { + $client->scanLocalPath("./"); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "scanLocalPath without running clamd"); +$nrTests++; + +$ok = 1; +try { + $client->scanLocalPathContinous("./"); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "scanLocalPathContinous without running clamd"); +$nrTests++; + +$ok = 1; +try { + $client->scanLocalPathMulti("./"); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "scanLocalPathMulti without running clamd"); +$nrTests++; + +$ok = 1; +try { + $client->scanLocalFile("eicar.com"); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "scanLocalFile without running clamd"); +$nrTests++; + +$ok = 1; +try { + $client->startSession(); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "startSession without running clamd"); +$nrTests++; + +$ok = 1; +try { + $client->endSession(); +} +catch +{ + $ok = 0; +}; +ok($ok == 0, "endSession without running clamd"); +$nrTests++; + + + +$ok = 1; +my $reply; +try { + $client = Net::ClamAV::Client->new(url => "localhost:3310"); + $reply=$client->ping(); +} +catch +{ + $ok = 0; +}; + +ok($ok == 1, "Ping with running clamd"); +$nrTests++; +ok($reply eq "PONG", "Ping returns PONG"); +$nrTests++; + +$ok = 1; +try { + $reply = $client->version(); +} +catch +{ + $ok = 0; +}; +ok($ok == 1, "version with running clamd"); +$nrTests++; +ok($reply =~ /^ClamAV\s\d+/, "Version returns a version"); +$nrTests++; + +$ok = 1; +try { + $reply = $client->reload(); +} +catch +{ + $ok = 0; +}; +ok($ok == 1, "reload with running clamd"); +$nrTests++; +ok($reply eq "RELOADING", "Reload returns RELOADING"); +$nrTests++; + +$ok = 1; +my $error=""; +try { + readpipe("mkdir -p /tmp/test-clam; cp eicar.com /tmp/test-clam/"); + $reply = $client->scanLocalPath("/tmp/test-clam"); + readpipe("rm -rf /tmp/test-clam"); +} +catch +{ + $error=$_; + $ok = 0; +}; +ok($ok == 1, "scanLocalPath with running clamd"); +$nrTests++; +ok($reply->{file} eq "/tmp/test-clam/eicar.com" && $reply->{result} eq "Win.Test.EICAR_HDB-1" , "Found Eicar Test Virus"); +$nrTests++; +done_testing($nrTests); diff --git a/weaver.ini b/weaver.ini new file mode 100644 index 0000000..32eb2d8 --- /dev/null +++ b/weaver.ini @@ -0,0 +1,8 @@ +[@Default] + +[-Transformer] +transformer = List + +[Availability] +[Bugs] +[Legal]