Source code for octopoes.models.ooi.email_security

import hashlib
from typing import Literal

from octopoes.models import OOI, Reference
from octopoes.models.ooi.dns.records import DNSTXTRecord
from octopoes.models.ooi.dns.zone import Hostname
from octopoes.models.ooi.network import IPAddress, NetBlock
from octopoes.models.persistence import ReferenceField



[docs]
class DNSSPFRecord(OOI):
    object_type: Literal["DNSSPFRecord"] = "DNSSPFRecord"
    value: str
    ttl: int | None = None
    all: str | None = None
    exp: str | None = None
    dns_txt_record: Reference = ReferenceField(DNSTXTRecord, max_inherit_scan_level=1)

    _natural_key_attrs = ["dns_txt_record", "value"]
    _reverse_relation_names = {"dns_txt_record": "dns_spf_record"}

    @property
    def natural_key(self) -> str:
        sha = hashlib.sha1(self.value.encode("UTF-8")).hexdigest()
        key = super().natural_key
        return key.replace(self.value, sha)


[docs]
    @classmethod
    def format_reference_human_readable(cls, reference: Reference) -> str:
        return f"SPF Record of {reference.tokenized.dns_txt_record.hostname.name}"





[docs]
class DNSSPFMechanism(OOI):
    spf_record: Reference = ReferenceField(DNSSPFRecord, max_inherit_scan_level=1)
    mechanism: str




[docs]
class DNSSPFMechanismIP(DNSSPFMechanism):
    object_type: Literal["DNSSPFMechanismIP"] = "DNSSPFMechanismIP"

    ip: Reference = ReferenceField(IPAddress)

    _natural_key_attrs = ["spf_record", "mechanism", "ip"]
    _information_value = ["mechanism"]
    _reverse_relation_names = {"spf_record": "spf_ip_mechanisms"}


[docs]
    @classmethod
    def format_reference_human_readable(cls, reference: Reference) -> str:
        return (
            f"SPF Record of {reference.tokenized.spf_record.dns_txt_record.hostname.name}"
            f"{reference.tokenized.mechanism} {reference.tokenized.ip.address}"
        )





[docs]
class DNSSPFMechanismHostname(DNSSPFMechanism):
    object_type: Literal["DNSSPFMechanismHostname"] = "DNSSPFMechanismHostname"

    hostname: Reference = ReferenceField(Hostname)

    _natural_key_attrs = ["spf_record", "mechanism", "hostname"]
    _information_value = ["mechanism"]
    _reverse_relation_names = {"spf_record": "spf_hostname_mechanisms"}


[docs]
    @classmethod
    def format_reference_human_readable(cls, reference: Reference) -> str:
        return (
            f"SPF Record of {reference.tokenized.spf_record.dns_txt_record.hostname.name} "
            f"{reference.tokenized.mechanism} {reference.tokenized.hostname.name}"
        )





[docs]
class DNSSPFMechanismNetBlock(DNSSPFMechanism):
    object_type: Literal["DNSSPFMechanismNetBlock"] = "DNSSPFMechanismNetBlock"

    netblock: Reference = ReferenceField(NetBlock)

    _natural_key_attrs = ["spf_record", "mechanism", "netblock"]
    _information_value = ["mechanism"]
    _reverse_relation_names = {"spf_record": "spf_netblock_mechanisms"}


[docs]
    @classmethod
    def format_reference_human_readable(cls, reference: Reference) -> str:
        return (
            f"SPF Record of {reference.tokenized.spf_record.dns_txt_record.hostname.name} "
            f" {reference.tokenized.mechanism} {reference.tokenized.netblock.start_ip}"
            f"/{reference.tokenized.netblock.mask}"
        )





[docs]
class DMARCTXTRecord(OOI):
    object_type: Literal["DMARCTXTRecord"] = "DMARCTXTRecord"
    value: str
    ttl: int | None
    hostname: Reference = ReferenceField(Hostname)

    _natural_key_attrs = ["value", "hostname"]
    _reverse_relation_names = {"hostname": "dmarc_txt_record"}


[docs]
    @classmethod
    def format_reference_human_readable(cls, reference: Reference) -> str:
        return f"DMARC TXT Record of {reference.tokenized.hostname.name}"





[docs]
class DKIMExists(OOI):
    object_type: Literal["DKIMExists"] = "DKIMExists"
    hostname: Reference = ReferenceField(Hostname)

    _natural_key_attrs = ["hostname"]
    _reverse_relation_names = {"hostname": "dkim_exists"}


[docs]
    @classmethod
    def format_reference_human_readable(cls, reference: Reference) -> str:
        return f"DKIM Exists on {reference.tokenized.hostname.name}"





[docs]
class DKIMSelector(OOI):
    object_type: Literal["DKIMSelector"] = "DKIMSelector"
    selector: str
    hostname: Reference = ReferenceField(Hostname)

    _natural_key_attrs = ["selector", "hostname"]
    _reverse_relation_names = {"hostname": "dkim_selector"}


[docs]
    @classmethod
    def format_reference_human_readable(cls, reference: Reference) -> str:
        return f"{reference.tokenized.selector} DKIM selector of {reference.tokenized.hostname.name}"





[docs]
class DKIMKey(OOI):
    object_type: Literal["DKIMKey"] = "DKIMKey"
    key: str
    dkim_selector: Reference = ReferenceField(DKIMSelector)

    _natural_key_attrs = ["key", "dkim_selector"]
    _reverse_relation_names = {"dkim_selector": "dkim_key"}


[docs]
    @classmethod
    def format_reference_human_readable(cls, reference: Reference) -> str:
        return (
            f"DKIM key of {reference.tokenized.dkim_selector.selector} on "
            f"{reference.tokenized.dkim_selector.hostname.name}"
        )