Skip to content
Sign up

flagon-io/g1t

public
0
294 linesCodeBlameRaw
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 about;
8pub mod access;
9pub mod advisories;
10pub mod account_deletion;
11pub mod accounts;
12pub mod actions;
13pub mod agents;
14pub mod audit;
15pub mod backups;
16pub mod billing;
17pub mod capture;
18pub mod checks;
19pub mod codeowners;
20pub mod coding_agents;
21pub mod credentials;
22pub mod datasets;
23pub mod deploy_keys;
24pub mod events;
25pub mod folios;
26pub mod github;
27pub mod guardrails;
28pub mod identity;
29pub mod inbox;
30pub mod live;
31pub mod integrations;
32pub mod members;
33pub mod mirrors;
34mod ids;
35mod names;
36mod outcome;
37pub mod packages;
38pub mod people;
39pub mod projects;
40pub mod repos;
41pub mod rules;
42pub mod runners;
43pub mod scopes;
44pub mod search;
45pub mod security;
46pub mod teams;
47pub mod security_suite;
48pub mod subscribers;
49pub mod time;
50pub mod tokens;
51pub mod updates;
52pub mod webhooks;
53pub mod work;
54
55pub use ids::{id_floor, new_id};
56pub use names::{
57 Username, aliasable_name, claimable_namespace, is_action_owner_name, is_claimable_name, claimable_username, is_namespace_shaped, is_reserved_name, is_route_name,
58 is_valid_namespace, is_valid_repo_name,
59};
60pub use outcome::{Failure, FailureCode, Outcome};
61
62use serde::{Deserialize, Serialize};
63
64/// What a member may do in a workspace. A member may also hold
65/// [`members::OrgRole`]s, which add to it.
66#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
67#[serde(rename_all = "lowercase")]
68pub enum Role {
69 /// Everything: Admin on every repository, the workspace's members,
70 /// settings, billing and security.
71 Owner,
72 /// The workspace's base permission on each repository, and what its
73 /// member privileges allow (see [`members::MemberPrivileges`]).
74 Member,
75}
76
77pub use members::{MemberPrivileges, OrgRole};
78
79/// One workspace a user belongs to.
80#[derive(Clone, Debug, Serialize, Deserialize)]
81pub struct Membership {
82 /// The workspace's name in URLs: `g1t.sh/<slug>`.
83 pub slug: String,
84 pub role: Role,
85 /// The workspace's display name, for showing it to people. Set when a
86 /// user is resolved from credentials; absent on principals made up by
87 /// a service.
88 #[serde(default, skip_serializing_if = "Option::is_none")]
89 pub name: Option<String>,
90 /// The workspace's uploaded icon: the SHA-256 of its bytes, served at
91 /// `/avatars/<avatar>`. Absent means the generated letter avatar.
92 #[serde(default, skip_serializing_if = "Option::is_none")]
93 pub avatar: Option<String>,
94 /// What a member gets on each of the workspace's repositories: the
95 /// workspace's base permission. Set when a user is resolved from
96 /// credentials; absent means the default, Write. Owners have Admin
97 /// whatever it says. See [`access`].
98 #[serde(default, skip_serializing_if = "Option::is_none")]
99 pub base_permission: Option<access::BasePermission>,
100 /// Who may create the workspace's teams. Set when a user is resolved
101 /// from credentials; absent means the default, any member. See
102 /// [`teams::TeamCreation`].
103 #[serde(default, skip_serializing_if = "Option::is_none")]
104 pub team_creation: Option<teams::TeamCreation>,
105 /// The roles the member holds besides `role`: billing manager,
106 /// security manager. Set when a user is resolved from credentials.
107 #[serde(default, skip_serializing_if = "Vec::is_empty")]
108 pub org_roles: Vec<OrgRole>,
109 /// What the workspace lets members (and repository admins) do. Set
110 /// when a user is resolved from credentials; absent means the
111 /// defaults. See [`members::MemberPrivileges`].
112 #[serde(default, skip_serializing_if = "Option::is_none")]
113 pub privileges: Option<MemberPrivileges>,
114}
115
116impl Membership {
117 /// A plain member of `slug`, as services act inside one workspace.
118 pub fn member(slug: impl Into<String>) -> Self {
119 Membership {
120 slug: slug.into(),
121 role: Role::Member,
122 name: None,
123 avatar: None,
124 base_permission: None,
125 team_creation: None,
126 org_roles: Vec::new(),
127 privileges: None,
128 }
129 }
130
131 /// Whether the member holds `role` besides owner or member.
132 pub fn has(&self, role: OrgRole) -> bool {
133 self.org_roles.contains(&role)
134 }
135}
136
137/// What a set of credentials resolved to.
138#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
139#[serde(rename_all = "lowercase")]
140pub enum PrincipalKind {
141 /// A person's account.
142 #[default]
143 User,
144 /// A workspace, acting through one of its own access tokens. Its `id`
145 /// is the workspace's, its `username` the workspace's slug, and it is a
146 /// member of that workspace and no other.
147 Workspace,
148 /// A g1t agent at work in a sandbox, acting through a token that lives
149 /// as long as its run and can do only what that token's scope lists, in
150 /// one repository. Its `username` is `g1t`.
151 Agent,
152 /// g1t itself: the platform acting on its own, as when it opens a
153 /// pull request to upgrade a vulnerable dependency or merges from the
154 /// queue. Never resolved from credentials: only services make one,
155 /// with [`User::system`]. Its `username` is `g1t`, which nobody can
156 /// register.
157 System,
158}
159
160/// g1t's own identity, as [`PrincipalKind::System`] work is recorded.
161pub mod system {
162 /// Its id wherever an author or actor id is stored.
163 pub const ID: &str = "g1t";
164 /// Its name, shown as the author of what it does.
165 pub const USERNAME: &str = "g1t";
166 /// The address on the commits it makes, which no mailbox receives.
167 pub const EMAIL: &str = "g1t@users.noreply.g1t.sh";
168 /// Ids that earlier versions stored for g1t's own actions, such as a
169 /// merge its settings made. Read as g1t too.
170 pub const LEGACY_IDS: [&str; 3] = ["g1t_policy", "svc_runner", "g1t_runner"];
171
172 /// Whether `id` is g1t's own.
173 pub fn is_system_id(id: &str) -> bool {
174 id == ID || LEGACY_IDS.contains(&id)
175 }
176}
177
178#[derive(Clone, Debug, Default, Serialize, Deserialize)]
179pub struct User {
180 pub id: String,
181 /// Lowercased: what the person is found, linked and mentioned by.
182 pub username: String,
183 /// The username as its owner wrote it (`Ana`), when that differs from
184 /// `username`: what pages show. Set on the signed-in person and on
185 /// people looked up by name; absent elsewhere, where `username` is shown.
186 #[serde(default, skip_serializing_if = "Option::is_none")]
187 pub display_username: Option<String>,
188 #[serde(default)]
189 pub kind: PrincipalKind,
190 /// Whether the account's email address has been confirmed. Unverified
191 /// accounts can sign in but cannot create or change anything.
192 #[serde(default)]
193 pub verified: bool,
194 /// The workspaces this user belongs to. Filled in when a user is
195 /// resolved from credentials, so any service can authorize from it.
196 #[serde(default)]
197 pub workspaces: Vec<Membership>,
198 /// The person's uploaded avatar: the SHA-256 of its bytes, served at
199 /// `/avatars/<avatar>`. Absent means the generated letter avatar.
200 #[serde(default, skip_serializing_if = "Option::is_none")]
201 pub avatar: Option<String>,
202 /// Set on an agent resolved from its token: who it acts for, with which
203 /// credential, and what it may do. See [`credentials`].
204 #[serde(default, skip_serializing_if = "Option::is_none")]
205 pub acting: Option<Box<credentials::Acting>>,
206 /// The repositories this user has been given a role on directly,
207 /// whether or not they belong to its workspace. Filled in with
208 /// `workspaces`; see [`access`].
209 #[serde(default, skip_serializing_if = "Vec::is_empty")]
210 pub grants: Vec<access::RepoGrant>,
211 /// Set on a user resolved from an access token: its scopes and the
212 /// workspaces or repositories it is limited to. Absent on a signed-in
213 /// session and on an agent (whose `acting` scope applies instead).
214 /// See [`scopes`].
215 #[serde(default, skip_serializing_if = "Option::is_none")]
216 pub token: Option<Box<scopes::TokenAccess>>,
217 /// The workspaces this person belongs to but cannot use until they
218 /// meet its policy, such as turning on two-factor authentication.
219 /// They are left out of `workspaces` and `grants` meanwhile. Set when
220 /// a person is resolved from a session.
221 #[serde(default, skip_serializing_if = "Vec::is_empty")]
222 pub held: Vec<members::PolicyHold>,
223}
224
225impl User {
226 /// g1t itself, acting in `workspace`: what the platform's own work,
227 /// such as security updates, is done and recorded as.
228 pub fn system(workspace: &str) -> User {
229 User {
230 id: system::ID.to_owned(),
231 username: system::USERNAME.to_owned(),
232 kind: PrincipalKind::System,
233 verified: true,
234 workspaces: vec![Membership::member(workspace.to_lowercase())],
235 ..User::default()
236 }
237 }
238
239 /// Whether this is g1t itself.
240 pub fn is_system(&self) -> bool {
241 self.kind == PrincipalKind::System
242 }
243
244 /// Whether this is a person whose account has not confirmed its email
245 /// address. Such an account can only confirm it (or change it, or sign
246 /// out): the site, the API, MCP and git refuse it everything else
247 /// ([`accounts::confirm_email_first`]).
248 pub fn awaits_confirmation(&self) -> bool {
249 self.kind == PrincipalKind::User && !self.verified
250 }
251
252 pub fn role_in(&self, slug: &str) -> Option<Role> {
253 self.workspaces
254 .iter()
255 .find(|membership| membership.slug == slug)
256 .map(|membership| membership.role)
257 }
258
259 pub fn is_member(&self, slug: &str) -> bool {
260 self.role_in(slug).is_some()
261 }
262
263 /// The membership in `slug`, if any.
264 pub fn membership(&self, slug: &str) -> Option<&Membership> {
265 self.workspaces.iter().find(|membership| membership.slug.eq_ignore_ascii_case(slug))
266 }
267
268 /// Whether this is a person who owns `slug`, or holds `role` in it.
269 pub fn owns_or_has(&self, slug: &str, role: OrgRole) -> bool {
270 self.membership(slug)
271 .is_some_and(|membership| membership.role == Role::Owner || membership.has(role))
272 }
273
274 /// Whether the user may manage `slug`'s billing: an owner or a billing
275 /// manager.
276 pub fn manages_billing(&self, slug: &str) -> bool {
277 self.owns_or_has(slug, OrgRole::BillingManager)
278 }
279
280 /// Whether the user may see and manage security across `slug`: an
281 /// owner or a security manager.
282 pub fn manages_security(&self, slug: &str) -> bool {
283 self.owns_or_has(slug, OrgRole::SecurityManager)
284 }
285
286 /// The workspace's member privileges as this user sees them: the
287 /// defaults when the membership does not say.
288 pub fn privileges_in(&self, slug: &str) -> MemberPrivileges {
289 self.membership(slug).and_then(|membership| membership.privileges).unwrap_or_default()
290 }
291}
292
293/// Who is asking. Every read and write in every service takes one.
294pub type Viewer = Option<User>;