focl 0.1.0

focl/focld - lightweight Rust BGP speaker
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
use std::collections::HashMap;
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use std::str::FromStr;
use std::sync::Arc;
use std::time::Duration;

use anyhow::{anyhow, Context, Result};
use bgpkit_parser::bgp::parse_bgp_message;
use bgpkit_parser::models::{
    AsPath, AsnLength, AttributeValue, Attributes, BgpMessage, BgpOpenMessage, BgpUpdateMessage,
    NetworkPrefix, Origin,
};
use bytes::Bytes;
use ipnet::IpNet;
use serde::{Deserialize, Serialize};
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::{TcpListener, TcpSocket, TcpStream};
use tokio::sync::{broadcast, RwLock};
use tokio::task::JoinHandle;
use tokio::time::{sleep, timeout, Instant};

use crate::config::{FoclConfig, PeerConfig};
use crate::types::{Event, EventEnvelope, PeerState};

mod auth;
use auth::{TcpSocketExt, TcpStreamExt};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PeerInfo {
    pub address: String,
    pub name: Option<String>,
    pub remote_as: u32,
    pub local_as: u32,
    pub remote_port: u16,
    pub passive: bool,
    pub auth_enabled: bool,
    pub state: PeerState,
    pub last_error: Option<String>,
    pub advertised_prefixes: usize,
    pub established_at: Option<i64>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RibSummary {
    pub peers_total: usize,
    pub peers_established: usize,
    pub advertised_prefixes_total: usize,
}

#[derive(Debug)]
struct PeerRuntime {
    info: PeerInfo,
    cfg: PeerConfig,
    task: JoinHandle<()>,
}

#[derive(Clone)]
pub struct BgpService {
    inner: Arc<BgpServiceInner>,
}

#[derive(Debug, Clone)]
struct PrefixEntry {
    network: IpNet,
    next_hop: Option<IpAddr>,
}

struct BgpServiceInner {
    global_asn: u32,
    router_id: Ipv4Addr,
    prefixes: Vec<PrefixEntry>,
    peers: RwLock<HashMap<String, PeerRuntime>>,
    event_tx: broadcast::Sender<EventEnvelope>,
}

impl BgpService {
    pub async fn new(cfg: &FoclConfig, event_tx: broadcast::Sender<EventEnvelope>) -> Result<Self> {
        let router_id = cfg
            .global
            .router_id
            .parse::<Ipv4Addr>()
            .context("global.router_id must be IPv4")?;

        let prefixes = cfg
            .prefixes
            .iter()
            .map(|p| {
                let network = IpNet::from_str(&p.network)
                    .with_context(|| format!("invalid prefix network: {}", p.network))?;
                let next_hop = p
                    .next_hop
                    .as_ref()
                    .map(|nh| nh.parse::<IpAddr>())
                    .transpose()
                    .with_context(|| format!("invalid next-hop address: {:?}", p.next_hop))?;
                Ok::<_, anyhow::Error>(PrefixEntry { network, next_hop })
            })
            .collect::<Result<Vec<_>, _>>()
            .context("invalid prefix in config")?;

        let inner = Arc::new(BgpServiceInner {
            global_asn: cfg.global.asn,
            router_id,
            prefixes,
            peers: RwLock::new(HashMap::new()),
            event_tx,
        });

        let service = Self { inner };
        service.start_peers(&cfg.peers).await;
        Ok(service)
    }

    async fn start_peers(&self, peers: &[PeerConfig]) {
        for peer in peers {
            if !peer.enabled {
                continue;
            }
            let runtime = self.spawn_peer_task(peer.clone());
            self.inner
                .peers
                .write()
                .await
                .insert(peer.address.clone(), runtime);
        }
    }

    fn spawn_peer_task(&self, peer_cfg: PeerConfig) -> PeerRuntime {
        let local_as = peer_cfg.local_as.unwrap_or(self.inner.global_asn);
        let info = PeerInfo {
            address: peer_cfg.address.clone(),
            name: peer_cfg.name.clone(),
            remote_as: peer_cfg.remote_as,
            local_as,
            remote_port: peer_cfg.remote_port,
            passive: peer_cfg.passive,
            auth_enabled: peer_cfg.password.is_some(),
            state: PeerState::Idle,
            last_error: None,
            advertised_prefixes: 0,
            established_at: None,
        };

        let service = self.clone();
        let address = peer_cfg.address.clone();
        let peer_for_task = peer_cfg.clone();
        let task = tokio::spawn(async move {
            service.peer_loop(peer_for_task).await;
            let mut peers = service.inner.peers.write().await;
            if let Some(runtime) = peers.get_mut(&address) {
                runtime.info.state = PeerState::Idle;
            }
        });

        PeerRuntime {
            info,
            cfg: peer_cfg,
            task,
        }
    }

    async fn peer_loop(&self, peer: PeerConfig) {
        loop {
            self.set_peer_state(&peer.address, PeerState::Connect, None, None)
                .await;

            let result = if peer.passive {
                self.run_passive_session(&peer).await
            } else {
                self.run_active_session(&peer).await
            };

            match result {
                Ok(()) => {
                    self.set_peer_state(&peer.address, PeerState::Active, None, None)
                        .await;
                }
                Err(err) => {
                    self.set_peer_state(
                        &peer.address,
                        PeerState::Active,
                        Some(err.to_string()),
                        None,
                    )
                    .await;
                }
            }

            sleep(Duration::from_secs(peer.connect_retry_secs as u64)).await;
        }
    }

    async fn run_active_session(&self, peer: &PeerConfig) -> Result<()> {
        let addr: SocketAddr = format!("{}:{}", peer.address, peer.remote_port)
            .parse()
            .with_context(|| {
                format!("invalid peer socket {}:{}", peer.address, peer.remote_port)
            })?;

        let mut stream = connect_with_optional_bind(peer, addr).await?;
        self.run_session(peer, &mut stream).await
    }

    async fn run_passive_session(&self, peer: &PeerConfig) -> Result<()> {
        let listen_addr = peer
            .local_address
            .clone()
            .unwrap_or_else(|| format!("0.0.0.0:{}", peer.remote_port));
        let listen: SocketAddr = normalize_socket_addr(&listen_addr, peer.remote_port)
            .with_context(|| format!("invalid passive local_address {}", listen_addr))?;

        let listener = TcpListener::bind(listen)
            .await
            .with_context(|| format!("failed binding passive listener {listen}"))?;

        let (mut stream, peer_addr) = listener.accept().await?;

        // Set TCP-MD5 signature if password is configured
        // Note: For passive mode, the MD5 must be set on the accepted socket
        // with the specific peer address
        if let Some(password) = &peer.password {
            stream
                .set_md5_signature(&peer_addr, password)
                .context("failed to set TCP-MD5 signature on accepted connection")?;
        }

        self.run_session(peer, &mut stream).await
    }

    async fn run_session(&self, peer: &PeerConfig, stream: &mut TcpStream) -> Result<()> {
        self.set_peer_state(&peer.address, PeerState::OpenSent, None, None)
            .await;

        let local_as = peer.local_as.unwrap_or(self.inner.global_asn);
        let hold_time = peer.hold_time_secs.max(3);

        let open = BgpMessage::Open(BgpOpenMessage {
            version: 4,
            asn: local_as.into(),
            hold_time,
            sender_ip: self.inner.router_id,
            extended_length: false,
            opt_params: vec![],
        });
        write_bgp_message(stream, &open).await?;

        let incoming = read_bgp_message(stream).await?;
        if !matches!(incoming, BgpMessage::Open(_)) {
            return Err(anyhow!("expected OPEN from peer"));
        }

        write_bgp_message(stream, &BgpMessage::KeepAlive).await?;
        let incoming = read_bgp_message(stream).await?;
        if !matches!(incoming, BgpMessage::KeepAlive) {
            return Err(anyhow!("expected KEEPALIVE from peer after OPEN"));
        }

        self.set_peer_state(
            &peer.address,
            PeerState::Established,
            None,
            Some(chrono::Utc::now().timestamp()),
        )
        .await;

        self.send_prefix_announcements(peer, stream).await?;

        let negotiated_hold = Duration::from_secs(hold_time as u64);
        let keepalive_interval = Duration::from_secs((hold_time as u64 / 3).max(1));
        let mut next_keepalive = Instant::now() + keepalive_interval;
        let mut hold_deadline = Instant::now() + negotiated_hold;

        loop {
            let now = Instant::now();
            if now >= next_keepalive {
                write_bgp_message(stream, &BgpMessage::KeepAlive).await?;
                next_keepalive = now + keepalive_interval;
            }

            if now >= hold_deadline {
                return Err(anyhow!("hold timer expired"));
            }

            let timeout_dur = std::cmp::min(
                next_keepalive.saturating_duration_since(now),
                Duration::from_secs(1),
            );
            match timeout(timeout_dur, read_bgp_message(stream)).await {
                Ok(Ok(msg)) => match msg {
                    BgpMessage::KeepAlive | BgpMessage::Update(_) | BgpMessage::Open(_) => {
                        hold_deadline = Instant::now() + negotiated_hold;
                    }
                    BgpMessage::Notification(_) => {
                        return Err(anyhow!("received NOTIFICATION from peer"));
                    }
                },
                Ok(Err(err)) => return Err(err),
                Err(_) => {}
            }
        }
    }

    async fn send_prefix_announcements(
        &self,
        peer: &PeerConfig,
        stream: &mut TcpStream,
    ) -> Result<()> {
        let local_as = peer.local_as.unwrap_or(self.inner.global_asn);
        let router_id = self.inner.router_id;

        for prefix_entry in &self.inner.prefixes {
            let update = build_announce_update(prefix_entry, router_id, local_as);
            write_bgp_message(stream, &update).await?;
        }

        let count = self.inner.prefixes.len();
        let mut peers = self.inner.peers.write().await;
        if let Some(runtime) = peers.get_mut(&peer.address) {
            runtime.info.advertised_prefixes = count;
        }

        Ok(())
    }

    async fn set_peer_state(
        &self,
        address: &str,
        state: PeerState,
        last_error: Option<String>,
        established_at: Option<i64>,
    ) {
        let mut peers = self.inner.peers.write().await;
        if let Some(runtime) = peers.get_mut(address) {
            runtime.info.state = state;
            if let Some(err) = last_error {
                runtime.info.last_error = Some(err);
            } else if matches!(state, PeerState::Established) {
                runtime.info.last_error = None;
            }
            if let Some(ts) = established_at {
                runtime.info.established_at = Some(ts);
            }
            let _ = self
                .inner
                .event_tx
                .send(EventEnvelope::new(Event::PeerState {
                    peer: address.to_string(),
                    state,
                }));
        }
    }

    pub async fn peer_list(&self) -> Vec<PeerInfo> {
        self.inner
            .peers
            .read()
            .await
            .values()
            .map(|r| r.info.clone())
            .collect()
    }

    pub async fn peer_show(&self, peer: &str) -> Option<PeerInfo> {
        self.inner
            .peers
            .read()
            .await
            .get(peer)
            .map(|r| r.info.clone())
    }

    pub async fn peer_reset(&self, peer: &str) -> Result<()> {
        let old = {
            let mut peers = self.inner.peers.write().await;
            peers.remove(peer)
        };

        let Some(old_runtime) = old else {
            return Err(anyhow!("peer {} not found", peer));
        };

        old_runtime.task.abort();

        let runtime = self.spawn_peer_task(old_runtime.cfg);
        self.inner
            .peers
            .write()
            .await
            .insert(peer.to_string(), runtime);
        Ok(())
    }

    pub async fn rib_summary(&self) -> RibSummary {
        let peers = self.inner.peers.read().await;
        let established = peers
            .values()
            .filter(|p| matches!(p.info.state, PeerState::Established))
            .count();

        RibSummary {
            peers_total: peers.len(),
            peers_established: established,
            advertised_prefixes_total: peers.values().map(|p| p.info.advertised_prefixes).sum(),
        }
    }

    pub async fn rib_out(&self, peer: &str) -> Result<Vec<String>> {
        let peers = self.inner.peers.read().await;
        if !peers.contains_key(peer) {
            return Err(anyhow!("peer {} not found", peer));
        }
        Ok(self
            .inner
            .prefixes
            .iter()
            .map(|p| p.network.to_string())
            .collect())
    }

    pub async fn rib_in(&self, peer: &str) -> Result<Vec<String>> {
        let peers = self.inner.peers.read().await;
        if !peers.contains_key(peer) {
            return Err(anyhow!("peer {} not found", peer));
        }
        Ok(vec![])
    }
}

async fn connect_with_optional_bind(peer: &PeerConfig, remote: SocketAddr) -> Result<TcpStream> {
    let local_bind = match peer.local_address.as_deref() {
        None => None,
        Some(raw) => Some(normalize_socket_addr(raw, 0).context("invalid peer local_address")?),
    };

    match (remote, local_bind) {
        (SocketAddr::V4(remote_v4), Some(SocketAddr::V4(local_v4))) => {
            let socket = TcpSocket::new_v4()?;
            socket.bind(SocketAddr::V4(local_v4))?;

            // Set TCP-MD5 signature if password is configured
            if let Some(password) = &peer.password {
                socket
                    .set_md5_signature(&remote, password)
                    .context("failed to set TCP-MD5 signature")?;
            }

            socket
                .connect(SocketAddr::V4(remote_v4))
                .await
                .map_err(Into::into)
        }
        (_, Some(local)) => {
            let socket = if local.is_ipv4() {
                TcpSocket::new_v4()?
            } else {
                TcpSocket::new_v6()?
            };
            socket.bind(local)?;

            // Set TCP-MD5 signature if password is configured
            if let Some(password) = &peer.password {
                socket
                    .set_md5_signature(&remote, password)
                    .context("failed to set TCP-MD5 signature")?;
            }

            socket.connect(remote).await.map_err(Into::into)
        }
        (_, None) => {
            // No local bind, set MD5 on connected stream
            let stream = TcpStream::connect(remote).await?;

            if let Some(password) = &peer.password {
                stream
                    .set_md5_signature(&remote, password)
                    .context("failed to set TCP-MD5 signature")?;
            }

            Ok(stream)
        }
    }
}

fn normalize_socket_addr(raw: &str, default_port: u16) -> Result<SocketAddr> {
    if let Ok(sa) = raw.parse::<SocketAddr>() {
        return Ok(sa);
    }

    let ip: IpAddr = raw
        .parse()
        .with_context(|| format!("invalid ip/address {raw}"))?;
    Ok(SocketAddr::new(ip, default_port))
}

async fn write_bgp_message(stream: &mut TcpStream, msg: &BgpMessage) -> Result<()> {
    let mut bytes = msg.encode(AsnLength::Bits32).to_vec();
    if bytes.len() < 19 {
        return Err(anyhow!("encoded BGP message too short"));
    }

    bytes[0..16].fill(0xff);

    stream.write_all(&bytes).await?;
    Ok(())
}

async fn read_bgp_message(stream: &mut TcpStream) -> Result<BgpMessage> {
    let mut header = [0u8; 19];
    stream.read_exact(&mut header).await?;

    if header[0..16] != [0xff; 16] {
        return Err(anyhow!("invalid BGP marker"));
    }

    let length = u16::from_be_bytes([header[16], header[17]]) as usize;
    if !(19..=4096).contains(&length) {
        return Err(anyhow!("invalid BGP message length {}", length));
    }

    let mut bytes = Vec::with_capacity(length);
    bytes.extend_from_slice(&header);

    let payload_len = length - 19;
    if payload_len > 0 {
        let mut payload = vec![0u8; payload_len];
        stream.read_exact(&mut payload).await?;
        bytes.extend_from_slice(&payload);
    }

    let bytes32 = bytes.clone();
    let mut raw32 = Bytes::from(bytes32);
    let parsed = parse_bgp_message(&mut raw32, false, &AsnLength::Bits32)
        .or_else(|_| {
            let mut raw16 = Bytes::from(bytes);
            parse_bgp_message(&mut raw16, false, &AsnLength::Bits16)
        })
        .map_err(|e| anyhow!("failed parsing BGP message using bgpkit-parser: {e}"))?;

    Ok(parsed)
}

fn build_announce_update(
    prefix_entry: &PrefixEntry,
    router_id: Ipv4Addr,
    local_as: u32,
) -> BgpMessage {
    let mut attrs = Attributes::default();
    attrs.add_attr(AttributeValue::Origin(Origin::IGP).into());
    attrs.add_attr(
        AttributeValue::AsPath {
            path: AsPath::from_sequence([local_as]),
            is_as4: false,
        }
        .into(),
    );

    // Determine next-hop: use configured next-hop or default based on prefix type
    let next_hop = prefix_entry.next_hop.unwrap_or_else(|| {
        match prefix_entry.network {
            IpNet::V4(_) => IpAddr::V4(router_id),
            IpNet::V6(_) => {
                // For IPv6, we need a valid IPv6 next-hop
                // Default to a link-local address derived from router_id if not specified
                // In practice, user should configure this
                IpAddr::V6(std::net::Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 1))
            }
        }
    });

    attrs.add_attr(AttributeValue::NextHop(next_hop).into());

    let announced = NetworkPrefix::new(prefix_entry.network, None);
    BgpMessage::Update(BgpUpdateMessage {
        withdrawn_prefixes: vec![],
        attributes: attrs,
        announced_prefixes: vec![announced],
    })
}