feat(forgerpc): bound a package workflow's forge calls by its accepted authority
This commit is contained in:
7 files changed
+122
-32
No files matched your search
@@ -527,7 +527,7 @@ func (b *boot) registerNATSRPC() error {
|
|||||||
log.Error("nats connection unavailable for task RPC", "err", err)
|
log.Error("nats connection unavailable for task RPC", "err", err)
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
unsubscribe, err := registerTaskRPCServers(coreConn, b.forgeClient, b.trees, b.identityRunners, b.stateStoreGrants.Client, log)
|
unsubscribe, err := registerTaskRPCServers(coreConn, b.forgeClient, b.trees, b.identityRunners, b.stateStoreGrants.Client, installedAuthorities{b.stateStoreGrants.Client}, log)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Error("task RPC server registration failed", "err", err)
|
log.Error("task RPC server registration failed", "err", err)
|
||||||
return err
|
return err
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
package archied
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
|
||||||
|
"github.com/samcharles93/archie-core/internal/domain/storepkg"
|
||||||
|
)
|
||||||
|
|
||||||
|
// installedAuthorities answers a package's accepted authority from the State
|
||||||
|
// Store. A package the operator has not accepted has none.
|
||||||
|
type installedAuthorities struct {
|
||||||
|
packages storepkg.Installations
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a installedAuthorities) AcceptedAuthority(ctx context.Context, name string) (storepkg.Authority, error) {
|
||||||
|
installed, err := a.packages.GetInstalled(ctx, name)
|
||||||
|
if err != nil || installed.AcceptedAuthority == nil {
|
||||||
|
return storepkg.Authority{}, err
|
||||||
|
}
|
||||||
|
return *installed.AcceptedAuthority, nil
|
||||||
|
}
|
||||||
@@ -356,7 +356,7 @@ func subscribeAgentEvents(nc *natsio.Conn, bus *events.Bus, log *slog.Logger) (u
|
|||||||
// tasks, and one server pair per identity answers that identity's scoped
|
// tasks, and one server pair per identity answers that identity's scoped
|
||||||
// subjects so a container-mode task owned by a non-root identity has its RPC
|
// subjects so a container-mode task owned by a non-root identity has its RPC
|
||||||
// calls served by its own forge client and worktree manager.
|
// calls served by its own forge client and worktree manager.
|
||||||
func registerTaskRPCServers(nc *natsio.Conn, forgeClient forge.Forge, trees *worktree.Manager, identities []*daemon.IdentityRunner, runs worktreerpc.Runs, log *slog.Logger) (unsubscribe func(), err error) {
|
func registerTaskRPCServers(nc *natsio.Conn, forgeClient forge.Forge, trees *worktree.Manager, identities []*daemon.IdentityRunner, runs worktreerpc.Runs, authorities forgerpc.Authorities, log *slog.Logger) (unsubscribe func(), err error) {
|
||||||
unsubs := make([]func(), 0, 2+2*len(identities))
|
unsubs := make([]func(), 0, 2+2*len(identities))
|
||||||
unsubAll := func() {
|
unsubAll := func() {
|
||||||
for _, u := range unsubs {
|
for _, u := range unsubs {
|
||||||
@@ -365,7 +365,7 @@ func registerTaskRPCServers(nc *natsio.Conn, forgeClient forge.Forge, trees *wor
|
|||||||
}
|
}
|
||||||
|
|
||||||
registerForge := func(fg forge.Forge, identity string) error {
|
registerForge := func(fg forge.Forge, identity string) error {
|
||||||
srv := &forgerpc.Server{Forge: fg, Runs: runs, Log: log.With("rpc_identity", identity)}
|
srv := &forgerpc.Server{Forge: fg, Runs: runs, Authorities: authorities, Log: log.With("rpc_identity", identity)}
|
||||||
u, err := srv.RegisterFor(nc, identity)
|
u, err := srv.RegisterFor(nc, identity)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("register forgerpc%s: %w", identitySuffix(identity), err)
|
return fmt.Errorf("register forgerpc%s: %w", identitySuffix(identity), err)
|
||||||
|
|||||||
@@ -56,7 +56,10 @@ func (p *WorkflowProjector) Apply(ctx context.Context, orgID, name, digest strin
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("contributed workflow %q: %w", contentName, err)
|
return fmt.Errorf("contributed workflow %q: %w", contentName, err)
|
||||||
}
|
}
|
||||||
entries = append(entries, workflow.WorkflowDefinitionEntry{ID: id, YAML: string(content)})
|
if workflow.PackageOf(string(content)) != "" {
|
||||||
|
return fmt.Errorf("contributed workflow %q: package is set by the installer, not the workflow", contentName)
|
||||||
|
}
|
||||||
|
entries = append(entries, workflow.WorkflowDefinitionEntry{ID: id, YAML: "package: " + strconv.Quote(name) + "\n" + string(content)})
|
||||||
recorded = append(recorded, storepkg.ProjectionEntry{Family: storepkg.FamilyWorkflows, EntryID: id})
|
recorded = append(recorded, storepkg.ProjectionEntry{Family: storepkg.FamilyWorkflows, EntryID: id})
|
||||||
}
|
}
|
||||||
// One apply, one request: a retried PutResource reuses the same request ID
|
// One apply, one request: a retried PutResource reuses the same request ID
|
||||||
|
|||||||
@@ -18,8 +18,12 @@ import (
|
|||||||
|
|
||||||
// YAMLDefinition is the portable, versioned workflow representation.
|
// YAMLDefinition is the portable, versioned workflow representation.
|
||||||
type YAMLDefinition struct {
|
type YAMLDefinition struct {
|
||||||
ID string `yaml:"id" json:"id"`
|
ID string `yaml:"id" json:"id"`
|
||||||
Steps []StepRecord `yaml:"steps" json:"steps"`
|
// Package names the installed package that contributed this workflow. The
|
||||||
|
// package projector sets it; a run of the workflow is bounded by the
|
||||||
|
// authority accepted for that package.
|
||||||
|
Package string `yaml:"package,omitempty" json:"package,omitempty"`
|
||||||
|
Steps []StepRecord `yaml:"steps" json:"steps"`
|
||||||
// WorkflowInterface declares the workflow's inputs, repository mode and
|
// WorkflowInterface declares the workflow's inputs, repository mode and
|
||||||
// agent profile.
|
// agent profile.
|
||||||
task.WorkflowInterface `yaml:",inline" json:",inline"`
|
task.WorkflowInterface `yaml:",inline" json:",inline"`
|
||||||
@@ -108,6 +112,18 @@ func ParseDefinition(src string, registry StepRegistry) (YAMLDefinition, error)
|
|||||||
return definition, nil
|
return definition, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// PackageOf returns the package a pinned definition was projected from, or
|
||||||
|
// empty for a workflow the operator wrote.
|
||||||
|
func PackageOf(src string) string {
|
||||||
|
var declared struct {
|
||||||
|
Package string `yaml:"package"`
|
||||||
|
}
|
||||||
|
if err := yaml.Unmarshal([]byte(src), &declared); err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return declared.Package
|
||||||
|
}
|
||||||
|
|
||||||
// StageNames returns the names a definition's steps run under, in order. It
|
// StageNames returns the names a definition's steps run under, in order. It
|
||||||
// reads a definition already pinned, so it decodes without validating.
|
// reads a definition already pinned, so it decodes without validating.
|
||||||
func StageNames(src string) ([]string, error) {
|
func StageNames(src string) ([]string, error) {
|
||||||
|
|||||||
@@ -8,12 +8,14 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/nats-io/nats.go"
|
"github.com/nats-io/nats.go"
|
||||||
|
|
||||||
domainidentity "github.com/samcharles93/archie-core/internal/domain/identity"
|
domainidentity "github.com/samcharles93/archie-core/internal/domain/identity"
|
||||||
|
"github.com/samcharles93/archie-core/internal/domain/storepkg"
|
||||||
"github.com/samcharles93/archie-core/internal/domain/workflow"
|
"github.com/samcharles93/archie-core/internal/domain/workflow"
|
||||||
"github.com/samcharles93/archie-core/internal/forge"
|
"github.com/samcharles93/archie-core/internal/forge"
|
||||||
"github.com/samcharles93/archie-core/internal/natsrpc"
|
"github.com/samcharles93/archie-core/internal/natsrpc"
|
||||||
@@ -136,11 +138,18 @@ type Response struct {
|
|||||||
natsrpc.Envelope
|
natsrpc.Envelope
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Authorities answers what operator accepted for an installed package. A
|
||||||
|
// package that is not installed, or not accepted, has no authority.
|
||||||
|
type Authorities interface {
|
||||||
|
AcceptedAuthority(ctx context.Context, name string) (storepkg.Authority, error)
|
||||||
|
}
|
||||||
|
|
||||||
// Server proxies forgerpc requests to a real forge.Forge implementation.
|
// Server proxies forgerpc requests to a real forge.Forge implementation.
|
||||||
type Server struct {
|
type Server struct {
|
||||||
Forge forge.Forge
|
Forge forge.Forge
|
||||||
Runs Runs
|
Runs Runs
|
||||||
Log *slog.Logger
|
Authorities Authorities
|
||||||
|
Log *slog.Logger
|
||||||
}
|
}
|
||||||
|
|
||||||
// Register subscribes all handlers on nc under the root (identity-less)
|
// Register subscribes all handlers on nc under the root (identity-less)
|
||||||
@@ -166,8 +175,10 @@ func (s *Server) RegisterFor(nc *nats.Conn, identity string) (unsubscribe func()
|
|||||||
}
|
}
|
||||||
|
|
||||||
// authorize checks that target's credential belongs to a live run of this
|
// authorize checks that target's credential belongs to a live run of this
|
||||||
// server's identity and that the run's repository is the one targeted.
|
// server's identity and that the run's repository is the one targeted. A run
|
||||||
func (s *Server) authorize(identity string, target Target) error {
|
// of a package's workflow also needs the forge permission accepted for that
|
||||||
|
// package.
|
||||||
|
func (s *Server) authorize(identity string, target Target, permission string) error {
|
||||||
if s.Runs == nil || target.Credential == "" {
|
if s.Runs == nil || target.Credential == "" {
|
||||||
return errors.New("forge request needs a run credential")
|
return errors.New("forge request needs a run credential")
|
||||||
}
|
}
|
||||||
@@ -179,6 +190,20 @@ func (s *Server) authorize(identity string, target Target) error {
|
|||||||
!strings.EqualFold(task.Owner, target.Owner) || !strings.EqualFold(task.Repo, target.Repo) {
|
!strings.EqualFold(task.Owner, target.Owner) || !strings.EqualFold(task.Repo, target.Repo) {
|
||||||
return errors.New("forge request is outside its run's repository")
|
return errors.New("forge request is outside its run's repository")
|
||||||
}
|
}
|
||||||
|
name := workflow.PackageOf(task.WorkflowDefinitionYAML)
|
||||||
|
if name == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if s.Authorities == nil {
|
||||||
|
return fmt.Errorf("package %q: forge permission %q is not accepted", name, permission)
|
||||||
|
}
|
||||||
|
accepted, err := s.Authorities.AcceptedAuthority(context.Background(), name)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("package %q authority: %w", name, err)
|
||||||
|
}
|
||||||
|
if !slices.Contains(accepted.ForgePermissions, permission) {
|
||||||
|
return fmt.Errorf("package %q: forge permission %q is not accepted", name, permission)
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -188,7 +213,7 @@ func (s *Server) handleComment(identity string, msg *nats.Msg) {
|
|||||||
s.respond(msg, CommentResponse{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode comment request: %w", err))})
|
s.respond(msg, CommentResponse{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode comment request: %w", err))})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := s.authorize(identity, req.Target); err != nil {
|
if err := s.authorize(identity, req.Target, "comment"); err != nil {
|
||||||
s.respond(msg, CommentResponse{Envelope: natsrpc.NewEnvelope(err)})
|
s.respond(msg, CommentResponse{Envelope: natsrpc.NewEnvelope(err)})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -202,7 +227,7 @@ func (s *Server) handleCloseIssue(identity string, msg *nats.Msg) {
|
|||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode close_issue request: %w", err))})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode close_issue request: %w", err))})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := s.authorize(identity, req.Target); err != nil {
|
if err := s.authorize(identity, req.Target, "comment"); err != nil {
|
||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -216,7 +241,7 @@ func (s *Server) handleCreatePR(identity string, msg *nats.Msg) {
|
|||||||
s.respond(msg, CreatePRResponse{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode create_pr request: %w", err))})
|
s.respond(msg, CreatePRResponse{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode create_pr request: %w", err))})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := s.authorize(identity, req.Target); err != nil {
|
if err := s.authorize(identity, req.Target, "open_pr"); err != nil {
|
||||||
s.respond(msg, CreatePRResponse{Envelope: natsrpc.NewEnvelope(err)})
|
s.respond(msg, CreatePRResponse{Envelope: natsrpc.NewEnvelope(err)})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -230,7 +255,7 @@ func (s *Server) handleLinkBranch(identity string, msg *nats.Msg) {
|
|||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode link_branch request: %w", err))})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode link_branch request: %w", err))})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := s.authorize(identity, req.Target); err != nil {
|
if err := s.authorize(identity, req.Target, "open_pr"); err != nil {
|
||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -244,7 +269,7 @@ func (s *Server) handleCreateReviewComments(identity string, msg *nats.Msg) {
|
|||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode create_review_comments request: %w", err))})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode create_review_comments request: %w", err))})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := s.authorize(identity, req.Target); err != nil {
|
if err := s.authorize(identity, req.Target, "review"); err != nil {
|
||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -267,7 +292,7 @@ func (s *Server) handleReplyToReview(identity string, msg *nats.Msg) {
|
|||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode reply_to_review request: %w", err))})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode reply_to_review request: %w", err))})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := s.authorize(identity, req.Target); err != nil {
|
if err := s.authorize(identity, req.Target, "review"); err != nil {
|
||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -286,7 +311,7 @@ func (s *Server) handleSetStateLabel(identity string, msg *nats.Msg) {
|
|||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode set_state_label request: %w", err))})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(fmt.Errorf("decode set_state_label request: %w", err))})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := s.authorize(identity, req.Target); err != nil {
|
if err := s.authorize(identity, req.Target, "comment"); err != nil {
|
||||||
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
s.respond(msg, Response{Envelope: natsrpc.NewEnvelope(err)})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,9 +5,19 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
|
"github.com/samcharles93/archie-core/internal/domain/storepkg"
|
||||||
"github.com/samcharles93/archie-core/internal/domain/workflow"
|
"github.com/samcharles93/archie-core/internal/domain/workflow"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
type acceptedByPackage map[string]storepkg.Authority
|
||||||
|
|
||||||
|
func (a acceptedByPackage) AcceptedAuthority(_ context.Context, name string) (storepkg.Authority, error) {
|
||||||
|
if authority, ok := a[name]; ok {
|
||||||
|
return authority, nil
|
||||||
|
}
|
||||||
|
return storepkg.Authority{}, errors.New("not installed")
|
||||||
|
}
|
||||||
|
|
||||||
type runsByToken map[string]*workflow.Task
|
type runsByToken map[string]*workflow.Task
|
||||||
|
|
||||||
func (r runsByToken) TaskForCredential(_ context.Context, token string) (*workflow.Task, error) {
|
func (r runsByToken) TaskForCredential(_ context.Context, token string) (*workflow.Task, error) {
|
||||||
@@ -17,26 +27,41 @@ func (r runsByToken) TaskForCredential(_ context.Context, token string) (*workfl
|
|||||||
return nil, errors.New("unknown")
|
return nil, errors.New("unknown")
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestForgeCallStaysInItsRunsRepository pins that a forge call is authorized
|
// TestForgeCallStaysInItsRunsAuthority pins that a forge call is authorized
|
||||||
// only by a live run credential, on its identity's server, for its own
|
// only by a live run credential, on its identity's server, for its own
|
||||||
// repository.
|
// repository, and for a package's workflow only within the forge permissions
|
||||||
func TestForgeCallStaysInItsRunsRepository(t *testing.T) {
|
// accepted for that package.
|
||||||
s := &Server{Runs: runsByToken{"live": {Identity: "bot", Owner: "acme", Repo: "app"}}}
|
func TestForgeCallStaysInItsRunsAuthority(t *testing.T) {
|
||||||
|
packaged := "package: triage\nid: triage\n"
|
||||||
|
s := &Server{
|
||||||
|
Runs: runsByToken{
|
||||||
|
"live": {Identity: "bot", Owner: "acme", Repo: "app"},
|
||||||
|
"pkg": {Identity: "bot", Owner: "acme", Repo: "app", WorkflowDefinitionYAML: packaged},
|
||||||
|
"removed": {Identity: "bot", Owner: "acme", Repo: "app", WorkflowDefinitionYAML: "package: gone\nid: gone\n"},
|
||||||
|
},
|
||||||
|
Authorities: acceptedByPackage{"triage": {ForgePermissions: []string{"comment"}}},
|
||||||
|
}
|
||||||
|
own := func(credential string) Target { return Target{Credential: credential, Owner: "acme", Repo: "app"} }
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
identity string
|
identity string
|
||||||
target Target
|
target Target
|
||||||
allowed bool
|
permission string
|
||||||
|
allowed bool
|
||||||
}{
|
}{
|
||||||
{"own repository", "bot", Target{Credential: "live", Owner: "acme", Repo: "app"}, true},
|
{"own repository", "bot", own("live"), "comment", true},
|
||||||
{"another repository", "bot", Target{Credential: "live", Owner: "acme", Repo: "other"}, false},
|
{"another repository", "bot", Target{Credential: "live", Owner: "acme", Repo: "other"}, "comment", false},
|
||||||
{"another identity's server", "other", Target{Credential: "live", Owner: "acme", Repo: "app"}, false},
|
{"another identity's server", "other", own("live"), "comment", false},
|
||||||
{"unknown credential", "bot", Target{Credential: "gone", Owner: "acme", Repo: "app"}, false},
|
{"unknown credential", "bot", own("gone"), "comment", false},
|
||||||
{"no credential", "bot", Target{Owner: "acme", Repo: "app"}, false},
|
{"no credential", "bot", Target{Owner: "acme", Repo: "app"}, "comment", false},
|
||||||
|
{"operator workflow is not bounded by a package", "bot", own("live"), "open_pr", true},
|
||||||
|
{"package workflow within its accepted permissions", "bot", own("pkg"), "comment", true},
|
||||||
|
{"package workflow beyond its accepted permissions", "bot", own("pkg"), "open_pr", false},
|
||||||
|
{"package workflow whose package is gone", "bot", own("removed"), "comment", false},
|
||||||
}
|
}
|
||||||
for _, tt := range tests {
|
for _, tt := range tests {
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
if err := s.authorize(tt.identity, tt.target); (err == nil) != tt.allowed {
|
if err := s.authorize(tt.identity, tt.target, tt.permission); (err == nil) != tt.allowed {
|
||||||
t.Fatalf("err %v, want allowed %v", err, tt.allowed)
|
t.Fatalf("err %v, want allowed %v", err, tt.allowed)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
Reference in new issue
Block a user