cloudpassage 0.99

Python SDK for CloudPassage Halo API

# cloudpassage-halo-python-sdk

## Python SDK for CloudPassage Halo API

### This is a BETA (v0.99). Please don't forget to pin your work against the version you're working with, especially if it's a beta :-)

### Installation

Requirements:

* requests
* pyaml


Install from pip with ```pip install cloudpassage```. If you want to make
modifications to the SDK you can install it in editable mode by downloading
the source from this github repo, navigating to the top directory within the
archive and running ```pip install -e .``` (note the . at the end).

### Quick Start

Here's the premise: you store your session configuration information (API
credentials, proxy settings, etc) in the cloudpassage.HaloSession object.
This object gets passed into the various class methods which allow you
to interact with the CloudPassage Halo API.

Practical example:
We'll print a list of all servers in our account:

```python
import cloudpassage

api_key = MY_HALO_API_KEY
api_secret = MY_API_SECRET
session = cloudpassage.HaloSession(api_key, api_secret)
server = cloudpassage.Server(session)

list_of_servers = server.list_all()
for s in list_of_servers:
print "ID: %s Name: %s" % (s["id"], s["hostname"])

```

### Testing

#### Important locations for testing:

tests/configs: You'll find a file here called portal.yaml. Copy it to
portal.yaml.local and complete the information inside with your API key and
secret. the .gitignore settings will keep you from checking in your creds
if you put them in the .local file. This file (portal.yaml.local) is
referenced directly by all tests requiring interaction with the API.

tests/policies: These are Halo policies, used primarily for integration
tests.

tests/tests: This is where you'll find the actual tests.


#### Environmental Requirements

You'll need to have a CloudPassage Halo account available for running the
tests, as many are integration-focused. These are the things you need to have
(at the very least) to get a clean testing run:

* Servers:
* Have at least one active Linux and active Windows server.
* One deactivated server of any type.
* Policies:
* One firewall policy
* One alert profile
* One Linux CSM policy
* One Linux FIM policy
* One Windows FIM policy
* One LIDS policy
* Scans:
* CSM (Failed scan)
* FIM (active baseline and successful scan)
* One CVE exception
* Events:
* One event produced by a Windows server.
* Server Group:
* Using the default group is fine.
* Assign the policies mentioned above to the group.
* Run FIM baselines against the Linux and Windows servers.
* Kick off a CSM scan if it doesn't happen automatically


#### Running tests:

Navigate to tests/ and run ``py.test ./integration ./unit ./style``
to run the entire test suite. You can remove any of these if you
want to focus on a particular section. For instance, to run only
the unit and style tests, you would use ``py.test ./unit ./style``.

If you've got the coverage module installed,
``py.test --cov=cloudpassage ./integration ./unit ./style``
will show statement test coverage.


<!---
#CPTAGS:community-supported integration api-example
#TBICON:images/python_icon.png
-->