blackship 0.2.1

A FreeBSD jail manager with state machine control
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
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
//! Persistent network metadata and runtime state.
//!
//! This module backs:
//! - named network definitions created by `blackship network create`
//! - resolved runtime networks merged from config and CLI-created state
//! - persistent IP leases for auto-assigned addresses
//! - persistent VNET attachment state for cleanup across CLI invocations

use super::ip::{IpAllocator, IpPool};
use crate::atomic::{read_toml, write_toml_atomic};
use crate::error::{Error, Result};
use crate::manifest;
use ipnet::IpNet;
use serde::{Deserialize, Serialize};
use std::collections::{BTreeMap, HashMap};
use std::ffi::OsStr;
use std::fs;
use std::io::ErrorKind;
use std::net::IpAddr;
use std::path::{Path, PathBuf};

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct NetworkRecord {
    pub name: String,
    pub bridge: String,
    pub subnet: String,
    pub gateway: String,
    /// "epair" (`if_bridge`) or "netgraph" (`ng_bridge`)
    #[serde(default = "default_backend_epair")]
    pub backend: String,
    /// Host-side gateway interface for netgraph networks (e.g., ngeth1)
    #[serde(default)]
    pub host_iface: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ResolvedNetwork {
    pub name: String,
    pub bridge: Option<String>,
    pub subnet: IpNet,
    pub gateway: IpAddr,
    /// "epair" or "netgraph", inherited by jails that omit a backend
    pub backend: String,
}

#[derive(Debug, Clone)]
pub struct NetworkStore {
    root: PathBuf,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct NetworkLeaseRecord {
    pub owner: String,
    pub ip: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
struct NetworkLeaseFile {
    leases: Vec<NetworkLeaseRecord>,
}

#[derive(Debug, Clone)]
pub struct NetworkLeaseStore {
    root: PathBuf,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct VnetStateRecord {
    pub owner: String,
    pub network: Option<String>,
    pub bridge: String,
    pub host_interface: String,
    pub jail_interface: String,
    /// "epair" or "netgraph" -persisted so cleanup knows which backend to use.
    #[serde(default = "default_backend_epair")]
    pub backend: String,
}

fn default_backend_epair() -> String {
    "epair".to_string()
}

#[derive(Debug, Clone)]
pub struct VnetStateStore {
    root: PathBuf,
}

impl NetworkStore {
    pub fn from_config(config: Option<&manifest::BlackshipConfig>) -> Self {
        Self {
            root: manifest::data_root(config).join("networks"),
        }
    }

    pub fn create(&self, record: &NetworkRecord) -> Result<()> {
        validate_network_name(&record.name)?;
        fs::create_dir_all(&self.root)
            .map_err(|e| Error::Network(format!("Failed to create network state dir: {e}")))?;

        let path = self.record_path(&record.name)?;
        let content = toml::to_string(record)
            .map_err(|e| Error::Network(format!("Failed to serialize network metadata: {e}")))?;
        match fs::OpenOptions::new()
            .write(true)
            .create_new(true)
            .open(&path)
        {
            Ok(mut file) => {
                use std::io::Write;
                file.write_all(content.as_bytes())
                    .map_err(|e| Error::Network(format!("Failed to write network metadata: {e}")))
            }
            Err(err) if err.kind() == ErrorKind::AlreadyExists => {
                Err(Error::NetworkAlreadyExists(record.name.clone()))
            }
            Err(err) => Err(Error::Network(format!(
                "Failed to create network metadata file: {err}"
            ))),
        }
    }

    /// Write a record, replacing any existing one (used to refresh
    /// runtime-assigned fields like `host_iface`).
    pub fn save(&self, record: &NetworkRecord) -> Result<()> {
        validate_network_name(&record.name)?;
        fs::create_dir_all(&self.root)
            .map_err(|e| Error::Network(format!("Failed to create network state dir: {e}")))?;
        let path = self.record_path(&record.name)?;
        let content = toml::to_string(record)
            .map_err(|e| Error::Network(format!("Failed to serialize network metadata: {e}")))?;
        fs::write(&path, content)
            .map_err(|e| Error::Network(format!("Failed to write network metadata: {e}")))
    }

    pub fn get(&self, name: &str) -> Result<Option<NetworkRecord>> {
        let path = self.record_path(name)?;
        if !path.exists() {
            return Ok(None);
        }

        read_network_record(&path)
    }

    pub fn delete(&self, name: &str) -> Result<bool> {
        let path = self.record_path(name)?;
        if !path.exists() {
            return Ok(false);
        }

        fs::remove_file(&path)
            .map_err(|e| Error::Network(format!("Failed to remove network metadata: {e}")))?;
        Ok(true)
    }

    pub fn list(&self) -> Result<Vec<NetworkRecord>> {
        if !self.root.exists() {
            return Ok(Vec::new());
        }

        let mut records = Vec::new();
        let entries = fs::read_dir(&self.root)
            .map_err(|e| Error::Network(format!("Failed to read network state dir: {e}")))?;

        for entry in entries {
            let entry =
                entry.map_err(|e| Error::Network(format!("Failed to read network entry: {e}")))?;
            let path = entry.path();

            if path.extension() != Some(OsStr::new("toml")) {
                continue;
            }

            if let Some(record) = read_network_record(&path)? {
                records.push(record);
            }
        }

        records.sort_by(|a, b| a.name.cmp(&b.name));
        Ok(records)
    }

    fn record_path(&self, name: &str) -> Result<PathBuf> {
        validate_network_name(name)?;
        Ok(self.root.join(format!("{name}.toml")))
    }
}

impl NetworkLeaseStore {
    pub fn from_config(config: Option<&manifest::BlackshipConfig>) -> Self {
        Self {
            root: manifest::data_root(config).join("network-leases"),
        }
    }

    pub fn list(&self, network: &str) -> Result<Vec<NetworkLeaseRecord>> {
        validate_network_name(network)?;
        let path = self.record_path(network);
        if !path.exists() {
            return Ok(Vec::new());
        }

        Ok(read_toml::<NetworkLeaseFile>(&path, "network lease metadata")?.leases)
    }

    /// Lock file guarding read-modify-write of one network's lease list
    fn lock_path(&self, network: &str) -> PathBuf {
        self.root.join(format!("{network}.lock"))
    }

    pub fn record(&self, network: &str, owner: &str, ip: IpAddr) -> Result<()> {
        validate_network_name(network)?;
        let _guard = FileLock::acquire(&self.lock_path(network))?;
        if owner.is_empty() {
            return Err(Error::InvalidArgument(
                "Network lease owner cannot be empty".into(),
            ));
        }

        fs::create_dir_all(&self.root)
            .map_err(|e| Error::Network(format!("Failed to create network lease dir: {e}")))?;

        let mut leases = self.list(network)?;
        let ip_str = ip.to_string();

        if let Some(existing) = leases
            .iter()
            .find(|lease| lease.owner != owner && lease.ip == ip_str)
        {
            return Err(Error::Network(format!(
                "Address {} is already leased to '{}'",
                existing.ip, existing.owner
            )));
        }

        if let Some(existing) = leases.iter_mut().find(|lease| lease.owner == owner) {
            existing.ip = ip_str;
        } else {
            leases.push(NetworkLeaseRecord {
                owner: owner.to_string(),
                ip: ip_str,
            });
        }

        leases.sort_by(|a, b| a.owner.cmp(&b.owner));
        write_toml_atomic(
            &self.record_path(network),
            &NetworkLeaseFile { leases },
            "network lease metadata",
        )
    }

    pub fn release(&self, network: &str, owner: &str) -> Result<bool> {
        validate_network_name(network)?;
        let _guard = FileLock::acquire(&self.lock_path(network))?;
        let path = self.record_path(network);
        if !path.exists() {
            return Ok(false);
        }

        let mut leases = self.list(network)?;
        let original_len = leases.len();
        leases.retain(|lease| lease.owner != owner);

        if leases.len() == original_len {
            return Ok(false);
        }

        if leases.is_empty() {
            fs::remove_file(&path).map_err(|e| {
                Error::Network(format!(
                    "Failed to remove empty network lease metadata: {e}"
                ))
            })?;
        } else {
            write_toml_atomic(
                &path,
                &NetworkLeaseFile { leases },
                "network lease metadata",
            )?;
        }

        Ok(true)
    }

    pub fn release_owner(&self, owner: &str) -> Result<Vec<(String, IpAddr)>> {
        if !self.root.exists() {
            return Ok(Vec::new());
        }

        let mut released = Vec::new();
        let entries = fs::read_dir(&self.root)
            .map_err(|e| Error::Network(format!("Failed to read network lease dir: {e}")))?;

        for entry in entries {
            let entry = entry
                .map_err(|e| Error::Network(format!("Failed to read network lease entry: {e}")))?;
            let path = entry.path();
            if path.extension() != Some(OsStr::new("toml")) {
                continue;
            }

            let Some(network_name) = path.file_stem().and_then(|stem| stem.to_str()) else {
                continue;
            };

            let leases = self.list(network_name)?;
            for lease in leases.iter().filter(|lease| lease.owner == owner) {
                let ip = lease.ip.parse().map_err(|e| {
                    Error::Network(format!(
                        "Failed to parse leased IP '{}' for owner '{}': {}",
                        lease.ip, owner, e
                    ))
                })?;
                released.push((network_name.to_string(), ip));
            }

            self.release(network_name, owner)?;
        }

        Ok(released)
    }

    fn record_path(&self, network: &str) -> PathBuf {
        self.root.join(format!("{network}.toml"))
    }
}

impl VnetStateStore {
    pub fn from_config(config: Option<&manifest::BlackshipConfig>) -> Self {
        Self {
            root: manifest::data_root(config).join("vnet"),
        }
    }

    pub fn save(&self, record: &VnetStateRecord) -> Result<()> {
        Self::validate_owner(&record.owner)?;

        fs::create_dir_all(&self.root)
            .map_err(|e| Error::Network(format!("Failed to create VNET state dir: {e}")))?;
        write_toml_atomic(
            &self.record_path(&record.owner),
            record,
            "VNET state metadata",
        )
    }

    pub fn get(&self, owner: &str) -> Result<Option<VnetStateRecord>> {
        Self::validate_owner(owner)?;
        let path = self.record_path(owner);
        if !path.exists() {
            return Ok(None);
        }

        read_toml::<VnetStateRecord>(&path, "VNET state metadata").map(Some)
    }

    pub fn delete(&self, owner: &str) -> Result<bool> {
        Self::validate_owner(owner)?;
        let path = self.record_path(owner);
        if !path.exists() {
            return Ok(false);
        }

        fs::remove_file(&path)
            .map_err(|e| Error::Network(format!("Failed to remove VNET state metadata: {e}")))?;
        Ok(true)
    }

    /// Every persisted VNET record, sorted by owner.
    pub fn list(&self) -> Result<Vec<VnetStateRecord>> {
        let entries = match fs::read_dir(&self.root) {
            Ok(entries) => entries,
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(Vec::new()),
            Err(e) => {
                return Err(Error::Network(format!(
                    "Failed to read VNET state dir: {e}"
                )));
            }
        };

        let mut records = Vec::new();
        for entry in entries.flatten() {
            let path = entry.path();
            if path.extension() != Some(std::ffi::OsStr::new("toml")) {
                continue;
            }
            match read_toml::<VnetStateRecord>(&path, "VNET state metadata") {
                Ok(record) => records.push(record),
                Err(e) => eprintln!(
                    "Warning: skipping VNET state record {}: {e}",
                    path.display()
                ),
            }
        }
        records.sort_by(|a, b| a.owner.cmp(&b.owner));
        Ok(records)
    }

    fn record_path(&self, owner: &str) -> PathBuf {
        self.root.join(format!("{owner}.toml"))
    }

    /// Validate owner string to prevent path traversal
    fn validate_owner(owner: &str) -> Result<()> {
        if owner.is_empty() {
            return Err(Error::InvalidArgument(
                "VNET state owner cannot be empty".into(),
            ));
        }
        if owner.contains('/') || owner.contains('\\') || owner.contains("..") {
            return Err(Error::InvalidArgument(format!(
                "VNET state owner '{owner}' contains invalid characters"
            )));
        }
        Ok(())
    }
}

pub fn load_runtime_networks(
    config: Option<&manifest::BlackshipConfig>,
) -> Result<Vec<ResolvedNetwork>> {
    let mut networks = BTreeMap::new();

    if let Some(config) = config {
        for network in &config.networks {
            let subnet: IpNet = network.subnet.parse().map_err(|e| {
                Error::Network(format!(
                    "Invalid subnet '{}' for network '{}': {}",
                    network.subnet, network.name, e
                ))
            })?;
            let gateway = if let Some(gateway) = network.gateway {
                IpPool::with_gateway(subnet, gateway)?.gateway()
            } else {
                IpPool::new(subnet)?.gateway()
            };

            networks.insert(
                network.name.clone(),
                ResolvedNetwork {
                    name: network.name.clone(),
                    bridge: None,
                    subnet,
                    gateway,
                    backend: default_backend_epair(),
                },
            );
        }
    }

    for record in NetworkStore::from_config(config).list()? {
        let subnet: IpNet = record.subnet.parse().map_err(|e| {
            Error::Network(format!(
                "Invalid subnet '{}' for network '{}': {}",
                record.subnet, record.name, e
            ))
        })?;
        let gateway: IpAddr = record.gateway.parse().map_err(|e| {
            Error::Network(format!(
                "Invalid gateway '{}' for network '{}': {}",
                record.gateway, record.name, e
            ))
        })?;
        let bridge = Some(record.bridge.clone());

        if let Some(existing) = networks.get_mut(&record.name) {
            if existing.subnet != subnet || existing.gateway != gateway {
                return Err(Error::Network(format!(
                    "Network '{}' is defined differently in config and runtime state",
                    record.name
                )));
            }
            existing.bridge = bridge;
            existing.backend.clone_from(&record.backend);
        } else {
            networks.insert(
                record.name.clone(),
                ResolvedNetwork {
                    name: record.name.clone(),
                    bridge,
                    subnet,
                    gateway,
                    backend: record.backend.clone(),
                },
            );
        }
    }

    Ok(networks.into_values().collect())
}

pub fn load_runtime_network_map(
    config: Option<&manifest::BlackshipConfig>,
) -> Result<HashMap<String, ResolvedNetwork>> {
    let mut map = HashMap::new();
    for network in load_runtime_networks(config)? {
        map.insert(network.name.clone(), network);
    }
    Ok(map)
}

pub fn build_runtime_allocator(
    config: Option<&manifest::BlackshipConfig>,
) -> Result<(
    HashMap<String, ResolvedNetwork>,
    IpAllocator,
    NetworkLeaseStore,
)> {
    let runtime_networks = load_runtime_network_map(config)?;
    let lease_store = NetworkLeaseStore::from_config(config);
    let mut allocator = IpAllocator::new();

    for network in runtime_networks.values() {
        let mut pool = IpPool::with_gateway(network.subnet, network.gateway)?;

        for lease in lease_store.list(&network.name)? {
            let ip: IpAddr = lease.ip.parse().map_err(|e| {
                Error::Network(format!(
                    "Failed to parse leased IP '{}' for owner '{}': {}",
                    lease.ip, lease.owner, e
                ))
            })?;
            pool.allocate_specific(ip)?;
        }

        allocator.add_pool(network.name.clone(), pool);
    }

    if let Some(config) = config {
        for jail in &config.jails {
            let Some(network) = jail.network.as_ref() else {
                continue;
            };
            let Some(static_ip) = network.ip else {
                continue;
            };

            for network_name in &network.networks {
                let Some(pool) = allocator.get_pool_mut(network_name) else {
                    continue;
                };
                pool.allocate_specific(static_ip)?;
            }
        }
    }

    Ok((runtime_networks, allocator, lease_store))
}

fn read_network_record(path: &Path) -> Result<Option<NetworkRecord>> {
    read_toml::<NetworkRecord>(path, "network metadata").map(Some)
}

/// Allocate an address and durably claim it, retrying when another process
/// wins the same address first.
///
/// Each process allocates from its own snapshot of the pool, so concurrent
/// creators pick the same free address; the lease store is the arbiter.
pub fn allocate_and_record(
    allocator: &mut IpAllocator,
    lease_store: &NetworkLeaseStore,
    network: &str,
    owner: &str,
) -> Result<IpAddr> {
    for _ in 0..256 {
        let ip = allocator.allocate(network)?;
        match lease_store.record(network, owner, ip) {
            Ok(()) => return Ok(ip),
            // Address taken between our read and our write: the allocator
            // has already marked it used, so the next round picks another.
            Err(Error::Network(msg)) if msg.contains("already leased") => {}
            Err(e) => return Err(e),
        }
    }
    Err(Error::Network(format!(
        "Could not claim a free address on network '{network}' after 256 attempts"
    )))
}

/// Exclusive advisory lock held for a read-modify-write of a state file.
///
/// Separate blackship processes racing on the same lease file would
/// otherwise lose updates: both read, both write, one wins.
pub struct FileLock {
    file: fs::File,
}

impl FileLock {
    pub fn acquire(path: &Path) -> Result<Self> {
        if let Some(parent) = path.parent() {
            fs::create_dir_all(parent)
                .map_err(|e| Error::Network(format!("Failed to create lock dir: {e}")))?;
        }
        let file = fs::OpenOptions::new()
            .write(true)
            .create(true)
            .truncate(false)
            .open(path)
            .map_err(|e| Error::Network(format!("Failed to open lock file: {e}")))?;
        file.lock()
            .map_err(|e| Error::Network(format!("Failed to lock {}: {e}", path.display())))?;
        Ok(Self { file })
    }
}

impl Drop for FileLock {
    fn drop(&mut self) {
        // Closing the file releases the lock anyway.
        let _ = self.file.unlock();
    }
}

fn validate_network_name(name: &str) -> Result<()> {
    if name.is_empty() {
        return Err(Error::InvalidArgument(
            "Network name cannot be empty".into(),
        ));
    }

    if !name
        .chars()
        .all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.'))
    {
        return Err(Error::InvalidArgument(format!(
            "Invalid network name '{name}': use only letters, numbers, '.', '-' and '_'"
        )));
    }

    Ok(())
}

#[cfg(test)]
mod tests;