komodo_client 2.0.0

Client for the Komodo build and deployment system
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
use std::{collections::HashMap, sync::OnceLock};

use anyhow::anyhow;
use indexmap::IndexMap;
use serde::{Deserialize, Serialize};
use strum::{AsRefStr, Display, EnumDiscriminants, EnumString};
use typeshare::typeshare;

use crate::entities::{I64, MongoId};

use super::{
  JsonValue, ResourceTargetVariant,
  permission::PermissionLevelAndSpecifics,
};

#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[cfg_attr(
  feature = "mongo",
  derive(mongo_indexed::derive::MongoIndexed)
)]
#[cfg_attr(feature = "mongo", doc_index({ "config.type": 1 }))]
#[cfg_attr(feature = "mongo", sparse_doc_index({ "config.data.google_id": 1 }))]
#[cfg_attr(feature = "mongo", sparse_doc_index({ "config.data.github_id": 1 }))]
pub struct User {
  /// The Mongo ID of the User.
  /// This field is de/serialized from/to JSON as
  /// `{ "_id": { "$oid": "..." }, ...(rest of User schema) }`
  #[serde(
    default,
    rename = "_id",
    skip_serializing_if = "String::is_empty",
    with = "bson::serde_helpers::hex_string_as_object_id"
  )]
  pub id: MongoId,

  /// The globally unique username for the user.
  #[cfg_attr(feature = "mongo", unique_index)]
  pub username: String,

  /// Whether user is enabled / able to access the api.
  #[cfg_attr(feature = "mongo", index)]
  #[serde(default)]
  pub enabled: bool,

  /// Can give / take other users admin priviledges.
  #[serde(default)]
  pub super_admin: bool,

  /// Whether the user has global admin permissions.
  #[serde(default)]
  pub admin: bool,

  /// Whether the user has permission to create servers.
  #[serde(default)]
  pub create_server_permissions: bool,

  /// Whether the user has permission to create builds
  #[serde(default)]
  pub create_build_permissions: bool,

  /// The primary user login.
  pub config: UserConfig,

  /// Additional linked login methods.
  /// May not contain 'Service' type config.
  #[serde(default)]
  pub linked_logins: LinkedLoginsMap,

  /// TOTP 2fa credentials
  #[serde(default)]
  pub totp: UserTotpConfig,

  /// WebAuthn Passkey 2fa credentials
  #[serde(default)]
  pub passkey: UserPasskeyConfig,

  /// Allow external / third party logins to skip 2fa.
  #[serde(default = "default_external_skip_2fa")]
  pub external_skip_2fa: bool,

  /// When the user last opened updates dropdown.
  #[serde(default)]
  pub last_update_view: I64,

  /// Recently viewed ids
  #[serde(default)]
  pub recents: HashMap<ResourceTargetVariant, Vec<String>>,

  /// Give the user elevated permissions on all resources of a certain type
  #[serde(default)]
  #[cfg_attr(feature = "utoipa", schema(value_type = HashMap<ResourceTargetVariant, PermissionLevelAndSpecifics>))]
  pub all:
    IndexMap<ResourceTargetVariant, PermissionLevelAndSpecifics>,

  #[serde(default)]
  pub updated_at: I64,
}

fn default_external_skip_2fa() -> bool {
  true
}

pub struct NewUserParams {
  pub username: String,
  pub enabled: bool,
  pub admin: bool,
  pub super_admin: bool,
  pub config: UserConfig,
  pub updated_at: i64,
}

impl User {
  pub fn new(
    NewUserParams {
      username,
      enabled,
      admin,
      super_admin,
      config,
      updated_at,
    }: NewUserParams,
  ) -> User {
    User {
      id: Default::default(),
      username,
      enabled,
      admin,
      super_admin,
      create_server_permissions: admin,
      create_build_permissions: admin,
      updated_at,
      last_update_view: 0,
      config,
      recents: Default::default(),
      all: Default::default(),
      linked_logins: Default::default(),
      totp: Default::default(),
      passkey: Default::default(),
      external_skip_2fa: Default::default(),
    }
  }
}

#[typeshare]
#[derive(Debug, Clone, Serialize, Deserialize, EnumDiscriminants)]
#[strum_discriminants(name(UserConfigVariant))]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[cfg_attr(
  not(feature = "utoipa"),
  strum_discriminants(derive(
    PartialOrd,
    Ord,
    Hash,
    Serialize,
    Deserialize,
    Display,
    EnumString,
    AsRefStr
  ))
)]
#[cfg_attr(
  feature = "utoipa",
  strum_discriminants(derive(
    PartialOrd,
    Ord,
    Hash,
    Serialize,
    Deserialize,
    Display,
    EnumString,
    AsRefStr,
    utoipa::ToSchema
  ))
)]
#[serde(tag = "type", content = "data")]
pub enum UserConfig {
  /// User that logs in with username / password
  Local { password: String },

  /// User that logs in via Google Oauth
  Google { google_id: String, avatar: String },

  /// User that logs in via Github Oauth
  Github { github_id: String, avatar: String },

  /// User that logs in via Oidc provider
  Oidc { provider: String, user_id: String },

  /// Non-human managed user, can have it's own permissions / api keys
  Service { description: String },
}

impl Default for UserConfig {
  fn default() -> Self {
    Self::Local {
      password: String::new(),
    }
  }
}

impl UserConfig {
  pub fn sanitize(&mut self) {
    if let UserConfig::Local { password } = self
      && !password.is_empty()
    {
      *password = "#".repeat(8);
    }
  }
}

#[typeshare]
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct LinkedLoginsMap(HashMap<UserConfigVariant, UserConfig>);

impl LinkedLoginsMap {
  pub fn get(
    &self,
    variant: UserConfigVariant,
  ) -> Option<&UserConfig> {
    self.0.get(&variant)
  }

  pub fn update(&mut self, login: UserConfig) -> anyhow::Result<()> {
    if let UserConfig::Service { .. } = &login {
      return Err(anyhow!(
        "Cannot insert Service type configuration as additional login method."
      ));
    }
    self.0.insert((&login).into(), login);
    Ok(())
  }

  pub fn remove(&mut self, variant: UserConfigVariant) {
    self.0.remove(&variant);
  }
}

#[typeshare]
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct UserTotpConfig {
  /// TOTP shared secret, encrypted
  pub secret: String,
  /// Unix timestamp in milliseconds when secret confirmed
  pub confirmed_at: I64,
  /// Hashed recovery codes.
  pub recovery_codes: Vec<String>,
}

impl UserTotpConfig {
  pub fn sanitize(&mut self) {
    self.secret.clear();
    self.recovery_codes.clear();
  }

  pub fn enrolled(&self) -> bool {
    !self.secret.is_empty()
  }
}

#[typeshare]
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct UserPasskeyConfig {
  /// Passkey config for 2fa. The exact schema is not public.
  pub passkey: Option<JsonValue>,
  /// Unix timestamp in milliseconds when key created
  pub created_at: I64,
}

impl UserPasskeyConfig {
  pub fn sanitize(&mut self) {
    self.passkey = None;
  }
}

impl User {
  /// Prepares user object for transport by clearing any sensitive fields
  pub fn sanitize(&mut self) {
    self.config.sanitize();
    self
      .linked_logins
      .0
      .values_mut()
      .for_each(UserConfig::sanitize);
    self.totp.sanitize();
    self.passkey.sanitize();
  }

  /// Returns whether user is an inbuilt service user
  ///
  /// NOTE: ALSO UPDATE `ui/src/lib/utils/is_service_user` to match
  pub fn is_service_user(user_id: &str) -> bool {
    matches!(
      user_id,
      "System"
        | "000000000000000000000000"
        | "Procedure"
        | "000000000000000000000001"
        | "Action"
        | "000000000000000000000002"
        | "Git Webhook"
        | "000000000000000000000003"
        | "Auto Redeploy"
        | "000000000000000000000004"
        | "Resource Sync"
        | "000000000000000000000005"
        | "Stack Wizard"
        | "000000000000000000000006"
        | "Build Manager"
        | "000000000000000000000007"
        | "Repo Manager"
        | "000000000000000000000008"
    )
  }
}

pub fn admin_service_user(user_id: &str) -> Option<User> {
  match user_id {
    "000000000000000000000000" | "System" => {
      system_user().to_owned().into()
    }
    "000000000000000000000001" | "Procedure" => {
      procedure_user().to_owned().into()
    }
    "000000000000000000000002" | "Action" => {
      action_user().to_owned().into()
    }
    "000000000000000000000003" | "Git Webhook" => {
      git_webhook_user().to_owned().into()
    }
    "000000000000000000000004" | "Auto Redeploy" => {
      auto_redeploy_user().to_owned().into()
    }
    "000000000000000000000005" | "Resource Sync" => {
      sync_user().to_owned().into()
    }
    "000000000000000000000006" | "Stack Wizard" => {
      stack_user().to_owned().into()
    }
    "000000000000000000000007" | "Build Manager" => {
      build_user().to_owned().into()
    }
    "000000000000000000000008" | "Repo Manager" => {
      repo_user().to_owned().into()
    }
    _ => None,
  }
}

pub fn system_user() -> &'static User {
  static SYSTEM_USER: OnceLock<User> = OnceLock::new();
  SYSTEM_USER.get_or_init(|| {
    let id_name = String::from("System");
    User {
      id: "000000000000000000000000".to_string(),
      username: id_name,
      enabled: true,
      admin: true,
      ..Default::default()
    }
  })
}

pub fn procedure_user() -> &'static User {
  static PROCEDURE_USER: OnceLock<User> = OnceLock::new();
  PROCEDURE_USER.get_or_init(|| {
    let id_name = String::from("Procedure");
    User {
      id: "000000000000000000000001".to_string(),
      username: id_name,
      enabled: true,
      admin: true,
      ..Default::default()
    }
  })
}

pub fn action_user() -> &'static User {
  static ACTION_USER: OnceLock<User> = OnceLock::new();
  ACTION_USER.get_or_init(|| {
    let id_name = String::from("Action");
    User {
      id: "000000000000000000000002".to_string(),
      username: id_name,
      enabled: true,
      admin: true,
      ..Default::default()
    }
  })
}

pub fn git_webhook_user() -> &'static User {
  static GIT_WEBHOOK_USER: OnceLock<User> = OnceLock::new();
  GIT_WEBHOOK_USER.get_or_init(|| {
    let id_name = String::from("Git Webhook");
    User {
      id: "000000000000000000000003".to_string(),
      username: id_name,
      enabled: true,
      admin: true,
      ..Default::default()
    }
  })
}

pub fn auto_redeploy_user() -> &'static User {
  static AUTO_REDEPLOY_USER: OnceLock<User> = OnceLock::new();
  AUTO_REDEPLOY_USER.get_or_init(|| {
    let id_name = String::from("Auto Redeploy");
    User {
      id: "000000000000000000000004".to_string(),
      username: id_name,
      enabled: true,
      admin: true,
      ..Default::default()
    }
  })
}

pub fn sync_user() -> &'static User {
  static SYNC_USER: OnceLock<User> = OnceLock::new();
  SYNC_USER.get_or_init(|| {
    let id_name = String::from("Resource Sync");
    User {
      id: "000000000000000000000005".to_string(),
      username: id_name,
      enabled: true,
      admin: true,
      ..Default::default()
    }
  })
}

pub fn stack_user() -> &'static User {
  static STACK_USER: OnceLock<User> = OnceLock::new();
  STACK_USER.get_or_init(|| {
    let id_name = String::from("Stack Wizard");
    User {
      id: "000000000000000000000006".to_string(),
      username: id_name,
      enabled: true,
      admin: true,
      ..Default::default()
    }
  })
}

pub fn build_user() -> &'static User {
  static BUILD_USER: OnceLock<User> = OnceLock::new();
  BUILD_USER.get_or_init(|| {
    let id_name = String::from("Build Manager");
    User {
      id: "000000000000000000000007".to_string(),
      username: id_name,
      enabled: true,
      admin: true,
      ..Default::default()
    }
  })
}

pub fn repo_user() -> &'static User {
  static REPO_USER: OnceLock<User> = OnceLock::new();
  REPO_USER.get_or_init(|| {
    let id_name = String::from("Repo Manager");
    User {
      id: "000000000000000000000008".to_string(),
      username: id_name,
      enabled: true,
      admin: true,
      ..Default::default()
    }
  })
}