pycadf package

Subpackages

• pycadf.helper package
  • Submodules
  • pycadf.helper.api module
  • Module contents
• pycadf.tests package
  • Subpackages
    • pycadf.tests.helper package
      • Submodules
      • pycadf.tests.helper.test_api module
      • Module contents
  • Submodules
  • pycadf.tests.base module
  • pycadf.tests.test_cadf_spec module
  • pycadf.tests.test_utils module
  • Module contents

Submodules

pycadf.attachment module

class pycadf.attachment.Attachment(typeURI=None, content=None, name=None)

Bases: pycadf.cadftype.CADFAbstractType

content

is_valid()

Validation to ensure Attachment required attributes are set.

name

typeURI

pycadf.cadftaxonomy module

pycadf.cadftaxonomy.is_valid_action(value)

pycadf.cadftaxonomy.is_valid_outcome(value)

pycadf.cadftaxonomy.is_valid_resource(value)

pycadf.cadftype module

class pycadf.cadftype.CADFAbstractType

Bases: object

The abstract base class for all CADF (complex) data types (classes).

as_dict()

Return dict representation of Event.

is_valid(value)

class pycadf.cadftype.ValidatorDescriptor(name, func=None)

Bases: object

pycadf.cadftype.is_valid_eventType(value)

pycadf.cadftype.is_valid_reporter_role(value)

pycadf.credential module

class pycadf.credential.Credential(token, type=None)

Bases: pycadf.cadftype.CADFAbstractType

is_valid()

Validation to ensure Credential required attributes are set.

token

type

class pycadf.credential.FederatedCredential(token, type, identity_provider, user, groups)

Bases: pycadf.credential.Credential

groups

identity_provider

is_valid()

Validation to ensure Credential required attributes are set.

user

pycadf.endpoint module

class pycadf.endpoint.Endpoint(url, name=None, port=None)

Bases: pycadf.cadftype.CADFAbstractType

is_valid()

Validation to ensure Endpoint required attributes are set.

name

port

url

pycadf.event module

class pycadf.event.Event(eventType='activity', id=None, eventTime=None, action='unknown', outcome='unknown', initiator=None, initiatorId=None, target=None, targetId=None, severity=None, reason=None, observer=None, observerId=None, name=None)

Bases: pycadf.cadftype.CADFAbstractType

action

add_attachment(attachment_val)

Add Attachment to Event

Parameters:attachment_val – Attachment to add to Event

add_measurement(measure_val)

Add a measurement value

Parameters:measure_val – Measurement data type to be added to Event

add_reporterstep(step)

Add a Reporterstep

Parameters:step – Reporterstep to be added to reporterchain

add_tag(tag_val)

Add Tag to Event

Parameters:tag_val – Tag to add to event

eventTime

eventType

id

initiator

initiatorId

is_valid()

Validation to ensure Event required attributes are set.

name

observer

observerId

outcome

reason

severity

target

targetId

pycadf.eventfactory module

class pycadf.eventfactory.EventFactory

Bases: object

Factory class to create different required attributes for the following CADF event types: ‘activity’: for tracking any interesting system activities for audit ‘monitor’: Events that carry Metrics and Measurements and support standards such as NIST ‘control’: For audit events that are based upon (security) policies and reflect some policy decision.

new_event(eventType='activity', **kwargs)

Create new event

Parameters:eventType – eventType of event. Defaults to ‘activity’

pycadf.geolocation module

class pycadf.geolocation.Geolocation(id=None, latitude=None, longitude=None, elevation=None, accuracy=None, city=None, state=None, regionICANN=None)

Bases: pycadf.cadftype.CADFAbstractType

accuracy

city

elevation

id

is_valid()

latitude

longitude

regionICANN

set_annotations(value)

state

pycadf.host module

class pycadf.host.Host(id=None, address=None, agent=None, platform=None)

Bases: pycadf.cadftype.CADFAbstractType

address

agent

id

is_valid()

Validation to ensure Host required attributes are set.

platform

pycadf.identifier module

pycadf.identifier.generate_uuid()

Generate a CADF identifier.

pycadf.identifier.is_valid(value)

Validation to ensure Identifier is correct.

pycadf.identifier.norm_ns(str_id)

Apply a namespace to the identifier.

pycadf.measurement module

class pycadf.measurement.Measurement(result=None, metric=None, metricId=None, calculatedBy=None)

Bases: pycadf.cadftype.CADFAbstractType

calculatedBy

is_valid()

Validation to ensure Measurement required attributes are set.

metric

metricId

result

pycadf.metric module

class pycadf.metric.Metric(metricId=None, unit=None, name=None)

Bases: pycadf.cadftype.CADFAbstractType

is_valid()

Validation to ensure Metric required attributes are set.

metricId

name

set_annotations(value)

unit

pycadf.path module

class pycadf.path.Path

Bases: pycadf.cadftype.CADFAbstractType

static is_valid(value)

set_path_absolute()

set_path_relative()

pycadf.reason module

class pycadf.reason.Reason(reasonType=None, reasonCode=None, policyType=None, policyId=None)

Bases: pycadf.cadftype.CADFAbstractType

is_valid()

Validation to ensure Reason required attributes are set.

policyId

policyType

reasonCode

reasonType

pycadf.reporterstep module

class pycadf.reporterstep.Reporterstep(role='modifier', reporterTime=None, reporter=None, reporterId=None)

Bases: pycadf.cadftype.CADFAbstractType

is_valid()

Validation to ensure Reporterstep required attributes are set.

reporter

reporterId

reporterTime

role

pycadf.resource module

class pycadf.resource.Resource(id=None, typeURI='unknown', name=None, ref=None, domain=None, credential=None, host=None, geolocation=None, geolocationId=None)

Bases: pycadf.cadftype.CADFAbstractType

add_address(addr)

Add CADF endpoints to Resource

Parameters:addr – CADF Endpoint to add to Resource

add_attachment(attach_val)

Add CADF attachment to Resource

Parameters:attach_val – CADF Attachment to add to Resource

credential

domain

geolocation

geolocationId

host

id

is_valid()

Validation to ensure Resource required attributes are set

name

ref

typeURI

pycadf.tag module

pycadf.tag.generate_name_value_tag(name, value)

Generate a CADF tag in the format name?value=<value>

Parameters:

• name – name of tag
• valuue – optional value tag

pycadf.tag.is_valid(value)

Validation check to ensure proper Tag format

pycadf.timestamp module

pycadf.timestamp.get_utc_now(timezone=None)

Return the current UTC time.

Parameters:timezone – an optional timezone param to offset time to.

pycadf.timestamp.is_valid(value)

Validation to ensure timestamp is a string.

pycadf.utils module

pycadf.utils.mask_value(value, s_percent=0.125)

Obfuscate a given string to show only a percentage of leading and trailing characters.

Parameters:s_percent – The percentage (in decimal) of characters to replace

Module contents