syntribos/doc/source/code-docs.rst

3.2 KiB

Syntribos Code Documentation

Configuration

This section describes the configuration specified in the second argument to the runner, your configuration file.

syntribos.config

Signals

This section describes Signals (syntribos.signal.SynSignal) and SignalHolders (syntribos.signal.SignalHolder).

syntribos.signal.SynSignal

syntribos.signal.SignalHolder

Checks

This section describes the checks, which analyze the HTTP response and returns a signal if it detects something that it knows about. It's intended to make it easier to inspect HTTP responses.

syntribos.checks.content_validity

syntribos.checks.fingerprint

syntribos.checks.header

syntribos.checks.http

syntribos.checks.length

syntribos.checks.ssl

syntribos.checks.stacktrace

syntribos.checks.string

syntribos.checks.time

Tests

This section describes the components involved with writing your own tests with syntribos.

All syntribos tests inherit from syntribos.tests.base.BaseTestCase, either directly, or through a subclass such as syntribos.tests.fuzz.base_fuzz.BaseFuzzTestCase.

All tests are aggregated in the syntribos.tests.base.test_table variable.

syntribos.tests.base

syntribos.tests.fuzz.datagen

Issues

This section describes the representation of issues that are uncovered by syntribos.

syntribos.issue

Results

This section describes the representation of results (collections of issues) from a given syntribos run.

syntribos.result

HTTP Requests

This section describes the components related to generating, fuzzing, and making HTTP requests.

syntribos.clients.http.client

syntribos.clients.http.parser

Extensions

This section describes syntribos extensions, which are called by the CALL_EXTERNAL field in the request template.

syntribos.extensions.identity.models.base