alice.pds.demo.boltless.dev
This repository has no description
4.9 kB
167 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 r.Post("/"+tangled.KnotAddMemberNSID, x.AddMember)
60 r.Post("/"+tangled.KnotRemoveMemberNSID, x.RemoveMember)
61 })
62
63 // merge check is an open endpoint
64 //
65 // TODO: should we constrain this more?
66 // - we can calculate on PR submit/resubmit/gitRefUpdate etc.
67 // - use ETags on clients to keep requests to a minimum
68 r.Post("/"+tangled.RepoMergeCheckNSID, x.MergeCheck)
69
70 // repo query endpoints (no auth required)
71 r.Get("/"+tangled.RepoTreeNSID, x.RepoTree)
72 r.Get("/"+tangled.RepoLogNSID, x.RepoLog)
73 r.Get("/"+tangled.RepoBranchesNSID, x.RepoBranches)
74 r.Get("/"+tangled.RepoTagsNSID, x.RepoTags)
75 r.Get("/"+tangled.RepoTagNSID, x.RepoTag)
76 r.Get("/"+tangled.RepoBlobNSID, x.RepoBlob)
77 r.Get("/"+tangled.RepoDiffNSID, x.RepoDiff)
78 r.Get("/"+tangled.RepoCompareNSID, x.RepoCompare)
79 r.Get("/"+tangled.RepoGetDefaultBranchNSID, x.RepoGetDefaultBranch)
80 r.Get("/"+tangled.RepoDescribeRepoNSID, x.RepoDescribeRepo)
81 r.Get("/"+tangled.RepoBranchNSID, x.RepoBranch)
82 r.Get("/"+tangled.RepoArchiveNSID, x.RepoArchive)
83 r.Get("/"+tangled.RepoLanguagesNSID, x.RepoLanguages)
84
85 // knot query endpoints (no auth required)
86 r.Get("/"+tangled.KnotListKeysNSID, x.ListKeys)
87 r.Get("/"+tangled.KnotVersionNSID, x.Version)
88
89 // service query endpoints (no auth required)
90 r.Get("/"+tangled.OwnerNSID, x.Owner)
91
92 return r
93}
94
95func (x *Xrpc) parseRepoParam(repo string) (string, error) {
96 if repo == "" || !strings.HasPrefix(repo, "did:") {
97 return "", xrpcerr.NewXrpcError(
98 xrpcerr.WithTag("InvalidRequest"),
99 xrpcerr.WithMessage("missing or invalid repo parameter, expected a repo DID"),
100 )
101 }
102
103 if !strings.Contains(repo, "/") {
104 repoPath, _, _, err := x.Db.ResolveRepoDIDOnDisk(x.Config.Repo.ScanPath, repo)
105 if err != nil {
106 return "", xrpcerr.RepoNotFoundError
107 }
108 return repoPath, nil
109 }
110
111 parts := strings.SplitN(repo, "/", 2)
112 ownerDid, repoName := parts[0], parts[1]
113
114 repoDid, err := x.Db.GetRepoDid(ownerDid, repoName)
115 if err == nil {
116 repoPath, _, _, resolveErr := x.Db.ResolveRepoDIDOnDisk(x.Config.Repo.ScanPath, repoDid)
117 if resolveErr == nil {
118 return repoPath, nil
119 }
120 }
121
122 repoPath, joinErr := securejoin.SecureJoin(x.Config.Repo.ScanPath, filepath.Join(ownerDid, repoName))
123 if joinErr != nil {
124 return "", xrpcerr.RepoNotFoundError
125 }
126 if _, statErr := os.Stat(repoPath); statErr != nil {
127 return "", xrpcerr.RepoNotFoundError
128 }
129 return repoPath, nil
130}
131
132func writeError(w http.ResponseWriter, e xrpcerr.XrpcError, status int) {
133 w.Header().Set("Content-Type", "application/json")
134 w.WriteHeader(status)
135 json.NewEncoder(w).Encode(e)
136}
137
138type limitWriter struct {
139 buf bytes.Buffer
140 limit int
141 written int
142}
143
144var errResponseTooLarge = errors.New("response too large")
145
146func (lw *limitWriter) Write(p []byte) (int, error) {
147 if lw.written+len(p) > lw.limit {
148 return 0, errResponseTooLarge
149 }
150 n, err := lw.buf.Write(p)
151 lw.written += n
152 return n, err
153}
154
155func (x *Xrpc) writeJson(w http.ResponseWriter, response any) {
156 lw := &limitWriter{limit: x.Config.Server.MaxResponseKB * 1024}
157 if err := json.NewEncoder(lw).Encode(response); err != nil {
158 if errors.Is(err, errResponseTooLarge) {
159 writeError(w, xrpcerr.RequestTooLargeError, http.StatusRequestEntityTooLarge)
160 } else {
161 writeError(w, xrpcerr.GenericError(err), http.StatusInternalServerError)
162 }
163 return
164 }
165 w.Header().Set("Content-Type", "application/json")
166 w.Write(lw.buf.Bytes())
167}