crates/contracts/src/scopes.rs · flagon-io/g1t

Scope::SecurityRead => "See secret scanning, code scanning and vulnerability alerts, custom patterns, the dependency graph and SBOM, and security settings",

418

Scope::SecurityWrite => "Dismiss and reopen alerts, bypass push protection, review bypass requests, manage custom patterns, upload SARIF and change security settings",

419

Scope::PackagesRead => "Pull container images and install private packages",

420

Scope::PackagesWrite => "Push container images and publish packages",

421

Scope::PackagesDelete => "Delete and restore packages and their versions",

422

Scope::IssuesRead => "Read issues and comments",

423

Scope::IssuesWrite => "Open, edit, close and comment on issues",

424

Scope::PullRequestsRead => "Read pull requests, their changes, sessions and merge queues",

425

Scope::PullRequestsWrite => "Open, review, close and merge pull requests",

426

Scope::AgentsRun => "Retired: put g1t's own agents to work. Grants nothing now",

427

Scope::WorkflowsRead => "Read workflows, runs and logs",

428

Scope::WorkflowsWrite => "Run, cancel, rerun and turn workflows on or off",

429

Scope::WorkflowFilesWrite => "Add, change and delete workflow files under .g1t/workflows and .github/workflows, with git or the API",

430

Scope::ChecksRead => "Read commits' statuses, check runs, check suites and annotations",

431

Scope::ChecksWrite => "Report statuses and check runs on commits, and ask for checks to run again",

432

Scope::DeploymentsRead => "See deployments, their statuses and environments",

433

Scope::DeploymentsWrite => "Report deployments and their statuses, from any CI",

434

Scope::ObservabilityRead => "See projects' requests, logs, traces, errors and metrics, and their observability settings, ingest tokens and exports",

435

Scope::ObservabilityWrite => "Resolve and ignore errors, and change projects' observability settings, ingest tokens and exports",

436

Scope::MemoryRead => "Retired: recall project and workspace memory. Grants nothing now",

437

Scope::MemoryWrite => "Retired: save project and workspace memory. Grants nothing now",

438

Scope::AccountRead => "Read your email addresses, invites, invitations, pinned projects and stars",

439

Scope::AccountWrite => "Change your email addresses, make invites, answer invitations, pin projects and star repositories",

440

Scope::NotificationsRead => "See your inbox, its threads, and what you subscribe to and watch",

441

Scope::NotificationsWrite => "Mark notifications read, done, saved or snoozed, subscribe to threads and watch repositories",

442

Scope::ChatRead => "Read the conversations you are in: channels, direct messages, threads and reactions, live",

443

Scope::ChatWrite => "Send, edit and delete your messages, react, mark conversations read, and answer cards in chat",

444

Scope::WorkspaceRead => "Read workspace settings, invites, integrations, AI providers, teams and rulesets",

445

Scope::WorkspaceAdmin => "Create and delete workspaces, invite members, connect integrations, add AI providers and choose what Ask answers with, create, change and delete teams, and change the workspace's rulesets",

446

Scope::BillingRead => "See a workspace's usage, budget and invoices",

447

Scope::BillingWrite => "Change a workspace's budget",

448

Scope::AccessRead => "See who has access to repositories",

449

Scope::AccessAdmin => "Give and take away access to repositories, a team's included",

450

Scope::WebhooksRead => "See webhooks and their deliveries",

451

Scope::WebhooksAdmin => "Create, change and delete webhooks",

452

Scope::SecretsRead => "List secrets (never their values) and read variables",

453

Scope::SecretsAdmin => "Set and delete secrets and variables",

454

Scope::RunnersRead => "See self-hosted runners and their groups",

455

Scope::RunnersAdmin => "Register and remove self-hosted runners, change their groups and settings",

456

Scope::ModelsRead => "Retired: see the AI Gateway's requests. Grants nothing now",

457

Scope::ModelsWrite => "Retired: send requests through the AI Gateway. Grants nothing now",

458

Scope::ArtifactsRead => "List, read and search artifacts you can see, their versions, and the numbers their dashboards show",

459

Scope::ArtifactsWrite => "Create, rename, move, edit, trash and restore artifacts, and propose changes to them",

460

Scope::ArtifactsAdmin => "Share artifacts, change who can open them, and delete them for good",

}

}

/// Whether tokens are offered it yet: its resource's [`Resource::offered`].

465

pub fn offered(self) -> bool {

466

self.resource().offered()

}

}

/// Every scope tokens are offered, in table order: what OAuth advertises.

471

pub fn offered_scopes() -> Vec<Scope> {

472

Scope::ALL.into_iter().filter(|scope| scope.offered()).collect()

473

}

474

475

impl Serialize for Scope {

476

fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {

477

serializer.serialize_str(self.as_str())

}

}

impl<'de> Deserialize<'de> for Scope {

482

fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {

483

let text = String::deserialize(deserializer)?;

484

Scope::parse(&text).ok_or_else(|| serde::de::Error::custom(format!("unknown scope {text}")))

}

}

/// Scopes as written in a token's row or an OAuth request: separated by

489

/// spaces or commas. Unknown names are left out, so a client asking for a

490

/// scope from a newer version gets the rest.

491

pub fn parse_scopes(text: &str) -> Vec<Scope> {

492

let mut scopes: Vec<Scope> = text

493

.split(|c: char| c.is_whitespace() || c == ',')

494

.filter_map(Scope::parse)

495

.filter(|scope| scope.offered())

496

.collect();

497

normalize(&mut scopes);

scopes

}

/// In table order, without repeats.

502

pub fn normalize(scopes: &mut Vec<Scope>) {

503

let given = std::mem::take(scopes);

504

scopes.extend(Scope::ALL.into_iter().filter(|scope| given.contains(scope)));

505

}

506

507

/// Space-separated, as stored and as OAuth writes them.

508

pub fn scopes_text(scopes: &[Scope]) -> String {

509

scopes.iter().map(|scope| scope.as_str()).collect::<Vec<_>>().join(" ")

510

}

511

512

/// Where a resource sits on the token form, and which tokens may hold it.

513

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]

514

#[serde(rename_all = "snake_case")]

515

pub enum ResourceGroup {

516

/// About repositories: what they hold and how they are run.

517

Repository,

518

/// About a workspace itself.

519

Workspace,

520

/// About the person: only a personal token may hold these.

Account,

}

impl ResourceGroup {

pub const ALL: [ResourceGroup; 3] = [ResourceGroup::Repository, ResourceGroup::Workspace, ResourceGroup::Account];

526

527

pub fn as_str(self) -> &'static str {

528

match self {

529

ResourceGroup::Repository => "repository",

530

ResourceGroup::Workspace => "workspace",

531

ResourceGroup::Account => "account",

}

}

}

impl Resource {

pub fn group(self) -> ResourceGroup {

538

match self {

539

Resource::Account | Resource::Notifications | Resource::Chat => ResourceGroup::Account,

540

Resource::Workspace | Resource::Billing | Resource::Runners | Resource::Models | Resource::Artifacts => ResourceGroup::Workspace,

541

_ => ResourceGroup::Repository,

}

}

pub fn parse(text: &str) -> Option<Resource> {

546

let text = text.trim().to_ascii_lowercase();

547

Resource::ALL.into_iter().find(|resource| resource.as_str() == text)

548

}

549

550

/// Its scopes, least first.

551

pub fn scopes(self) -> Vec<Scope> {

552

Scope::ALL.into_iter().filter(|scope| scope.resource() == self).collect()

}

}

// --- Permissions --------------------------------------------------------------

557

//

558

// A token's permissions are its scopes read per resource: each resource

559

// at none or one level (`{"issues": "write", "repo": "read"}`). A level

560

// includes the ones below it, so the highest scope held of each resource

561

// says everything; that is what a token stores. Personal tokens and a

562

// workspace's own tokens are made, shown and checked this way alike.

563

564

/// The highest scope of each resource held, in table order: the fewest

565

/// scopes that give the same access, as tokens store them.

566

pub fn top_scopes(scopes: &[Scope]) -> Vec<Scope> {

567

let mut top: Vec<Scope> = Vec::new();

568

for resource in Resource::ALL {

569

if let Some(best) = scopes.iter().filter(|scope| scope.resource() == resource).max_by_key(|scope| scope.level()) {

top.push(*best);

}

}

normalize(&mut top);

top

}

/// Every resource at its highest level: all a token can be given.

578

pub fn everything() -> Vec<Scope> {

579

top_scopes(&offered_scopes())

580

}

581

582

/// Scopes as permissions: each resource held, by name, at its highest

583

/// level held.

584

pub fn permissions_of(scopes: &[Scope]) -> std::collections::BTreeMap<String, String> {

585

top_scopes(scopes)

586

.into_iter()

587

.map(|scope| (scope.resource().as_str().to_owned(), scope.level().as_str().to_owned()))

.collect()

}

/// Permissions as asked for (`{"issues": "write"}`, `none` or empty left

592

/// out) into the scopes a token stores, or why they cannot be. `personal`

593

/// is whether the token is a person's: only theirs may hold account ones.

594

pub fn resolve_permissions(asked: &std::collections::BTreeMap<String, String>, personal: bool) -> Result<Vec<Scope>, String> {

595

let mut scopes = Vec::new();

596

for (name, level) in asked {

597

let Some(resource) = Resource::parse(name).filter(|resource| resource.offered()) else {

598

return Err(format!("There is no permission called {name}."));

599

};

600

let level = level.trim().to_ascii_lowercase();

601

if level.is_empty() || level == "none" {

602

continue;

603

}

604

let Some(scope) = Scope::parse(&format!("{}:{level}", resource.as_str())) else {

605

let levels: Vec<&str> = resource.scopes().iter().map(|scope| scope.level().as_str()).collect();

606

return Err(format!("{} is none or {}, not {level}.", resource.as_str(), levels.join(", ")));

607

};

608

if resource.group() == ResourceGroup::Account && !personal {

609

return Err(format!("{} is about a person's account: a workspace's token cannot hold it.", resource.as_str()));

}

scopes.push(scope);

}

Ok(top_scopes(&scopes))

614

}

615

616

/// What a token stores for full access, which is not a scope a client can

617

/// ask for by name.

618

pub const FULL_ACCESS: &str = "*";

619

620

/// Starting points for choosing scopes.

621

#[derive(Clone, Copy, Debug, PartialEq, Eq)]

pub enum Preset {

ReadOnly,

Agent,

Ci,

Full,

}

impl Preset {

pub const ALL: [Preset; 4] = [Preset::ReadOnly, Preset::Agent, Preset::Ci, Preset::Full];

631

632

pub fn as_str(self) -> &'static str {

633

match self {

634

Preset::ReadOnly => "read_only",

635

Preset::Agent => "agent",

636

Preset::Ci => "ci",

637

Preset::Full => "full",

}

}

pub fn label(self) -> &'static str {

642

match self {

643

Preset::ReadOnly => "Read only",

644

Preset::Agent => "Agent",

645

Preset::Ci => "CI",

646

Preset::Full => "Full access",

}

}

/// Its scopes; `None` for full access.

651

pub fn scopes(self) -> Option<Vec<Scope>> {

652

// Chat is not in any: a person's conversations go to an application

653

// only when it asks for them by name.

let reads = || {

Scope::ALL

.into_iter()

.filter(|scope| scope.level() == Level::Read && scope.offered() && scope.resource() != Resource::Chat)

658

};

659

match self {

660

Preset::ReadOnly => Some(reads().collect()),

661

Preset::Agent => {

662

// Not the machines work runs on: an agent has no business

663

// knowing a workspace's own runners.

664

let mut scopes: Vec<Scope> = reads().filter(|scope| scope.resource() != Resource::Runners).collect();

665

// And answering what needs the person it works for: marking

666

// it done, subscribing, watching.

667

// And starting a repository for what it builds, which changes

668

// nothing already there: `repo:write` would let it change

669

// merge settings and delete branches and releases.

scopes.extend([

Scope::RepoCreate,

Scope::CodeWrite,

Scope::IssuesWrite,

Scope::PullRequestsWrite,

675

Scope::NotificationsWrite,

676

]);

677

normalize(&mut scopes);

678

Some(scopes)

679

}

680

Preset::Ci => Some(vec![

Scope::RepoRead,

Scope::CodeRead,

Scope::CodeWrite,

Scope::PackagesRead,

Scope::PackagesWrite,

686

Scope::WorkflowsRead,

687

Scope::WorkflowsWrite,

688

Scope::ChecksRead,

689

Scope::ChecksWrite,

690

Scope::DeploymentsRead,

691

Scope::DeploymentsWrite,

692

]),

693

Preset::Full => None,

}

}

}

/// What an OAuth client gets when it asks for nothing in particular: the

699

/// agent preset. Never an admin scope.

700

pub fn oauth_default() -> Vec<Scope> {

701

Preset::Agent.scopes().unwrap_or_default()

702

}

703

704

/// Set on a [`crate::User`] resolved from an access token: what the token

705

/// may do. Absent on a signed-in session, which may do whatever its person

706

/// can.

707

#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]

708

pub struct TokenAccess {

709

/// The token's id, as audit entries and errors name it.

710

#[serde(default)]

711

pub token_id: String,

712

/// Its scopes, as `resource:level`. Absent: full access, everything the

713

/// person (or workspace) can do.

714

#[serde(default, skip_serializing_if = "Option::is_none")]

715

pub scopes: Option<Vec<String>>,

716

/// Made before tokens had scopes: full access until someone narrows it.

717

#[serde(default, skip_serializing_if = "std::ops::Not::not")]

718

pub legacy: bool,

719

/// Set on a workflow job's token (`G1T_TOKEN`): the one repository it

720

/// reaches, as `owner/name`. Every other is refused, whatever its owner

721

/// could reach.

722

#[serde(default, skip_serializing_if = "Option::is_none")]

723

pub repo: Option<String>,

724

/// Set on a workflow job's token: the run and job it was made for. The

725

/// audit log records its changes as that job's, and what it changes

726

/// starts no workflows (only `workflow_dispatch` and

727

/// `repository_dispatch` do), so a workflow cannot set itself off.

728

#[serde(default, skip_serializing_if = "Option::is_none")]

729

pub job: Option<JobToken>,

730

/// The token's name, as its owner gave it, so a log can say which

731

/// token made a request. Absent where whoever resolved it did not say.

732

#[serde(default, skip_serializing_if = "Option::is_none")]

733

pub name: Option<String>,

734

/// Set on a token narrowed to less than its owner can reach: one

735

/// workspace (all, selected or none of its private repositories), or

736

/// none at all (its owner's account and public repositories). Absent

737

/// on a token that reaches every workspace its owner can.

738

///

739

/// The wire key is `fine_grained`, kept from before tokens were one

740

/// kind, so services deployed at different moments agree on it.

741

#[serde(rename = "fine_grained", default, skip_serializing_if = "Option::is_none")]

742

pub reach: Option<TokenReach>,

743

/// Set on a workspace's own token that an owner gave Admin when making

744

/// it. Without it a workspace's token has Write on the workspace's

745

/// repositories, as a member would (see [`crate::access`]).

746

#[serde(default, skip_serializing_if = "std::ops::Not::not")]

747

pub admin: bool,

748

/// Set on what a repository's deploy key resolves to: the key's id. Its

749

/// `repo` is the one repository it reaches.

750

#[serde(default, skip_serializing_if = "Option::is_none")]

751

pub deploy_key: Option<String>,

752

/// Set on a person's token whose owner let it use the website (g1t.sh)

753

/// as them, sent as `Authorization: Bearer`. Not a scope: no preset,

754

/// full access or OAuth grant includes it, and git, the API and MCP

755

/// ignore it.

756

#[serde(default, skip_serializing_if = "std::ops::Not::not")]

pub website: bool,

}

/// Which repositories a token reaches in the workspace it is made for.

761

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]

762

#[serde(rename_all = "snake_case")]

763

pub enum RepositorySelection {

764

/// Every repository of the workspace, ones made later included.

765

#[default]

766

All,

767

/// The repositories chosen, by id.

768

Selected,

769

/// None of the workspace's private repositories: public repositories,

770

/// read-only, and the workspace's own settings its permissions allow.

771

/// With no workspace: the owner's account and public repositories only.

Public,

}

impl RepositorySelection {

776

pub fn as_str(self) -> &'static str {

777

match self {

778

RepositorySelection::All => "all",

779

RepositorySelection::Selected => "selected",

780

RepositorySelection::Public => "public",

}

}

pub fn parse(text: &str) -> Option<RepositorySelection> {

785

match text.trim().to_ascii_lowercase().as_str() {

786

"all" => Some(RepositorySelection::All),

787

"selected" => Some(RepositorySelection::Selected),

788

"public" | "public_only" | "none" => Some(RepositorySelection::Public),

_ => None,

}

}

}

/// What a narrowed token reaches, as identity resolves it on each use.

795

#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]

796

pub struct TokenReach {

797

/// The workspace whose repositories and settings it reaches, by slug as

798

/// it is now. Absent: its owner's account only, with public

799

/// repositories read-only.

800

#[serde(default, skip_serializing_if = "Option::is_none")]

801

pub workspace: Option<String>,

802

#[serde(default)]

803

pub repositories: RepositorySelection,

804

/// With [`RepositorySelection::Selected`]: the repositories' ids.

805

#[serde(default, skip_serializing_if = "Vec::is_empty")]

806

pub repo_ids: Vec<String>,

}

impl TokenReach {

/// Whether it reaches the repository with this id in the workspace

811

/// `namespace` for more than what anyone may do with a public one.

812

pub fn covers(&self, repo_id: &str, namespace: &str) -> bool {

813

let Some(workspace) = self.workspace.as_deref() else {

814

return false;

815

};

816

if !workspace.eq_ignore_ascii_case(namespace) {

817

return false;

818

}

819

match self.repositories {

820

RepositorySelection::All => true,

821

RepositorySelection::Selected => self.repo_ids.iter().any(|id| id == repo_id),

822

RepositorySelection::Public => false,

}

}

/// Whether it is made for the workspace `slug`.

827

pub fn owned_by(&self, slug: &str) -> bool {

828

self.workspace.as_deref().is_some_and(|workspace| workspace.eq_ignore_ascii_case(slug))

}

}

/// Where workflow files live. Adding, changing or deleting a file under

833

/// one, with git or through g1t, needs [`Scope::WorkflowFilesWrite`] from a

834

/// token: what GitHub's `workflow` scope and `workflows` permission do.

835

pub const WORKFLOW_DIRS: [&str; 2] = [".g1t/workflows/", ".github/workflows/"];

836

837

/// Whether `path` is a workflow file, or a file in one's directory.

838

pub fn is_workflow_file(path: &str) -> bool {

839

let path = path.trim_start_matches('/');

840

WORKFLOW_DIRS.iter().any(|dir| {

841

path.len() >= dir.len() && path.is_char_boundary(dir.len()) && path[..dir.len()].eq_ignore_ascii_case(dir)

842

}) || WORKFLOW_DIRS.iter().any(|dir| path.eq_ignore_ascii_case(dir.trim_end_matches('/')))

843

}

844

845

/// Whether a token may add, change or delete the files at `paths`: a

846

/// refusal naming the first workflow file it may not touch, else `None`.

847

/// A signed-in person (no token) is never refused here; their role decides.

848

pub fn decide_workflow_files<'a>(access: Option<&TokenAccess>, paths: impl IntoIterator<Item = &'a str>) -> Option<Decision> {

849

let access = access?;

850

if access.allows(Scope::WorkflowFilesWrite) && access.job.is_none() {

851

return None;

852

}

853

let path = paths.into_iter().find(|path| is_workflow_file(path))?;

854

let why = if access.job.is_some() {

855

"a workflow job's token can never add or change workflow files".to_owned()

856

} else {

857

format!("it needs the {} scope", Scope::WorkflowFilesWrite.as_str())

};

Some(Decision::deny(

"token:workflows",

format!("This access token cannot change the workflow file {path}: {why}."),

))

}

/// The workflow job a token was made for.

866

#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]

867

pub struct JobToken {

868

/// The run, `run_…`.

869

pub run_id: String,

870

/// The job, `job_…`.

871

pub job_id: String,

872

/// Whether it may open pull requests and approve them, by its

873

/// repository's and workspace's choice ("Allow g1t Actions to create and

874

/// approve pull requests"). Off unless chosen.

875

#[serde(default)]

876

pub pull_requests: bool,

}

impl TokenAccess {

/// Full access to everything: the access tokens made before scopes had.

881

pub fn full() -> Self {

882

TokenAccess::default()

883

}

884

885

/// Whether it may reach the repository `owner/name`: every token but a

886

/// workflow job's, which reaches its own repository only.

887

pub fn reaches(&self, repo: &str) -> bool {

888

self.repo.as_deref().is_none_or(|only| only.eq_ignore_ascii_case(repo))

889

}

890

891

pub fn is_full(&self) -> bool {

892

self.scopes.is_none()

893

}

894

895

/// The scopes it holds, or `None` for full access.

896

pub fn granted(&self) -> Option<Vec<Scope>> {

897

self.scopes

898

.as_ref()

899

.map(|scopes| scopes.iter().filter_map(|scope| Scope::parse(scope)).collect())

900

}

901

902

pub fn allows(&self, needed: Scope) -> bool {

903

match self.granted() {

904

None => true,

905

Some(granted) => granted.iter().any(|held| held.includes(needed)),

}

}

/// Whether it reaches the repository with this id in `namespace` for

910

/// more than reading a public one: every token but a narrowed one

911

/// outside its workspace or repository selection. Its owner's role

912

/// still decides; see [`crate::access`].

913

pub fn covers_repo(&self, repo_id: &str, namespace: &str) -> bool {

914

self.reach.as_ref().is_none_or(|reach| reach.covers(repo_id, namespace))

}

}

/// Every operation of the API and MCP server, with the scope it needs. An

919

/// operation in [`NO_SCOPE`] needs none. The API checks that every one of

920

/// its operations is in exactly one of the two.

921

pub const OPERATIONS: &[(&str, Scope)] = &[

922

// Your account.

923

("list_emails", Scope::AccountRead),

924

("add_email", Scope::AccountWrite),

925

("confirm_email", Scope::AccountWrite),

926

("remove_email", Scope::AccountWrite),

927

("update_email_settings", Scope::AccountWrite),

928

("list_invites", Scope::AccountRead),

929

("create_invite", Scope::AccountWrite),

930

("revoke_invite", Scope::AccountWrite),

931

("resend_invite", Scope::AccountWrite),

932

("list_invitations", Scope::AccountRead),

933

("accept_invitation", Scope::AccountWrite),

934

("decline_invitation", Scope::AccountWrite),

935

("list_my_repo_invitations", Scope::AccountRead),

936

("accept_repo_invitation", Scope::AccountWrite),

937

("decline_repo_invitation", Scope::AccountWrite),

938

// Your pinned projects: a preference of your account.

939

("list_pinned_projects", Scope::AccountRead),

940

("pin_project", Scope::AccountWrite),

941

// Your stars: a preference of your account.

942

("list_starred", Scope::AccountRead),

943

("check_starred", Scope::AccountRead),

944

("star_repo", Scope::AccountWrite),

945

("unstar_repo", Scope::AccountWrite),

946

("unpin_project", Scope::AccountWrite),

947

("reorder_pinned_projects", Scope::AccountWrite),

948

// Your inbox: notifications, subscriptions and watching.

949

("list_notifications", Scope::NotificationsRead),

950

("get_notification_thread", Scope::NotificationsRead),

951

("get_thread_subscription", Scope::NotificationsRead),

952

("get_repo_subscription", Scope::NotificationsRead),

953

("list_watched_repos", Scope::NotificationsRead),

954

("mark_notifications_read", Scope::NotificationsWrite),

955

("mark_thread_read", Scope::NotificationsWrite),

956

("mark_thread_done", Scope::NotificationsWrite),

957

("save_thread", Scope::NotificationsWrite),

958

("snooze_thread", Scope::NotificationsWrite),

959

("set_thread_subscription", Scope::NotificationsWrite),

960

("delete_thread_subscription", Scope::NotificationsWrite),

961

("set_repo_subscription", Scope::NotificationsWrite),

962

("delete_repo_subscription", Scope::NotificationsWrite),

963

// Workspaces, their invites and integrations.

964

("create_workspace", Scope::WorkspaceAdmin),

965

("delete_workspace", Scope::WorkspaceAdmin),

966

("get_workspace", Scope::WorkspaceRead),

967

("update_workspace", Scope::WorkspaceAdmin),

968

// Its members, and who owns it.

969

("list_members", Scope::WorkspaceRead),

970

("update_member", Scope::WorkspaceAdmin),

971

("remove_member", Scope::WorkspaceAdmin),

972

("transfer_ownership", Scope::WorkspaceAdmin),

973

("leave_workspace", Scope::AccountWrite),

974

("list_workspace_invites", Scope::WorkspaceRead),

975

("invite_member", Scope::WorkspaceAdmin),

976

("revoke_workspace_invite", Scope::WorkspaceAdmin),

977

("list_integrations", Scope::WorkspaceRead),

978

("connect_integration", Scope::WorkspaceAdmin),

979

("update_integration", Scope::WorkspaceAdmin),

980

("disconnect_integration", Scope::WorkspaceAdmin),

981

("test_integration", Scope::WorkspaceAdmin),

982

// Its AI: the AI providers it keeps keys for, and what Ask answers with.

983

("list_ai_providers", Scope::WorkspaceRead),

984

("add_ai_provider", Scope::WorkspaceAdmin),

985

("update_ai_provider", Scope::WorkspaceAdmin),

986

("remove_ai_provider", Scope::WorkspaceAdmin),

987

("test_ai_provider", Scope::WorkspaceAdmin),

988

("get_ask_settings", Scope::WorkspaceRead),

989

("set_ask_settings", Scope::WorkspaceAdmin),

990

// Teams: reading them, and managing them. A team's role on a

991

// repository is who has access.

992

("list_teams", Scope::WorkspaceRead),

993

("get_team", Scope::WorkspaceRead),

994

("list_team_members", Scope::WorkspaceRead),

995

("list_child_teams", Scope::WorkspaceRead),

996

("list_team_repos", Scope::WorkspaceRead),

997

("list_user_teams", Scope::WorkspaceRead),

998

("create_team", Scope::WorkspaceAdmin),

999

("list_workspace_rulesets", Scope::WorkspaceRead),

1000

("get_workspace_ruleset", Scope::WorkspaceRead),

1001

("list_workspace_rule_evaluations", Scope::WorkspaceRead),

1002

("create_workspace_ruleset", Scope::WorkspaceAdmin),

1003

("update_workspace_ruleset", Scope::WorkspaceAdmin),

1004

("delete_workspace_ruleset", Scope::WorkspaceAdmin),

1005

("update_team", Scope::WorkspaceAdmin),

1006

("delete_team", Scope::WorkspaceAdmin),

1007

("set_team_member", Scope::WorkspaceAdmin),

1008

("remove_team_member", Scope::WorkspaceAdmin),

1009

("set_team_review_assignment", Scope::WorkspaceAdmin),

1010

// A workspace's billing: usage, budget and invoices.

1011

("get_usage", Scope::BillingRead),

1012

("get_budget", Scope::BillingRead),

1013

("list_invoices", Scope::BillingRead),

1014

("get_billing_details", Scope::BillingRead),

1015

("set_budget", Scope::BillingWrite),

1016

// Repositories.

1017

("list_repos", Scope::RepoRead),

1018

("get_repo", Scope::RepoRead),

1019

("list_forks", Scope::RepoRead),

1020

// Comments on commits are read with the repository, and written as

1021

// comments on issues are.

1022

("list_repo_commit_comments", Scope::RepoRead),

1023

("list_commit_comments", Scope::RepoRead),

1024

// A repository's files, as clone and fetch need.

1025

// A file or directory of a repository, as clone and fetch would give it.

1026

("get_contents", Scope::CodeRead),

1027

("list_commits", Scope::CodeRead),

1028

("download_tarball_archive", Scope::CodeRead),

1029

("download_zipball_archive", Scope::CodeRead),

1030

("why", Scope::CodeRead),

1031

// Projects follow their repositories.

1032

("list_projects", Scope::RepoRead),

1033

("get_project", Scope::RepoRead),

1034

("search", Scope::RepoRead),

1035

("list_events", Scope::RepoRead),

1036

// A workspace's activity: the events of its repositories the caller can read.

1037

("get_workspace_activity", Scope::RepoRead),

1038

// What the default branch says about a repository, who starred it, and

1039

// its releases.

1040

("get_languages", Scope::RepoRead),

1041

("list_contributors", Scope::RepoRead),

1042

("get_license", Scope::RepoRead),

1043

("list_stargazers", Scope::RepoRead),

1044

("list_releases", Scope::RepoRead),

1045

("get_latest_release", Scope::RepoRead),

1046

("get_release_by_tag", Scope::RepoRead),

1047

("get_release", Scope::RepoRead),

1048

("create_release", Scope::RepoWrite),

1049

("update_release", Scope::RepoWrite),

1050

("delete_release", Scope::RepoWrite),

1051

("list_labels", Scope::RepoRead),

1052

("list_milestones", Scope::RepoRead),

1053

("get_milestone", Scope::RepoRead),

1054

("create_label", Scope::IssuesWrite),

1055

("update_label", Scope::IssuesWrite),

1056

("delete_label", Scope::IssuesWrite),

1057

("add_default_labels", Scope::IssuesWrite),

1058

("create_milestone", Scope::IssuesWrite),

1059

("update_milestone", Scope::IssuesWrite),

1060

("delete_milestone", Scope::IssuesWrite),

1061

("get_repo_settings", Scope::RepoRead),

1062

("list_check_names", Scope::RepoRead),

1063

("list_deleted_repos", Scope::RepoRead),

1064

("list_security_alerts", Scope::RepoRead),

1065

("get_codeowners_errors", Scope::RepoRead),

1066

// Creating one changes nothing already there: `repo:create`, which

1067

// `repo:write` includes.

1068

("create_repo", Scope::RepoCreate),

1069

("update_repo", Scope::RepoWrite),

1070

("update_project", Scope::RepoWrite),

1071

("update_repo_settings", Scope::RepoWrite),

1072

// Rulesets: reading them is reading the repository; changing them

1073

// changes what everyone, agents included, may do, so it is admin.

1074

("list_repo_rulesets", Scope::RepoRead),

1075

("get_repo_ruleset", Scope::RepoRead),

1076

("get_branch_rules", Scope::RepoRead),

1077

("list_rule_evaluations", Scope::RepoRead),

1078

("create_repo_ruleset", Scope::RepoAdmin),

1079

("update_repo_ruleset", Scope::RepoAdmin),

1080

("delete_repo_ruleset", Scope::RepoAdmin),

1081

("rename_branch", Scope::RepoWrite),

1082

("create_branch", Scope::RepoWrite),

1083

("delete_branch", Scope::RepoWrite),

1084

("rename_repo", Scope::RepoAdmin),

1085

("transfer_repo", Scope::RepoAdmin),

1086

// Forking makes a repository, as create_repo does; syncing moves a

1087

// fork's branch; detaching changes what the fork is.

1088

("fork_repo", Scope::RepoWrite),

1089

("sync_fork", Scope::RepoWrite),

1090

("detach_fork", Scope::RepoAdmin),

1091

("archive_repo", Scope::RepoAdmin),

1092

("unarchive_repo", Scope::RepoAdmin),

1093

("set_repo_visibility", Scope::RepoAdmin),

1094

("delete_repo", Scope::RepoAdmin),

1095

("restore_repo", Scope::RepoAdmin),

1096

("purge_repo", Scope::RepoAdmin),

1097

// A dismissed secret is let through push protection.

1098

("dismiss_security_alert", Scope::RepoAdmin),

1099

("reopen_security_alert", Scope::RepoAdmin),

1100

// The security suite: alerts, push protection, patterns, code

1101

// scanning, the supply chain and settings.

1102

("list_secret_scanning_alerts", Scope::SecurityRead),

1103

("get_secret_scanning_alert", Scope::SecurityRead),

1104

("list_secret_scanning_locations", Scope::SecurityRead),

1105

("list_bypass_requests", Scope::SecurityRead),

1106

("list_custom_patterns", Scope::SecurityRead),

1107

("list_code_scanning_alerts", Scope::SecurityRead),

1108

("get_code_scanning_alert", Scope::SecurityRead),

1109

("list_code_scanning_analyses", Scope::SecurityRead),

1110

("get_sarif_upload", Scope::SecurityRead),

1111

("list_vulnerability_alerts", Scope::SecurityRead),

1112

("get_vulnerability_alert", Scope::SecurityRead),

1113

("get_dependency_graph", Scope::SecurityRead),

1114

("get_sbom", Scope::SecurityRead),

1115

("compare_dependencies", Scope::SecurityRead),

1116

("rerun_dependency_review", Scope::SecurityWrite),

1117

("get_security_settings", Scope::SecurityRead),

1118

("get_workspace_security_settings", Scope::SecurityRead),

1119

("get_security_overview", Scope::SecurityRead),

1120

("list_security_advisories", Scope::SecurityRead),

1121

("get_security_advisory", Scope::SecurityRead),

1122

("list_vulnerability_reports", Scope::SecurityRead),

1123

("update_secret_scanning_alert", Scope::SecurityWrite),

1124

("bypass_push_protection", Scope::SecurityWrite),

1125

("check_secret_validity", Scope::SecurityWrite),

1126

("review_bypass_request", Scope::SecurityWrite),

1127

("create_custom_pattern", Scope::SecurityWrite),

1128

("update_custom_pattern", Scope::SecurityWrite),

1129

("delete_custom_pattern", Scope::SecurityWrite),

1130

("dry_run_custom_pattern", Scope::SecurityWrite),

1131

("update_code_scanning_alert", Scope::SecurityWrite),

1132

("upload_sarif", Scope::SecurityWrite),

1133

("update_vulnerability_alert", Scope::SecurityWrite),

1134

("update_security_settings", Scope::SecurityWrite),

1135

("update_workspace_security_settings", Scope::SecurityWrite),

1136

("create_security_advisory", Scope::SecurityWrite),

1137

("update_security_advisory", Scope::SecurityWrite),

1138

("set_security_advisory_state", Scope::SecurityWrite),

1139

("report_vulnerability", Scope::SecurityWrite),

1140

("review_vulnerability_report", Scope::SecurityWrite),

1141

// Issues.

1142

("list_issues", Scope::IssuesRead),

1143

("get_issue", Scope::IssuesRead),

1144

("create_issue", Scope::IssuesWrite),

1145

("update_issue", Scope::IssuesWrite),

1146

("list_issue_labels", Scope::IssuesRead),

1147

("add_issue_labels", Scope::IssuesWrite),

1148

("set_issue_labels", Scope::IssuesWrite),

1149

("remove_issue_labels", Scope::IssuesWrite),

1150

("close_issue", Scope::IssuesWrite),

1151

("reopen_issue", Scope::IssuesWrite),

1152

("add_comment", Scope::IssuesWrite),

1153

("edit_comment", Scope::IssuesWrite),

1154

("delete_comment", Scope::IssuesWrite),

1155

("react", Scope::IssuesWrite),

1156

("create_commit_comment", Scope::IssuesWrite),

1157

("update_commit_comment", Scope::IssuesWrite),

1158

("delete_commit_comment", Scope::IssuesWrite),

1159

// Looking up a ticket the work refers to, through the workspace's

1160

// integrations, and bringing one in as an issue.

1161

("get_context", Scope::IssuesRead),

1162

("import_issue", Scope::IssuesWrite),

1163

// Coordinating work on issues: claims, and the context to pick one up.

1164

("list_claims", Scope::IssuesRead),

1165

("get_work", Scope::IssuesRead),

1166

("claim_issue", Scope::IssuesWrite),

1167

("release_claim", Scope::IssuesWrite),

1168

("hand_off_issue", Scope::IssuesWrite),

1169

// Pull requests.

1170

("list_pull_requests", Scope::PullRequestsRead),

1171

("get_pull_request", Scope::PullRequestsRead),

1172

("get_pull_request_changes", Scope::PullRequestsRead),

1173

("read_session", Scope::PullRequestsRead),

1174

("get_merge_queue", Scope::PullRequestsRead),

1175

("get_pull_request_merge_options", Scope::PullRequestsRead),

1176

("list_decisions", Scope::PullRequestsRead),

1177

("create_pull_request", Scope::PullRequestsWrite),

1178

("update_pull_request", Scope::PullRequestsWrite),

1179

("record_session", Scope::PullRequestsWrite),

1180

("record_decision", Scope::PullRequestsWrite),

1181

("mark_pull_request_ready", Scope::PullRequestsWrite),

1182

("close_pull_request", Scope::PullRequestsWrite),

1183

("reopen_pull_request", Scope::PullRequestsWrite),

1184

("convert_pull_request_to_draft", Scope::PullRequestsWrite),

1185

("review_pull_request", Scope::PullRequestsWrite),

1186

("merge_pull_request", Scope::PullRequestsWrite),

1187

("update_pull_request_branch", Scope::PullRequestsWrite),

1188

("enable_pull_request_auto_merge", Scope::PullRequestsWrite),

1189

("disable_pull_request_auto_merge", Scope::PullRequestsWrite),

1190

("delete_pull_request_head_branch", Scope::PullRequestsWrite),

1191

("restore_pull_request_head_branch", Scope::PullRequestsWrite),

1192

("request_reviewers", Scope::PullRequestsWrite),

1193

("remove_requested_reviewers", Scope::PullRequestsWrite),

1194

// Harness sessions, which record how pull requests are made.

1195

("get_session", Scope::PullRequestsRead),

1196

("list_sessions", Scope::PullRequestsRead),

1197

("start_session", Scope::PullRequestsWrite),

1198

("update_session", Scope::PullRequestsWrite),

1199

("end_session", Scope::PullRequestsWrite),

1200

("record_session_entries", Scope::PullRequestsWrite),

1201

("start_agent_session", Scope::PullRequestsWrite),

1202

// Workflows.

1203

("list_workflows", Scope::WorkflowsRead),

1204

("get_workflow", Scope::WorkflowsRead),

1205

("list_workflow_runs", Scope::WorkflowsRead),

1206

("get_workflow_run", Scope::WorkflowsRead),

1207

("get_job_logs", Scope::WorkflowsRead),

1208

("dispatch_workflow", Scope::WorkflowsWrite),

1209

("cancel_workflow_run", Scope::WorkflowsWrite),

1210

("rerun_workflow_run", Scope::WorkflowsWrite),

1211

("update_workflow", Scope::WorkflowsWrite),

1212

("list_artifacts", Scope::WorkflowsRead),

1213

("list_workflow_run_artifacts", Scope::WorkflowsRead),

1214

("get_artifact", Scope::WorkflowsRead),

1215

("download_artifact", Scope::WorkflowsRead),

1216

("get_artifact_retention", Scope::WorkflowsRead),

1217

("delete_artifact", Scope::WorkflowsWrite),

1218

("set_artifact_retention", Scope::WorkflowsWrite),

1219

("list_caches", Scope::WorkflowsRead),

1220

("get_cache_usage", Scope::WorkflowsRead),

1221

("delete_caches_by_key", Scope::WorkflowsWrite),

1222

("delete_cache", Scope::WorkflowsWrite),

1223

// Checks: statuses, check runs and check suites on commits.

1224

("list_commit_statuses", Scope::ChecksRead),

1225

("get_combined_status", Scope::ChecksRead),

1226

("list_check_runs_for_ref", Scope::ChecksRead),

1227

("get_check_run", Scope::ChecksRead),

1228

("list_check_run_annotations", Scope::ChecksRead),

1229

("list_check_suites_for_ref", Scope::ChecksRead),

1230

("get_check_suite", Scope::ChecksRead),

1231

("create_commit_status", Scope::ChecksWrite),

1232

("create_check_run", Scope::ChecksWrite),

1233

("update_check_run", Scope::ChecksWrite),

1234

("rerequest_check_run", Scope::ChecksWrite),

1235

("rerequest_check_suite", Scope::ChecksWrite),

1236

// Deployments, wherever they run: reading them, and reporting them.

1237

("list_deployments", Scope::DeploymentsRead),

1238

("get_deployment", Scope::DeploymentsRead),

1239

("list_deployment_statuses", Scope::DeploymentsRead),

1240

("list_environments", Scope::DeploymentsRead),

1241

("get_environment", Scope::DeploymentsRead),

1242

("create_deployment", Scope::DeploymentsWrite),

1243

("create_deployment_status", Scope::DeploymentsWrite),

1244

("start_deployment_build", Scope::DeploymentsWrite),

1245

// Observability: what a project's software did, and how it is collected.

1246

("get_observability_overview", Scope::ObservabilityRead),

1247

("list_requests", Scope::ObservabilityRead),

1248

("get_request", Scope::ObservabilityRead),

1249

("list_logs", Scope::ObservabilityRead),

1250

("list_traces", Scope::ObservabilityRead),

1251

("get_trace", Scope::ObservabilityRead),

1252

("list_errors", Scope::ObservabilityRead),

1253

("list_metrics", Scope::ObservabilityRead),

1254

("get_metric", Scope::ObservabilityRead),

1255

("get_observability_settings", Scope::ObservabilityRead),

1256

("list_ingest_tokens", Scope::ObservabilityRead),

1257

("list_telemetry_exports", Scope::ObservabilityRead),

1258

("get_observability_usage", Scope::ObservabilityRead),

1259

("update_error", Scope::ObservabilityWrite),

1260

("update_observability_settings", Scope::ObservabilityWrite),

1261

("create_ingest_token", Scope::ObservabilityWrite),

1262

("delete_ingest_token", Scope::ObservabilityWrite),

1263

("create_telemetry_export", Scope::ObservabilityWrite),

1264

("update_telemetry_export", Scope::ObservabilityWrite),

1265

("delete_telemetry_export", Scope::ObservabilityWrite),

1266

// What keeps runs safe: the runs environments hold and reviewing them,

1267

// approving a pull request's run, and a repository's own rules for

1268

// its environments and tokens, which are an admin's.

1269

("get_pending_deployments", Scope::WorkflowsRead),

1270

("review_pending_deployments", Scope::WorkflowsWrite),

1271

("approve_workflow_run", Scope::WorkflowsWrite),

1272

("get_workflow_permissions", Scope::RepoRead),

1273

("get_fork_pr_approval", Scope::RepoRead),

1274

("get_actions_access", Scope::RepoRead),

1275

("get_actions_permissions", Scope::RepoRead),

1276

("update_environment", Scope::RepoAdmin),

1277

("delete_environment", Scope::RepoAdmin),

1278

("set_workflow_permissions", Scope::RepoAdmin),

1279

("set_fork_pr_approval", Scope::RepoAdmin),

1280

("set_actions_access", Scope::RepoAdmin),

1281

("set_actions_permissions", Scope::RepoAdmin),

1282

// Starting workflows from outside, as a push would.

1283

("create_repository_dispatch", Scope::CodeWrite),

1284

// A workspace's policy for its repositories' tokens.

1285

("get_workspace_workflow_permissions", Scope::WorkspaceRead),

1286

("set_workspace_workflow_permissions", Scope::WorkspaceAdmin),

1287

// The workflows a workspace runs in its repositories: its owners'.

1288

("list_workspace_managed_workflows", Scope::WorkspaceRead),

1289

("create_workspace_managed_workflow", Scope::WorkspaceAdmin),

1290

("update_workspace_managed_workflow", Scope::WorkspaceAdmin),

1291

("delete_workspace_managed_workflow", Scope::WorkspaceAdmin),

1292

// A person's own Getting started in a workspace: reading it is reading

1293

// the workspace; dismissing it changes only their own account.

1294

("get_onboarding", Scope::WorkspaceRead),

1295

("update_onboarding", Scope::AccountWrite),

1296

// A workspace's rules for personal access tokens, and the members'

1297

// tokens that reach it: who has access.

1298

("get_token_policy", Scope::WorkspaceRead),

1299

("set_token_policy", Scope::WorkspaceAdmin),

1300

("list_member_tokens", Scope::AccessRead),

1301

("list_token_requests", Scope::AccessRead),

1302

("review_token_request", Scope::AccessAdmin),

1303

("revoke_member_token", Scope::AccessAdmin),

1304

// Who has access.

1305

("list_collaborators", Scope::AccessRead),

1306

("get_collaborator_permission", Scope::AccessRead),

1307

("list_repo_invitations", Scope::AccessRead),

1308

("list_outside_collaborators", Scope::AccessRead),

1309

("add_collaborator", Scope::AccessAdmin),

1310

("update_collaborator", Scope::AccessAdmin),

1311

("remove_collaborator", Scope::AccessAdmin),

1312

("revoke_repo_invitation", Scope::AccessAdmin),

1313

("set_base_permission", Scope::AccessAdmin),

1314

("set_team_repo", Scope::AccessAdmin),

1315

("remove_team_repo", Scope::AccessAdmin),

1316

// Deploy keys: each lets a machine reach one repository, so they

1317

// are part of who has access.

1318

("list_deploy_keys", Scope::AccessRead),

1319

("get_deploy_key", Scope::AccessRead),

1320

("create_deploy_key", Scope::AccessAdmin),

1321

("delete_deploy_key", Scope::AccessAdmin),

1322

// Webhooks.

1323

("list_webhooks", Scope::WebhooksRead),

1324

("list_webhook_deliveries", Scope::WebhooksRead),

1325

("create_webhook", Scope::WebhooksAdmin),

1326

("update_webhook", Scope::WebhooksAdmin),

1327

("delete_webhook", Scope::WebhooksAdmin),

1328

("ping_webhook", Scope::WebhooksAdmin),

1329

("redeliver_webhook", Scope::WebhooksAdmin),

1330

// Secrets and variables.

1331

("list_actions_secrets", Scope::SecretsRead),

1332

("list_actions_variables", Scope::SecretsRead),

1333

("set_actions_secret", Scope::SecretsAdmin),

1334

("delete_actions_secret", Scope::SecretsAdmin),

1335

("set_actions_variable", Scope::SecretsAdmin),

1336

("delete_actions_variable", Scope::SecretsAdmin),

1337

// Self-hosted runners.

1338

("list_runners", Scope::RunnersRead),

1339

("list_runner_groups", Scope::RunnersRead),

1340

("get_runner_settings", Scope::RunnersRead),

1341

("create_runner_registration_token", Scope::RunnersAdmin),

1342

("remove_runner", Scope::RunnersAdmin),

1343

("create_runner_group", Scope::RunnersAdmin),

1344

("update_runner_group", Scope::RunnersAdmin),

1345

("delete_runner_group", Scope::RunnersAdmin),

1346

("update_runner_settings", Scope::RunnersAdmin),

1347

// Packages: reading them, their versions and who may use them needs

1348

// `packages:read`; changing their settings, access and Manage Actions

1349

// access `packages:write` (and the Admin role on the package, which the

1350

// packages service checks); deleting and restoring packages and

1351

// versions `packages:delete`, as the registries' own deletes do.

1352

("list_packages", Scope::PackagesRead),

1353

("get_package", Scope::PackagesRead),

1354

("list_package_versions", Scope::PackagesRead),

1355

("get_package_version", Scope::PackagesRead),

1356

("list_package_access", Scope::PackagesRead),

1357

("list_package_actions_access", Scope::PackagesRead),

1358

("update_package", Scope::PackagesWrite),

1359

("link_package", Scope::PackagesWrite),

1360

("unlink_package", Scope::PackagesWrite),

1361

("set_package_access", Scope::PackagesWrite),

1362

("remove_package_access", Scope::PackagesWrite),

1363

("set_package_actions_access", Scope::PackagesWrite),

1364

("remove_package_actions_access", Scope::PackagesWrite),

1365

("delete_package", Scope::PackagesDelete),

1366

("restore_package", Scope::PackagesDelete),

1367

("delete_package_version", Scope::PackagesDelete),

1368

("restore_package_version", Scope::PackagesDelete),

1369

// Artifacts mode's docs, slides, designs and dashboards (the `artifact`

1370

// MCP tool). Reading takes artifacts:read, making and changing them

1371

// artifacts:write, and sharing them or deleting them for good

1372

// artifacts:admin. The artifacts service then checks the person's own role

1373

// on each one.

1374

("list_workspace_artifacts", Scope::ArtifactsRead),

1375

("search_workspace_artifacts", Scope::ArtifactsRead),

1376

("get_workspace_artifact", Scope::ArtifactsRead),

1377

("get_workspace_artifact_content", Scope::ArtifactsRead),

1378

("list_workspace_artifact_versions", Scope::ArtifactsRead),

1379

("get_workspace_artifact_access", Scope::ArtifactsRead),

1380

("list_workspace_artifact_templates", Scope::ArtifactsRead),

1381

("list_workspace_artifact_spaces", Scope::ArtifactsRead),

1382

("query_workspace_dataset", Scope::ArtifactsRead),

1383

("create_workspace_artifact", Scope::ArtifactsWrite),

1384

("update_workspace_artifact", Scope::ArtifactsWrite),

1385

("edit_workspace_artifact", Scope::ArtifactsWrite),

1386

("trash_workspace_artifact", Scope::ArtifactsWrite),

1387

("restore_workspace_artifact", Scope::ArtifactsWrite),

1388

("restore_workspace_artifact_version", Scope::ArtifactsWrite),

1389

("set_workspace_artifact_access", Scope::ArtifactsAdmin),

1390

("purge_workspace_artifact", Scope::ArtifactsAdmin),

1391

];

1392

1393

/// Operations any token may use: saying who it is.

1394

pub const NO_SCOPE: &[&str] = &["whoami"];

1395

1396

/// The scope `operation` needs. `None` for one in [`NO_SCOPE`]; an

1397

/// operation in neither list needs full access.

1398

pub fn scope_for(operation: &str) -> Option<Scope> {

1399

OPERATIONS

1400

.iter()

1401

.find(|(name, _)| *name == operation)

1402

.map(|(_, scope)| *scope)

1403

}

1404

1405

/// What a token needs for `operation` with this input beyond its own

1406

/// scope: changing who has access, rerunning a workflow, and making a

1407

/// repository public or private.

1408

pub fn extra_scopes(operation: &str, input: &serde_json::Value) -> Vec<Scope> {

1409

let mut extra = Vec::new();

1410

// A workspace's base permission is who has access.

1411

if operation == "update_workspace" && input.get("base_permission").is_some_and(|v| !v.is_null()) {

1412

extra.push(Scope::AccessAdmin);

1413

}

1414

// Asking a g1t Actions job or run to run again reruns its workflow.

1415

if matches!(operation, "rerequest_check_run" | "rerequest_check_suite")

1416

&& input["id"].as_str().is_some_and(|id| id.starts_with("job_") || id.starts_with("run_"))

1417

{

1418

extra.push(Scope::WorkflowsWrite);

1419

}

1420

if operation == "update_repo" && ["private", "default_branch", "allow_forking", "max_ref_updates"].iter().any(|key| input.get(*key).is_some_and(|v| !v.is_null())) {

1421

extra.push(Scope::RepoAdmin);

}

extra

}

/// The scopes a call needs, its own first.

1427

pub fn needed(operation: &str, input: &serde_json::Value) -> Vec<Scope> {

1428

scope_for(operation)

1429

.into_iter()

1430

.chain(extra_scopes(operation, input))

.collect()

}

/// Whether `access` may use `operation` with `input`. The person's (or

1435

/// workspace's) role is checked after this, by the service that owns what

1436

/// was asked about.

1437

pub fn decide(access: &TokenAccess, operation: &str, input: &serde_json::Value) -> Decision {

1438

let rule = if access.legacy { "token:legacy" } else { "token:scope" };

1439

// A workflow job may open or approve pull requests only where its

1440

// repository and workspace let it, as on GitHub.

1441

if let Some(job) = &access.job

1442

&& !job.pull_requests

1443

&& (operation == "create_pull_request" || (operation == "review_pull_request" && input["verdict"].as_str() == Some("approve")))

1444

{

1445

return Decision::deny(

1446

"token:pull-requests",

1447

"A workflow job cannot open or approve pull requests here: an admin can allow it under Settings, Actions.",

1448

);

1449

}

1450

if let Some(only) = access.repo.as_deref()

1451

&& !NO_SCOPE.contains(&operation)

1452

{

1453

match input["repo"].as_str() {

1454

Some(repo) if access.reaches(repo) => {}

1455

Some(repo) => {

1456

return Decision::deny("token:repository", format!("{} {only}: it cannot reach {repo}.", one_repository(access)));

1457

}

1458

None => {

1459

return Decision::deny("token:repository", format!("{} {only}, and {operation} is not about one repository.", one_repository(access)));

}

}

}

// Making a repository (forking makes one) needs a token that reaches

1464

// every repository of the workspace it goes in, ones made later

1465

// included: a token for chosen repositories would otherwise make one

1466

// outside its choice and then administer it.

1467

if let Some(reach) = &access.reach

1468

&& matches!(operation, "fork_repo" | "create_repo")

1469

{

1470

let destination = input["workspace"].as_str().map(str::trim).filter(|slug| !slug.is_empty());

1471

let elsewhere = match (&reach.workspace, destination) {

1472

(Some(workspace), Some(destination)) => !workspace.eq_ignore_ascii_case(destination),

1473

// Its owner's own workspace, which a workspace's token is not.

1474

(Some(_), None) => true,

1475

(None, _) => false,

1476

};

1477

if reach.repositories != RepositorySelection::All || elsewhere {

1478

return Decision::deny(

1479

"token:resource-owner",

1480

"This access token cannot create repositories there: that needs a token that reaches every repository of the workspace it goes in.",

);

}

}

// A token made for one workspace (or none) only reads outside it:

1485

// public repositories, as anyone may. Inside it, its repository

1486

// selection is checked with its owner's role (`access::granted`).

1487

if let Some(reach) = &access.reach

1488

&& let Some(repo) = input["repo"].as_str()

1489

&& !NO_SCOPE.contains(&operation)

1490

{

1491

let namespace = repo.split('/').next().unwrap_or_default();

1492

// Forking only reads its source; where the fork goes is judged above.

1493

let changes = operation != "fork_repo" && needed(operation, input).iter().any(|scope| scope.level() != Level::Read);

1494

if changes && !reach.owned_by(namespace) {

1495

let made_for = reach.workspace.as_deref().map_or_else(|| "your account only".to_owned(), |workspace| format!("the workspace {workspace}"));

1496

return Decision::deny(

1497

"token:resource-owner",

1498

format!("This access token is made for {made_for}: elsewhere it can only read public repositories, and {repo} is not in its reach."),

);

}

}

if access.scopes.is_some() {

1503

let known = NO_SCOPE.contains(&operation) || scope_for(operation).is_some();

1504

if !known {

1505

return Decision::deny("token:scope", format!("This access token cannot use {operation}: it needs full access."));

1506

}

1507

if let Some(missing) = needed(operation, input).into_iter().find(|scope| !access.allows(*scope)) {

1508

return Decision::deny(

1509

"token:scope",

1510

format!("This access token needs the {} scope to use {operation}.", missing.as_str()),

);

}

}

Decision::allow(rule)

1515

}

1516

1517

/// What a token held to one repository is, for saying why it was refused.

1518

fn one_repository(access: &TokenAccess) -> &'static str {

1519

if access.job.is_some() { "This token is a workflow job's in" } else { "This token reaches only" }

1520

}

1521

1522

/// Whether a token may use the repository `owner/name` at all: a refusal

1523

/// for a workflow job's token or a deploy key in another repository,

1524

/// else `None`. Git and

1525

/// the package registries ask this before [`decide_git`] and

1526

/// [`decide_packages`].

1527

pub fn decide_repo(access: &TokenAccess, repo: &str) -> Option<Decision> {

1528

let only = access.repo.as_deref()?;

1529

let why = if access.deploy_key.is_some() {

1530

format!("This deploy key is for {only}: it cannot reach {repo}.")

1531

} else {

1532

format!("{} {only}: it cannot reach {repo}.", one_repository(access))

1533

};

1534

(!access.reaches(repo)).then(|| Decision::deny("token:repository", why))

1535

}

1536

1537

/// Whether a token may clone or fetch (`write` false), or push to (`write`

1538

/// true), a repository with git. `public` is whether anyone may read it,

1539

/// which needs no scope.

1540

pub fn decide_git(access: &TokenAccess, write: bool, public: bool) -> Decision {

1541

let needed = if write { Scope::CodeWrite } else { Scope::CodeRead };

1542

if !access.allows(needed) && (write || !public) {

1543

if access.deploy_key.is_some() {

1544

return Decision::deny(

1545

"token:scope",

1546

"This deploy key is read-only. An admin of the repository can add it again with write access to push with it.",

1547

);

1548

}

1549

return Decision::deny(

1550

"token:scope",

1551

format!("This access token needs the {} scope to {} with git.", needed.as_str(), if write { "push" } else { "clone or fetch a private repository" }),

1552

);

1553

}

1554

Decision::allow(if access.legacy { "token:legacy" } else { "token:scope" })

1555

}

1556

1557

/// Whether a token may pull (`Level::Read`), push or publish

1558

/// (`Level::Write`), or delete (`Level::Delete`) packages. `public` is

1559

/// whether anyone may pull the package, which needs no scope.

1560

pub fn decide_packages(access: &TokenAccess, level: Level, public: bool) -> Decision {

1561

let (needed, doing) = match level {

1562

Level::Read => (Scope::PackagesRead, "pull a private package"),

1563

Level::Delete | Level::Admin => (Scope::PackagesDelete, "delete packages"),

1564

Level::Create | Level::Write | Level::Run => (Scope::PackagesWrite, "push or publish packages"),

1565

};

1566

if !access.allows(needed) && !(level == Level::Read && public) {

1567

return Decision::deny(

1568

"token:scope",

1569

format!("This access token needs the {} scope to {doing}.", needed.as_str()),

1570

);

1571

}

1572

Decision::allow(if access.legacy { "token:legacy" } else { "token:scope" })

}

#[cfg(test)]

mod tests {

use super::*;

use serde_json::json;

1579

1580

fn token(scopes: &[Scope]) -> TokenAccess {

1581

TokenAccess {

1582

token_id: "tok_1".to_owned(),

1583

scopes: Some(scopes.iter().map(|scope| scope.as_str().to_owned()).collect()),

1584

legacy: false,

1585

name: None,

1586

..TokenAccess::default()

}

}

#[test]

fn every_scope_reads_back_and_belongs_to_a_resource() {

1592

for scope in Scope::ALL {

1593

assert_eq!(Scope::parse(scope.as_str()), Some(scope));

1594

assert!(scope.as_str().starts_with(scope.resource().as_str()));

1595

assert!(scope.includes(scope));

1596

}

1597

assert_eq!(Scope::parse(" Issues:Write "), Some(Scope::IssuesWrite));

1598

assert_eq!(Scope::parse("issues"), None);

}

#[test]

fn a_higher_level_includes_the_lower_ones_of_its_resource_only() {

1603

assert!(Scope::RepoAdmin.includes(Scope::RepoRead));

1604

assert!(Scope::RepoAdmin.includes(Scope::RepoWrite));

1605

assert!(Scope::RepoWrite.includes(Scope::RepoCreate));

1606

assert!(Scope::RepoCreate.includes(Scope::RepoRead));

1607

assert!(!Scope::RepoCreate.includes(Scope::RepoWrite));

1608

assert!(Scope::IssuesWrite.includes(Scope::IssuesRead));

1609

assert!(!Scope::IssuesRead.includes(Scope::IssuesWrite));

1610

assert!(!Scope::RepoAdmin.includes(Scope::CodeWrite));

1611

assert!(!Scope::PullRequestsWrite.includes(Scope::IssuesWrite));

}

#[test]

fn operations_are_listed_once_and_never_also_free() {

1616

let mut seen = std::collections::HashSet::new();

1617

for (name, _) in OPERATIONS {

1618

assert!(seen.insert(*name), "{name} twice");

1619

assert!(!NO_SCOPE.contains(name), "{name}");

}

}

#[test]

fn scopes_are_parsed_from_oauth_text_leaving_out_unknown_ones() {

1625

assert_eq!(

1626

parse_scopes("issues:write repo:read,bogus:thing issues:write"),

1627

vec![Scope::RepoRead, Scope::IssuesWrite]

1628

);

1629

assert_eq!(scopes_text(&[Scope::RepoRead, Scope::IssuesWrite]), "repo:read issues:write");

}

#[test]

fn the_oauth_default_is_the_agent_preset_and_never_admin() {

1634

let scopes = oauth_default();

1635

assert!(scopes.contains(&Scope::IssuesWrite));

1636

assert!(scopes.contains(&Scope::PullRequestsWrite));

1637

assert!(!scopes.contains(&Scope::AgentsRun));

1638

assert!(scopes.iter().all(|scope| !scope.dangerous()), "{scopes:?}");

1639

for read in Scope::ALL.into_iter().filter(|scope| scope.level() == Level::Read && scope.offered()) {

1640

// Every read offered but the machines work runs on, and chat.

1641

assert_eq!(scopes.contains(&read), read != Scope::RunnersRead && read != Scope::ChatRead, "{read:?}");

1642

}

1643

assert!(Preset::ReadOnly.scopes().unwrap().iter().all(|scope| scope.level() == Level::Read));

1644

assert_eq!(Preset::Full.scopes(), None);

}

#[test]

fn retired_scopes_parse_but_are_never_granted() {

1649

// Stored tokens and OAuth grants that hold them still read.

1650

for text in ["agents:run", "memory:read", "memory:write", "models:read", "models:write"] {

1651

let scope = Scope::parse(text).unwrap();

1652

assert!(scope.resource().retired() && !scope.offered(), "{text}");

1653

let back: Scope = serde_json::from_value(json!(text)).unwrap();

1654

assert_eq!(back, scope);

1655

}

1656

// But nothing hands them out, and asking for them gets the rest.

1657

assert_eq!(parse_scopes("agents:run issues:read memory:write models:write"), vec![Scope::IssuesRead]);

1658

assert!(!offered_scopes().iter().any(|scope| scope.resource().retired()));

1659

assert!(!everything().iter().any(|scope| scope.resource().retired()));

1660

for preset in Preset::ALL {

1661

let scopes = preset.scopes().unwrap_or_default();

1662

assert!(!scopes.iter().any(|scope| scope.resource().retired()), "{}", preset.as_str());

1663

}

1664

// And no operation needs them.

1665

assert!(!OPERATIONS.iter().any(|(_, scope)| scope.resource().retired()));

}

#[test]

fn billing_is_read_by_presets_and_changed_by_none_but_full_access() {

1670

assert!(Preset::ReadOnly.scopes().unwrap().contains(&Scope::BillingRead));

1671

for preset in [Preset::ReadOnly, Preset::Agent, Preset::Ci] {

1672

assert!(!preset.scopes().unwrap().contains(&Scope::BillingWrite), "{}", preset.as_str());

1673

}

1674

assert_eq!(scope_for("set_budget"), Some(Scope::BillingWrite));

1675

assert_eq!(scope_for("get_usage"), Some(Scope::BillingRead));

1676

let reader = token(&[Scope::BillingRead]);

1677

assert!(decide(&reader, "list_invoices", &json!({})).allowed);

1678

assert!(decide(&reader, "set_budget", &json!({})).reason.unwrap().contains("billing:write"));

}

#[test]

fn artifacts_are_offered_read_by_presets_and_shared_only_with_admin() {

1683

for scope in [Scope::ArtifactsRead, Scope::ArtifactsWrite, Scope::ArtifactsAdmin] {

1684

assert_eq!(scope.resource(), Resource::Artifacts);

1685

assert!(scope.offered());

1686

assert!(offered_scopes().contains(&scope));

1687

assert_eq!(parse_scopes(scope.as_str()), vec![scope]);

1688

assert!(OPERATIONS.iter().any(|(_, needed)| *needed == scope), "{scope:?} gates nothing");

1689

}

1690

// Reading them is a read like any other; changing them is chosen.

1691

for preset in [Preset::ReadOnly, Preset::Agent] {

1692

let scopes = preset.scopes().unwrap();

1693

assert!(scopes.contains(&Scope::ArtifactsRead), "{}", preset.as_str());

1694

assert!(!scopes.contains(&Scope::ArtifactsWrite) && !scopes.contains(&Scope::ArtifactsAdmin), "{}", preset.as_str());

1695

}

1696

assert!(!Preset::Ci.scopes().unwrap().contains(&Scope::ArtifactsRead));

1697

assert!(everything().contains(&Scope::ArtifactsAdmin));

1698

assert!(Scope::ArtifactsAdmin.includes(Scope::ArtifactsWrite));

1699

assert!(Scope::ArtifactsAdmin.dangerous());

1700

assert!(!Scope::ArtifactsWrite.dangerous());

1701

assert_eq!(Resource::Artifacts.group(), ResourceGroup::Workspace);

1702

let asked = std::collections::BTreeMap::from([("artifacts".to_owned(), "write".to_owned())]);

1703

assert_eq!(resolve_permissions(&asked, true), Ok(vec![Scope::ArtifactsWrite]));

1704

assert!(offered_scopes().contains(&Scope::ArtifactsAdmin));

1705

// Sharing and deleting for good need admin; editing needs write.

1706

assert_eq!(scope_for("set_workspace_artifact_access"), Some(Scope::ArtifactsAdmin));

1707

assert_eq!(scope_for("purge_workspace_artifact"), Some(Scope::ArtifactsAdmin));

1708

assert_eq!(scope_for("edit_workspace_artifact"), Some(Scope::ArtifactsWrite));

1709

assert_eq!(scope_for("get_workspace_artifact_content"), Some(Scope::ArtifactsRead));

1710

let writer = token(&[Scope::ArtifactsWrite]);

1711

assert!(decide(&writer, "edit_workspace_artifact", &json!({})).allowed);

1712

assert!(decide(&writer, "list_workspace_artifacts", &json!({})).allowed, "write includes read");

1713

assert!(decide(&writer, "set_workspace_artifact_access", &json!({})).reason.unwrap().contains("artifacts:admin"));

1714

// Workflow runs' artifacts are another thing, with their own scope.

1715

let reader = token(&[Scope::ArtifactsRead]);

1716

assert!(!decide(&reader, "list_artifacts", &json!({ "repo": "acme/web" })).allowed);

1717

assert!(!decide(&token(&[Scope::WorkflowsRead]), "list_workspace_artifacts", &json!({})).allowed);

}

#[test]

fn chat_is_a_persons_own_and_given_only_when_asked_for() {

1722

for scope in [Scope::ChatRead, Scope::ChatWrite] {

1723

assert_eq!(scope.resource(), Resource::Chat);

1724

assert!(!scope.dangerous());

1725

assert_eq!(Scope::parse(scope.as_str()), Some(scope));

1726

}

1727

assert_eq!(Resource::Chat.label(), "Chat");

1728

assert_eq!(Resource::Chat.group(), ResourceGroup::Account);

1729

assert!(Scope::ChatWrite.includes(Scope::ChatRead));

1730

assert!(!Scope::ChatRead.includes(Scope::ChatWrite));

1731

// No preset, and so no OAuth default, gives it.

1732

for preset in Preset::ALL {

1733

let scopes = preset.scopes().unwrap_or_default();

1734

assert!(!scopes.iter().any(|scope| scope.resource() == Resource::Chat), "{}", preset.as_str());

1735

}

1736

assert!(!oauth_default().iter().any(|scope| scope.resource() == Resource::Chat));

1737

// An application that asks for it by name gets it; full access holds it.

1738

assert_eq!(parse_scopes("chat:read chat:write"), vec![Scope::ChatRead, Scope::ChatWrite]);

1739

assert!(offered_scopes().contains(&Scope::ChatWrite));

1740

assert!(everything().contains(&Scope::ChatWrite));

1741

assert!(TokenAccess::full().allows(Scope::ChatWrite));

1742

// Only a person's token may hold it.

1743

let asked = std::collections::BTreeMap::from([("chat".to_owned(), "write".to_owned())]);

1744

assert_eq!(resolve_permissions(&asked, true), Ok(vec![Scope::ChatWrite]));

1745

assert!(resolve_permissions(&asked, false).is_err());

}

#[test]

fn the_agent_preset_creates_repositories_and_changes_none() {

1750

let agent = Preset::Agent.scopes().unwrap();

1751

assert!(agent.contains(&Scope::RepoCreate));

1752

assert!(!agent.contains(&Scope::RepoWrite) && !agent.contains(&Scope::RepoAdmin));

1753

assert!(oauth_default().contains(&Scope::RepoCreate));

1754

assert_eq!(Scope::parse("repo:create"), Some(Scope::RepoCreate));

1755

assert_eq!(Scope::RepoCreate.level(), Level::Create);

1756

assert!(!Scope::RepoCreate.dangerous());

1757

// Creating needs repo:create, which repo:write still gives.

1758

assert_eq!(scope_for("create_repo"), Some(Scope::RepoCreate));

1759

let creator = token(&agent);

1760

assert!(decide(&creator, "create_repo", &json!({ "name": "web" })).allowed);

1761

assert!(decide(&token(&[Scope::RepoWrite]), "create_repo", &json!({ "name": "web" })).allowed);

1762

assert!(!decide(&token(&[Scope::RepoRead]), "create_repo", &json!({ "name": "web" })).allowed);

1763

// And nothing that changes or deletes what is there.

1764

for op in [

1765

"update_repo",

1766

"update_repo_settings",

"delete_branch",

"rename_branch",

"delete_release",

"fork_repo",

"set_repo_visibility",

"delete_repo",

"transfer_repo",

] {

assert!(!decide(&creator, op, &json!({ "repo": "acme/web" })).allowed, "{op}");

1776

}

1777

// As a permission it is one level of repositories.

1778

let asked = std::collections::BTreeMap::from([("repo".to_owned(), "create".to_owned())]);

1779

assert_eq!(resolve_permissions(&asked, true), Ok(vec![Scope::RepoCreate]));

1780

assert_eq!(top_scopes(&[Scope::RepoRead, Scope::RepoCreate]), vec![Scope::RepoCreate]);

}

#[test]

fn checks_are_reported_with_checks_write_which_ci_gets() {

1785

assert_eq!(scope_for("create_check_run"), Some(Scope::ChecksWrite));

1786

assert_eq!(scope_for("create_commit_status"), Some(Scope::ChecksWrite));

1787

assert_eq!(scope_for("list_check_runs_for_ref"), Some(Scope::ChecksRead));

1788

let ci = Preset::Ci.scopes().unwrap();

1789

assert!(ci.contains(&Scope::ChecksWrite));

1790

assert!(!Preset::Agent.scopes().unwrap().contains(&Scope::ChecksWrite));

1791

let reporter = token(&[Scope::ChecksWrite]);

1792

assert!(decide(&reporter, "update_check_run", &json!({ "id": "cr_1" })).allowed);

1793

assert!(decide(&reporter, "rerequest_check_run", &json!({ "id": "cr_1" })).allowed);

1794

// A g1t Actions job runs again as its workflow does.

1795

let refused = decide(&reporter, "rerequest_check_run", &json!({ "id": "job_1" }));

1796

assert!(refused.reason.unwrap().contains("workflows:write"));

}

#[test]

fn a_job_token_reaches_its_repository_only() {

1801

let job = TokenAccess {

1802

repo: Some("acme/web".into()),

1803

job: Some(JobToken { run_id: "run_1".into(), job_id: "job_1".into(), pull_requests: false }),

1804

..token(&[Scope::RepoRead, Scope::IssuesWrite, Scope::IssuesRead, Scope::PullRequestsWrite])

1805

};

1806

assert!(decide(&job, "create_issue", &json!({ "repo": "acme/web" })).allowed);

1807

assert!(decide(&job, "create_issue", &json!({ "repo": "Acme/Web" })).allowed, "names compare without case");

1808

let elsewhere = decide(&job, "create_issue", &json!({ "repo": "acme/api" }));

1809

assert!(!elsewhere.allowed);

1810

assert_eq!(elsewhere.rule, "token:repository");

1811

// Nothing beyond the one repository, a workspace's listing included.

1812

assert!(!decide(&job, "list_repos", &json!({})).allowed);

1813

assert!(decide(&job, "whoami", &json!({})).allowed);

1814

// Its scopes still hold inside it.

1815

assert!(!decide(&job, "create_pull_request", &json!({ "repo": "acme/web" })).allowed);

1816

assert!(decide_repo(&job, "acme/web").is_none());

1817

assert!(!decide_repo(&job, "acme/api").unwrap().allowed);

1818

assert!(decide_repo(&token(&[Scope::CodeRead]), "acme/api").is_none(), "other tokens reach what their owner can");

1819

// Opening and approving pull requests is off unless allowed.

1820

assert_eq!(decide(&job, "create_pull_request", &json!({ "repo": "acme/web" })).rule, "token:pull-requests");

1821

assert!(!decide(&job, "review_pull_request", &json!({ "repo": "acme/web", "verdict": "approve" })).allowed);

1822

assert!(decide(&job, "review_pull_request", &json!({ "repo": "acme/web", "verdict": "request_changes" })).allowed);

1823

let allowed = TokenAccess { job: Some(JobToken { pull_requests: true, ..job.job.clone().unwrap() }), ..job.clone() };

1824

assert!(decide(&allowed, "create_pull_request", &json!({ "repo": "acme/web" })).allowed);

}

#[test]

fn workflow_files_need_their_own_scope() {

1829

for path in [".g1t/workflows/ci.yml", ".github/workflows/deploy.yaml", "/.github/workflows/x.yml", ".GitHub/Workflows/ci.yml", ".github/workflows"] {

1830

assert!(is_workflow_file(path), "{path}");

1831

}

1832

for path in ["README.md", ".github/CODEOWNERS", ".github/workflowsx/ci.yml", "docs/.github/workflows/ci.yml", ".g1t/actions/ci.yml"] {

1833

assert!(!is_workflow_file(path), "{path}");

1834

}

1835

let code = token(&[Scope::CodeWrite]);

1836

let refused = decide_workflow_files(Some(&code), ["README.md", ".github/workflows/ci.yml"]).unwrap();

1837

assert_eq!(refused.rule, "token:workflows");

1838

assert!(refused.reason.as_deref().unwrap().contains(".github/workflows/ci.yml"));

1839

assert!(refused.reason.as_deref().unwrap().contains("workflow_files:write"));

1840

assert!(decide_workflow_files(Some(&code), ["README.md"]).is_none());

1841

assert!(decide_workflow_files(Some(&token(&[Scope::CodeWrite, Scope::WorkflowFilesWrite])), [".g1t/workflows/ci.yml"]).is_none());

1842

assert!(decide_workflow_files(Some(&TokenAccess::full()), [".g1t/workflows/ci.yml"]).is_none(), "full access");

1843

assert!(decide_workflow_files(None, [".g1t/workflows/ci.yml"]).is_none(), "a signed-in person");

1844

// A job's token never may, as GITHUB_TOKEN never may.

1845

let job = TokenAccess { job: Some(JobToken::default()), ..TokenAccess::full() };

1846

assert!(decide_workflow_files(Some(&job), [".g1t/workflows/ci.yml"]).unwrap().reason.unwrap().contains("job"));

1847

// Nothing in a preset changes workflow files but full access.

1848

for preset in [Preset::ReadOnly, Preset::Agent, Preset::Ci] {

1849

assert!(!preset.scopes().unwrap().contains(&Scope::WorkflowFilesWrite), "{}", preset.as_str());

1850

}

1851

assert!(!Scope::WorkflowFilesWrite.includes(Scope::WorkflowsWrite) && !Scope::WorkflowsWrite.includes(Scope::WorkflowFilesWrite));

}

#[test]

fn a_narrowed_token_only_reads_outside_its_workspace() {

1856

let reach = TokenReach { workspace: Some("acme".into()), repositories: RepositorySelection::All, repo_ids: Vec::new() };

1857

let fine = TokenAccess { reach: Some(reach), ..token(&[Scope::RepoRead, Scope::IssuesRead, Scope::IssuesWrite]) };

1858

assert!(decide(&fine, "create_issue", &json!({ "repo": "acme/web" })).allowed);

1859

assert!(decide(&fine, "create_issue", &json!({ "repo": "Acme/web" })).allowed);

1860

let elsewhere = decide(&fine, "create_issue", &json!({ "repo": "globex/site" }));

1861

assert_eq!(elsewhere.rule, "token:resource-owner");

1862

assert!(elsewhere.reason.unwrap().contains("acme"));

1863

assert!(decide(&fine, "get_issue", &json!({ "repo": "globex/site" })).allowed, "public repositories elsewhere read");

1864

assert!(!decide(&fine, "create_pull_request", &json!({ "repo": "acme/web" })).allowed, "its scopes still hold");

1865

let mine = TokenAccess { reach: Some(TokenReach::default()), ..token(&[Scope::IssuesWrite]) };

1866

assert!(decide(&mine, "create_issue", &json!({ "repo": "acme/web" })).reason.unwrap().contains("your account"));

1867

assert!(fine.covers_repo("rep_1", "acme") && !fine.covers_repo("rep_1", "globex"));

1868

let selected = TokenReach { workspace: Some("acme".into()), repositories: RepositorySelection::Selected, repo_ids: vec!["rep_1".into()] };

1869

assert!(selected.covers("rep_1", "ACME") && !selected.covers("rep_2", "acme"));

1870

let public = TokenReach { repositories: RepositorySelection::Public, ..selected.clone() };

1871

assert!(!public.covers("rep_1", "acme") && public.owned_by("acme"));

1872

assert!(token(&[]).covers_repo("rep_1", "anything"), "a token for every workspace reaches what its owner can");

1873

assert_eq!(RepositorySelection::parse("public_only"), Some(RepositorySelection::Public));

}

#[test]

fn only_a_token_for_all_of_a_workspace_makes_repositories_there() {

1878

let all = TokenReach { workspace: Some("acme".into()), repositories: RepositorySelection::All, repo_ids: Vec::new() };

1879

let writes = |reach: TokenReach| TokenAccess { reach: Some(reach), ..token(&[Scope::RepoRead, Scope::RepoWrite]) };

1880

let fork = |workspace: Option<&str>| json!({ "repo": "acme/lib", "workspace": workspace });

1881

assert!(decide(&writes(all.clone()), "fork_repo", &fork(Some("acme"))).allowed);

1882

assert!(decide(&writes(all.clone()), "create_repo", &json!({ "workspace": "Acme" })).allowed);

1883

// Its chosen repositories, or public ones only: never a new one.

1884

let selected = TokenReach { repositories: RepositorySelection::Selected, repo_ids: vec!["rep_1".into()], ..all.clone() };

1885

let refused = decide(&writes(selected), "fork_repo", &fork(Some("acme")));

1886

assert_eq!(refused.rule, "token:resource-owner");

1887

assert!(refused.reason.unwrap().contains("every repository"));

1888

let public = TokenReach { repositories: RepositorySelection::Public, ..all.clone() };

1889

assert!(!decide(&writes(public), "create_repo", &json!({ "workspace": "acme" })).allowed);

1890

// Another workspace, or its maker's own, which is not the token's.

1891

assert!(!decide(&writes(all.clone()), "fork_repo", &fork(Some("globex"))).allowed);

1892

assert!(!decide(&writes(all), "fork_repo", &fork(None)).allowed);

1893

// A token for its owner's account forks into their own workspace.

1894

assert!(decide(&writes(TokenReach::default()), "fork_repo", &fork(None)).allowed);

1895

// Forking only reads its source, wherever that is.

1896

let elsewhere = json!({ "repo": "globex/site", "workspace": "acme" });

1897

assert!(decide(&writes(TokenReach { workspace: Some("acme".into()), ..TokenReach::default() }), "fork_repo", &elsewhere).allowed);

}

#[test]

fn permissions_are_scopes_read_per_resource() {

1902

let asked: std::collections::BTreeMap<String, String> =

1903

[("issues", "write"), ("repo", "read"), ("code", "none"), ("packages", "delete")].iter().map(|(a, b)| ((*a).to_owned(), (*b).to_owned())).collect();

1904

let scopes = resolve_permissions(&asked, true).unwrap();

1905

assert_eq!(scopes, vec![Scope::RepoRead, Scope::PackagesDelete, Scope::IssuesWrite]);

1906

let back = permissions_of(&scopes);

1907

assert_eq!(back.get("issues").map(String::as_str), Some("write"));

1908

assert_eq!(back.get("packages").map(String::as_str), Some("delete"));

1909

assert!(!back.contains_key("code"));

1910

// Lower levels held beside a higher one say nothing more.

1911

assert_eq!(top_scopes(&[Scope::RepoRead, Scope::RepoAdmin, Scope::RepoWrite]), vec![Scope::RepoAdmin]);

1912

// Every offered resource's top, and nothing a level can lose.

1913

let all = everything();

1914

assert_eq!(all.len(), Resource::ALL.into_iter().filter(|resource| resource.offered()).count());

1915

for scope in offered_scopes() {

1916

assert!(all.iter().any(|held| held.includes(scope)), "{scope:?}");

}

}

#[test]

fn permissions_are_checked_by_name_level_and_owner() {

1922

let one = |name: &str, level: &str| -> std::collections::BTreeMap<String, String> { [(name.to_owned(), level.to_owned())].into() };

1923

assert!(resolve_permissions(&one("wiki", "read"), true).unwrap_err().contains("wiki"));

1924

assert!(resolve_permissions(&one("issues", "admin"), true).unwrap_err().contains("read, write"));

1925

assert!(resolve_permissions(&one("workflow_files", "read"), true).is_err(), "workflow files are written only");

1926

assert!(resolve_permissions(&one("notifications", "read"), false).unwrap_err().contains("account"));

1927

assert_eq!(resolve_permissions(&one("notifications", "read"), true).unwrap(), vec![Scope::NotificationsRead]);

1928

assert!(resolve_permissions(&one("agents", "run"), false).unwrap_err().contains("agents"), "retired");

1929

assert!(resolve_permissions(&one("models", "read"), false).is_err(), "retired");

1930

for resource in Resource::ALL {

1931

assert_eq!(Resource::parse(resource.as_str()), Some(resource));

1932

assert!(!resource.scopes().is_empty());

}

}

#[test]

fn a_legacy_token_can_do_everything() {

1938

let legacy = TokenAccess { legacy: true, ..TokenAccess::full() };

1939

for (operation, _) in OPERATIONS {

1940

assert!(decide(&legacy, operation, &json!({})).allowed, "{operation}");

1941

}

1942

assert_eq!(decide(&legacy, "delete_repo", &json!({})).rule, "token:legacy");

}

#[test]

fn a_missing_scope_is_named() {

1947

let read = token(&[Scope::IssuesRead]);

1948

assert!(decide(&read, "get_issue", &json!({})).allowed);

1949

assert!(decide(&read, "whoami", &json!({})).allowed);

1950

let refused = decide(&read, "create_issue", &json!({}));

1951

assert!(!refused.allowed);

1952

assert_eq!(refused.reason.as_deref(), Some("This access token needs the issues:write scope to use create_issue."));

1953

// An operation the table does not know needs full access.

1954

assert!(!decide(&read, "something_new", &json!({})).allowed);

}

#[test]

fn making_a_repository_public_or_private_needs_repo_admin() {

1959

let maintainer = token(&[Scope::RepoWrite]);

1960

assert!(decide(&maintainer, "update_repo", &json!({ "website": "https://x.dev" })).allowed);

1961

assert!(!decide(&maintainer, "update_repo", &json!({ "private": true })).allowed);

}

#[test]

fn a_workspaces_base_permission_needs_access_admin_too() {

1966

let admin = token(&[Scope::WorkspaceAdmin]);

1967

assert!(decide(&admin, "update_workspace", &json!({ "name": "Acme" })).allowed);

1968

let refused = decide(&admin, "update_workspace", &json!({ "name": "Acme", "base_permission": "read" }));

1969

assert!(refused.reason.unwrap().contains("access:admin"));

1970

let both = token(&[Scope::WorkspaceAdmin, Scope::AccessAdmin]);

1971

assert!(decide(&both, "update_workspace", &json!({ "base_permission": "read" })).allowed);

1972

assert!(!decide(&token(&[Scope::WorkspaceRead]), "update_workspace", &json!({ "name": "Acme" })).allowed);

}

#[test]

fn git_push_needs_code_write_and_private_reads_need_code_read() {

1977

let reader = token(&[Scope::CodeRead]);

1978

assert!(decide_git(&reader, false, false).allowed);

1979

let refused = decide_git(&reader, true, false);

1980

assert!(!refused.allowed);

1981

assert!(refused.reason.unwrap().contains("code:write"));

1982

let issues = token(&[Scope::IssuesWrite]);

1983

assert!(!decide_git(&issues, false, false).allowed);

1984

assert!(decide_git(&issues, false, true).allowed, "public code needs no scope");

1985

assert!(!decide_git(&issues, true, true).allowed, "pushing to public code still needs code:write");

1986

let writer = token(&[Scope::CodeWrite]);

1987

assert!(decide_git(&writer, true, false).allowed);

1988

assert!(decide_git(&writer, false, false).allowed, "code:write includes code:read");

1989

assert!(decide_git(&TokenAccess::full(), true, false).allowed);

}

#[test]

fn packages_need_their_own_scopes_and_public_pulls_none() {

1994

let reader = token(&[Scope::PackagesRead]);

1995

assert!(decide_packages(&reader, Level::Read, false).allowed);

1996

assert!(!decide_packages(&reader, Level::Write, false).allowed);

1997

let code = token(&[Scope::CodeWrite]);

1998

assert!(!decide_packages(&code, Level::Read, false).allowed, "code scopes are not package scopes");

1999

assert!(decide_packages(&code, Level::Read, true).allowed, "public packages pull with any token");

2000

let writer = token(&[Scope::PackagesWrite]);

2001

assert!(decide_packages(&writer, Level::Write, false).allowed);

2002

assert!(decide_packages(&writer, Level::Read, false).allowed, "packages:write includes packages:read");

2003

let refused = decide_packages(&writer, Level::Delete, false);

2004

assert!(refused.reason.unwrap().contains("packages:delete"));

2005

assert!(decide_packages(&token(&[Scope::PackagesDelete]), Level::Write, false).allowed);

2006

assert!(Scope::PackagesDelete.dangerous());

2007

// Tokens made before these scopes, and full-access ones, keep working.

2008

let legacy = TokenAccess { legacy: true, ..TokenAccess::full() };

2009

assert!(decide_packages(&legacy, Level::Delete, false).allowed);

2010

assert!(decide_packages(&TokenAccess::full(), Level::Write, false).allowed);

}

#[test]

fn token_access_travels_as_json() {

2015

let access = token(&[Scope::IssuesRead]);

2016

let wire = serde_json::to_value(&access).unwrap();

2017

assert_eq!(wire["scopes"], json!(["issues:read"]));

2018

assert!(wire.get("resources").is_none());

2019

let back: TokenAccess = serde_json::from_value(wire).unwrap();

2020

assert_eq!(back, access);

2021

let full: TokenAccess = serde_json::from_value(json!({})).unwrap();

2022

assert!(full.is_full());

2023

// A reach written by an older version is ignored: a token reaches

2024

// whatever its owner can.

2025

let older: TokenAccess = serde_json::from_value(json!({

2026

"token_id": "tok_1",

2027

"scopes": ["issues:read"],

2028

"resources": { "kind": "repositories", "repositories": ["acme/rocket"] },

2029

}))

2030

.unwrap();

2031

assert_eq!(older, access);

2032

// Using the website is off unless set, and said only when on.

2033

assert!(!access.website);

2034

assert!(wire_of(&access).get("website").is_none());

2035

let website = TokenAccess { website: true, ..access };

2036

assert_eq!(wire_of(&website)["website"], json!(true));

2037

// Never part of full access.

2038

assert!(!TokenAccess::full().website);

2039

}

2040

2041

fn wire_of(access: &TokenAccess) -> serde_json::Value {

2042

serde_json::to_value(access).unwrap()

2043

}

2044

2045

/// The site's copy of the table, `packages/contracts/src/scopes.ts`,

2046

/// lists the same scopes in the same order, the same operations with

2047

/// the same scopes, and the same presets.

2048

#[test]

2049

fn the_typescript_mirror_has_the_same_table() {

2050

let ts = include_str!("../../../packages/contracts/src/scopes.ts");

2051

let section = |start: &str| {

2052

ts.split_once(start)

2053

.and_then(|(_, rest)| rest.split_once("] as const"))

2054

.map(|(table, _)| table)

2055

.unwrap_or_else(|| panic!("{start} in scopes.ts"))

2056

};

2057

let names = |table: &str| -> Vec<String> {

section(table)

.lines()

.collect()

};

// Offered scopes in `SCOPES`, retired ones in `RETIRED_SCOPES`, the

2064

// rest in `UPCOMING_SCOPES`.

2065

let listed = |keep: fn(&Scope) -> bool| -> Vec<String> { Scope::ALL.iter().filter(|scope| keep(scope)).map(|scope| scope.as_str().to_owned()).collect() };

2066

assert_eq!(names("export const SCOPES = ["), listed(|scope| scope.offered()));

2067

assert_eq!(names("export const UPCOMING_SCOPES"), listed(|scope| !scope.offered() && !scope.resource().retired()));

2068

assert_eq!(names("export const RETIRED_SCOPES"), listed(|scope| scope.resource().retired()));

2069

let operations: Vec<(String, String)> = section("export const OPERATION_SCOPES = [")

2070

.lines()

2071

.filter_map(|line| {

2072

let mut quoted = line.split('"').skip(1).step_by(2);

2073

Some((quoted.next()?.to_owned(), quoted.next()?.to_owned()))

2074

})

2075

.collect();

2076

let expected: Vec<(String, String)> = OPERATIONS

2077

.iter()

2078

.map(|(name, scope)| ((*name).to_owned(), scope.as_str().to_owned()))

2079

.collect();

2080

assert_eq!(operations, expected);

2081

for preset in Preset::ALL {

2082

let list = section(&format!("{}: [", preset.as_str()));

2083

let mirrored: Vec<&str> = list

2084

.split(',')

2085

.map(|item| item.trim().trim_matches('"'))

2086

.filter(|item| !item.is_empty())

2087

.collect();

2088

let expected: Vec<&str> = preset

2089

.scopes()

2090

.map(|scopes| scopes.iter().map(|scope| scope.as_str()).collect())

2091

.unwrap_or_else(|| vec!["*"]);

2092

assert_eq!(mirrored, expected, "{}", preset.as_str());

2093

}

2094

// Each resource with its group, in the same order: offered ones in

2095

// `SCOPE_RESOURCES`, retired ones in `RETIRED_RESOURCES`, the rest in

2096

// `UPCOMING_RESOURCES`.

2097

let tables: [(&str, fn(Resource) -> bool); 3] = [

2098

("export const SCOPE_RESOURCES", |resource| resource.offered()),

2099

("export const UPCOMING_RESOURCES", |resource| !resource.offered() && !resource.retired()),

2100

("export const RETIRED_RESOURCES", |resource| resource.retired()),

2101

];

2102

for (table, keep) in tables {

2103

let resources = ts

2104

.split_once(table)

2105

.and_then(|(_, rest)| rest.split_once("

2106

];"))

2107

.map(|(table, _)| table)

2108

.unwrap_or_else(|| panic!("{table} in scopes.ts"));

2109

let rows: Vec<&str> = resources.lines().filter(|line| line.trim_start().starts_with("{ resource:")).collect();

2110

let expected: Vec<Resource> = Resource::ALL.into_iter().filter(|resource| keep(*resource)).collect();

2111

assert_eq!(rows.len(), expected.len(), "{table}");

2112

for (row, resource) in rows.iter().zip(expected) {

2113

assert!(row.contains(&format!("resource: \"{}\"", resource.as_str())), "{row}");

2114

assert!(row.contains(&format!("group: \"{}\"", resource.group().as_str())), "{row}");

}

}

}

}