Skip to content

Latest commit

 

History

History
126 lines (86 loc) · 3.56 KB

running-tests-script.md

File metadata and controls

126 lines (86 loc) · 3.56 KB
Raw

Running Atomic Tests

In order to run tests using atomic-operator you must have one or more atomic tests.

Selecting Tests to Run

By default, atomic-operator will run all known tests within the provided directory.

from atomic_operator import AtomicOperator

art = AtomicOperator()

print(art.run(atomics_path='my_local_folder/atomic-red-team'))

If you would like to specify specific tests then you must provide them as a list as input.

Please note that techniques passed in but be separated by a , and NO spaces.

from atomic_operator import AtomicOperator

art = AtomicOperator()

print(art.run(
    techniques='T1560.002', 'T1560.001'], atomics_path='my_local_folder/atomic-red-team'
))

Checking Dependencies

There is an optional paramater that determines if atomic-operator should check dependencies or not. By default we do not check dependenicies but if set to True we will.

art.run(
    atomics_path='my_local_folder/atomic-red-team',
    check_dependencies=True
)

check_dependencies means we will run any defined prereq_command defined within the Atomic test.

Get Prerequisities

Another optional paramater deteremines if we retrieve or run any get_prereq_command values defined within the Atomic test.

art.run(
    atomics_path='my_local_folder/atomic-red-team',
    check_dependencies=True,
    get_prereq_command=True,
)

Setting this value to True means we will run that command but only if check_dependencies is set to True as well.

Cleanup

This optional parameter is by default set to False but if set to True then we will run any cleanup_command values defined within an Atomic test.

art.run(
    atomics_path='my_local_folder/atomic-red-team',
    cleanup=True
)

Command Timeout

The command_timeout parameter tells atomic-operator the duration (in seconds) to run a command without exiting that process.

art.run(
    atomics_path='my_local_folder/atomic-red-team',
    command_timeout=40
)

This defaults to 20 seconds but you can specify another value if needed.

Debug

The debug parameter will show additional details about the Atomic and tests (e.g. descriptions, etc.).

art.run(
    atomics_path='my_local_folder/atomic-red-team',
    debug=True
)

The default value is False and must be set to True to show this extra detail.

Interactive Argument Inputs

The prompt_for_input_args parameter will enable an interactive session and prompt you to enter arguments for any Atomic test(s) that require input arguments. You can simply provide a value or select to use the default defined within the Atomic test.

art.run(
    atomics_path='my_local_folder/atomic-red-team',
    prompt_for_input_args=True
)

The default value is False and must be set to True to prompt you for input values.

kwargs

If you choose not to set prompt_for_input_args to True then you can provide a dictionary of arguments in the kwargs input. This dictionary is only used for setting input argument values.

For example, if you were running the Atomic test T1564.001 then would pass in a dictionary into the kwargs argument.

If you do not want atomic-operator to prompt you for inputs you can simply run the following on the command line:

inputs = {
    'filename': 'myscript.py'
}

art.run(
    atomics_path='my_local_folder/atomic-red-team',
    prompt_for_input_args=False,
    **inputs
)