Metadata-Version: 2.2
Name: varroaclient
Version: 1.2.2
Summary: Vulnerability management for Opentack - Client
Home-page: https://github.com/NeCTAR-RC/python-varroaclient
Author: ARDC Nectar Cloud Services
Author-email: coreservices@ardc.edu.au
License: Apache-2.0
Keywords: varroa
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pbr
Requires-Dist: oslo.utils
Requires-Dist: keystoneauth1
Requires-Dist: osc-lib
Requires-Dist: nectarclient-lib<2.0.0,>=1.0.0
Requires-Dist: python-openstackclient
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

# Varroa Client

Client for Varroa

For more information, see https://github.com/NeCTAR-RC/varroa/

## Installation

 pip install varroaclient

## Common openstack CLI Commands

### IP History
Varroa will keep track of what openstack resource owned an IP address for what period

#### To list the resource history of an IP address
```
openstack ip history 203.0.113.1
```

### Security Risk Type
A security risk type is an admin defined type of security risk.
e.g. "Password SSH allowed"

A security risk type has a name and a description. The description should describe what the security risk is and ideally the steps taken to fix this risk.
#### Some example commands
```
openstack security risk type list
openstack security risk type show <security risk type id>
openstack security risk type set <security risk type id>
openstack security risk type create <name>
openstack security risk type delete <security risk type id>
```

### Security Risks
A security risk is the linkage of a security risk type to an openstack resource.
e.g. Compute instance with id XYZ has a "Password SSH allowed" security risk.

Only the IP address of the affected resource needs to be entered when creating a new security risk. Varroa will then process this entry and attempt to link that IP address to an Openstack resource.
#### Some example commands
```
openstack security risk list --all
openstack security risk show <security risk id>
openstack security risk create -i <ip address> <type> -t <time in following format YYYY-MM-DDTHH:MM:SS+HH:MM> -e <expires in following format YYYY-MM-DDTHH:MM:SS+HH:MM>
openstack security risk delete <security risk id>

