githuboidc

Documentation

Index

• Variables
• func OIDCAvailable() bool
• func ProvideVerifier(ctx context.Context) (*keyfunc.JWKS, error)
• type Claims
  • func Validate(ctx context.Context, jwks *keyfunc.JWKS, tokenStr string) (*Claims, error)
• type Token
  • func JWT(ctx context.Context, audience string) (*Token, error)

Variables

var ErrMissingIdTokenWrite = errors.New("please add `id-token: write` to your workflow permissions")

Functions

func OIDCAvailable

func OIDCAvailable() bool

func ProvideVerifier

func ProvideVerifier(ctx context.Context) (*keyfunc.JWKS, error)

Types

type Claims

type Claims struct {
	jwt.RegisteredClaims

	JobWorkflowRef    string `json:"job_workflow_ref"`
	Sha               string `json:"sha"`
	EventName         string `json:"event_name"`
	Repository        string `json:"repository"`
	Workflow          string `json:"workflow"`
	Ref               string `json:"ref"`
	JobWorkflowSha    string `json:"job_workflow_sha"`
	RunnerEnvironment string `json:"runner_environment"`
	RepositoryID      string `json:"repository_id"`
	RepositoryOwner   string `json:"repository_owner"`
	RepositoryOwnerID string `json:"repository_owner_id"`
	WorkflowRef       string `json:"workflow_ref"`
	WorkflowSha       string `json:"workflow_sha"`
	RunID             string `json:"run_id"`
	RunAttempt        string `json:"run_attempt"`
}

func Validate

func Validate(ctx context.Context, jwks *keyfunc.JWKS, tokenStr string) (*Claims, error)

type Token

type Token struct {
	Value string `json:"value"`
}

func JWT

func JWT(ctx context.Context, audience string) (*Token, error)