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