Nexpose Client v4.0.0

This version contains breaking changes from 3.x versions, due to recent changes in Nexpose private APIs.

New Features

Updated Asset Filter for IP Address and IP Range

Nexpose 6.2.5 introduced the ability to filter assets by a single IP address (e.g. for Tags and Dynamic Asset Groups). This changed the names of the field and operators for IP Address criteria.

Please update to v4.0.2 for bugfix for this feature

IP_RANGE is now IP_ADDRESS and IN and NOT_IN operators are replaced by IN_RANGE and NOT_IN_RANGE. The IS and IS_NOT operators are now usable for a single IP address.

See #224 for details.

Scan Import now returns a Scan ID on success

For Nexpose versions 6.2.6 and later the Nexpose::Connection#import_scan method has been updated to return a scan ID on a successful import. For Nexpose versions prior to 6.2.6, it will return an empty string as before.

See #223 for details.

Nexpose Client v3.3.2

Bug Fixes

• Updated Nexpose::HostOrIP#convert to support ranges with any amount of white space around they hyphen delimiter, including a lack of white space. See #214
• Updated datatable methods to use the updated endpoint for user preferences, fixing #220 and #222 (see #221).

Nexpose Client v3.3.1

Bug Fixes

This release includes a fix for the Credential#test method, which was using different parameters from what is defined in SiteCredentials. See #215 and #216.

Nexpose Client v3.3.0

New Features

Engine Version Information

Added Nexpose::Connection#engine_versions which contains the output of the version engines console command in a more easily consumable hash. Contributed by @Red5d. Thank you!

Scheduled Backup

Added Nexpose::ScheduledBackup to allow creating and modifying scheduled backups in Nexpose. Requires Nexpose version 6.2.1 or later.

Scheduled Maintenance

Added Nexpose::ScheduledMaintenance to allow creating and modifying scheduled maintenance tasks in Nexpose. Requires Nexpose version 6.2.1 or later.

Nexpose Client v3.2.0

New Feature

Windows Service Editor

Allows to enable Windows Services within a Scan Template Configuration.
See more information about this feature on our Community site

Nexpose Client v3.1.0

New Feature

Two Factor Authentication

With the release of Nexpose 6.1.5, two factor authentication is now available. Please see the following post on our Rapid7 Community page for information about setting up this feature. For information on how to use two factor authentication with the nexpose client see additional information in our wiki.

Nexpose Client v3.0.1

Bug Fixes

This release includes a bug fix for the new error message handling that was added in v3.0.0.

Nexpose Client v3.0.0

This version contains breaking changes from 2.x versions.

New Features

Adhoc scan site assets with a specific template and scan engine

A new method has been added: Connection#scan_assets_with_template_and_engine which allows ad-hoc scanning a subset of assets in a site with a specific template and scan engine. This replicates the behavior available in the UI's Start New Scan dialog.

See #195 for more details.

Asset scan history

A new method has been added: Connection#asset_scan_history which will return a list of scans which include the asset.

Note: This is fairly slow and not recommended for use on large numbers of assets.

See #198 for more details.

Paused scans

A new method has been added: Connection#paused_scans which returns a list of paused scans. If a site ID is provided, only paused scans for that site will be returned. Otherwise all paused scans will be returned.

See #196 for more details.

Other Changes

Removed Rex dependency

Since only one small piece of Rex was actually being used by nexpose-client, and the rest of Rex poses issues for Windows users, we've extracted the relevant pieces from Rex into nexpose-client.

See #201 for more details.

Removed deprecated methods

After version 1.0 of nexpose-client some methods were marked as deprecated. After version 2.0 some other methods were also marked as deprecated. As of version 3.0 all deprecated methods are removed completely.

See #203 and #184 for more details.

Nexpose Client v2.3.0

New features

Added support for modifying the asset linking global preference. Nexpose::GlobalSettings now has the asset_linking attribute, which can be set to true or false.

See #202 for more details.

Nexpose Client v2.2.0

New Features

Scan template - enhanced and debug logging configuration

Added methods for toggling the enhanced logging and debug logging setting in scan templates. The new method is Nexpose::ScanTemplate#enable_debug_logging. See #197 for more information.
This feature requires Nexpose version 6.1.0 or later.