The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Net-SecurityCenter-0.300
River stage zero No dependents
1 ++
/ Net::SecurityCenter::REST

NAME

Net::SecurityCenter::REST - Perl interface to Tenable.sc (SecurityCenter) REST API

SYNOPSIS

    use Net::SecurityCenter::REST;

    my $sc = Net::SecurityCenter::REST('sc.example.org');

    if (! $sc->login('secman', 'password')) {
        die $sc->error;
    }

    my $running_scans = $sc->get('/scanResult', { filter => 'running' });

    $sc->logout();

DESCRIPTION

This module provides Perl scripts easy way to interface the REST API of Tenable.sc (SecurityCenter).

For more information about the Tenable.sc (SecurityCenter) REST API follow the online documentation:

https://docs.tenable.com/sccv/api/index.html

CONSTRUCTOR

Net::SecurityCenter::REST->new ( host [, $params ] )

Create a new instance of Net::SecurityCenter::REST.

Params:

  • timeout : Request timeout in seconds (default is 180) 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, Log::Any or Mojo::Log) for log the REST request and response messages.

  • scheme : URI scheme (default: HTTPS).

METHODS

$sc->post|get|put|delete|patch ( $path [, \%params ] )

Execute a request to Tenable.sc REST API. These methods are shorthand for calling request() for the given method.

    my $nessus_scan = $sc->post('/scanResult/1337/download',  { 'downloadType' => 'v2' });

$sc->request ( $method, $path [, \%params ] )

Execute a HTTP request of the given method type ('GET', 'POST', 'PUT', 'DELETE', ''PATCH') to Tenable.sc REST API.

$sc->login ( ... )

Login into Tenable.sc using username/password or API Key.

Username and password authentication

    $sc->login( $username, $password ):
    $sc->login( username => ..., password => ... );

API Key authentication

Since Tenable.SC 5.13 it's possibile to use API Key authentication using access_key and secret_key:

    $sc->login( access_key => ..., secret_key => ... );

More information about API Key authentication:

$sc->logout

Logout from Tenable.sc.

$sc->upload ( $file )

Upload a file into Tenable.sc.

$sc->error

Catch the Tenable.sc errors and return Net::SecurityCenter::Error class.

SUPPORT

Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at https://github.com/giterlizzi/perl-Net-SecurityCenter/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-SecurityCenter

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

AUTHOR

  • Giuseppe Di Terlizzi <gdt@cpan.org>

LICENSE AND COPYRIGHT

This software is copyright (c) 2018-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.