Struct twistrs::enrich::DomainMetadata

pub struct DomainMetadata {
    pub fqdn: String,
    pub ips: Option<Vec<IpAddr>>,
    pub smtp: Option<SmtpMetadata>,
}

Container to store interesting FQDN metadata on domains that we resolve.

Whenever any domain enrichment occurs, the following struct is return to indicate the information that was derived.

N.B—there will be cases where a single domain can have multiple DomainMetadata instancees associated with it.

Fields

fqdn: String

The domain that is being enriched.

ips: Option<Vec<IpAddr>>

Any IPv4 and IPv6 ips that were discovered during domain resolution.

smtp: Option<SmtpMetadata>

Any SMTP message data (if any) that was returned by an SMTP server.

Implementations

impl DomainMetadata

pub fn new(fqdn: String) -> DomainMetadata

Create a new empty state for a particular FQDN.

pub async fn dns_resolvable<'_>(&'_ self) -> Result<DomainMetadata>

Asynchronous DNS resolution on a DomainMetadata instance.

Returns Ok(DomainMetadata) is the domain was resolved, otherwise returns Err(EnrichmentError).

N.B—also host lookups are done over port 80.

pub async fn mx_check<'_>(&'_ self) -> Result<DomainMetadata>

Asynchronous SMTP check. Attempts to establish an SMTP connection to the FQDN on port 25 and send a pre-defi ned email.

Currently returns Ok(DomainMetadata) always, which internally contains Option<SmtpMetadata>. To check if the SMTP relay worked, check that DomainMetadata.smtp is Some(v).

pub async fn all<'_>(&'_ self) -> Result<Vec<DomainMetadata>>

Performs all FQDN enrichment methods on a given FQDN. This is the only function that returns a Vec<DomainMetadata>.

Panics

Currently panics if any of the internal enrichment methods returns an Err.

Trait Implementations

impl Clone for DomainMetadata

fn clone(&self) -> DomainMetadata

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DomainMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.