snap-control 0.1.0

Control plane implementation of the SNAP transport underlay for SCION
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

// Copyright 2025 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.
//! SNAP control plane models.

use std::net::SocketAddr;

#[cfg(test)]
use mockall::{automock, predicate::*};
use scion_proto::address::IsdAsn;
use snap_dataplane::session::manager::{SessionOpenError, SessionTokenError};
use snap_tokens::snap_token::SnapTokenClaims;
use thiserror::Error;

use crate::crpc_api::api_service::model::SessionGrant;

/// List the available data planes.
#[cfg_attr(test, automock)]
pub trait DataPlaneDiscovery: Send + Sync {
    /// List all SNAP data planes.
    fn list_snap_data_planes(&self) -> Vec<SnapDataPlane>;
    /// List all UDP data planes.
    fn list_udp_data_planes(&self) -> Vec<UdpDataPlane>;
}

/// Data plane session granter.
#[cfg_attr(test, automock)]
pub trait SessionGranter: Send + Sync {
    /// Create a SNAP data plane session for the given address and SNAP token.
    fn create_session(
        &self,
        addr: SocketAddr,
        snap_token: SnapTokenClaims,
    ) -> Result<SessionGrant, CreateSessionError>;
}

/// Session creation error.
#[derive(Debug, Error)]
pub enum CreateSessionError {
    /// Data plane not found.
    #[error("no data plane with matching address exists")]
    DataPlaneNotFound,
    /// Failed to open session.
    #[error("open session error: {0}")]
    OpenSession(#[from] SessionOpenError),
    /// Failed to issue session token.
    #[error("failed to issue session token: {0}")]
    IssueSessionToken(#[from] SessionTokenError),
}

/// SNAP data plane information.
pub struct SnapDataPlane {
    /// The listener address of the data plane.
    pub address: SocketAddr,
    /// The ISD-ASes of the data plane.
    pub isd_ases: Vec<IsdAsn>,
}

/// UDP data plane information.
pub struct UdpDataPlane {
    /// The UDP socket address of the data plane.
    pub endpoint: SocketAddr,
    /// The ISD-ASes and their associated interfaces for this UDP data plane.
    pub isd_ases: Vec<IsdAsInterfaces>,
}

/// The interface IDs for an ISD-AS.
pub struct IsdAsInterfaces {
    /// The ISD-AS identifier
    pub isd_as: IsdAsn,
    /// The interface IDs for this ISD-AS
    pub interfaces: Vec<u32>,
}