securitycenter-cli

command module
v0.0.0-...-23b4524 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 16, 2018 License: GPL-3.0 Imports: 12 Imported by: 0

README

SecurityCenter CLI (written in Go)


Note: Please keep in mind this is to be considered alpha software. Use it in production environments at your own discretion.

Summary

This is a simple command line application to use various tasks capable in Tenable Network Security's Security Center (>= v5.0) and manipulate data within SecurityCenter. This should make automating various tasks in SecurityCenter (such as automated backups, syncing assets from a local database or file into SC, auditing user acces, etc) much easier.

Built-in is also an interactive menu useful for exporting and importing records (Assets, Users, Groups, Scan Results). This menu, and mostly this entire command line application, was built based on requirements needed or requested by West Virginia University's Information Security Services. This project is open-source licensed by the GNU General Public License (v3) found in the LICENSE file in this directory.

Supported are Linux, Mac OS, and Windows environments via Go's popular go build tool command.

Downloading and Installing

  • With Go installed: go get github.com/austindizzy/securitycenter-cli
  • Without Go: Download your OS specific binary from this project's releases page.

Third-Party Technologies

This was built using the following technologies:

  • SecurityCenter - A vulnerability management and analytics solution by Tenable Network Security.
  • Go ( > 1.5)

Documentation GoDoc

This project contains various packages which are able to be imported into your Go application which may speed things up is you're also working with SecurityCenter's API, collection authentication interactively, or creating interactive submenus. Go documentation can be viewed on GoDoc.

Running ./securitycenter-cli help will output some help documentation for using the command line application.

NAME:
   securitycenter-cli - a trusty cli for your trusty nvs

USAGE:
   securitycenter-cli [global options] command [command options] [arguments.
..]

VERSION:
   0.1a

AUTHOR(S):
   Austin Siford <Austin.Siford@mail.wvu.edu>

COMMANDS:
     export, x  export objects from SecurityCenter to a flat file
     import, i  import objects from a flat file to SecurityCenter
     test, c    test auth token for validity
     menu, m    start interactive menu
     auth, c    get/set auth tokens

GLOBAL OPTIONS:
   --host value             Tenable Nessus SecurityCenter API host [%TNS_HOST%]
   --token value, -t value  Auth token for SecurityCenter. [%TNS_TOKEN%]
   --session value          Auth session for SecurityCenter [%TNS_SESSION%]
   --debug                  Enable verbose logging.
   --help, -h               show help
   --version, -v            print the version

Specialized help documentation for each command can also be found by running ./securitycenter-cli [command] help, for instance with ./securitycenter-cli export --help

NAME:
   securitycenter-cli export - export objects from SecurityCenter to a flat
file

USAGE:
   securitycenter-cli export [command options] [data type to export]

OPTIONS:
   --fields value  fields to export
   --filter value  filter exported records
   --output value  optional file output

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package api is used to communicate with SecurityCenter's REST JSON API, in the context of a command line application.
Package api is used to communicate with SecurityCenter's REST JSON API, in the context of a command line application.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL