Sign in

flagon-io/g1t

public

g1t/crates/contracts/src/lib.rs

195 lines7,072 bytesCodeBlame
1//! Types and service interfaces shared by every g1t service.
2//!
3//! Each service has a module here holding the data it exchanges and the
4//! arguments of each of its methods. Services and their callers depend on
5//! this crate, never on each other's code.
6
7pub mod access;
8pub mod accounts;
9pub mod actions;
10pub mod agents;
11pub mod audit;
12pub mod backups;
13pub mod billing;
14pub mod capture;
15pub mod credentials;
16pub mod events;
17pub mod github;
18pub mod guardrails;
19pub mod identity;
20pub mod integrations;
21mod ids;
22mod names;
23mod outcome;
24pub mod packages;
25pub mod projects;
26pub mod repos;
27pub mod runners;
28pub mod scopes;
29pub mod search;
30pub mod security;
31pub mod time;
32pub mod webhooks;
33pub mod work;
34
35pub use ids::new_id;
36pub use names::{claimable_namespace, is_reserved_name, is_valid_namespace, is_valid_repo_name};
37pub use outcome::{Failure, FailureCode, Outcome};
38
39use serde::{Deserialize, Serialize};
40
41/// What a member may do in a workspace.
42#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
43#[serde(rename_all = "lowercase")]
44pub enum Role {
45 /// Everything a member can, plus managing members.
46 Owner,
47 /// Create repositories, push, manage issues and merge pull requests.
48 Member,
49}
50
51/// One workspace a user belongs to.
52#[derive(Clone, Debug, Serialize, Deserialize)]
53pub struct Membership {
54 /// The workspace's name in URLs: `g1t.sh/<slug>`.
55 pub slug: String,
56 pub role: Role,
57 /// The workspace's display name, for showing it to people. Set when a
58 /// user is resolved from credentials; absent on principals made up by
59 /// a service.
60 #[serde(default, skip_serializing_if = "Option::is_none")]
61 pub name: Option<String>,
62 /// The workspace's uploaded icon: the SHA-256 of its bytes, served at
63 /// `/avatars/<avatar>`. Absent means the generated letter avatar.
64 #[serde(default, skip_serializing_if = "Option::is_none")]
65 pub avatar: Option<String>,
66 /// What a member gets on each of the workspace's repositories: the
67 /// workspace's base permission. Set when a user is resolved from
68 /// credentials; absent means the default, Write. Owners have Admin
69 /// whatever it says. See [`access`].
70 #[serde(default, skip_serializing_if = "Option::is_none")]
71 pub base_permission: Option<access::BasePermission>,
72}
73
74impl Membership {
75 /// A plain member of `slug`, as services act inside one workspace.
76 pub fn member(slug: impl Into<String>) -> Self {
77 Membership {
78 slug: slug.into(),
79 role: Role::Member,
80 name: None,
81 avatar: None,
82 base_permission: None,
83 }
84 }
85}
86
87/// What a set of credentials resolved to.
88#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
89#[serde(rename_all = "lowercase")]
90pub enum PrincipalKind {
91 /// A person's account.
92 #[default]
93 User,
94 /// A workspace, acting through one of its own access tokens. Its `id`
95 /// is the workspace's, its `username` the workspace's slug, and it is a
96 /// member of that workspace and no other.
97 Workspace,
98 /// A g1t agent at work in a sandbox, acting through a token that lives
99 /// as long as its run and can do only what that token's scope lists, in
100 /// one repository. Its `username` is `g1t`.
101 Agent,
102 /// g1t itself: the platform acting on its own, as when it opens a
103 /// pull request to upgrade a vulnerable dependency or merges from the
104 /// queue. Never resolved from credentials: only services make one,
105 /// with [`User::system`]. Its `username` is `g1t`, which nobody can
106 /// register.
107 System,
108}
109
110/// g1t's own identity, as [`PrincipalKind::System`] work is recorded.
111pub mod system {
112 /// Its id wherever an author or actor id is stored.
113 pub const ID: &str = "g1t";
114 /// Its name, shown as the author of what it does.
115 pub const USERNAME: &str = "g1t";
116 /// The address on the commits it makes, which no mailbox receives.
117 pub const EMAIL: &str = "g1t@users.noreply.g1t.sh";
118 /// Ids that earlier versions stored for g1t's own actions, such as a
119 /// merge its settings made. Read as g1t too.
120 pub const LEGACY_IDS: [&str; 3] = ["g1t_policy", "svc_runner", "g1t_runner"];
121
122 /// Whether `id` is g1t's own.
123 pub fn is_system_id(id: &str) -> bool {
124 id == ID || LEGACY_IDS.contains(&id)
125 }
126}
127
128#[derive(Clone, Debug, Default, Serialize, Deserialize)]
129pub struct User {
130 pub id: String,
131 pub username: String,
132 #[serde(default)]
133 pub kind: PrincipalKind,
134 /// Whether the account's email address has been confirmed. Unverified
135 /// accounts can sign in but cannot create or change anything.
136 #[serde(default)]
137 pub verified: bool,
138 /// The workspaces this user belongs to. Filled in when a user is
139 /// resolved from credentials, so any service can authorize from it.
140 #[serde(default)]
141 pub workspaces: Vec<Membership>,
142 /// The person's uploaded avatar: the SHA-256 of its bytes, served at
143 /// `/avatars/<avatar>`. Absent means the generated letter avatar.
144 #[serde(default, skip_serializing_if = "Option::is_none")]
145 pub avatar: Option<String>,
146 /// Set on an agent resolved from its token: who it acts for, with which
147 /// credential, and what it may do. See [`credentials`].
148 #[serde(default, skip_serializing_if = "Option::is_none")]
149 pub acting: Option<Box<credentials::Acting>>,
150 /// The repositories this user has been given a role on directly,
151 /// whether or not they belong to its workspace. Filled in with
152 /// `workspaces`; see [`access`].
153 #[serde(default, skip_serializing_if = "Vec::is_empty")]
154 pub grants: Vec<access::RepoGrant>,
155 /// Set on a user resolved from an access token: its scopes and the
156 /// workspaces or repositories it is limited to. Absent on a signed-in
157 /// session and on an agent (whose `acting` scope applies instead).
158 /// See [`scopes`].
159 #[serde(default, skip_serializing_if = "Option::is_none")]
160 pub token: Option<Box<scopes::TokenAccess>>,
161}
162
163impl User {
164 /// g1t itself, acting in `workspace`: what the platform's own work,
165 /// such as security updates, is done and recorded as.
166 pub fn system(workspace: &str) -> User {
167 User {
168 id: system::ID.to_owned(),
169 username: system::USERNAME.to_owned(),
170 kind: PrincipalKind::System,
171 verified: true,
172 workspaces: vec![Membership::member(workspace.to_lowercase())],
173 ..User::default()
174 }
175 }
176
177 /// Whether this is g1t itself.
178 pub fn is_system(&self) -> bool {
179 self.kind == PrincipalKind::System
180 }
181
182 pub fn role_in(&self, slug: &str) -> Option<Role> {
183 self.workspaces
184 .iter()
185 .find(|membership| membership.slug == slug)
186 .map(|membership| membership.role)
187 }
188
189 pub fn is_member(&self, slug: &str) -> bool {
190 self.role_in(slug).is_some()
191 }
192}
193
194/// Who is asking. Every read and write in every service takes one.
195pub type Viewer = Option<User>;