rustici 1.1.0

Pure-Rust client for strongSwan's VICI protocol
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

<p align="center">
  <img src="assets/rustici.svg" alt="rustici logo" height="120" />
</p>

<p align="center">
  A minimal Rust client for the strongSwan <strong>VICI</strong> protocol — inspired by the ideas behind <code>davici</code>, but implemented from scratch in Rust.
</p>

<p align="center">
  <!-- CI badge -->
  <a href="https://github.com/mira-mobility/rustici/actions/workflows/ci.yml">
    <img src="https://github.com/mira-mobility/rustici/actions/workflows/ci.yml/badge.svg" alt="CI" />
  </a>

  <!-- Crates.io version -->
  <a href="https://crates.io/crates/rustici">
    <img src="https://img.shields.io/crates/v/rustici.svg" alt="crates.io version" />
  </a>

  <!-- Docs.rs -->
  <a href="https://docs.rs/rustici">
    <img src="https://img.shields.io/docsrs/rustici" alt="docs.rs" />
  </a>

  <!-- License -->
  <a href="LICENSE">
    <img src="https://img.shields.io/badge/license-LGPL%202.1%2B-blue" alt="License: LGPL-2.1+" />
  </a>

  <!-- Platform -->
  <img src="https://img.shields.io/badge/platform-unix-lightgrey" alt="Platform: Unix" />
</p>

<p align="center"><em>Status: experimental MVP. Pure <code>std</code>, blocking I/O, UNIX-only. No external deps.</em></p>

## Features

- Encode/decode VICI **messages** (sections, lists, key/values).
- Encode/decode VICI **packets** and transport framing (32-bit BE length).
- **Blocking** client over `UnixStream` for request/response commands.
- Register/unregister for **events** and read event messages.
- No dependency on `libstrongswan` or `davici` — fresh Rust code.

> Note: This library focuses on the protocol. It intentionally does not try to mirror the exact C API. Instead, it provides a small, idiomatic Rust surface that's easy to extend with higher-level helpers.

## Example

List IKE_SAs using the `list-sas` command:

```rust
use rustici::{Client, Message};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cli = Client::connect(rustici::client::DEFAULT_SOCKET)?;

    // empty request message
    let req = Message::new();

    let resp = cli.call("list-sas", &req)?;
    println!("{}", resp);
    Ok(())
}
```

Build and run example:

```bash
cargo run --example list_sas
```

## Protocol references

- VICI plugin docs: https://docs.strongswan.org/docs/latest/plugins/vici.html
- VICI protocol README (packet/message grammar; transport is length-prefixed with a 32-bit BE header)

## Acknowledgments

This library is a Rust implementation based on the [davici library](https://github.com/strongswan/davici) from the strongSwan project.

strongSwan has been actively developed since 2005, with the modern IKE daemon written from scratch in a modular, object-oriented design. The intellectual property rights to strongSwan were acquired by secunet Security Networks AG in June 2022.
We thank the strongSwan maintainers and contributors for their excellent work:

Andreas Steffen (strongSec GmbH)
Tobias Brunner (codelabs GmbH)
secunet Security Networks AG
Martin Willi (original davici author)

## License

This library is licensed under the GNU Lesser General Public License v2.1 or later (LGPL-2.1+) (Based on the original davici library).

Rust implementation:

- Copyright (C) 2025 Mira Mobility

See the [LICENSE](LICENSE) file for the full license text.