File Coverage

blib/lib/Net/SecurityCenter/API/Scan.pm

Criterion	Covered	Total	%
statement	41	87	47.1
branch	5	22	22.7
condition	0	3	0.0
subroutine	9	16	56.2
pod	5	6	83.3
total	60	134	44.7

package Net::SecurityCenter::API::Scan;

use warnings;
use strict;

use Carp;
use English qw( -no_match_vars );

use parent 'Net::SecurityCenter::Base';

use Net::SecurityCenter::Utils qw(:all);

our $VERSION = '0.300';

my $common_template = {

    id => {
        required => 1,
        allow    => qr/^\d+$/,
        messages => {
            required => 'Scan ID is required',
            allow    => 'Invalid Scan ID',
        },
    },

    filter => {
        allow => [ 'usable', 'manageable' ]
    },

    fields => {
        filter => \&sc_filter_array_to_string,
    }

};

#-------------------------------------------------------------------------------
# METHODS
#-------------------------------------------------------------------------------

sub add {

    my ( $self, %args ) = @_;

    my $single_id_filter = sub {
        return { 'id' => $_[0] };
    };

    my $array_ids_filter = sub {

        my $data = [];

        foreach my $id ( @{ $_[0] } ) {
            push( @{$data}, { 'id' => $id } );
        }

        return $data;

    };

    my $report_filter = sub {

        my $data         = [];
        my $report_types = [ 'cumulative', 'patched', 'individual', 'lce', 'archive', 'mobile' ];

        require Params::Check;

        foreach my $id ( keys %{ $_[0] } ) {

            my $type = $_[0]->{$id};

            if ( !Params::Check::allow( $type, @{$report_types} ) ) {
                croak( "Invalid 'reports ($type) value (allowed values: " . join( ', ', @{$report_types} ) . ')' );
            }

            push( @{$data}, { 'id' => $id, 'reportSource' => $type } );

        }

        return $data;

    };

    my $tmpl = {
        name => {
            required => 1,
            errors   => { required => 'Specify scan name' }
        },
        description => {},
        targets     => {
            filter => \&sc_filter_array_to_string,
            remap  => 'ipList'
        },
        assets => {
            filter => \&$array_ids_filter,
        },
        zone => {
            allow  => qr/\d+/,
            errors => { allow => 'Invalid Scan Zone ID' },
            filter => \&$single_id_filter
        },
        policy => {
            allow  => qr/\d+/,
            errors => { allow => 'Invalid Policy ID' },
            filter => \&$single_id_filter
        },
        plugin => {
            allow  => qr/\d+/,
            errors => { allow => 'Invalid Plugin ID' },
            filter => \&$single_id_filter
        },
        repository => {
            allow  => qr/\d+/,
            errors => { allow => 'Invalid Repository ID' },
            filter => \&$single_id_filter
        },
        credentials => {
            filter => \&$array_ids_filter,
        },
        max_time => {
            allow => qr/\d+/,
            remap => 'maxScanTime'
        },
        email_on_launch => {
            remap  => 'emailOnLaunch',
            filter => \&sc_filter_int_to_bool,
            allow  => qr/\d/,
        },
        email_on_finish => {
            remap  => 'emailOnFinish',
            filter => \&sc_filter_int_to_bool,
            allow  => qr/\d/,
        },
        dhcp_tracking => {
            remap  => 'dhcpTracking',
            filter => \&sc_filter_int_to_bool,
            allow  => qr/\d/,
        },
        reports => {
            filter => \&$report_filter,
        },
        type => {
            allow => [ 'plugin', 'policy' ]
        },
        timeout => {
            allow => [ 'discard', 'import', 'rollover' ],
            remap => 'timeoutAction',
        },
        schedule => {
            filter => sub {
                return sc_schedule( %{ $_[0] } );
            },
        },
        rollover => {
            allow => [ 'nextDay', 'template' ],
            remap => 'rolloverType',
        },
        scan_vhost => {
            remap => 'scanningVirtualHosts'
        },
    };

    my $params = sc_check_params( $tmpl, \%args );

    croak('"policy" and "plugin" are not allowed in same time')
        if ( defined( $params->{'policy'} ) && defined( $params->{'plugin'} ) );

    if ( !defined( $params->{'type'} ) ) {
        $params->{'type'} = ( $params->{'policy'} ) ? 'policy' : 'plugin';
    }

    my $result = $self->client->post( '/scan', $params );

    # Return the Scan Result ID for schedule=now scans
    if ( defined( $result->{'scanResultID'} ) ) {
        return $result->{'scanResultID'};
    }

    # Return the Scan ID
    if ( defined( $result->{'id'} ) ) {
        return $result->{'id'};
    }

}

#-------------------------------------------------------------------------------

sub execute {

    my ( $self, %params ) = @_;

    $params{'schedule'} = { 'type' => 'now' };

    return $self->add(%params);

}

#-------------------------------------------------------------------------------

sub launch {

    my ( $self, %args ) = @_;

    my $tmpl = {
        diagnostic_target   => { remap => 'diagnosticTarget' },
        diagnostic_password => { remap => 'diagnosticPassword' },
        id                  => $common_template->{'id'},
    };

    my $params  = sc_check_params( $tmpl, \%args );
    my $scan_id = delete( $params->{'id'} );
    my $result  = $self->client->post( "/scan/$scan_id/launch", $params );

    if ( !defined( $result->{'scanResult'}->{'id'} ) ) {
        croak('Invalid response from SecurityCenter');    # TODO
    }

    return $result->{'scanResult'}->{'id'};

}

#-------------------------------------------------------------------------------

sub list {

    my ( $self, %args ) = @_;

    my $tmpl = {
        fields => $common_template->{'fields'},
        filter => $common_template->{'filter'},
        raw    => {},
    };

    my $params = sc_check_params( $tmpl, \%args );
    my $raw    = delete( $params->{'raw'} );
    my $scans  = $self->client->get( '/scan', $params );

    return        if ( !$scans );
    return $scans if ($raw);
    return sc_merge($scans);
}

#-------------------------------------------------------------------------------

sub get {

    my ( $self, %args ) = @_;

    my $tmpl = {
        fields => $common_template->{'fields'},
        id     => $common_template->{'id'},
    };

    my $params  = sc_check_params( $tmpl, \%args );
    my $scan_id = delete( $params->{'id'} );
    my $raw     = delete( $params->{'raw'} );
    my $scan    = $self->client->get( "/scan/$scan_id", $params );

    return       if ( !$scan );
    return $scan if ($scan);
    return sc_normalize_hash($scan);

}

#-------------------------------------------------------------------------------

sub delete {

    my ( $self, %args ) = @_;

    my $tmpl = { id => $common_template->{'id'}, };

    my $params  = sc_check_params( $tmpl, \%args );
    my $scan_id = delete( $params->{'id'} );

    return $self->client->delete("/scan/$scan_id");    # TODO

}

#-------------------------------------------------------------------------------

1;

__END__