api

package

v0.0.0-...-4a47344 Latest Latest Go to latest Published: Mar 28, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Claims map[string]interface{}

type Handler struct {
	// contains filtered or unexported fields
}

func NewHandler(log *slog.Logger, tracer trace.Tracer, tokenParser TokenParser, tokenChecker TokenChecker, tokenIssuer TokenIssuer) *Handler

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type TokenChecker interface {
	Check(context.Context, Claims, *TokenRequest) (bool, error)
}

TokenCheck checks if a client is authorized to request a token

type TokenIssuer func(context.Context, *TokenRequest) (string, error)

type TokenParser interface {
	Parse(ctx context.Context, tok string) (Claims, error)
}

TokenParser validates a token and returns the identity of the Actions Workflow it was issued to.

type TokenRequest struct {
	Repositories []string          `json:"repositories"`
	Permissions  map[string]string `json:"permissions"`
}

TokenRequest is a request from a workflow for permissions

func (r TokenRequest) Owner() string

func (r TokenRequest) OwnerPermissions() bool

func (r TokenRequest) Valid() error

type TokenResponse struct {
	Token     string `json:"token"`
	Revocable bool   `json:"revocable"`
	Error     string `json:"error,omitempty"`
}