alice.pds.demo.boltless.dev
This repository has no description
4.7 kB
165 lines
1package xrpc
2
3import (
4 "bytes"
5 "encoding/json"
6 "errors"
7 "log/slog"
8 "net/http"
9 "os"
10 "path/filepath"
11 "strings"
12
13 securejoin "github.com/cyphar/filepath-securejoin"
14 "github.com/go-chi/chi/v5"
15 "tangled.org/core/api/tangled"
16 "tangled.org/core/idresolver"
17 "tangled.org/core/knotserver/config"
18 "tangled.org/core/knotserver/db"
19 "tangled.org/core/knotserver/sandbox"
20 "tangled.org/core/notifier"
21 "tangled.org/core/rbac"
22 xrpcerr "tangled.org/core/xrpc/errors"
23 "tangled.org/core/xrpc/serviceauth"
24)
25
26const ActorDid = serviceauth.ActorDid
27
28type DidIngester interface {
29 AddDid(did string)
30 RemoveDid(did string)
31}
32
33type Xrpc struct {
34 Config *config.Config
35 Db *db.DB
36 Ingester DidIngester
37 Enforcer *rbac.Enforcer
38 Logger *slog.Logger
39 Notifier *notifier.Notifier
40 Resolver *idresolver.Resolver
41 ServiceAuth *serviceauth.ServiceAuth
42 Sandbox sandbox.Backend
43}
44
45func (x *Xrpc) Router() http.Handler {
46 r := chi.NewRouter()
47
48 r.Group(func(r chi.Router) {
49 r.Use(x.ServiceAuth.VerifyServiceAuth)
50
51 r.Post("/"+tangled.RepoSetDefaultBranchNSID, x.SetDefaultBranch)
52 r.Post("/"+tangled.RepoDeleteBranchNSID, x.DeleteBranch)
53 r.Post("/"+tangled.RepoCreateNSID, x.CreateRepo)
54 r.Post("/"+tangled.RepoDeleteNSID, x.DeleteRepo)
55 r.Post("/"+tangled.RepoForkStatusNSID, x.ForkStatus)
56 r.Post("/"+tangled.RepoForkSyncNSID, x.ForkSync)
57 r.Post("/"+tangled.RepoHiddenRefNSID, x.HiddenRef)
58 r.Post("/"+tangled.RepoMergeNSID, x.Merge)
59 })
60
61 // merge check is an open endpoint
62 //
63 // TODO: should we constrain this more?
64 // - we can calculate on PR submit/resubmit/gitRefUpdate etc.
65 // - use ETags on clients to keep requests to a minimum
66 r.Post("/"+tangled.RepoMergeCheckNSID, x.MergeCheck)
67
68 // repo query endpoints (no auth required)
69 r.Get("/"+tangled.RepoTreeNSID, x.RepoTree)
70 r.Get("/"+tangled.RepoLogNSID, x.RepoLog)
71 r.Get("/"+tangled.RepoBranchesNSID, x.RepoBranches)
72 r.Get("/"+tangled.RepoTagsNSID, x.RepoTags)
73 r.Get("/"+tangled.RepoTagNSID, x.RepoTag)
74 r.Get("/"+tangled.RepoBlobNSID, x.RepoBlob)
75 r.Get("/"+tangled.RepoDiffNSID, x.RepoDiff)
76 r.Get("/"+tangled.RepoCompareNSID, x.RepoCompare)
77 r.Get("/"+tangled.RepoGetDefaultBranchNSID, x.RepoGetDefaultBranch)
78 r.Get("/"+tangled.RepoDescribeRepoNSID, x.RepoDescribeRepo)
79 r.Get("/"+tangled.RepoBranchNSID, x.RepoBranch)
80 r.Get("/"+tangled.RepoArchiveNSID, x.RepoArchive)
81 r.Get("/"+tangled.RepoLanguagesNSID, x.RepoLanguages)
82
83 // knot query endpoints (no auth required)
84 r.Get("/"+tangled.KnotListKeysNSID, x.ListKeys)
85 r.Get("/"+tangled.KnotVersionNSID, x.Version)
86
87 // service query endpoints (no auth required)
88 r.Get("/"+tangled.OwnerNSID, x.Owner)
89
90 return r
91}
92
93func (x *Xrpc) parseRepoParam(repo string) (string, error) {
94 if repo == "" || !strings.HasPrefix(repo, "did:") {
95 return "", xrpcerr.NewXrpcError(
96 xrpcerr.WithTag("InvalidRequest"),
97 xrpcerr.WithMessage("missing or invalid repo parameter, expected a repo DID"),
98 )
99 }
100
101 if !strings.Contains(repo, "/") {
102 repoPath, _, _, err := x.Db.ResolveRepoDIDOnDisk(x.Config.Repo.ScanPath, repo)
103 if err != nil {
104 return "", xrpcerr.RepoNotFoundError
105 }
106 return repoPath, nil
107 }
108
109 parts := strings.SplitN(repo, "/", 2)
110 ownerDid, repoName := parts[0], parts[1]
111
112 repoDid, err := x.Db.GetRepoDid(ownerDid, repoName)
113 if err == nil {
114 repoPath, _, _, resolveErr := x.Db.ResolveRepoDIDOnDisk(x.Config.Repo.ScanPath, repoDid)
115 if resolveErr == nil {
116 return repoPath, nil
117 }
118 }
119
120 repoPath, joinErr := securejoin.SecureJoin(x.Config.Repo.ScanPath, filepath.Join(ownerDid, repoName))
121 if joinErr != nil {
122 return "", xrpcerr.RepoNotFoundError
123 }
124 if _, statErr := os.Stat(repoPath); statErr != nil {
125 return "", xrpcerr.RepoNotFoundError
126 }
127 return repoPath, nil
128}
129
130func writeError(w http.ResponseWriter, e xrpcerr.XrpcError, status int) {
131 w.Header().Set("Content-Type", "application/json")
132 w.WriteHeader(status)
133 json.NewEncoder(w).Encode(e)
134}
135
136type limitWriter struct {
137 buf bytes.Buffer
138 limit int
139 written int
140}
141
142var errResponseTooLarge = errors.New("response too large")
143
144func (lw *limitWriter) Write(p []byte) (int, error) {
145 if lw.written+len(p) > lw.limit {
146 return 0, errResponseTooLarge
147 }
148 n, err := lw.buf.Write(p)
149 lw.written += n
150 return n, err
151}
152
153func (x *Xrpc) writeJson(w http.ResponseWriter, response any) {
154 lw := &limitWriter{limit: x.Config.Server.MaxResponseKB * 1024}
155 if err := json.NewEncoder(lw).Encode(response); err != nil {
156 if errors.Is(err, errResponseTooLarge) {
157 writeError(w, xrpcerr.RequestTooLargeError, http.StatusRequestEntityTooLarge)
158 } else {
159 writeError(w, xrpcerr.GenericError(err), http.StatusInternalServerError)
160 }
161 return
162 }
163 w.Header().Set("Content-Type", "application/json")
164 w.Write(lw.buf.Bytes())
165}