pocketscion 0.5.2

A lightweight SCION network simulator
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

// 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.

//! PocketSCION example topologies for testing.

use std::{collections::BTreeMap, num::NonZeroU16, time::SystemTime};

use crate::{
    network::scion::topology::{ScionAs, ScionLink, ScionLinkType, ScionTopology},
    runtime::PocketScionRuntimeBuilder,
    state::SharedPocketScionState,
    topologies::{IA132, IA212, IA222, PocketScionHandle, UnderlayType},
};

/// PocketSCION topology with two ASes and a single link between them.
pub async fn minimal_topology(underlay: UnderlayType) -> PocketScionHandle {
    let mut pstate = SharedPocketScionState::new(SystemTime::now());

    // Define the topology
    let mut topo = ScionTopology::new();
    topo.add_as(ScionAs::new_core(IA212))
        .unwrap()
        .add_as(ScionAs::new_core(IA132))
        .unwrap()
        .add_link(ScionLink::new(IA132, 1, ScionLinkType::Core, IA212, 3).unwrap())
        .unwrap();

    pstate.set_topology(topo);

    // Create Endhost API
    let _eh132 = pstate.add_endhost_api(vec![IA132]);
    let _eh212 = pstate.add_endhost_api(vec![IA212]);

    match underlay {
        // Add SNAPs
        UnderlayType::Snap => {
            let _snap132 = pstate.add_snap(IA132).unwrap();
            let _snap212 = pstate.add_snap(IA212).unwrap();
        }
        // Add two routers for UDP underlay
        UnderlayType::Udp => {
            pstate.add_router(
                IA132,
                vec![NonZeroU16::new(1).unwrap(), NonZeroU16::new(2).unwrap()],
                vec![],
                BTreeMap::new(),
            );
            pstate.add_router(
                IA212,
                vec![NonZeroU16::new(3).unwrap(), NonZeroU16::new(4).unwrap()],
                vec![],
                BTreeMap::new(),
            );
        }
    }

    let pocketscion = PocketScionRuntimeBuilder::new()
        .with_system_state(pstate.into_state())
        .with_mgmt_listen_addr("127.0.0.1:0".parse().unwrap())
        .start()
        .await
        .expect("Failed to start PocketSCION");

    let api_client = pocketscion.api_client();

    PocketScionHandle::new(pocketscion, api_client)
}

/// PocketSCION topology with three ASes and two paths from [IA132] to [IA212].
pub async fn two_path_topology(underlay: UnderlayType) -> PocketScionHandle {
    scion_sdk_utils::rustls::select_ring_crypto_provider();

    let mut pstate = SharedPocketScionState::new(SystemTime::now());

    // Define the topology
    let mut topo = ScionTopology::new();
    topo.add_as(ScionAs::new_core(IA212))
        .unwrap()
        .add_as(ScionAs::new_core(IA132))
        .unwrap()
        .add_as(ScionAs::new_core(IA222))
        .unwrap()
        .add_link(ScionLink::new(IA132, 1, ScionLinkType::Core, IA212, 3).unwrap())
        .unwrap()
        .add_link(ScionLink::new(IA132, 2, ScionLinkType::Core, IA222, 1).unwrap())
        .unwrap()
        .add_link(ScionLink::new(IA212, 4, ScionLinkType::Core, IA222, 2).unwrap())
        .unwrap();

    pstate.set_topology(topo);

    // Create Endhost API
    let _eh132 = pstate.add_endhost_api(vec![IA132]);
    let _eh212 = pstate.add_endhost_api(vec![IA212]);

    match underlay {
        // Create two SNAPs with data planes
        UnderlayType::Snap => {
            let _snap132 = pstate.add_snap(IA132).unwrap();
            let _snap212 = pstate.add_snap(IA212).unwrap();
        }
        // Add two routers for UDP underlay
        UnderlayType::Udp => {
            pstate.add_router(
                IA132,
                vec![NonZeroU16::new(1).unwrap(), NonZeroU16::new(2).unwrap()],
                vec![],
                BTreeMap::new(),
            );
            pstate.add_router(
                IA212,
                vec![NonZeroU16::new(3).unwrap(), NonZeroU16::new(4).unwrap()],
                vec![],
                BTreeMap::new(),
            );
        }
    }

    let pocketscion = PocketScionRuntimeBuilder::new()
        .with_system_state(pstate.into_state())
        .with_mgmt_listen_addr("127.0.0.1:0".parse().unwrap())
        .start()
        .await
        .expect("Failed to start PocketSCION");

    let api_client = pocketscion.api_client();

    PocketScionHandle::new(pocketscion, api_client)
}