rustifi 1.0.0

Open source Rust library to interface with Ubiquiti's UniFi Controller API.
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

# rustifi

A Rust API library for UniFi Network controllers.

## Quick Start

```rust
use rustifi::UnifiClient;

#[tokio::main]
async fn main() -> rustifi::Result<()> {
    // Create a client with strict TLS validation (recommended)
    let client = UnifiClient::with_api_key(
        "https://unifi.example.com",
        "your-api-key"
    )?;

    // Fetch all sites
    let sites = client.request::<rustifi::api::sites::GetSites>().await?;
    for site in sites.data {
        println!("Site: {} ({})", site.name, site.id);
    }

    Ok(())
}
```

## TLS Certificate Handling

By default, rustifi uses **strict TLS validation** and requires valid certificates.

### For Controllers with Valid Certificates

Use the standard constructors:

```rust
// These require valid TLS certificates
let client = UnifiClient::new("https://unifi.example.com")?;
let client = UnifiClient::with_api_key("https://unifi.example.com", "api-key")?;
```

### For Local Controllers with Self-Signed Certificates

Many local UniFi controllers use self-signed certificates. For these, use the `_insecure` variants:

```rust
// WARNING: Only use for local controllers on trusted networks
let client = UnifiClient::new_insecure("https://192.168.1.1")?;
let client = UnifiClient::with_api_key_insecure("https://192.168.1.1", "api-key")?;
```

> **Security Warning**: The `_insecure` methods disable TLS certificate validation,
> which makes connections vulnerable to man-in-the-middle attacks. Only use these
> methods for local controllers on trusted networks.

## WORK IN PROGRESS


## To Do

- [x] Implement some access points
- [ ] Implement some switches
- [ ] Ensure compliance with Rust API Guidelines Checklist, Including traits
    - Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Display, Default
    - From, TryFrom, AsRef, AsMut
    - Errors
- [ ] Link capacity on uplinks
- [ ] Tests
- [ ] Documentation
- [ ] Examples

## Layout & Features

- [ ] Devices
    - [x] Basic Information
        - [x] Get
        - [x] Update
    - [ ] AP
        - [ ] Group
        - [x] Model
        - [x] Name
        - [x] Radio
            - [x] Channel
            - [x] Width
            - [x] Power
            - [ ] Meshing
        - [x] Number of Clients
        - [ ] CPU
        - [ ] Memory
    - [ ] SW
        - [x] Name
        - [x] Model
        - [ ] Port
            - [ ] Number
            - [ ] Type
            - [ ] Status
            - [ ] Uptime
            - [ ] Bytes
            - [ ] Packets
            - [ ] Dropped
            - [ ] Errors
            - [ ] Native VLAN
            - [ ] Allowed VLANs
            - [ ] Port Isolation
        - [x] CPU
        - [x] Memory
- [ ] Clients
    - [ ] Type
    - [ ] Impose Punishment
    - [ ] Ban
- [ ] WiFi
- [ ] Network

## Models

### APs

- [ ] UX
- [ ] NanoHD
- [ ] U7-Pro
- [ ] U7-Pro-Max
- [x] U6-Mesh
- [x] UWB-XG
- [x] UAP-XG
- [x] AC-Mesh
- [x] AC-Mesh-Pro
- [x] AC-Pro

### Switch

- [ ] USW-Pro-Aggregation
- [ ] USW-Aggregation

## License

This project is licensed under GNU General Public License v2.0 (`GPL-2.0-only`).