Skip to content
Sign in

flagon-io/g1t

public
0

g1t/crates/contracts/src/scopes.rs

1,198 lines52,191 bytesCodeBlame

Pick any line to see why it is the way it is: the commit, the pull request and issue it came from, and what the agent was thinking.

Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1//! Scopes: what an access token may do on its owner's behalf.
2//!
3//! A personal access token, a workspace's token and an application signed
4//! in with OAuth each carry a set of scopes. A token reaches whatever the
5//! one it acts as can reach: a person's token, that person's workspaces and
6//! repositories; a workspace's token, that workspace. What a request may do
7//! is the intersection of two things: the role of whoever the token acts as
8//! (see [`crate::access`]) and the token's scopes.
9//!
10//! Each scope is a resource and a level, written `resource:level`, such as
11//! `issues:write`. A higher level of a resource includes the lower ones:
12//! `repo:admin` includes `repo:write`, which includes `repo:read`.
13//!
14//! This module is the one source of truth: the API (REST and MCP) and git
15//! enforce it, and identity stores it. `packages/contracts/src/scopes.ts`
16//! mirrors the table for the site; a test keeps the two the same.
17
18use serde::{Deserialize, Serialize};
19
20use crate::credentials::Decision;
21
22/// Something a token can be given access to.
23#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
24pub enum Resource {
25 Account,
API: notifications over REST and MCP, with notifications scopes26 Notifications,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step27 Workspace,
Usage, Billing settings and prepaid AI credit; fixes from the UX audit28 Billing,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step29 Repo,
30 Code,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar31 Security,
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member32 Packages,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step33 Issues,
34 PullRequests,
35 Agents,
36 Workflows,
Merge checks: statuses and check runs on every commit37 Checks,
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9738 Deployments,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step39 Memory,
40 Access,
41 Webhooks,
42 Secrets,
Fast pages, required checks on the branch, self-hosted runners, honest incidents43 Runners,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens44 Models,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step45}
46
47impl Resource {
Merge checks: statuses and check runs on every commit48 pub const ALL: [Resource; 20] = [
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step49 Resource::Repo,
50 Resource::Code,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar51 Resource::Security,
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member52 Resource::Packages,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step53 Resource::Issues,
54 Resource::PullRequests,
55 Resource::Agents,
56 Resource::Workflows,
Merge checks: statuses and check runs on every commit57 Resource::Checks,
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9758 Resource::Deployments,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step59 Resource::Memory,
60 Resource::Account,
API: notifications over REST and MCP, with notifications scopes61 Resource::Notifications,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step62 Resource::Workspace,
Usage, Billing settings and prepaid AI credit; fixes from the UX audit63 Resource::Billing,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step64 Resource::Access,
65 Resource::Webhooks,
66 Resource::Secrets,
Fast pages, required checks on the branch, self-hosted runners, honest incidents67 Resource::Runners,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens68 Resource::Models,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step69 ];
70
71 pub fn as_str(self) -> &'static str {
72 match self {
73 Resource::Account => "account",
API: notifications over REST and MCP, with notifications scopes74 Resource::Notifications => "notifications",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step75 Resource::Workspace => "workspace",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit76 Resource::Billing => "billing",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step77 Resource::Repo => "repo",
78 Resource::Code => "code",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar79 Resource::Security => "security",
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member80 Resource::Packages => "packages",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step81 Resource::Issues => "issues",
82 Resource::PullRequests => "pull_requests",
83 Resource::Agents => "agents",
84 Resource::Workflows => "workflows",
Merge checks: statuses and check runs on every commit85 Resource::Checks => "checks",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9786 Resource::Deployments => "deployments",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step87 Resource::Memory => "memory",
88 Resource::Access => "access",
89 Resource::Webhooks => "webhooks",
90 Resource::Secrets => "secrets",
Fast pages, required checks on the branch, self-hosted runners, honest incidents91 Resource::Runners => "runners",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens92 Resource::Models => "models",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step93 }
94 }
95
96 /// Its name, for people.
97 pub fn label(self) -> &'static str {
98 match self {
99 Resource::Account => "Your account",
API: notifications over REST and MCP, with notifications scopes100 Resource::Notifications => "Notifications",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step101 Resource::Workspace => "Workspaces",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit102 Resource::Billing => "Billing",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step103 Resource::Repo => "Repositories",
104 Resource::Code => "Code",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar105 Resource::Security => "Security",
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member106 Resource::Packages => "Packages",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step107 Resource::Issues => "Issues",
108 Resource::PullRequests => "Pull requests",
109 Resource::Agents => "g1t agents",
110 Resource::Workflows => "Workflows",
Merge checks: statuses and check runs on every commit111 Resource::Checks => "Checks and statuses",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97112 Resource::Deployments => "Deployments",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step113 Resource::Memory => "Memory and context",
114 Resource::Access => "Who has access",
115 Resource::Webhooks => "Webhooks",
116 Resource::Secrets => "Secrets and variables",
Fast pages, required checks on the branch, self-hosted runners, honest incidents117 Resource::Runners => "Self-hosted runners",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens118 Resource::Models => "AI Gateway",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step119 }
120 }
121}
122
123/// How much of a resource.
124#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
125pub enum Level {
126 Read,
127 Write,
128 /// Starting g1t's agents, which spends the workspace's money.
129 Run,
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member130 /// Deleting what cannot be brought back, such as a package's versions.
131 Delete,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step132 Admin,
133}
134
135impl Level {
136 pub fn as_str(self) -> &'static str {
137 match self {
138 Level::Read => "read",
139 Level::Write => "write",
140 Level::Run => "run",
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member141 Level::Delete => "delete",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step142 Level::Admin => "admin",
143 }
144 }
145}
146
147/// One scope. Its text form, `resource:level`, is what tokens store, OAuth
148/// clients ask for, and errors name.
149#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
150pub enum Scope {
151 RepoRead,
152 RepoWrite,
153 RepoAdmin,
154 CodeRead,
155 CodeWrite,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar156 SecurityRead,
157 SecurityWrite,
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member158 PackagesRead,
159 PackagesWrite,
160 PackagesDelete,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step161 IssuesRead,
162 IssuesWrite,
163 PullRequestsRead,
164 PullRequestsWrite,
165 AgentsRun,
166 WorkflowsRead,
167 WorkflowsWrite,
Merge checks: statuses and check runs on every commit168 ChecksRead,
169 ChecksWrite,
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97170 DeploymentsRead,
171 DeploymentsWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step172 MemoryRead,
173 MemoryWrite,
174 AccountRead,
175 AccountWrite,
API: notifications over REST and MCP, with notifications scopes176 NotificationsRead,
177 NotificationsWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step178 WorkspaceRead,
179 WorkspaceAdmin,
Usage, Billing settings and prepaid AI credit; fixes from the UX audit180 BillingRead,
181 BillingWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step182 AccessRead,
183 AccessAdmin,
184 WebhooksRead,
185 WebhooksAdmin,
186 SecretsRead,
187 SecretsAdmin,
Fast pages, required checks on the branch, self-hosted runners, honest incidents188 RunnersRead,
189 RunnersAdmin,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens190 ModelsRead,
191 ModelsWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step192}
193
194impl Scope {
195 /// Every scope, grouped by resource, least first.
Merge checks: statuses and check runs on every commit196 pub const ALL: [Scope; 41] = [
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step197 Scope::RepoRead,
198 Scope::RepoWrite,
199 Scope::RepoAdmin,
200 Scope::CodeRead,
201 Scope::CodeWrite,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar202 Scope::SecurityRead,
203 Scope::SecurityWrite,
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member204 Scope::PackagesRead,
205 Scope::PackagesWrite,
206 Scope::PackagesDelete,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step207 Scope::IssuesRead,
208 Scope::IssuesWrite,
209 Scope::PullRequestsRead,
210 Scope::PullRequestsWrite,
211 Scope::AgentsRun,
212 Scope::WorkflowsRead,
213 Scope::WorkflowsWrite,
Merge checks: statuses and check runs on every commit214 Scope::ChecksRead,
215 Scope::ChecksWrite,
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97216 Scope::DeploymentsRead,
217 Scope::DeploymentsWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step218 Scope::MemoryRead,
219 Scope::MemoryWrite,
220 Scope::AccountRead,
221 Scope::AccountWrite,
API: notifications over REST and MCP, with notifications scopes222 Scope::NotificationsRead,
223 Scope::NotificationsWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step224 Scope::WorkspaceRead,
225 Scope::WorkspaceAdmin,
Usage, Billing settings and prepaid AI credit; fixes from the UX audit226 Scope::BillingRead,
227 Scope::BillingWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step228 Scope::AccessRead,
229 Scope::AccessAdmin,
230 Scope::WebhooksRead,
231 Scope::WebhooksAdmin,
232 Scope::SecretsRead,
233 Scope::SecretsAdmin,
Fast pages, required checks on the branch, self-hosted runners, honest incidents234 Scope::RunnersRead,
235 Scope::RunnersAdmin,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens236 Scope::ModelsRead,
237 Scope::ModelsWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step238 ];
239
240 pub fn as_str(self) -> &'static str {
241 match self {
242 Scope::RepoRead => "repo:read",
243 Scope::RepoWrite => "repo:write",
244 Scope::RepoAdmin => "repo:admin",
245 Scope::CodeRead => "code:read",
246 Scope::CodeWrite => "code:write",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar247 Scope::SecurityRead => "security:read",
248 Scope::SecurityWrite => "security:write",
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member249 Scope::PackagesRead => "packages:read",
250 Scope::PackagesWrite => "packages:write",
251 Scope::PackagesDelete => "packages:delete",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step252 Scope::IssuesRead => "issues:read",
253 Scope::IssuesWrite => "issues:write",
254 Scope::PullRequestsRead => "pull_requests:read",
255 Scope::PullRequestsWrite => "pull_requests:write",
256 Scope::AgentsRun => "agents:run",
257 Scope::WorkflowsRead => "workflows:read",
258 Scope::WorkflowsWrite => "workflows:write",
Merge checks: statuses and check runs on every commit259 Scope::ChecksRead => "checks:read",
260 Scope::ChecksWrite => "checks:write",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97261 Scope::DeploymentsRead => "deployments:read",
262 Scope::DeploymentsWrite => "deployments:write",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step263 Scope::MemoryRead => "memory:read",
264 Scope::MemoryWrite => "memory:write",
265 Scope::AccountRead => "account:read",
266 Scope::AccountWrite => "account:write",
API: notifications over REST and MCP, with notifications scopes267 Scope::NotificationsRead => "notifications:read",
268 Scope::NotificationsWrite => "notifications:write",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step269 Scope::WorkspaceRead => "workspace:read",
270 Scope::WorkspaceAdmin => "workspace:admin",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit271 Scope::BillingRead => "billing:read",
272 Scope::BillingWrite => "billing:write",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step273 Scope::AccessRead => "access:read",
274 Scope::AccessAdmin => "access:admin",
275 Scope::WebhooksRead => "webhooks:read",
276 Scope::WebhooksAdmin => "webhooks:admin",
277 Scope::SecretsRead => "secrets:read",
278 Scope::SecretsAdmin => "secrets:admin",
Fast pages, required checks on the branch, self-hosted runners, honest incidents279 Scope::RunnersRead => "runners:read",
280 Scope::RunnersAdmin => "runners:admin",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens281 Scope::ModelsRead => "models:read",
282 Scope::ModelsWrite => "models:write",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step283 }
284 }
285
286 pub fn parse(text: &str) -> Option<Scope> {
287 let text = text.trim().to_ascii_lowercase();
288 Scope::ALL.into_iter().find(|scope| scope.as_str() == text)
289 }
290
291 pub fn resource(self) -> Resource {
292 let name = self.as_str().split_once(':').map_or("", |(resource, _)| resource);
293 Resource::ALL
294 .into_iter()
295 .find(|resource| resource.as_str() == name)
296 .unwrap_or(Resource::Account)
297 }
298
299 pub fn level(self) -> Level {
300 match self.as_str().rsplit_once(':').map_or("", |(_, level)| level) {
301 "write" => Level::Write,
302 "run" => Level::Run,
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member303 "delete" => Level::Delete,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step304 "admin" => Level::Admin,
305 _ => Level::Read,
306 }
307 }
308
309 /// Whether holding `self` gives `other`: the same resource, at the same
310 /// level or a lower one.
311 pub fn includes(self, other: Scope) -> bool {
312 self.resource() == other.resource() && self.level() >= other.level()
313 }
314
315 /// Changes that are hard or impossible to undo, or that decide who can
316 /// reach what. Shown behind a warning wherever scopes are chosen.
317 pub fn dangerous(self) -> bool {
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member318 matches!(self.level(), Level::Admin | Level::Delete)
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step319 }
320
321 /// What it lets a token do, in plain words.
322 pub fn describe(self) -> &'static str {
323 match self {
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97324 Scope::RepoRead => "See repositories, their settings, labels, timelines, releases, languages, contributors and security alerts, and search",
325 Scope::RepoWrite => "Create repositories, rename branches, change how pull requests merge and publish releases",
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge326 Scope::RepoAdmin => "Rename, archive, transfer, delete or change who can see a repository, change its rulesets, and dismiss security alerts",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step327 Scope::CodeRead => "Clone and fetch private repositories with git",
328 Scope::CodeWrite => "Push commits with git",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar329 Scope::SecurityRead => "See secret scanning, code scanning and vulnerability alerts, custom patterns, the dependency graph and SBOM, and security settings",
330 Scope::SecurityWrite => "Dismiss and reopen alerts, bypass push protection, review bypass requests, manage custom patterns, upload SARIF and change security settings",
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member331 Scope::PackagesRead => "Pull container images and install private packages",
332 Scope::PackagesWrite => "Push container images and publish packages",
333 Scope::PackagesDelete => "Delete packages and their versions",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step334 Scope::IssuesRead => "Read issues, comments and plans",
335 Scope::IssuesWrite => "Open, edit, close and comment on issues",
336 Scope::PullRequestsRead => "Read pull requests, their changes, sessions and merge queues",
337 Scope::PullRequestsWrite => "Open, review, close and merge pull requests",
338 Scope::AgentsRun => "Put g1t agents to work and message them, which uses the workspace's money",
339 Scope::WorkflowsRead => "Read workflows, runs and logs",
340 Scope::WorkflowsWrite => "Run, cancel, rerun and turn workflows on or off",
Merge checks: statuses and check runs on every commit341 Scope::ChecksRead => "Read commits' statuses, check runs, check suites and annotations",
342 Scope::ChecksWrite => "Report statuses and check runs on commits, and ask for checks to run again",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97343 Scope::DeploymentsRead => "See deployments, their statuses and environments",
344 Scope::DeploymentsWrite => "Report deployments and their statuses, from any CI",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step345 Scope::MemoryRead => "Recall memory and search the workspace's context",
346 Scope::MemoryWrite => "Save memory for the next agent",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97347 Scope::AccountRead => "Read your email addresses, invites, invitations, pinned projects and stars",
348 Scope::AccountWrite => "Change your email addresses, make invites, answer invitations, pin projects and star repositories",
API: notifications over REST and MCP, with notifications scopes349 Scope::NotificationsRead => "See your inbox, its threads, and what you subscribe to and watch",
350 Scope::NotificationsWrite => "Mark notifications read, done, saved or snoozed, subscribe to threads and watch repositories",
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge351 Scope::WorkspaceRead => "Read workspace settings, invites, integrations, model routes, teams and rulesets",
352 Scope::WorkspaceAdmin => "Create and delete workspaces, invite members, connect integrations, create, change and delete teams, and change the workspace's rulesets",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit353 Scope::BillingRead => "See a workspace's usage, budget, AI credit and invoices",
354 Scope::BillingWrite => "Change a workspace's budget and buy AI credit",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step355 Scope::AccessRead => "See who has access to repositories",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar356 Scope::AccessAdmin => "Give and take away access to repositories, a team's included",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step357 Scope::WebhooksRead => "See webhooks and their deliveries",
358 Scope::WebhooksAdmin => "Create, change and delete webhooks",
359 Scope::SecretsRead => "List secrets (never their values) and read variables",
360 Scope::SecretsAdmin => "Set and delete secrets and variables",
Fast pages, required checks on the branch, self-hosted runners, honest incidents361 Scope::RunnersRead => "See self-hosted runners, their groups and where agents run",
362 Scope::RunnersAdmin => "Register and remove self-hosted runners, change their groups and settings",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens363 Scope::ModelsRead => "See the workspace's AI Gateway requests: their models, tokens, cost and status",
364 Scope::ModelsWrite => "Send model requests through the AI Gateway, which uses the workspace's AI credit",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step365 }
366 }
367}
368
369impl Serialize for Scope {
370 fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
371 serializer.serialize_str(self.as_str())
372 }
373}
374
375impl<'de> Deserialize<'de> for Scope {
376 fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
377 let text = String::deserialize(deserializer)?;
378 Scope::parse(&text).ok_or_else(|| serde::de::Error::custom(format!("unknown scope {text}")))
379 }
380}
381
382/// Scopes as written in a token's row or an OAuth request: separated by
383/// spaces or commas. Unknown names are left out, so a client asking for a
384/// scope from a newer version gets the rest.
385pub fn parse_scopes(text: &str) -> Vec<Scope> {
386 let mut scopes: Vec<Scope> = text
387 .split(|c: char| c.is_whitespace() || c == ',')
388 .filter_map(Scope::parse)
389 .collect();
390 normalize(&mut scopes);
391 scopes
392}
393
394/// In table order, without repeats.
395pub fn normalize(scopes: &mut Vec<Scope>) {
396 let given = std::mem::take(scopes);
397 scopes.extend(Scope::ALL.into_iter().filter(|scope| given.contains(scope)));
398}
399
400/// Space-separated, as stored and as OAuth writes them.
401pub fn scopes_text(scopes: &[Scope]) -> String {
402 scopes.iter().map(|scope| scope.as_str()).collect::<Vec<_>>().join(" ")
403}
404
405/// What a token stores for full access, which is not a scope a client can
406/// ask for by name.
407pub const FULL_ACCESS: &str = "*";
408
409/// Starting points for choosing scopes.
410#[derive(Clone, Copy, Debug, PartialEq, Eq)]
411pub enum Preset {
412 ReadOnly,
413 Agent,
414 Ci,
415 Full,
416}
417
418impl Preset {
419 pub const ALL: [Preset; 4] = [Preset::ReadOnly, Preset::Agent, Preset::Ci, Preset::Full];
420
421 pub fn as_str(self) -> &'static str {
422 match self {
423 Preset::ReadOnly => "read_only",
424 Preset::Agent => "agent",
425 Preset::Ci => "ci",
426 Preset::Full => "full",
427 }
428 }
429
430 pub fn label(self) -> &'static str {
431 match self {
432 Preset::ReadOnly => "Read only",
433 Preset::Agent => "Agent",
434 Preset::Ci => "CI",
435 Preset::Full => "Full access",
436 }
437 }
438
439 /// Its scopes; `None` for full access.
440 pub fn scopes(self) -> Option<Vec<Scope>> {
441 let reads = || Scope::ALL.into_iter().filter(|scope| scope.level() == Level::Read);
442 match self {
443 Preset::ReadOnly => Some(reads().collect()),
444 Preset::Agent => {
Fast pages, required checks on the branch, self-hosted runners, honest incidents445 // Not the machines work runs on: an agent has no business
446 // knowing a workspace's own runners.
447 let mut scopes: Vec<Scope> = reads().filter(|scope| scope.resource() != Resource::Runners).collect();
API: notifications over REST and MCP, with notifications scopes448 // And answering what needs the person it works for: marking
449 // it done, subscribing, watching.
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step450 scopes.extend([
451 Scope::CodeWrite,
452 Scope::IssuesWrite,
453 Scope::PullRequestsWrite,
454 Scope::AgentsRun,
455 Scope::MemoryWrite,
API: notifications over REST and MCP, with notifications scopes456 Scope::NotificationsWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step457 ]);
458 normalize(&mut scopes);
459 Some(scopes)
460 }
461 Preset::Ci => Some(vec![
462 Scope::RepoRead,
463 Scope::CodeRead,
464 Scope::CodeWrite,
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member465 Scope::PackagesRead,
466 Scope::PackagesWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step467 Scope::WorkflowsRead,
468 Scope::WorkflowsWrite,
Merge checks: statuses and check runs on every commit469 Scope::ChecksRead,
470 Scope::ChecksWrite,
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97471 Scope::DeploymentsRead,
472 Scope::DeploymentsWrite,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step473 ]),
474 Preset::Full => None,
475 }
476 }
477}
478
479/// What an OAuth client gets when it asks for nothing in particular: the
480/// agent preset. Never an admin scope.
481pub fn oauth_default() -> Vec<Scope> {
482 Preset::Agent.scopes().unwrap_or_default()
483}
484
485/// Set on a [`crate::User`] resolved from an access token: what the token
486/// may do. Absent on a signed-in session, which may do whatever its person
487/// can.
488#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
489pub struct TokenAccess {
490 /// The token's id, as audit entries and errors name it.
491 #[serde(default)]
492 pub token_id: String,
493 /// Its scopes, as `resource:level`. Absent: full access, everything the
494 /// person (or workspace) can do.
495 #[serde(default, skip_serializing_if = "Option::is_none")]
496 pub scopes: Option<Vec<String>>,
497 /// Made before tokens had scopes: full access until someone narrows it.
498 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
499 pub legacy: bool,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens500 /// The token's name, as its owner gave it, so a log can say which
501 /// token made a request. Absent where whoever resolved it did not say.
502 #[serde(default, skip_serializing_if = "Option::is_none")]
503 pub name: Option<String>,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step504}
505
506impl TokenAccess {
507 /// Full access to everything: the access tokens made before scopes had.
508 pub fn full() -> Self {
509 TokenAccess::default()
510 }
511
512 pub fn is_full(&self) -> bool {
513 self.scopes.is_none()
514 }
515
516 /// The scopes it holds, or `None` for full access.
517 pub fn granted(&self) -> Option<Vec<Scope>> {
518 self.scopes
519 .as_ref()
520 .map(|scopes| scopes.iter().filter_map(|scope| Scope::parse(scope)).collect())
521 }
522
523 pub fn allows(&self, needed: Scope) -> bool {
524 match self.granted() {
525 None => true,
526 Some(granted) => granted.iter().any(|held| held.includes(needed)),
527 }
528 }
529}
530
531/// Every operation of the API and MCP server, with the scope it needs. An
532/// operation in [`NO_SCOPE`] needs none. The API checks that every one of
533/// its operations is in exactly one of the two.
534pub const OPERATIONS: &[(&str, Scope)] = &[
535 // Your account.
536 ("list_emails", Scope::AccountRead),
537 ("add_email", Scope::AccountWrite),
538 ("remove_email", Scope::AccountWrite),
539 ("update_email_settings", Scope::AccountWrite),
540 ("list_invites", Scope::AccountRead),
541 ("create_invite", Scope::AccountWrite),
542 ("revoke_invite", Scope::AccountWrite),
543 ("list_my_repo_invitations", Scope::AccountRead),
544 ("accept_repo_invitation", Scope::AccountWrite),
545 ("decline_repo_invitation", Scope::AccountWrite),
API: pinned projects over REST and MCP546 // Your pinned projects: a preference of your account.
547 ("list_pinned_projects", Scope::AccountRead),
548 ("pin_project", Scope::AccountWrite),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97549 // Your stars: a preference of your account.
550 ("list_starred", Scope::AccountRead),
551 ("check_starred", Scope::AccountRead),
552 ("star_repo", Scope::AccountWrite),
553 ("unstar_repo", Scope::AccountWrite),
API: pinned projects over REST and MCP554 ("unpin_project", Scope::AccountWrite),
555 ("reorder_pinned_projects", Scope::AccountWrite),
API: notifications over REST and MCP, with notifications scopes556 // Your inbox: notifications, subscriptions and watching.
557 ("list_notifications", Scope::NotificationsRead),
558 ("get_notification_thread", Scope::NotificationsRead),
559 ("get_thread_subscription", Scope::NotificationsRead),
560 ("get_repo_subscription", Scope::NotificationsRead),
561 ("list_watched_repos", Scope::NotificationsRead),
562 ("mark_notifications_read", Scope::NotificationsWrite),
563 ("mark_thread_read", Scope::NotificationsWrite),
564 ("mark_thread_done", Scope::NotificationsWrite),
565 ("save_thread", Scope::NotificationsWrite),
566 ("snooze_thread", Scope::NotificationsWrite),
567 ("set_thread_subscription", Scope::NotificationsWrite),
568 ("delete_thread_subscription", Scope::NotificationsWrite),
569 ("set_repo_subscription", Scope::NotificationsWrite),
570 ("delete_repo_subscription", Scope::NotificationsWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step571 // Workspaces, their invites and integrations.
572 ("create_workspace", Scope::WorkspaceAdmin),
573 ("delete_workspace", Scope::WorkspaceAdmin),
Merge branch 'worktree-agent-ad7c6d88d93adc817'574 ("get_workspace", Scope::WorkspaceRead),
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily575 ("update_workspace", Scope::WorkspaceAdmin),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step576 ("list_workspace_invites", Scope::WorkspaceRead),
577 ("invite_member", Scope::WorkspaceAdmin),
578 ("revoke_workspace_invite", Scope::WorkspaceAdmin),
579 ("list_integrations", Scope::WorkspaceRead),
580 ("connect_integration", Scope::WorkspaceAdmin),
AI Gateway: OpenAI's format, open models, and your own providers581 ("update_integration", Scope::WorkspaceAdmin),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step582 ("disconnect_integration", Scope::WorkspaceAdmin),
583 ("test_integration", Scope::WorkspaceAdmin),
584 ("get_model_routes", Scope::WorkspaceRead),
585 ("set_model_routes", Scope::WorkspaceAdmin),
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar586 // Teams: reading them, and managing them. A team's role on a
587 // repository is who has access.
588 ("list_teams", Scope::WorkspaceRead),
589 ("get_team", Scope::WorkspaceRead),
590 ("list_team_members", Scope::WorkspaceRead),
591 ("list_child_teams", Scope::WorkspaceRead),
592 ("list_team_repos", Scope::WorkspaceRead),
593 ("list_user_teams", Scope::WorkspaceRead),
594 ("create_team", Scope::WorkspaceAdmin),
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge595 ("list_workspace_rulesets", Scope::WorkspaceRead),
596 ("get_workspace_ruleset", Scope::WorkspaceRead),
597 ("list_workspace_rule_evaluations", Scope::WorkspaceRead),
598 ("create_workspace_ruleset", Scope::WorkspaceAdmin),
599 ("update_workspace_ruleset", Scope::WorkspaceAdmin),
600 ("delete_workspace_ruleset", Scope::WorkspaceAdmin),
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar601 ("update_team", Scope::WorkspaceAdmin),
602 ("delete_team", Scope::WorkspaceAdmin),
603 ("set_team_member", Scope::WorkspaceAdmin),
604 ("remove_team_member", Scope::WorkspaceAdmin),
605 ("set_team_review_assignment", Scope::WorkspaceAdmin),
Usage, Billing settings and prepaid AI credit; fixes from the UX audit606 // A workspace's billing: usage, budget, AI credit and invoices.
607 ("get_usage", Scope::BillingRead),
608 ("get_budget", Scope::BillingRead),
609 ("get_ai_credit", Scope::BillingRead),
610 ("list_invoices", Scope::BillingRead),
611 ("get_billing_details", Scope::BillingRead),
612 ("set_budget", Scope::BillingWrite),
613 ("buy_ai_credit", Scope::BillingWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step614 // Repositories.
615 ("list_repos", Scope::RepoRead),
616 ("get_repo", Scope::RepoRead),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97617 // Projects follow their repositories.
618 ("list_projects", Scope::RepoRead),
619 ("get_project", Scope::RepoRead),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step620 ("search", Scope::RepoRead),
621 ("list_events", Scope::RepoRead),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97622 // What the default branch says about a repository, who starred it, and
623 // its releases.
624 ("get_languages", Scope::RepoRead),
625 ("list_contributors", Scope::RepoRead),
626 ("get_license", Scope::RepoRead),
627 ("list_stargazers", Scope::RepoRead),
628 ("list_releases", Scope::RepoRead),
629 ("get_latest_release", Scope::RepoRead),
630 ("get_release_by_tag", Scope::RepoRead),
631 ("get_release", Scope::RepoRead),
632 ("create_release", Scope::RepoWrite),
633 ("update_release", Scope::RepoWrite),
634 ("delete_release", Scope::RepoWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step635 ("list_labels", Scope::RepoRead),
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar636 ("list_milestones", Scope::RepoRead),
637 ("get_milestone", Scope::RepoRead),
638 ("create_label", Scope::IssuesWrite),
639 ("update_label", Scope::IssuesWrite),
640 ("delete_label", Scope::IssuesWrite),
641 ("add_default_labels", Scope::IssuesWrite),
642 ("create_milestone", Scope::IssuesWrite),
643 ("update_milestone", Scope::IssuesWrite),
644 ("delete_milestone", Scope::IssuesWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step645 ("get_repo_settings", Scope::RepoRead),
Fast pages, required checks on the branch, self-hosted runners, honest incidents646 ("list_check_names", Scope::RepoRead),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step647 ("list_deleted_repos", Scope::RepoRead),
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily648 ("list_security_alerts", Scope::RepoRead),
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar649 ("get_codeowners_errors", Scope::RepoRead),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step650 ("create_repo", Scope::RepoWrite),
651 ("update_repo", Scope::RepoWrite),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97652 ("update_project", Scope::RepoWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step653 ("update_repo_settings", Scope::RepoWrite),
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge654 // Rulesets: reading them is reading the repository; changing them
655 // changes what everyone, agents included, may do, so it is admin.
656 ("list_repo_rulesets", Scope::RepoRead),
657 ("get_repo_ruleset", Scope::RepoRead),
658 ("get_branch_rules", Scope::RepoRead),
659 ("list_rule_evaluations", Scope::RepoRead),
660 ("create_repo_ruleset", Scope::RepoAdmin),
661 ("update_repo_ruleset", Scope::RepoAdmin),
662 ("delete_repo_ruleset", Scope::RepoAdmin),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step663 ("rename_branch", Scope::RepoWrite),
664 ("rename_repo", Scope::RepoAdmin),
665 ("transfer_repo", Scope::RepoAdmin),
666 ("archive_repo", Scope::RepoAdmin),
667 ("unarchive_repo", Scope::RepoAdmin),
668 ("set_repo_visibility", Scope::RepoAdmin),
669 ("delete_repo", Scope::RepoAdmin),
670 ("restore_repo", Scope::RepoAdmin),
671 ("purge_repo", Scope::RepoAdmin),
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily672 // A dismissed secret is let through push protection.
673 ("dismiss_security_alert", Scope::RepoAdmin),
674 ("reopen_security_alert", Scope::RepoAdmin),
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar675 // The security suite: alerts, push protection, patterns, code
676 // scanning, the supply chain and settings.
677 ("list_secret_scanning_alerts", Scope::SecurityRead),
678 ("get_secret_scanning_alert", Scope::SecurityRead),
679 ("list_secret_scanning_locations", Scope::SecurityRead),
680 ("list_bypass_requests", Scope::SecurityRead),
681 ("list_custom_patterns", Scope::SecurityRead),
682 ("list_code_scanning_alerts", Scope::SecurityRead),
683 ("get_code_scanning_alert", Scope::SecurityRead),
684 ("list_code_scanning_analyses", Scope::SecurityRead),
685 ("get_sarif_upload", Scope::SecurityRead),
686 ("list_vulnerability_alerts", Scope::SecurityRead),
687 ("get_vulnerability_alert", Scope::SecurityRead),
688 ("get_dependency_graph", Scope::SecurityRead),
689 ("get_sbom", Scope::SecurityRead),
690 ("compare_dependencies", Scope::SecurityRead),
691 ("get_security_settings", Scope::SecurityRead),
692 ("get_workspace_security_settings", Scope::SecurityRead),
693 ("get_security_overview", Scope::SecurityRead),
694 ("update_secret_scanning_alert", Scope::SecurityWrite),
695 ("bypass_push_protection", Scope::SecurityWrite),
696 ("check_secret_validity", Scope::SecurityWrite),
697 ("review_bypass_request", Scope::SecurityWrite),
698 ("create_custom_pattern", Scope::SecurityWrite),
699 ("update_custom_pattern", Scope::SecurityWrite),
700 ("delete_custom_pattern", Scope::SecurityWrite),
701 ("dry_run_custom_pattern", Scope::SecurityWrite),
702 ("update_code_scanning_alert", Scope::SecurityWrite),
703 ("upload_sarif", Scope::SecurityWrite),
704 ("update_vulnerability_alert", Scope::SecurityWrite),
705 ("fix_security_alert", Scope::SecurityWrite),
706 ("update_security_settings", Scope::SecurityWrite),
707 ("update_workspace_security_settings", Scope::SecurityWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step708 // Issues and plans.
709 ("list_issues", Scope::IssuesRead),
710 ("get_issue", Scope::IssuesRead),
711 ("get_plan", Scope::IssuesRead),
712 ("create_issue", Scope::IssuesWrite),
713 ("update_issue", Scope::IssuesWrite),
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar714 ("list_issue_labels", Scope::IssuesRead),
715 ("add_issue_labels", Scope::IssuesWrite),
716 ("set_issue_labels", Scope::IssuesWrite),
717 ("remove_issue_labels", Scope::IssuesWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step718 ("close_issue", Scope::IssuesWrite),
719 ("reopen_issue", Scope::IssuesWrite),
720 ("add_comment", Scope::IssuesWrite),
721 ("import_issue", Scope::IssuesWrite),
722 ("apply_plan", Scope::IssuesWrite),
723 // Pull requests.
724 ("list_pull_requests", Scope::PullRequestsRead),
725 ("get_pull_request", Scope::PullRequestsRead),
726 ("get_pull_request_changes", Scope::PullRequestsRead),
727 ("read_session", Scope::PullRequestsRead),
728 ("get_merge_queue", Scope::PullRequestsRead),
729 ("create_pull_request", Scope::PullRequestsWrite),
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar730 ("update_pull_request", Scope::PullRequestsWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step731 ("record_session", Scope::PullRequestsWrite),
732 ("mark_pull_request_ready", Scope::PullRequestsWrite),
733 ("close_pull_request", Scope::PullRequestsWrite),
734 ("review_pull_request", Scope::PullRequestsWrite),
735 ("merge_pull_request", Scope::PullRequestsWrite),
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar736 ("request_reviewers", Scope::PullRequestsWrite),
737 ("remove_requested_reviewers", Scope::PullRequestsWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step738 // g1t's agents.
739 ("assign_issue", Scope::AgentsRun),
740 ("delegate", Scope::AgentsRun),
741 ("plan_work", Scope::AgentsRun),
742 ("message_agent", Scope::AgentsRun),
743 ("answer_message", Scope::AgentsRun),
744 ("take_messages", Scope::AgentsRun),
745 // Workflows.
746 ("list_workflows", Scope::WorkflowsRead),
747 ("list_workflow_runs", Scope::WorkflowsRead),
748 ("get_workflow_run", Scope::WorkflowsRead),
749 ("get_job_logs", Scope::WorkflowsRead),
750 ("dispatch_workflow", Scope::WorkflowsWrite),
751 ("cancel_workflow_run", Scope::WorkflowsWrite),
752 ("rerun_workflow_run", Scope::WorkflowsWrite),
753 ("update_workflow", Scope::WorkflowsWrite),
Merge checks: statuses and check runs on every commit754 // Checks: statuses, check runs and check suites on commits.
755 ("list_commit_statuses", Scope::ChecksRead),
756 ("get_combined_status", Scope::ChecksRead),
757 ("list_check_runs_for_ref", Scope::ChecksRead),
758 ("get_check_run", Scope::ChecksRead),
759 ("list_check_run_annotations", Scope::ChecksRead),
760 ("list_check_suites_for_ref", Scope::ChecksRead),
761 ("get_check_suite", Scope::ChecksRead),
762 ("create_commit_status", Scope::ChecksWrite),
763 ("create_check_run", Scope::ChecksWrite),
764 ("update_check_run", Scope::ChecksWrite),
765 ("rerequest_check_run", Scope::ChecksWrite),
766 ("rerequest_check_suite", Scope::ChecksWrite),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97767 // Deployments, wherever they run: reading them, and reporting them.
768 ("list_deployments", Scope::DeploymentsRead),
769 ("get_deployment", Scope::DeploymentsRead),
770 ("list_deployment_statuses", Scope::DeploymentsRead),
771 ("list_environments", Scope::DeploymentsRead),
772 ("get_environment", Scope::DeploymentsRead),
773 ("create_deployment", Scope::DeploymentsWrite),
774 ("create_deployment_status", Scope::DeploymentsWrite),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step775 // Memory and the context hub.
776 ("recall", Scope::MemoryRead),
777 ("search_context", Scope::MemoryRead),
778 ("get_entity", Scope::MemoryRead),
779 ("get_context", Scope::MemoryRead),
780 ("remember", Scope::MemoryWrite),
781 // Who has access.
782 ("list_collaborators", Scope::AccessRead),
783 ("get_collaborator_permission", Scope::AccessRead),
784 ("list_repo_invitations", Scope::AccessRead),
785 ("list_outside_collaborators", Scope::AccessRead),
786 ("add_collaborator", Scope::AccessAdmin),
787 ("update_collaborator", Scope::AccessAdmin),
788 ("remove_collaborator", Scope::AccessAdmin),
789 ("revoke_repo_invitation", Scope::AccessAdmin),
790 ("set_base_permission", Scope::AccessAdmin),
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar791 ("set_team_repo", Scope::AccessAdmin),
792 ("remove_team_repo", Scope::AccessAdmin),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step793 // Webhooks.
794 ("list_webhooks", Scope::WebhooksRead),
795 ("list_webhook_deliveries", Scope::WebhooksRead),
796 ("create_webhook", Scope::WebhooksAdmin),
797 ("update_webhook", Scope::WebhooksAdmin),
798 ("delete_webhook", Scope::WebhooksAdmin),
799 ("ping_webhook", Scope::WebhooksAdmin),
800 ("redeliver_webhook", Scope::WebhooksAdmin),
801 // Secrets and variables.
802 ("list_actions_secrets", Scope::SecretsRead),
803 ("list_actions_variables", Scope::SecretsRead),
804 ("set_actions_secret", Scope::SecretsAdmin),
805 ("delete_actions_secret", Scope::SecretsAdmin),
806 ("set_actions_variable", Scope::SecretsAdmin),
807 ("delete_actions_variable", Scope::SecretsAdmin),
Fast pages, required checks on the branch, self-hosted runners, honest incidents808 // Self-hosted runners.
809 ("list_runners", Scope::RunnersRead),
810 ("list_runner_groups", Scope::RunnersRead),
811 ("get_runner_settings", Scope::RunnersRead),
812 ("create_runner_registration_token", Scope::RunnersAdmin),
813 ("remove_runner", Scope::RunnersAdmin),
814 ("create_runner_group", Scope::RunnersAdmin),
815 ("update_runner_group", Scope::RunnersAdmin),
816 ("delete_runner_group", Scope::RunnersAdmin),
817 ("update_runner_settings", Scope::RunnersAdmin),
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens818 // The AI Gateway. Sending a request to a model needs `models:write`,
819 // checked by the model proxy at models.g1t.sh, not here.
820 ("list_gateway_requests", Scope::ModelsRead),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step821];
822
823/// Operations any token may use: saying who it is.
824pub const NO_SCOPE: &[&str] = &["whoami"];
825
826/// The scope `operation` needs. `None` for one in [`NO_SCOPE`]; an
827/// operation in neither list needs full access.
828pub fn scope_for(operation: &str) -> Option<Scope> {
829 OPERATIONS
830 .iter()
831 .find(|(name, _)| *name == operation)
832 .map(|(_, scope)| *scope)
833}
834
835/// What a token needs for `operation` with this input beyond its own
836/// scope: starting agents from an operation that can, and making a
837/// repository public or private.
838pub fn extra_scopes(operation: &str, input: &serde_json::Value) -> Vec<Scope> {
839 let mut extra = Vec::new();
840 let assigns = input["assign"].as_bool() == Some(true)
841 || input["agent"].as_bool() == Some(true)
842 || input["assign_agent"].as_bool() == Some(true);
843 if assigns && matches!(operation, "apply_plan" | "import_issue" | "create_issue") {
844 extra.push(Scope::AgentsRun);
845 }
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar846 // Fixing an alert opens an issue and puts g1t on it.
847 if operation == "fix_security_alert" {
848 extra.extend([Scope::IssuesWrite, Scope::AgentsRun]);
849 }
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step850 // Opening the issue an agent is put on.
851 if operation == "delegate" {
852 extra.push(Scope::IssuesWrite);
853 }
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily854 // A workspace's base permission is who has access.
855 if operation == "update_workspace" && input.get("base_permission").is_some_and(|v| !v.is_null()) {
856 extra.push(Scope::AccessAdmin);
857 }
Merge checks: statuses and check runs on every commit858 // Asking a g1t Actions job or run to run again reruns its workflow.
859 if matches!(operation, "rerequest_check_run" | "rerequest_check_suite")
860 && input["id"].as_str().is_some_and(|id| id.starts_with("job_") || id.starts_with("run_"))
861 {
862 extra.push(Scope::WorkflowsWrite);
863 }
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step864 if operation == "update_repo" && (input.get("private").is_some_and(|v| !v.is_null()) || input.get("default_branch").is_some_and(|v| !v.is_null())) {
865 extra.push(Scope::RepoAdmin);
866 }
867 extra
868}
869
870/// The scopes a call needs, its own first.
871pub fn needed(operation: &str, input: &serde_json::Value) -> Vec<Scope> {
872 scope_for(operation)
873 .into_iter()
874 .chain(extra_scopes(operation, input))
875 .collect()
876}
877
878/// Whether `access` may use `operation` with `input`. The person's (or
879/// workspace's) role is checked after this, by the service that owns what
880/// was asked about.
881pub fn decide(access: &TokenAccess, operation: &str, input: &serde_json::Value) -> Decision {
882 let rule = if access.legacy { "token:legacy" } else { "token:scope" };
883 if access.scopes.is_some() {
884 let known = NO_SCOPE.contains(&operation) || scope_for(operation).is_some();
885 if !known {
886 return Decision::deny("token:scope", format!("This access token cannot use {operation}: it needs full access."));
887 }
888 if let Some(missing) = needed(operation, input).into_iter().find(|scope| !access.allows(*scope)) {
889 return Decision::deny(
890 "token:scope",
891 format!("This access token needs the {} scope to use {operation}.", missing.as_str()),
892 );
893 }
894 }
895 Decision::allow(rule)
896}
897
898/// Whether a token may clone or fetch (`write` false), or push to (`write`
899/// true), a repository with git. `public` is whether anyone may read it,
900/// which needs no scope.
901pub fn decide_git(access: &TokenAccess, write: bool, public: bool) -> Decision {
902 let needed = if write { Scope::CodeWrite } else { Scope::CodeRead };
903 if !access.allows(needed) && (write || !public) {
904 return Decision::deny(
905 "token:scope",
906 format!("This access token needs the {} scope to {} with git.", needed.as_str(), if write { "push" } else { "clone or fetch a private repository" }),
907 );
908 }
909 Decision::allow(if access.legacy { "token:legacy" } else { "token:scope" })
910}
911
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member912/// Whether a token may pull (`Level::Read`), push or publish
913/// (`Level::Write`), or delete (`Level::Delete`) packages. `public` is
914/// whether anyone may pull the package, which needs no scope.
915pub fn decide_packages(access: &TokenAccess, level: Level, public: bool) -> Decision {
916 let (needed, doing) = match level {
917 Level::Read => (Scope::PackagesRead, "pull a private package"),
918 Level::Delete | Level::Admin => (Scope::PackagesDelete, "delete packages"),
919 Level::Write | Level::Run => (Scope::PackagesWrite, "push or publish packages"),
920 };
921 if !access.allows(needed) && !(level == Level::Read && public) {
922 return Decision::deny(
923 "token:scope",
924 format!("This access token needs the {} scope to {doing}.", needed.as_str()),
925 );
926 }
927 Decision::allow(if access.legacy { "token:legacy" } else { "token:scope" })
928}
929
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step930#[cfg(test)]
931mod tests {
932 use super::*;
933 use serde_json::json;
934
935 fn token(scopes: &[Scope]) -> TokenAccess {
936 TokenAccess {
937 token_id: "tok_1".to_owned(),
938 scopes: Some(scopes.iter().map(|scope| scope.as_str().to_owned()).collect()),
939 legacy: false,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens940 name: None,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step941 }
942 }
943
944 #[test]
945 fn every_scope_reads_back_and_belongs_to_a_resource() {
946 for scope in Scope::ALL {
947 assert_eq!(Scope::parse(scope.as_str()), Some(scope));
948 assert!(scope.as_str().starts_with(scope.resource().as_str()));
949 assert!(scope.includes(scope));
950 }
951 assert_eq!(Scope::parse(" Issues:Write "), Some(Scope::IssuesWrite));
952 assert_eq!(Scope::parse("issues"), None);
953 }
954
955 #[test]
956 fn a_higher_level_includes_the_lower_ones_of_its_resource_only() {
957 assert!(Scope::RepoAdmin.includes(Scope::RepoRead));
958 assert!(Scope::RepoAdmin.includes(Scope::RepoWrite));
959 assert!(Scope::IssuesWrite.includes(Scope::IssuesRead));
960 assert!(!Scope::IssuesRead.includes(Scope::IssuesWrite));
961 assert!(!Scope::RepoAdmin.includes(Scope::CodeWrite));
962 assert!(!Scope::PullRequestsWrite.includes(Scope::IssuesWrite));
963 }
964
965 #[test]
966 fn operations_are_listed_once_and_never_also_free() {
967 let mut seen = std::collections::HashSet::new();
968 for (name, _) in OPERATIONS {
969 assert!(seen.insert(*name), "{name} twice");
970 assert!(!NO_SCOPE.contains(name), "{name}");
971 }
972 }
973
974 #[test]
975 fn scopes_are_parsed_from_oauth_text_leaving_out_unknown_ones() {
976 assert_eq!(
977 parse_scopes("issues:write repo:read,bogus:thing issues:write"),
978 vec![Scope::RepoRead, Scope::IssuesWrite]
979 );
980 assert_eq!(scopes_text(&[Scope::RepoRead, Scope::IssuesWrite]), "repo:read issues:write");
981 }
982
983 #[test]
984 fn the_oauth_default_is_the_agent_preset_and_never_admin() {
985 let scopes = oauth_default();
986 assert!(scopes.contains(&Scope::IssuesWrite));
987 assert!(scopes.contains(&Scope::PullRequestsWrite));
988 assert!(scopes.contains(&Scope::AgentsRun));
989 assert!(scopes.iter().all(|scope| !scope.dangerous()), "{scopes:?}");
990 for read in Scope::ALL.into_iter().filter(|scope| scope.level() == Level::Read) {
Fast pages, required checks on the branch, self-hosted runners, honest incidents991 // Every read but the machines work runs on.
992 assert_eq!(scopes.contains(&read), read != Scope::RunnersRead, "{read:?}");
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step993 }
994 assert!(Preset::ReadOnly.scopes().unwrap().iter().all(|scope| scope.level() == Level::Read));
995 assert_eq!(Preset::Full.scopes(), None);
996 }
997
998 #[test]
Usage, Billing settings and prepaid AI credit; fixes from the UX audit999 fn billing_is_read_by_presets_and_changed_by_none_but_full_access() {
1000 assert!(Preset::ReadOnly.scopes().unwrap().contains(&Scope::BillingRead));
1001 for preset in [Preset::ReadOnly, Preset::Agent, Preset::Ci] {
1002 assert!(!preset.scopes().unwrap().contains(&Scope::BillingWrite), "{}", preset.as_str());
1003 }
1004 assert_eq!(scope_for("set_budget"), Some(Scope::BillingWrite));
1005 assert_eq!(scope_for("buy_ai_credit"), Some(Scope::BillingWrite));
1006 assert_eq!(scope_for("get_usage"), Some(Scope::BillingRead));
1007 let reader = token(&[Scope::BillingRead]);
1008 assert!(decide(&reader, "list_invoices", &json!({})).allowed);
1009 assert!(decide(&reader, "set_budget", &json!({})).reason.unwrap().contains("billing:write"));
1010 }
1011
1012 #[test]
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens1013 fn the_ai_gateway_spends_only_with_models_write_which_no_preset_gives() {
1014 // Reading the log is a read like any other.
1015 assert_eq!(scope_for("list_gateway_requests"), Some(Scope::ModelsRead));
1016 assert!(Preset::ReadOnly.scopes().unwrap().contains(&Scope::ModelsRead));
1017 // Sending requests spends the workspace's AI credit: chosen on purpose.
1018 for preset in [Preset::ReadOnly, Preset::Agent, Preset::Ci] {
1019 assert!(!preset.scopes().unwrap().contains(&Scope::ModelsWrite), "{}", preset.as_str());
1020 }
1021 assert!(Scope::ModelsWrite.includes(Scope::ModelsRead));
1022 assert!(!Scope::ModelsWrite.dangerous());
1023 assert!(token(&[Scope::ModelsWrite]).allows(Scope::ModelsWrite));
1024 assert!(!token(&[Scope::BillingWrite]).allows(Scope::ModelsWrite));
1025 assert!(TokenAccess::full().allows(Scope::ModelsWrite));
1026 }
1027
1028 #[test]
Merge checks: statuses and check runs on every commit1029 fn checks_are_reported_with_checks_write_which_ci_gets() {
1030 assert_eq!(scope_for("create_check_run"), Some(Scope::ChecksWrite));
1031 assert_eq!(scope_for("create_commit_status"), Some(Scope::ChecksWrite));
1032 assert_eq!(scope_for("list_check_runs_for_ref"), Some(Scope::ChecksRead));
1033 let ci = Preset::Ci.scopes().unwrap();
1034 assert!(ci.contains(&Scope::ChecksWrite));
1035 assert!(!Preset::Agent.scopes().unwrap().contains(&Scope::ChecksWrite));
1036 let reporter = token(&[Scope::ChecksWrite]);
1037 assert!(decide(&reporter, "update_check_run", &json!({ "id": "cr_1" })).allowed);
1038 assert!(decide(&reporter, "rerequest_check_run", &json!({ "id": "cr_1" })).allowed);
1039 // A g1t Actions job runs again as its workflow does.
1040 let refused = decide(&reporter, "rerequest_check_run", &json!({ "id": "job_1" }));
1041 assert!(refused.reason.unwrap().contains("workflows:write"));
1042 }
1043
1044 #[test]
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1045 fn a_legacy_token_can_do_everything() {
1046 let legacy = TokenAccess { legacy: true, ..TokenAccess::full() };
1047 for (operation, _) in OPERATIONS {
1048 assert!(decide(&legacy, operation, &json!({})).allowed, "{operation}");
1049 }
1050 assert_eq!(decide(&legacy, "delete_repo", &json!({})).rule, "token:legacy");
1051 }
1052
1053 #[test]
1054 fn a_missing_scope_is_named() {
1055 let read = token(&[Scope::IssuesRead]);
1056 assert!(decide(&read, "get_issue", &json!({})).allowed);
1057 assert!(decide(&read, "whoami", &json!({})).allowed);
1058 let refused = decide(&read, "create_issue", &json!({}));
1059 assert!(!refused.allowed);
1060 assert_eq!(refused.reason.as_deref(), Some("This access token needs the issues:write scope to use create_issue."));
1061 // An operation the table does not know needs full access.
1062 assert!(!decide(&read, "something_new", &json!({})).allowed);
1063 }
1064
1065 #[test]
1066 fn starting_agents_from_another_operation_needs_agents_run() {
1067 let writer = token(&[Scope::IssuesWrite]);
1068 assert!(decide(&writer, "apply_plan", &json!({})).allowed);
1069 let refused = decide(&writer, "apply_plan", &json!({ "assign": true }));
1070 assert!(refused.reason.unwrap().contains("agents:run"));
1071 let maintainer = token(&[Scope::RepoWrite]);
1072 assert!(decide(&maintainer, "update_repo", &json!({ "description": "x" })).allowed);
1073 assert!(!decide(&maintainer, "update_repo", &json!({ "private": true })).allowed);
1074 }
1075
1076 #[test]
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily1077 fn a_workspaces_base_permission_needs_access_admin_too() {
1078 let admin = token(&[Scope::WorkspaceAdmin]);
1079 assert!(decide(&admin, "update_workspace", &json!({ "name": "Acme" })).allowed);
1080 let refused = decide(&admin, "update_workspace", &json!({ "name": "Acme", "base_permission": "read" }));
1081 assert!(refused.reason.unwrap().contains("access:admin"));
1082 let both = token(&[Scope::WorkspaceAdmin, Scope::AccessAdmin]);
1083 assert!(decide(&both, "update_workspace", &json!({ "base_permission": "read" })).allowed);
1084 assert!(!decide(&token(&[Scope::WorkspaceRead]), "update_workspace", &json!({ "name": "Acme" })).allowed);
1085 }
1086
1087 #[test]
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1088 fn delegating_needs_both_agents_and_issues() {
1089 let agents = token(&[Scope::AgentsRun]);
1090 assert!(decide(&agents, "delegate", &json!({})).reason.unwrap().contains("issues:write"));
1091 let both = token(&[Scope::AgentsRun, Scope::IssuesWrite]);
1092 assert!(decide(&both, "delegate", &json!({})).allowed);
1093 }
1094
1095 #[test]
1096 fn git_push_needs_code_write_and_private_reads_need_code_read() {
1097 let reader = token(&[Scope::CodeRead]);
1098 assert!(decide_git(&reader, false, false).allowed);
1099 let refused = decide_git(&reader, true, false);
1100 assert!(!refused.allowed);
1101 assert!(refused.reason.unwrap().contains("code:write"));
1102 let issues = token(&[Scope::IssuesWrite]);
1103 assert!(!decide_git(&issues, false, false).allowed);
1104 assert!(decide_git(&issues, false, true).allowed, "public code needs no scope");
1105 assert!(!decide_git(&issues, true, true).allowed, "pushing to public code still needs code:write");
1106 let writer = token(&[Scope::CodeWrite]);
1107 assert!(decide_git(&writer, true, false).allowed);
1108 assert!(decide_git(&writer, false, false).allowed, "code:write includes code:read");
1109 assert!(decide_git(&TokenAccess::full(), true, false).allowed);
1110 }
1111
1112 #[test]
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member1113 fn packages_need_their_own_scopes_and_public_pulls_none() {
1114 let reader = token(&[Scope::PackagesRead]);
1115 assert!(decide_packages(&reader, Level::Read, false).allowed);
1116 assert!(!decide_packages(&reader, Level::Write, false).allowed);
1117 let code = token(&[Scope::CodeWrite]);
1118 assert!(!decide_packages(&code, Level::Read, false).allowed, "code scopes are not package scopes");
1119 assert!(decide_packages(&code, Level::Read, true).allowed, "public packages pull with any token");
1120 let writer = token(&[Scope::PackagesWrite]);
1121 assert!(decide_packages(&writer, Level::Write, false).allowed);
1122 assert!(decide_packages(&writer, Level::Read, false).allowed, "packages:write includes packages:read");
1123 let refused = decide_packages(&writer, Level::Delete, false);
1124 assert!(refused.reason.unwrap().contains("packages:delete"));
1125 assert!(decide_packages(&token(&[Scope::PackagesDelete]), Level::Write, false).allowed);
1126 assert!(Scope::PackagesDelete.dangerous());
1127 // Tokens made before these scopes, and full-access ones, keep working.
1128 let legacy = TokenAccess { legacy: true, ..TokenAccess::full() };
1129 assert!(decide_packages(&legacy, Level::Delete, false).allowed);
1130 assert!(decide_packages(&TokenAccess::full(), Level::Write, false).allowed);
1131 }
1132
1133 #[test]
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1134 fn token_access_travels_as_json() {
1135 let access = token(&[Scope::IssuesRead]);
1136 let wire = serde_json::to_value(&access).unwrap();
1137 assert_eq!(wire["scopes"], json!(["issues:read"]));
1138 assert!(wire.get("resources").is_none());
1139 let back: TokenAccess = serde_json::from_value(wire).unwrap();
1140 assert_eq!(back, access);
1141 let full: TokenAccess = serde_json::from_value(json!({})).unwrap();
1142 assert!(full.is_full());
1143 // A reach written by an older version is ignored: a token reaches
1144 // whatever its owner can.
1145 let older: TokenAccess = serde_json::from_value(json!({
1146 "token_id": "tok_1",
1147 "scopes": ["issues:read"],
1148 "resources": { "kind": "repositories", "repositories": ["acme/rocket"] },
1149 }))
1150 .unwrap();
1151 assert_eq!(older, access);
1152 }
1153
1154 /// The site's copy of the table, `packages/contracts/src/scopes.ts`,
1155 /// lists the same scopes in the same order, the same operations with
1156 /// the same scopes, and the same presets.
1157 #[test]
1158 fn the_typescript_mirror_has_the_same_table() {
1159 let ts = include_str!("../../../packages/contracts/src/scopes.ts");
1160 let section = |start: &str| {
1161 ts.split_once(start)
1162 .and_then(|(_, rest)| rest.split_once("] as const"))
1163 .map(|(table, _)| table)
1164 .unwrap_or_else(|| panic!("{start} in scopes.ts"))
1165 };
1166 let scopes: Vec<&str> = section("export const SCOPES = [")
1167 .lines()
1168 .filter_map(|line| line.split_once("scope: \"").and_then(|(_, rest)| rest.split_once('"')).map(|(scope, _)| scope))
1169 .collect();
1170 let expected: Vec<&str> = Scope::ALL.iter().map(|scope| scope.as_str()).collect();
1171 assert_eq!(scopes, expected);
1172 let operations: Vec<(String, String)> = section("export const OPERATION_SCOPES = [")
1173 .lines()
1174 .filter_map(|line| {
1175 let mut quoted = line.split('"').skip(1).step_by(2);
1176 Some((quoted.next()?.to_owned(), quoted.next()?.to_owned()))
1177 })
1178 .collect();
1179 let expected: Vec<(String, String)> = OPERATIONS
1180 .iter()
1181 .map(|(name, scope)| ((*name).to_owned(), scope.as_str().to_owned()))
1182 .collect();
1183 assert_eq!(operations, expected);
1184 for preset in Preset::ALL {
1185 let list = section(&format!("{}: [", preset.as_str()));
1186 let mirrored: Vec<&str> = list
1187 .split(',')
1188 .map(|item| item.trim().trim_matches('"'))
1189 .filter(|item| !item.is_empty())
1190 .collect();
1191 let expected: Vec<&str> = preset
1192 .scopes()
1193 .map(|scopes| scopes.iter().map(|scope| scope.as_str()).collect())
1194 .unwrap_or_else(|| vec!["*"]);
1195 assert_eq!(mirrored, expected, "{}", preset.as_str());
1196 }
1197 }
1198}

This file's history is long; its oldest lines are credited to the oldest commit read.