/ 
Net-OpenVAS-0.101
River stage zero No dependents
/ Net::OpenVAS::OMP

NAME

Net::OpenVAS - Perl extension for OpenVAS Scanner

SYNOPSIS

use Net::OpenVAS qw( -commands );

my $openvas = Net::OpenVAS->new(
    host     => 'localhost:9390',
    username => 'admin',
    password => 's3cr3t'
) or die "ERROR: $@";

my $task = $openvas->create_task(
    name   => [ 'Scan created via Net::OpenVAS' ],
    target => { id => 'a800d5c7-3493-4f73-8401-c42e5f2bfc9c' },
    config => { id => 'daba56c8-73ec-11df-a475-002264764cea' }
);

if ( $task->is_created ) {

    my $task_id = $task->result->{id};

    say "Created task $task_id";

    my $task_start = $openvas->start_task( task_id => $task_id );

    say "Task $task_id started (" . $task_start->status_text . ')' if ( $task_start->is_accepted );

}

if ( $openvas->error ) {
    say "ERROR: " . $openvas->error;
}

DESCRIPTION

This module provides Perl scripts easy way to interface the OMP (OpenVAS Management Protocol) of OpenVAS.

For more information about the OPM follow the online documentation:

https://docs.greenbone.net/API/OMP/omp.html

CONSTRUCTOR

Net::OpenVAS::OMP->new ( host => $host, username => $username, password => $password [, logger => $logger, timeout => 60, ssl_options => \%ssl_options ] )

Create a new instance of Net::Net::OpenVAS::OMP.

Params:

  • host : OpenVAS host (and port)

  • username, password : OpenVAS Credentials

  • timeout : Request timeout in seconds (default is 60) If a socket open, read or write takes longer than the timeout, an exception is thrown.

  • ssl_options : A hashref of SSL_* options to pass through to IO::Socket::SSL.

  • logger : A logger instance (eg. Log::Log4perl or Log::Any for log the REST request and response messages.

METHODS

$openvas->command ( $command [, \%arguments ] )

Execute a command to OpenVAS via OMP and return Net::OpenVAS::OMP::Result class instance.

my $task = $openvas->command( 'get_tasks', task_id => '46f15597-b721-403c-96a1-cce439af63a7' );

$openvas->error

Return Net::OpenVAS::Error class instance.

COMMANDS HELPER

Net::OpenVAS::OMP provide a flag (-commands) for import all OpenVAS OMP commands.

use Net::OpenVAS::OMP;
[...]
my $version = $openvas->command('get_version');

use Net::OpenVAS::OMP qw( -commands );
[...]
my $version = $openvas->get_version;

Available commands:

authenticate commands create_agent create_alert create_asset create_config
create_credential create_filter create_group create_note create_override
create_permission create_port_list create_port_range create_report
create_report_format create_role create_scanner create_schedule create_tag
create_target create_task create_user delete_agent delete_asset
delete_config delete_alert delete_credential delete_filter delete_group
delete_note delete_override delete_report delete_permission delete_port_list
delete_port_range delete_report_format delete_role delete_scanner
delete_schedule delete_tag delete_target delete_task delete_user
describe_auth empty_trashcan get_agents get_configs get_aggregates
get_alerts get_assets get_credentials get_feeds get_filters get_groups
get_info get_notes get_nvts get_nvt_families get_overrides get_permissions
get_port_lists get_preferences get_reports get_report_formats get_results
get_roles get_scanners get_schedules get_settings get_system_reports
get_tags get_targets get_tasks get_users get_version help modify_agent
modify_alert modify_asset modify_auth modify_config modify_credential
modify_filter modify_group modify_note modify_override modify_permission
modify_port_list modify_report modify_report_format modify_role
modify_scanner modify_schedule modify_setting modify_target modify_tag
modify_task modify_user move_task restore resume_task run_wizard start_task
stop_task sync_cert sync_feed sync_config sync_scap test_alert verify_agent
verify_report_format verify_scanner

SUPPORT

Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at https://github.com/giterlizzi/perl-Net-OpenVAS/issues. You will be notified automatically of any progress on your issue.

Source Code

This is open source software. The code repository is available for public review and contribution under the terms of the license.

https://github.com/giterlizzi/perl-Net-OpenVAS

git clone https://github.com/giterlizzi/perl-Net-OpenVAS.git

AUTHOR

  • Giuseppe Di Terlizzi <gdt@cpan.org>

LICENSE AND COPYRIGHT

This software is copyright (c) 2020 by Giuseppe Di Terlizzi.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.