Getting started on macOS and Linux

A guide to installing and using AtomicTestHarnesses

Contents

• Contents
• Prepare your environment
• Install AtomicTestHarnesses
  • Installing from PyPi
  • Fixing common problems
• Explore AtomicTestHarnesses
• Next steps

Prepare your environment

Before you install AtomicTestHarnesses make sure you have the following:

• The POSIX AtomicTestHarness test require Python 3.10 or greater in order to run. Make sure your system has the appropriate version of python installed.
• Permission to test. Always ask your environment owner for permission before executing a test.

Install AtomicTestHarnesses

Installing from PyPi

The POSIX AtomicTestHarnesses can be installed like any other Python package hosted on PyPi. Simple use pip or pipenv to install it

pip install posixath

or

pipenv install posixath

The package manager should take care of installing any dependencies needed in order to run the tests

Fixing Common Problems

Some tests may need root privileges in order to run. If you run into permission errors when running certain tests it may be because you need to run with elevated privileges.

Explore AtomicTestHarnesses

The best way to see what the POSIX AtomicTestHarnesses can do be sure to check out our docs located in the docs folder in the posix directory. You can use mkdocs to make a local doc server instance to make viewing the documentation much easier. You can also run

python -m posixath --help

or

python -m posixath [linux|macos] --list

to get information on tests that can be run and some simple examples of how to run them.

Next Steps

Once you have the POSIX AtomicTestHarnesses installed check out the documentation for each given attack technique. Each attack technique is unique and will have slightly different data it can accept, generate, and output. Also any caveats are clearly documented