pyoaev.contracts.contract_config

Module Contents

class pyoaev.contracts.contract_config.SupportedLanguage

Bases: str, enum.Enum

fr: str = 'fr'

en: str = 'en'

class pyoaev.contracts.contract_config.ContractFieldType

Bases: str, enum.Enum

Text: str = 'text'

Number: str = 'number'

Tuple: str = 'tuple'

Checkbox: str = 'checkbox'

Textarea: str = 'textarea'

Select: str = 'select'

Article: str = 'article'

Challenge: str = 'challenge'

DependencySelect: str = 'dependency-select'

Attachment: str = 'attachment'

Team: str = 'team'

Expectation: str = 'expectation'

Asset: str = 'asset'

AssetGroup: str = 'asset-group'

Payload: str = 'payload'

class pyoaev.contracts.contract_config.ContractFieldKey

Bases: str, enum.Enum

Asset: str = 'assets'

AssetGroup: str = 'asset_groups'

class pyoaev.contracts.contract_config.ContractOutputType

Bases: str, enum.Enum

Text: str = 'text'

Number: str = 'number'

Port: str = 'port'

PortsScan: str = 'portscan'

IPv4: str = 'ipv4'

IPv6: str = 'ipv6'

CVE: str = 'cve'

Asset: str = 'asset'

class pyoaev.contracts.contract_config.ExpectationType

Bases: str, enum.Enum

text: str = 'TEXT'

document: str = 'DOCUMENT'

article: str = 'ARTICLE'

challenge: str = 'CHALLENGE'

manual: str = 'MANUAL'

prevention: str = 'PREVENTION'

detection: str = 'DETECTION'

vulnerability: str = 'VULNERABILITY'

class pyoaev.contracts.contract_config.Expectation

expectation_type: ExpectationType

expectation_name: str

expectation_description: str

expectation_score: int

expectation_expectation_group: bool

class pyoaev.contracts.contract_config.LinkedFieldModel

key: str

type: ContractFieldType

class pyoaev.contracts.contract_config.ContractElement

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

key: str

label: str

type: str = ''

mandatoryGroups: List[str] = []

mandatoryConditionFields: List[str] = []

mandatoryConditionValues: Dict[str, any] = []

visibleConditionFields: List[str] = []

visibleConditionValues: Dict[str, any] = []

linkedFields: List[str] = []

mandatory: bool = False

readOnly: bool = False

property get_type: str

Abstractmethod:

class pyoaev.contracts.contract_config.ContractCardinalityElement

Bases: ContractElement, abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

cardinality: str

defaultValue: List[str] = []

class pyoaev.contracts.contract_config.ContractOutputElement

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

type: str

field: str

labels: List[str]

isFindingCompatible: bool

isMultiple: bool

class pyoaev.contracts.contract_config.ContractConfig

type: str

expose: bool

label: dict[SupportedLanguage, str]

color_dark: str

color_light: str

class pyoaev.contracts.contract_config.Domain

domain_id: str

domain_name: str

domain_color: str

domain_created_at: str

domain_updated_at: str

class pyoaev.contracts.contract_config.Contract

contract_id: str

label: dict[SupportedLanguage, str]

fields: List[ContractElement]

outputs: List[ContractOutputElement]

config: ContractConfig

manual: bool

variables: List[pyoaev.contracts.contract_utils.ContractVariable]

contract_attack_patterns_external_ids: List[str] = []

contract_vulnerability_external_ids: List[str] = []

is_atomic_testing: bool = True

platforms: List[str] = []

external_id: str = None

domains: List[Domain] = None

add_attack_pattern(var: str)

add_vulnerability(var: str)

add_variable(var: pyoaev.contracts.contract_utils.ContractVariable)

to_contract_add_input(source_id: str)

to_contract_update_input()

class pyoaev.contracts.contract_config.ContractTeam

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

property get_type: str

class pyoaev.contracts.contract_config.ContractText

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

defaultValue: str = ''

property get_type: str

pyoaev.contracts.contract_config.prepare_contracts(contracts)

class pyoaev.contracts.contract_config.ContractTuple

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

attachmentKey: str = None

contractAttachment: bool

tupleFilePrefix: str = 'file :: '

property get_type: str

class pyoaev.contracts.contract_config.ContractTextArea

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

defaultValue: str = ''

richText: bool = False

property get_type: str

class pyoaev.contracts.contract_config.ContractCheckbox

Bases: ContractElement

Helper class that provides a standard way to create an ABC using inheritance.

defaultValue: bool = False

property get_type: str

class pyoaev.contracts.contract_config.ContractAttachment

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

property get_type: str

class pyoaev.contracts.contract_config.ContractExpectations

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

cardinality

predefinedExpectations: List[Expectation] = []

property get_type: str

class pyoaev.contracts.contract_config.ContractSelect

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

choices: dict[str, str] = None

property get_type: str

class pyoaev.contracts.contract_config.ContractAsset

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

key: str = 'assets'

property get_type: str

class pyoaev.contracts.contract_config.ContractAssetGroup

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

key: str = 'asset_groups'

property get_type: str

class pyoaev.contracts.contract_config.ContractPayload

Bases: ContractCardinalityElement

Helper class that provides a standard way to create an ABC using inheritance.

property get_type: str