mail-auth 0.15.1

DKIM, ARC, SPF and DMARC library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

/*
 * SPDX-FileCopyrightText: 2020 Stalwart Labs LLC <hello@stalw.art>
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 */

use super::{ChainLink, ChainValidation};
use crate::DkimResult;

/// The result of ARC chain validation (RFC 8617, Section 5.2).
///
/// An alias of [`DkimResult`]: `Pass` when the chain validated, `None` when
/// the message has no ARC headers, and `Fail`, `Neutral`, `PermError` or
/// `TempError` carrying the error that stopped validation. See
/// [`MessageAuthenticator::verify_arc`](crate::MessageAuthenticator::verify_arc)
/// for when each variant is returned.
pub type ArcResult = DkimResult;

/// The outcome of ARC chain validation.
///
/// Returned by
/// [`MessageAuthenticator::verify_arc`](crate::MessageAuthenticator::verify_arc)
/// and passed to [`ArcSealer::seal`](super::ArcSealer::seal) and to
/// [`AuthenticationResults::with_arc_result`](crate::AuthenticationResults::with_arc_result).
/// Built from a bare [`ArcResult`] through `From`, with an empty chain.
#[derive(Debug, PartialEq, Eq, Clone)]
pub struct ArcOutput<'x> {
    pub(crate) result: ArcResult,
    pub(crate) set: Vec<ChainLink<'x>>,
}

impl ArcOutput<'_> {
    /// Returns the chain validation result.
    pub fn result(&self) -> &ArcResult {
        &self.result
    }

    /// Returns the ARC sets of the incoming chain, oldest (instance 1)
    /// first. Empty when the message has no ARC headers or they could not be
    /// grouped into sets.
    pub fn chain(&self) -> &[ChainLink<'_>] {
        &self.set
    }
}

impl<'x> ArcOutput<'x> {
    pub(crate) fn with_result(mut self, result: ArcResult) -> Self {
        self.result = result;
        self
    }

    /// Returns `true` when a new ARC set may be added: the chain is empty or
    /// its newest `ARC-Seal` does not carry `cv=fail` (RFC 8617,
    /// Section 5.1.2).
    pub fn can_be_sealed(&self) -> bool {
        self.set.is_empty() || self.set.last().unwrap().seal.header.cv != ChainValidation::Fail
    }
}

impl From<ArcResult> for ArcOutput<'_> {
    fn from(result: ArcResult) -> Self {
        ArcOutput {
            result,
            set: Vec::new(),
        }
    }
}

impl Default for ArcOutput<'_> {
    fn default() -> Self {
        Self {
            result: DkimResult::None,
            set: Vec::new(),
        }
    }
}