snap-dataplane 0.4.0

Data 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

// 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.
//! Tunnel gateway state.

use std::net::SocketAddr;

use serde::{Deserialize, Serialize};

/// Tunnel gateway I/O configuration.
#[derive(Debug, PartialEq, Clone, Default, Serialize, Deserialize)]
pub struct TunnelGatewayIoConfig {
    /// Optional socket address to listen on for incoming SNAP tunnel connections.
    pub listen_addr: Option<SocketAddr>,
}

impl TunnelGatewayIoConfig {
    /// Creates a new tunnel gateway I/O configuration with the given listen address.
    pub fn new(listen_addr: SocketAddr) -> Self {
        Self {
            listen_addr: Some(listen_addr),
        }
    }
}

pub mod dto {
    //! DTO for the tunnel gateway state.
    use anyhow::Context;
    use serde::{Deserialize, Serialize};
    use utoipa::ToSchema;

    use crate::tunnel_gateway::state::TunnelGatewayIoConfig;

    /// The I/O configuration of a SNAP data plane.
    #[derive(Debug, Serialize, Deserialize, ToSchema, Clone)]
    pub struct IoDataPlaneConfigDto {
        /// The data plane address.
        #[schema(nullable = false)]
        #[serde(skip_serializing_if = "Option::is_none", default)]
        pub addr: Option<String>,
    }

    impl From<&TunnelGatewayIoConfig> for IoDataPlaneConfigDto {
        fn from(value: &TunnelGatewayIoConfig) -> Self {
            IoDataPlaneConfigDto {
                addr: value.listen_addr.map(|addr| addr.to_string()),
            }
        }
    }

    impl TryFrom<IoDataPlaneConfigDto> for TunnelGatewayIoConfig {
        type Error = anyhow::Error;

        fn try_from(value: IoDataPlaneConfigDto) -> Result<Self, Self::Error> {
            let listen_addr = match value.addr {
                Some(addr) => Some(addr.parse().context("invalid listen address")?),
                None => None,
            };

            Ok(Self { listen_addr })
        }
    }
}