isb-server 1.9.0

isb serve's HTTP side: users and sessions, the audit log, history, the MCP and REST server, fleet servers and the embedded web UI. Use the `isb` crate.
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
//! The account rules every surface shares: roles, scopes, workspaces and
//! who may mint a token.

use super::*;
use crate::auth::tests::store;
use crate::auth::{AuthStore, User};

const PW: &str = "correct horse battery";

fn org(s: &str) -> OrgId {
    OrgId::new(s).unwrap()
}

/// `u` signed in as `kind`, with their memberships.
fn as_kind(s: &AuthStore, u: &User, kind: PrincipalKind) -> Principal {
    let orgs: Vec<(OrgId, Role)> = s
        .memberships(u.id)
        .unwrap()
        .into_iter()
        .map(|m| (m.org, m.role))
        .collect();
    // An org token is confined to its org, as authenticate_token does.
    let orgs = match &kind {
        PrincipalKind::ApiToken { org: Some(o), .. } => {
            orgs.into_iter().filter(|(x, _)| x == o).collect()
        }
        _ => orgs,
    };
    let confined = matches!(&kind, PrincipalKind::ApiToken { org: Some(_), .. });
    Principal {
        user: u.clone(),
        kind,
        orgs,
        platform_admin: u.platform_admin && !confined,
        downscoped: None,
    }
}

fn session(s: &AuthStore, u: &User) -> Principal {
    as_kind(s, u, PrincipalKind::Session { id: 1 })
}

fn org_token(s: &AuthStore, u: &User, o: &str, scopes: &[&str]) -> Principal {
    as_kind(
        s,
        u,
        PrincipalKind::ApiToken {
            id: 9,
            org: Some(org(o)),
            name: "t".into(),
            scopes: scopes.iter().map(|x| x.to_string()).collect(),
        },
    )
}

struct World {
    s: AuthStore,
    root: User,
    owner: User,
    admin: User,
    member: User,
    viewer: User,
    outsider: User,
}

fn world() -> World {
    let (s, _) = store();
    let root = s.create_user("root@x.io", "Root", Some(PW), true).unwrap();
    let mk = |e: &str, r: Option<Role>| {
        let u = s.create_user(e, e, Some(PW), false).unwrap();
        if let Some(r) = r {
            s.ensure_org(&org("acme")).unwrap();
            s.set_member(&org("acme"), u.id, r).unwrap();
        }
        u
    };
    let owner = mk("owner@x.io", Some(Role::Owner));
    let admin = mk("admin@x.io", Some(Role::Admin));
    let member = mk("member@x.io", Some(Role::Member));
    let viewer = mk("viewer@x.io", Some(Role::Viewer));
    let outsider = mk("out@x.io", None);
    World {
        s,
        root,
        owner,
        admin,
        member,
        viewer,
        outsider,
    }
}

fn forbidden<T: std::fmt::Debug>(r: R<T>) -> bool {
    matches!(r, Err(AuthError::Forbidden(_)))
}

fn hidden<T: std::fmt::Debug>(r: R<T>) -> bool {
    matches!(r, Err(AuthError::NotFound(_)))
}

#[test]
fn members_follow_the_role_matrix() {
    let w = world();
    let (s, acme) = (&w.s, org("acme"));
    // Every member reads the member list; outsiders do not learn the org.
    for u in [&w.owner, &w.admin, &w.member, &w.viewer, &w.root] {
        let v = members(s, &session(s, u), &acme).unwrap();
        assert_eq!(v["members"].as_array().unwrap().len(), 4);
    }
    assert!(hidden(members(s, &session(s, &w.outsider), &acme)));
    assert!(hidden(invitations(s, &session(s, &w.outsider), &acme)));
    // Invitations and org tokens: owners and admins only.
    assert!(invitations(s, &session(s, &w.admin), &acme).is_ok());
    assert!(org_tokens(s, &session(s, &w.owner), &acme).is_ok());
    for u in [&w.member, &w.viewer] {
        let p = session(s, u);
        assert!(forbidden(invitations(s, &p, &acme)));
        assert!(forbidden(org_tokens(s, &p, &acme)));
        assert!(forbidden(invite(s, &p, &acme, "n@x.io", None, None)));
        assert!(forbidden(set_role(s, &p, &acme, w.viewer.id, Role::Member)));
    }
    // An admin manages members and admins, never owners.
    let admin = session(s, &w.admin);
    assert!(forbidden(invite(
        s,
        &admin,
        &acme,
        "n@x.io",
        Some(Role::Owner),
        None
    )));
    assert!(forbidden(set_role(
        s,
        &admin,
        &acme,
        w.owner.id,
        Role::Member
    )));
    assert!(forbidden(set_role(
        s,
        &admin,
        &acme,
        w.member.id,
        Role::Owner
    )));
    assert!(forbidden(remove_member(s, &admin, &acme, w.owner.id)));
    set_role(s, &admin, &acme, w.viewer.id, Role::Member).unwrap();
    // The invitation's token and link come back once.
    let v = invite(
        s,
        &admin,
        &acme,
        "n@x.io",
        Some(Role::Admin),
        Some("https://isb.x.io/"),
    )
    .unwrap();
    let token = v["token"].as_str().unwrap();
    assert_eq!(v["link"], format!("https://isb.x.io/invite#{token}"));
    let id = v["invitation"]["id"].as_i64().unwrap();
    revoke_invitation(s, &admin, &acme, id).unwrap();
    assert!(hidden(revoke_invitation(s, &admin, &acme, id)));
    // An owner makes owners; anyone may leave.
    set_role(s, &session(s, &w.owner), &acme, w.admin.id, Role::Owner).unwrap();
    remove_member(s, &session(s, &w.viewer), &acme, w.viewer.id).unwrap();
    assert!(forbidden(remove_member(
        s,
        &session(s, &w.member),
        &acme,
        w.admin.id
    )));
}

#[test]
fn scoped_tokens_only_read_and_workspaces_reach_nothing() {
    let w = world();
    let (s, acme) = (&w.s, org("acme"));
    let read = org_token(s, &w.owner, "acme", &["read"]);
    assert!(members(s, &read, &acme).is_ok());
    assert!(tokens(s, &read, None).is_ok());
    assert!(forbidden(invite(s, &read, &acme, "n@x.io", None, None)));
    assert!(forbidden(add_ssh_key(s, &read, "ssh-ed25519 AAAA", None)));
    assert!(forbidden(revoke_token(s, &read, 1)));
    assert!(forbidden(revoke_session(s, &read, 1)));
    // `admin` in the scopes lifts it.
    let admin = org_token(s, &w.owner, "acme", &["admin"]);
    assert!(invite(s, &admin, &acme, "n@x.io", None, None).is_ok());
    // A workspace is nobody's account.
    let ws = Principal::workspace(&acme, "dev", Role::Admin);
    assert!(forbidden(members(s, &ws, &acme)));
    assert!(forbidden(invitations(s, &ws, &acme)));
    assert!(forbidden(invite(s, &ws, &acme, "n@x.io", None, None)));
    assert!(forbidden(tokens(s, &ws, None)));
    assert!(forbidden(org_tokens(s, &ws, &acme)));
    assert!(forbidden(ssh_keys(s, &ws)));
    assert!(forbidden(sessions(s, &ws)));
    assert!(forbidden(users(s, &ws)));
    let t = NewToken {
        name: "x".into(),
        org: Some(acme.clone()),
        expires: None,
        scopes: vec![],
        superadmin: false,
    };
    assert!(forbidden(create_token(s, &ws, t)));
    // But it may ask who it is.
    assert_eq!(me(s, &ws, None).unwrap()["auth"]["kind"], "workspace");
}

fn new_token(o: &str) -> NewToken {
    NewToken {
        name: "child".into(),
        org: Some(org(o)),
        expires: Some("1h".into()),
        scopes: vec!["read".into()],
        superadmin: false,
    }
}

#[test]
fn tokens_never_mint_tokens() {
    let w = world();
    let s = &w.s;
    // A person signed in mints one, for an org they are in.
    let v = create_token(s, &session(s, &w.member), new_token("acme")).unwrap();
    assert!(v["token"].as_str().unwrap().starts_with("isb_tok_"));
    assert_eq!(v["info"]["scopes"], json!(["read"]));
    assert!(forbidden(create_token(
        s,
        &session(s, &w.outsider),
        new_token("acme")
    )));
    let access = as_kind(s, &w.member, PrincipalKind::Access);
    assert!(create_token(s, &access, new_token("acme")).is_ok());
    // No token of any kind mints one: not narrower, not shorter-lived.
    for scopes in [&[][..], &["admin"][..]] {
        let t = org_token(s, &w.owner, "acme", scopes);
        let e = create_token(s, &t, new_token("acme")).unwrap_err();
        assert!(e.to_string().contains("cannot mint"), "{e}");
    }
    let sa_token = Superadmin::as_user(
        SuperadminSource::Token {
            id: 1,
            name: "ops".into(),
        },
        w.root.clone(),
        s,
    )
    .unwrap();
    assert!(forbidden(create_token(
        s,
        &sa_token.principal,
        new_token("acme")
    )));
    // A tailnet superadmin with an account is a person at a keyboard.
    let tailnet = Superadmin::as_user(
        SuperadminSource::Tailnet {
            login: "root@x.io".into(),
            node: "laptop".into(),
            tags: vec![],
        },
        w.root.clone(),
        s,
    )
    .unwrap();
    assert!(create_token(s, &tailnet.principal, new_token("acme")).is_ok());
    // A superadmin token is never minted here.
    let mut t = new_token("acme");
    t.superadmin = true;
    assert!(forbidden(create_token(s, &session(s, &w.root), t)));
}

#[test]
fn revoking_tokens_and_keys() {
    let w = world();
    let s = &w.s;
    let member = session(s, &w.member);
    let v = create_token(s, &member, new_token("acme")).unwrap();
    let id = v["info"]["id"].as_i64().unwrap();
    // Another member does not see it; an org admin may revoke it.
    assert!(hidden(revoke_token(s, &session(s, &w.viewer), id)));
    assert!(hidden(revoke_token(s, &session(s, &w.outsider), id)));
    revoke_token(s, &session(s, &w.admin), id).unwrap();
    assert!(hidden(revoke_token(s, &member, id)));
    // SSH keys are the caller's own.
    let key = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIK85M+Nlyes6IrHWrRVqw80hYRdvPHO+GwqREPk1qxkh alice@laptop";
    let k = add_ssh_key(s, &member, key, Some("laptop")).unwrap();
    let kid = k["ssh_key"]["id"].as_i64().unwrap();
    assert_eq!(
        ssh_keys(s, &member).unwrap()["ssh_keys"]
            .as_array()
            .unwrap()
            .len(),
        1
    );
    assert!(
        ssh_keys(s, &session(s, &w.viewer)).unwrap()["ssh_keys"]
            .as_array()
            .unwrap()
            .is_empty()
    );
    assert!(hidden(delete_ssh_key(s, &session(s, &w.viewer), kid)));
    delete_ssh_key(s, &member, kid).unwrap();
}

#[test]
fn users_are_for_platform_admins() {
    let w = world();
    let s = &w.s;
    assert!(forbidden(users(s, &session(s, &w.owner))));
    let change = UserChange {
        disabled: Some(true),
        platform_admin: None,
    };
    assert!(forbidden(update_user(
        s,
        &session(s, &w.owner),
        w.member.id,
        &change
    )));
    let root = session(s, &w.root);
    assert_eq!(
        users(s, &root).unwrap()["users"].as_array().unwrap().len(),
        6
    );
    // Not yourself, and never the last platform admin.
    assert!(forbidden(update_user(s, &root, w.root.id, &change)));
    let v = update_user(s, &root, w.member.id, &change).unwrap();
    assert_eq!(v["user"]["disabled"], true);
    // A platform admin's org token is confined to the org: not a platform admin.
    let t = as_kind(
        s,
        &w.root,
        PrincipalKind::ApiToken {
            id: 1,
            org: Some(org("acme")),
            name: "t".into(),
            scopes: vec![],
        },
    );
    assert!(forbidden(users(s, &t)));
}

#[test]
fn platform_admins_act_on_other_accounts() {
    let w = world();
    let s = &w.s;
    let root = session(s, &w.root);
    let owner = session(s, &w.owner);
    // Every token, every org.
    create_token(s, &session(s, &w.member), new_token("acme")).unwrap();
    assert!(forbidden(all_tokens(s, &owner)));
    let all = all_tokens(s, &root).unwrap();
    assert_eq!(all["tokens"][0]["user"]["email"], "member@x.io");
    // Someone's SSH keys: read and remove, never add.
    let key = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIK85M+Nlyes6IrHWrRVqw80hYRdvPHO+GwqREPk1qxkh alice@laptop";
    let k = add_ssh_key(s, &session(s, &w.member), key, Some("laptop")).unwrap();
    let kid = k["ssh_key"]["id"].as_i64().unwrap();
    let mine = ssh_keys(s, &session(s, &w.member)).unwrap();
    assert!(forbidden(user_ssh_keys(s, &owner, w.member.id)));
    assert_eq!(user_ssh_keys(s, &root, w.member.id).unwrap(), mine);
    assert!(hidden(user_ssh_keys(s, &root, 999)));
    assert!(hidden(delete_user_ssh_key(s, &root, w.viewer.id, kid)));
    delete_user_ssh_key(s, &root, w.member.id, kid).unwrap();
}

/// `orgs` (and `memberships`) of `me` with `existing` as the orgs there are.
fn listed(s: &AuthStore, p: &Principal, existing: &[&str]) -> (Vec<String>, Vec<String>) {
    let real: Vec<OrgId> = existing.iter().map(|o| org(o)).collect();
    let f: OrgsFn = std::sync::Arc::new(move || Ok(real.clone()));
    let v = me(s, p, Some(&f)).unwrap();
    let names = |a: &Value, k: Option<&str>| -> Vec<String> {
        a.as_array()
            .unwrap()
            .iter()
            .map(|x| k.map_or(x, |k| &x[k]).as_str().unwrap().to_string())
            .collect()
    };
    (
        names(&v["orgs"], None),
        names(&v["memberships"], Some("org")),
    )
}

#[test]
fn whoami_lists_the_orgs_that_exist() {
    let w = world();
    let s = &w.s;
    // Rows the store keeps for an org that is gone (removed past the
    // daemon), and a membership in it.
    s.ensure_org(&org("stale")).unwrap();
    s.set_member(&org("stale"), w.member.id, Role::Admin)
        .unwrap();
    // A platform admin sees every org that exists, including ones the store
    // has no row for (made past the daemon) and none it only remembers.
    let (orgs, _) = listed(s, &session(s, &w.root), &["acme", "default", "made-by-cli"]);
    assert_eq!(orgs, ["acme", "default", "made-by-cli"]);
    // A superadmin likewise.
    let sa = Superadmin::synthetic(SuperadminSource::Token {
        id: 1,
        name: "ci".into(),
    })
    .principal;
    let (orgs, _) = listed(s, &sa, &["acme", "default"]);
    assert_eq!(orgs, ["acme", "default"]);
    // A member: their memberships among the orgs that exist; the stale one
    // shows nowhere.
    let (orgs, ms) = listed(s, &session(s, &w.member), &["acme", "default"]);
    assert_eq!(orgs, ["acme"]);
    assert_eq!(ms, ["acme"]);
    // A platform admin's org token is confined like anyone's.
    let t = org_token(s, &w.root, "acme", &[]);
    assert!(listed(s, &t, &["acme", "default"]).0.is_empty());
    // Without a source of truth (or when it fails), the store stands in.
    let v = me(s, &session(s, &w.member), None).unwrap();
    assert_eq!(v["orgs"], json!(["acme", "stale"]));
    let broken: OrgsFn = std::sync::Arc::new(|| Err("incus is down".into()));
    let v = me(s, &session(s, &w.member), Some(&broken)).unwrap();
    assert_eq!(v["orgs"], json!(["acme", "stale"]));
}

#[test]
fn deleting_an_org_takes_its_memberships_invitations_and_tokens() {
    let w = world();
    let s = &w.s;
    let acme = org("acme");
    s.create_invitation(Some(w.owner.id), &acme, "n@x.io", Role::Member)
        .unwrap();
    create_token(s, &session(s, &w.member), new_token("acme")).unwrap();
    assert!(s.delete_org(&acme).unwrap());
    assert!(s.memberships(w.member.id).unwrap().is_empty());
    assert!(s.list_members(&acme).unwrap().is_empty());
    assert!(s.list_invitations(&acme).unwrap().is_empty());
    let v = tokens(s, &session(s, &w.member), None).unwrap();
    assert!(v["tokens"].as_array().unwrap().is_empty(), "{v}");
}