scion-stack 0.6.1

SCION endhost network stack
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
77
78
79
80
81
82
83
84
85

// Copyright 2026 Anapaya Systems
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! DNS resolution helpers for SCION addresses.

pub mod txt;

use async_trait::async_trait;
use sciparse::address::ip_addr::ScionIpAddr;
use thiserror::Error;

/// DNS resolver trait for SCION address discovery.
///
/// Implementations return zero or more `ScionAddr` values for a given domain
/// name. The resolver is expected to be async and safe to share across tasks.
///
/// # Error handling
///
/// Implementations SHOULD return `ResolveError::NoValidEntries` only when a
/// lookup succeeds but yields no valid SCION TXT entries. Partial failures
/// SHOULD return the valid addresses and log warnings for invalid entries.
#[async_trait]
pub trait ScionDnsResolver: Send + Sync {
    /// Resolve a domain into SCION addresses.
    ///
    /// Implementations SHOULD return only valid addresses and log warnings for
    /// invalid TXT entries. Errors are reserved for lookup failures or when no
    /// valid addresses can be produced.
    async fn resolve(&self, domain: &str) -> Result<Vec<ScionIpAddr>, ResolveError>;
}

/// Errors returned by SCION DNS resolution.
// Derives `PartialEq` for testability; as a consequence, `DnsLookup` carries a formatted message
// rather than the underlying (non-`PartialEq`) DNS error. See API_CONVENTIONS.md.
#[derive(Debug, Error, PartialEq)]
#[non_exhaustive]
pub enum ResolveError {
    /// DNS lookup failed.
    #[error("dns lookup failed: {0}")]
    DnsLookup(String),
    /// No valid TSAR entries were found.
    #[error("no valid TSAR TXT entries for {domain}")]
    NoValidEntries {
        /// Domain name that was looked up.
        domain: String,
        /// Invalid entries encountered during parsing or TXT decoding.
        invalid_entries: Vec<InvalidEntry>,
    },
}

/// Metadata for a TXT entry that could not be parsed.
#[derive(Debug, Clone, PartialEq)]
pub struct InvalidEntry {
    raw: String,
    reason: String,
}

impl InvalidEntry {
    pub(crate) fn new(raw: impl Into<String>, reason: impl Into<String>) -> Self {
        Self {
            raw: raw.into(),
            reason: reason.into(),
        }
    }

    /// Return the raw TXT entry that failed parsing.
    pub fn raw(&self) -> &str {
        &self.raw
    }

    /// Return the reason this TXT entry failed parsing.
    pub fn reason(&self) -> &str {
        &self.reason
    }
}