PxnxJruby
This is the official gem package for the Nexpose Cisco PxGrid Integration.
For assistance with using the gem please email the Rapid7 integrations support team at [email protected].
Installation
Please follow the Cisco ISE documentation for instructions on installing Cisco ISE, enabling PxGrid and setting up certificates on the pxGrid client and target node(s).
The script was created using JRuby: as such, a JRuby interpreter must be installed on the system where it’s going to run. The following link shows the different options for installing Ruby in several platforms:
http://jruby.org/
Add this line to your application's Gemfile:
gem 'nexpose_pxgrid'
And then execute:
$ bundle
Or install it yourself as:
$ gem install nexpose_pxgrid
From Cisco Docs
If the client is connecting to the pxGrid Controller for the first time, an account is established on the pxGrid Controller. In pxGrid’s auto-registration mode (set by administrator through the ISE web-based user interface), the client is allowed to communicate once the account is created. Whereas if auto registration mode is turned off, the node and authorization group assignment of the node remains in Pending Approval mode and not allowed to communicate over pxGrid until it is approved by the administrator. Also, the user must be part of the EPS group.
Usage
To use the PxGrid integration after installing the gem and configuring the Cisco ISE:
- Edit the pxnx.config file under the gem config folder and add the necessary data.
- Setup the necessary Environment variables, containing information on the ISE instance, listed in the documentation.
- Run the pxnx.rb file under the bin folder. If installed with Gem the command
console> jruby pxnx.rb
should suffice.
Note: Gem is usually installed under
- Windows: C:\Ruby<version>\lib\ruby\gems\version\gems
- Linux: /var/lib/gems/<version>/gems/ Please refer to your particular Ruby documentation for actual installation folder.
A logger is also implemented by default, and the log can be found under /var/lib/logs/
; please refer to the log file in case of an error.
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake false
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pxnx_jruby.
License
The gem is available as open source under the terms of the MIT License.