octodns.processor.spf

Classes

SpfDnsLookupProcessor(name, **kwargs)

Validate that SPF values in TXT records are valid.

Exceptions

`SpfDnsLookupException`
`SpfValueException`

exception octodns.processor.spf.SpfValueException[source]: Bases: ProcessorException

exception octodns.processor.spf.SpfDnsLookupException[source]: Bases: ProcessorException

class octodns.processor.spf.SpfDnsLookupProcessor(name, **kwargs)[source]

Bases: BaseProcessor

Validate that SPF values in TXT records are valid.

Example usage:

processors:
  spf:
    class: octodns.processor.spf.SpfDnsLookupProcessor

zones:
  example.com.:
    sources:
      - config
    processors:
      - spf
    targets:
      - route53

The validation can be skipped for specific records by setting the lenient flag, e.g.:

_spf:
  octodns:
    lenient: true
  ttl: 86400
  type: TXT
  value: v=spf1 ptr ~all

log = <Logger SpfDnsLookupProcessor (WARNING)>

__init__(name, **kwargs)[source]

Initialize the processor.

Parameters:

name (str) – Unique identifier for this processor instance. Used in logging and configuration references.
lenient (bool) – When True, the processor will operate in lenient mode. This value is combined with the per-call lenient parameter in process_* methods.

Note

The name parameter is deprecated and will be removed in version 2.0. Use id instead.

_get_spf_from_txt_values(record: Record, values: List[str]) → str | None[source]

Parameters:

record (Record)
values (List[str])

Return type:

str | None

_process_answer(answer: Answer) → List[str][source]

Parameters:: answer (Answer)
Return type:: List[str]

_check_dns_lookups(record: Record, values: List[str], lookups: int = 0) → int[source]

Parameters:

record (Record)
values (List[str])
lookups (int)

Return type:

int

process_source_zone(zone, sources, lenient=False)[source]

Process the desired zone after all sources have populated.

Called after all sources have completed populate. Provides an opportunity for the processor to modify the desired zone that targets will receive.

Parameters:

desired (octodns.zone.Zone) – The desired zone state after all sources have populated. This zone will be used as the target state for planning.
sources (list[octodns.provider.base.BaseProvider]) – List of source providers that populated the zone. May be empty for aliased zones.
lenient (bool) – When True, relaxed validation rules should be applied when modifying zone records.

Returns:

The modified desired zone, typically the same object passed in.

Return type:

octodns.zone.Zone

Important

Will see desired after any modifications done by Provider._process_desired_zone and processors configured to run before this one.
May modify desired directly.
Must return desired which will normally be the desired param.
Must not modify records directly; record.copy should be called, the results of which can be modified, and then Zone.add_record may be used with replace=True.
May call Zone.remove_record to remove records from desired.
Sources may be empty, as will be the case for aliased zones.
Implementations should combine self.lenient or lenient and pass the result to any record and zone calls that accept lenient as a parameter, e.g. zone.add_record(..., lenient=lenient).