patch of knotserver: add xrpc api for set default branch · round #0 · pull #348 · tangled.org/core

knotserver/config/config.go

···

       2
       2
        
       

     

       3
       3
        
       import (

     

       4
       4
        
       	"context"

     

       5
       5
       +
       	"fmt"

     

       5
       6
        
       

     

       7
       7
       +
       	"github.com/bluesky-social/indigo/atproto/syntax"

     

       6
       8
        
       	"github.com/sethvargo/go-envconfig"

     

       7
       9
        
       )

     

       8
       10
        
       

     
···

       25
       27
        
       	Dev bool `env:"DEV, default=false"`

     

       26
       28
        
       }

     

       27
       29
        
       

     

       30
       30
       +
       func (s Server) Did() syntax.DID {

     

       31
       31
       +
       	return syntax.DID(fmt.Sprintf("did:web:%s", s.Hostname))

     

       32
       32
       +
       }

     

       33
       33
       +
       

     

       28
       34
        
       type Config struct {

     

       29
       35
        
       	Repo            Repo   `env:",prefix=KNOT_REPO_"`

     

       30
       36
        
       	Server          Server `env:",prefix=KNOT_SERVER_"`

+37 -18

knotserver/handler.go

···

       8
       8
        
       	"runtime/debug"

     

       9
       9
        
       

     

       10
       10
        
       	"github.com/go-chi/chi/v5"

     

       11
       11
       +
       	"tangled.sh/tangled.sh/core/idresolver"

     

       11
       12
        
       	"tangled.sh/tangled.sh/core/jetstream"

     

       12
       13
        
       	"tangled.sh/tangled.sh/core/knotserver/config"

     

       13
       14
        
       	"tangled.sh/tangled.sh/core/knotserver/db"

     

       15
       15
       +
       	"tangled.sh/tangled.sh/core/knotserver/xrpc"

     

       16
       16
       +
       	tlog "tangled.sh/tangled.sh/core/log"

     

       14
       17
        
       	"tangled.sh/tangled.sh/core/notifier"

     

       15
       18
        
       	"tangled.sh/tangled.sh/core/rbac"

     

       16
       19
        
       )

     

       17
       20
        
       

     

       18
       18
       -
       const (

     

       19
       19
       -
       	ThisServer = "thisserver" // resource identifier for rbac enforcement

     

       20
       20
       -
       )

     

       21
       21
       -
       

     

       22
       21
        
       type Handle struct {

     

       23
       23
       -
       	c  *config.Config

     

       24
       24
       -
       	db *db.DB

     

       25
       25
       -
       	jc *jetstream.JetstreamClient

     

       26
       26
       -
       	e  *rbac.Enforcer

     

       27
       27
       -
       	l  *slog.Logger

     

       28
       28
       -
       	n  *notifier.Notifier

     

       22
       22
       +
       	c        *config.Config

     

       23
       23
       +
       	db       *db.DB

     

       24
       24
       +
       	jc       *jetstream.JetstreamClient

     

       25
       25
       +
       	e        *rbac.Enforcer

     

       26
       26
       +
       	l        *slog.Logger

     

       27
       27
       +
       	n        *notifier.Notifier

     

       28
       28
       +
       	resolver *idresolver.Resolver

     

       29
       29
        
       

     

       30
       30
        
       	// init is a channel that is closed when the knot has been initailized

     

       31
       31
        
       	// i.e. when the first user (knot owner) has been added.

     
···

       37
       37
        
       	r := chi.NewRouter()

     

       38
       38
        
       

     

       39
       39
        
       	h := Handle{

     

       40
       40
       -
       		c:    c,

     

       41
       41
       -
       		db:   db,

     

       42
       42
       -
       		e:    e,

     

       43
       43
       -
       		l:    l,

     

       44
       44
       -
       		jc:   jc,

     

       45
       45
       -
       		n:    n,

     

       46
       46
       -
       		init: make(chan struct{}),

     

       40
       40
       +
       		c:        c,

     

       41
       41
       +
       		db:       db,

     

       42
       42
       +
       		e:        e,

     

       43
       43
       +
       		l:        l,

     

       44
       44
       +
       		jc:       jc,

     

       45
       45
       +
       		n:        n,

     

       46
       46
       +
       		resolver: idresolver.DefaultResolver(),

     

       47
       47
       +
       		init:     make(chan struct{}),

     

       47
       48
        
       	}

     

       48
       49
        
       

     

       49
       49
       -
       	err := e.AddKnot(ThisServer)

     

       50
       50
       +
       	err := e.AddKnot(rbac.ThisServer)

     

       50
       51
        
       	if err != nil {

     

       51
       52
        
       		return nil, fmt.Errorf("failed to setup enforcer: %w", err)

     

       52
       53
        
       	}

     
···

       131
       132
        
       		})

     

       132
       133
        
       	})

     

       133
       134
        
       

     

       135
       135
       +
       	// xrpc apis

     

       136
       136
       +
       	r.Mount("/xrpc", h.XrpcRouter())

     

       137
       137
       +
       

     

       134
       138
        
       	// Create a new repository.

     

       135
       139
        
       	r.Route("/repo", func(r chi.Router) {

     

       136
       140
        
       		r.Use(h.VerifySignature)

     
···

       163
       167
        
       	return r, nil

     

       164
       168
        
       }

     

       165
       169
        
       

     

       170
       170
       +
       func (h *Handle) XrpcRouter() http.Handler {

     

       171
       171
       +
       	logger := tlog.New("knots")

     

       172
       172
       +
       

     

       173
       173
       +
       	xrpc := &xrpc.Xrpc{

     

       174
       174
       +
       		Config:   h.c,

     

       175
       175
       +
       		Db:       h.db,

     

       176
       176
       +
       		Ingester: h.jc,

     

       177
       177
       +
       		Enforcer: h.e,

     

       178
       178
       +
       		Logger:   logger,

     

       179
       179
       +
       		Notifier: h.n,

     

       180
       180
       +
       		Resolver: h.resolver,

     

       181
       181
       +
       	}

     

       182
       182
       +
       	return xrpc.Router()

     

       183
       183
       +
       }

     

       184
       184
       +
       

     

       166
       185
        
       // version is set during build time.

     

       167
       186
        
       var version string

     

       168
       187

+149

knotserver/xrpc/router.go

···

       1
       1
       +
       package xrpc

     

       2
       2
       +
       

     

       3
       3
       +
       import (

     

       4
       4
       +
       	"context"

     

       5
       5
       +
       	"encoding/json"

     

       6
       6
       +
       	"fmt"

     

       7
       7
       +
       	"log/slog"

     

       8
       8
       +
       	"net/http"

     

       9
       9
       +
       	"strings"

     

       10
       10
       +
       

     

       11
       11
       +
       	"tangled.sh/tangled.sh/core/api/tangled"

     

       12
       12
       +
       	"tangled.sh/tangled.sh/core/idresolver"

     

       13
       13
       +
       	"tangled.sh/tangled.sh/core/jetstream"

     

       14
       14
       +
       	"tangled.sh/tangled.sh/core/knotserver/config"

     

       15
       15
       +
       	"tangled.sh/tangled.sh/core/knotserver/db"

     

       16
       16
       +
       	"tangled.sh/tangled.sh/core/notifier"

     

       17
       17
       +
       	"tangled.sh/tangled.sh/core/rbac"

     

       18
       18
       +
       

     

       19
       19
       +
       	"github.com/bluesky-social/indigo/atproto/auth"

     

       20
       20
       +
       	"github.com/go-chi/chi/v5"

     

       21
       21
       +
       )

     

       22
       22
       +
       

     

       23
       23
       +
       type Xrpc struct {

     

       24
       24
       +
       	Config   *config.Config

     

       25
       25
       +
       	Db       *db.DB

     

       26
       26
       +
       	Ingester *jetstream.JetstreamClient

     

       27
       27
       +
       	Enforcer *rbac.Enforcer

     

       28
       28
       +
       	Logger   *slog.Logger

     

       29
       29
       +
       	Notifier *notifier.Notifier

     

       30
       30
       +
       	Resolver *idresolver.Resolver

     

       31
       31
       +
       }

     

       32
       32
       +
       

     

       33
       33
       +
       func (x *Xrpc) Router() http.Handler {

     

       34
       34
       +
       	r := chi.NewRouter()

     

       35
       35
       +
       

     

       36
       36
       +
       	r.With(x.VerifyServiceAuth).Post("/"+tangled.RepoSetDefaultBranchNSID, x.SetDefaultBranch)

     

       37
       37
       +
       

     

       38
       38
       +
       	return r

     

       39
       39
       +
       }

     

       40
       40
       +
       

     

       41
       41
       +
       func (x *Xrpc) VerifyServiceAuth(next http.Handler) http.Handler {

     

       42
       42
       +
       	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {

     

       43
       43
       +
       		l := x.Logger.With("url", r.URL)

     

       44
       44
       +
       

     

       45
       45
       +
       		token := r.Header.Get("Authorization")

     

       46
       46
       +
       		token = strings.TrimPrefix(token, "Bearer ")

     

       47
       47
       +
       

     

       48
       48
       +
       		s := auth.ServiceAuthValidator{

     

       49
       49
       +
       			Audience: x.Config.Server.Did().String(),

     

       50
       50
       +
       			Dir:      x.Resolver.Directory(),

     

       51
       51
       +
       		}

     

       52
       52
       +
       

     

       53
       53
       +
       		did, err := s.Validate(r.Context(), token, nil)

     

       54
       54
       +
       		if err != nil {

     

       55
       55
       +
       			l.Error("signature verification failed", "err", err)

     

       56
       56
       +
       			writeError(w, AuthError(err), http.StatusForbidden)

     

       57
       57
       +
       			return

     

       58
       58
       +
       		}

     

       59
       59
       +
       

     

       60
       60
       +
       		r = r.WithContext(

     

       61
       61
       +
       			context.WithValue(r.Context(), ActorDid, did),

     

       62
       62
       +
       		)

     

       63
       63
       +
       

     

       64
       64
       +
       		next.ServeHTTP(w, r)

     

       65
       65
       +
       	})

     

       66
       66
       +
       }

     

       67
       67
       +
       

     

       68
       68
       +
       type XrpcError struct {

     

       69
       69
       +
       	Tag     string `json:"error"`

     

       70
       70
       +
       	Message string `json:"message"`

     

       71
       71
       +
       }

     

       72
       72
       +
       

     

       73
       73
       +
       func NewXrpcError(opts ...ErrOpt) XrpcError {

     

       74
       74
       +
       	x := XrpcError{}

     

       75
       75
       +
       	for _, o := range opts {

     

       76
       76
       +
       		o(&x)

     

       77
       77
       +
       	}

     

       78
       78
       +
       

     

       79
       79
       +
       	return x

     

       80
       80
       +
       }

     

       81
       81
       +
       

     

       82
       82
       +
       type ErrOpt = func(xerr *XrpcError)

     

       83
       83
       +
       

     

       84
       84
       +
       func WithTag(tag string) ErrOpt {

     

       85
       85
       +
       	return func(xerr *XrpcError) {

     

       86
       86
       +
       		xerr.Tag = tag

     

       87
       87
       +
       	}

     

       88
       88
       +
       }

     

       89
       89
       +
       

     

       90
       90
       +
       func WithMessage[S ~string](s S) ErrOpt {

     

       91
       91
       +
       	return func(xerr *XrpcError) {

     

       92
       92
       +
       		xerr.Message = string(s)

     

       93
       93
       +
       	}

     

       94
       94
       +
       }

     

       95
       95
       +
       

     

       96
       96
       +
       func WithError(e error) ErrOpt {

     

       97
       97
       +
       	return func(xerr *XrpcError) {

     

       98
       98
       +
       		xerr.Message = e.Error()

     

       99
       99
       +
       	}

     

       100
       100
       +
       }

     

       101
       101
       +
       

     

       102
       102
       +
       var MissingActorDidError = NewXrpcError(

     

       103
       103
       +
       	WithTag("MissingActorDid"),

     

       104
       104
       +
       	WithMessage("actor DID not supplied"),

     

       105
       105
       +
       )

     

       106
       106
       +
       

     

       107
       107
       +
       var AuthError = func(err error) XrpcError {

     

       108
       108
       +
       	return NewXrpcError(

     

       109
       109
       +
       		WithTag("Auth"),

     

       110
       110
       +
       		WithError(fmt.Errorf("signature verification failed: %w", err)),

     

       111
       111
       +
       	)

     

       112
       112
       +
       }

     

       113
       113
       +
       

     

       114
       114
       +
       var InvalidRepoError = func(r string) XrpcError {

     

       115
       115
       +
       	return NewXrpcError(

     

       116
       116
       +
       		WithTag("InvalidRepo"),

     

       117
       117
       +
       		WithError(fmt.Errorf("supplied at-uri is not a repo: %s", r)),

     

       118
       118
       +
       	)

     

       119
       119
       +
       }

     

       120
       120
       +
       

     

       121
       121
       +
       var AccessControlError = func(d string) XrpcError {

     

       122
       122
       +
       	return NewXrpcError(

     

       123
       123
       +
       		WithTag("AccessControl"),

     

       124
       124
       +
       		WithError(fmt.Errorf("DID does not have sufficent access permissions for this operation: %s", d)),

     

       125
       125
       +
       	)

     

       126
       126
       +
       }

     

       127
       127
       +
       

     

       128
       128
       +
       var GitError = func(e error) XrpcError {

     

       129
       129
       +
       	return NewXrpcError(

     

       130
       130
       +
       		WithTag("Git"),

     

       131
       131
       +
       		WithError(fmt.Errorf("git error: %w", e)),

     

       132
       132
       +
       	)

     

       133
       133
       +
       }

     

       134
       134
       +
       

     

       135
       135
       +
       func GenericError(err error) XrpcError {

     

       136
       136
       +
       	return NewXrpcError(

     

       137
       137
       +
       		WithTag("InvalidRepo"),

     

       138
       138
       +
       		WithError(err),

     

       139
       139
       +
       	)

     

       140
       140
       +
       }

     

       141
       141
       +
       

     

       142
       142
       +
       // this is slightly different from http_util::write_error to follow the spec:

     

       143
       143
       +
       //

     

       144
       144
       +
       // the json object returned must include an "error" and a "message"

     

       145
       145
       +
       func writeError(w http.ResponseWriter, e XrpcError, status int) {

     

       146
       146
       +
       	w.Header().Set("Content-Type", "application/json")

     

       147
       147
       +
       	w.WriteHeader(status)

     

       148
       148
       +
       	json.NewEncoder(w).Encode(e)

     

       149
       149
       +
       }

+87

knotserver/xrpc/set_default_branch.go

···

       1
       1
       +
       package xrpc

     

       2
       2
       +
       

     

       3
       3
       +
       import (

     

       4
       4
       +
       	"encoding/json"

     

       5
       5
       +
       	"fmt"

     

       6
       6
       +
       	"net/http"

     

       7
       7
       +
       

     

       8
       8
       +
       	comatproto "github.com/bluesky-social/indigo/api/atproto"

     

       9
       9
       +
       	"github.com/bluesky-social/indigo/atproto/syntax"

     

       10
       10
       +
       	"github.com/bluesky-social/indigo/xrpc"

     

       11
       11
       +
       	securejoin "github.com/cyphar/filepath-securejoin"

     

       12
       12
       +
       	"tangled.sh/tangled.sh/core/api/tangled"

     

       13
       13
       +
       	"tangled.sh/tangled.sh/core/knotserver/git"

     

       14
       14
       +
       	"tangled.sh/tangled.sh/core/rbac"

     

       15
       15
       +
       )

     

       16
       16
       +
       

     

       17
       17
       +
       const ActorDid string = "ActorDid"

     

       18
       18
       +
       

     

       19
       19
       +
       func (x *Xrpc) SetDefaultBranch(w http.ResponseWriter, r *http.Request) {

     

       20
       20
       +
       	l := x.Logger

     

       21
       21
       +
       	fail := func(e XrpcError) {

     

       22
       22
       +
       		l.Error("failed", "kind", e.Tag, "error", e.Message)

     

       23
       23
       +
       		writeError(w, e, http.StatusBadRequest)

     

       24
       24
       +
       	}

     

       25
       25
       +
       

     

       26
       26
       +
       	actorDid, ok := r.Context().Value(ActorDid).(*syntax.DID)

     

       27
       27
       +
       	if !ok {

     

       28
       28
       +
       		fail(MissingActorDidError)

     

       29
       29
       +
       		return

     

       30
       30
       +
       	}

     

       31
       31
       +
       

     

       32
       32
       +
       	var data tangled.RepoSetDefaultBranch_Input

     

       33
       33
       +
       	if err := json.NewDecoder(r.Body).Decode(&data); err != nil {

     

       34
       34
       +
       		fail(GenericError(err))

     

       35
       35
       +
       		return

     

       36
       36
       +
       	}

     

       37
       37
       +
       

     

       38
       38
       +
       	// unfortunately we have to resolve repo-at here

     

       39
       39
       +
       	repoAt, err := syntax.ParseATURI(data.Repo)

     

       40
       40
       +
       	if err != nil {

     

       41
       41
       +
       		fail(InvalidRepoError(data.Repo))

     

       42
       42
       +
       		return

     

       43
       43
       +
       	}

     

       44
       44
       +
       

     

       45
       45
       +
       	// resolve this aturi to extract the repo record

     

       46
       46
       +
       	ident, err := x.Resolver.ResolveIdent(r.Context(), repoAt.Authority().String())

     

       47
       47
       +
       	if err != nil || ident.Handle.IsInvalidHandle() {

     

       48
       48
       +
       		fail(GenericError(fmt.Errorf("failed to resolve handle: %w", err)))

     

       49
       49
       +
       		return

     

       50
       50
       +
       	}

     

       51
       51
       +
       

     

       52
       52
       +
       	xrpcc := xrpc.Client{Host: ident.PDSEndpoint()}

     

       53
       53
       +
       	resp, err := comatproto.RepoGetRecord(r.Context(), &xrpcc, "", tangled.RepoNSID, repoAt.Authority().String(), repoAt.RecordKey().String())

     

       54
       54
       +
       	if err != nil {

     

       55
       55
       +
       		fail(GenericError(err))

     

       56
       56
       +
       		return

     

       57
       57
       +
       	}

     

       58
       58
       +
       

     

       59
       59
       +
       	repo := resp.Value.Val.(*tangled.Repo)

     

       60
       60
       +
       	didPath, err := securejoin.SecureJoin(actorDid.String(), repo.Name)

     

       61
       61
       +
       	if err != nil {

     

       62
       62
       +
       		fail(GenericError(err))

     

       63
       63
       +
       		return

     

       64
       64
       +
       	}

     

       65
       65
       +
       

     

       66
       66
       +
       	if ok, err := x.Enforcer.IsPushAllowed(actorDid.String(), rbac.ThisServer, didPath); !ok || err != nil {

     

       67
       67
       +
       		l.Error("insufficent permissions", "did", actorDid.String())

     

       68
       68
       +
       		writeError(w, AccessControlError(actorDid.String()), http.StatusUnauthorized)

     

       69
       69
       +
       		return

     

       70
       70
       +
       	}

     

       71
       71
       +
       

     

       72
       72
       +
       	path, _ := securejoin.SecureJoin(x.Config.Repo.ScanPath, didPath)

     

       73
       73
       +
       	gr, err := git.PlainOpen(path)

     

       74
       74
       +
       	if err != nil {

     

       75
       75
       +
       		fail(InvalidRepoError(data.Repo))

     

       76
       76
       +
       		return

     

       77
       77
       +
       	}

     

       78
       78
       +
       

     

       79
       79
       +
       	err = gr.SetDefaultBranch(data.DefaultBranch)

     

       80
       80
       +
       	if err != nil {

     

       81
       81
       +
       		l.Error("setting default branch", "error", err.Error())

     

       82
       82
       +
       		writeError(w, GitError(err), http.StatusInternalServerError)

     

       83
       83
       +
       		return

     

       84
       84
       +
       	}

     

       85
       85
       +
       

     

       86
       86
       +
       	w.WriteHeader(http.StatusNoContent)

     

       87
       87
       +
       }