Skip to content

Latest commit

 

History

History
161 lines (122 loc) · 5.13 KB

README.md

File metadata and controls

161 lines (122 loc) · 5.13 KB
Raw

Pytwistcli - a Python wrapper around the Twistlock API

Pytwistcli is a pure Python 3 wrapper around the Twistlock RESTful API. It provides convenient Pythonic access to the data and functions available from the Twistlock server.

There is also a CLI to provide access to the same API functions.

At this stage only a very small subset of functionality is available; namely interrogation of the packages available inside a container image, as returned from the Images API.

Basic CLI format

The current CLI takes the form:

pytwistcli image [search|file|save]

The search sub-command interrogates the Twistlock console. The file sub command interrogates a local copy of the Twistlock image data. The save sub-command downloads data from the Twistlock console and saves to a local file for later perusal with the file command.

When searching the console directly, the command takes the form:

pytwistcli image search <search spec> <searchtype>

Search spec is anything that the console recognises as a search string, but pytwistcli currently only recognises the image digest (starting with the prefix sha256:) or an image tag.

When searching the server you need to tell pytwistcli the server details. You can do this in two different ways:

  • Pass CLI options --twistlock-url, --twistlock-user and --twistlock-password, or,
  • Set environment variarbles TWISTLOCK_URL, TWISTLOCK_PASSWORD, and TWISTLOCK_USER

Similarly the file search takes the same parameters with the addition of the file name:

pytwistcli file <filename> <search spec> <searchtype>

The searchtype argument can be one of the recognised Twistlock package types (e.g. "package" for OS packages, "python" for Python packages), or one of:

  • cves: Lists all the CVEs for the image
  • list: Shows all the package types that are in the image

Examples

pytwistcli image file analysis.json myproject/container:latest list

Will return a list of the different types of packages available in the container identified by the tag myproject/container:latest in the data file analysis.json. Currently this is one of binary, gem, jar, nodejs, package (OS packages), python, and windows.

pytwistcli image file analysis.json sha256:940c39377c1a42ab19aa78b890037092aefd17edacd7ec135b1abb6876ad011a packages

Will return the list of operating system packages contained in the image with the given SHA256 whose data is in the analysis.json file.

pytwistcli image file analysis.json myproject/container:latest python

Will return the list of Python packages contained in the image with the given tag whose data is in the analysis.json file.

pytwistcli image search myproject/container:latest nodejs

Will search the Twistlock server directly for the container with tag myproject/container:latest and return its nodejs packages.

pytwistcli image save data.json myproject/container:latest

Will save the data for myproject/container:latest to the file data.json. The search spec can also be anything matching multiple images, resulting in a data file containing multiple images.

pytwistcli image file --list-images <file>
pytwistcli image search --list-images <searchspec>

Will show all images either in a file or on the server that match the search spec.

Field selection and sorting

To sort the output, pass --sort-by <fieldname>. If the field does not exist in the data being selecte, you will get an error.

You can also pass -f <fieldname> or --field <fieldname> multiple times to select which fields from the data to display.

Example:

pytwistcli image search console_2_5_102 binary --sort-by cveCount -f cveCount -f path

shows the packages with CVEs from Twistlock's own console image, sorted by the CVE count.

Running tests

tox Will run the Python 3 tests, the PEP8 tests, and Bandit (security checker).

tox -e cover will give you a test coverage report.

tox -e debug Runs the tests in single threaded mode so you can add breakpoints.

tox -e test pytwistcli.tests.test_file.TestClass.test_name Runs the pytwistcli.tests.test_file.TestClass.test_name test only.

Running the application

tox -e run

Runs the CLI and passes in any arguments also given.

Other handy environments

tox -e repl gives you an iPython prompt in the virtualenv context

Building RPMs

If setup.py or setup.cfg changes, re-build the spec file with:

python setup.py bdist_rpm --spec-only

TODO - development!

There's a ton of improvements that can yet be made, this is currently a bit of a PoC and very much a WIP. The API is not in any use other than the CLI, so the CLI has had more attention. The API design needs some love.

Some ideas for change:

  • Add more top-level API commands
  • Create objects representing parts of the data and expose on the public API
  • Make the API a little more object-orientated and nest those objects like the CLI is doing.
  • The CLI is missing a ton of unit tests
  • Move the CLI's sorting feature into the API