1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package ports
4
5import (
6 "context"
7 "errors"
8 "io"
9 "time"
10
11 "bnema.dev/ermite/internal/domain"
12)
13
14// The interfaces below are the use cases as the inbound adapters (the API,
15// Git over HTTP, the web) and the composition root see them. The types of package
16// usecase implement them, each assertion being made in usecase; the mocks in
17// ports/mocks stand in for them in the tests of the adapters.
18
19// AuthService turns the secret of a request into a principal. It returns
20// domain.ErrUnauthenticated for a secret that is not valid. *usecase.Auth
21// implements it.
22type AuthService interface {
23 Authenticate(ctx context.Context, secret string) (domain.Principal, error)
24}
25
26// Revalidator confirms that a principal obtained earlier is still
27// authorized. *usecase.Auth implements it.
28type Revalidator interface {
29 Revalidate(ctx context.Context, p domain.Principal) error
30}
31
32// RepoLookup is the read side of a single repository. A repository the
33// principal may not read is domain.ErrNotFound. *usecase.Repos implements it, as
34// part of RepoService.
35type RepoLookup interface {
36 Get(ctx context.Context, p domain.Principal, name domain.RepoName) (domain.Repo, error)
37}
38
39// RepoService is the repository use cases the API serves. *usecase.Repos
40// implements it.
41type RepoService interface {
42 RepoLookup
43 ListPage(ctx context.Context, p domain.Principal, size int, token string) (RepoPage, error)
44 View(ctx context.Context, repo domain.Repo) (RepoView, error)
45 Create(ctx context.Context, p domain.Principal, params CreateRepoParams) (domain.Repo, error)
46 Update(ctx context.Context, p domain.Principal, name domain.RepoName, params UpdateRepoParams) (domain.Repo, error)
47 Delete(ctx context.Context, p domain.Principal, name domain.RepoName) error
48}
49
50// TokenService is the access token use cases the API serves. *usecase.Tokens
51// implements it.
52type TokenService interface {
53 Create(ctx context.Context, p domain.Principal, params CreateTokenParams) (CreatedToken, error)
54 ListPage(ctx context.Context, p domain.Principal, size int, token string) (TokenPage, error)
55 Revoke(ctx context.Context, p domain.Principal, id string) error
56}
57
58// GitHubAPIService is the subset of GitHub's REST API that ermite serves under
59// /-/github/api, for the actions that run on it (ADR 0025, CI-2). owner is the
60// owner of the URL: only ERMITE_OWNER names repositories, any other owner is
61// domain.ErrNotFound, as is a repository the principal may not read.
62// *usecase.CI implements it.
63type GitHubAPIService interface {
64 // GetRepo returns the JSON of GET /repos/{owner}/{repo}.
65 GetRepo(ctx context.Context, p domain.Principal, owner, repo string) ([]byte, error)
66 // HashAlgorithm returns the object format of the repository, "sha1".
67 HashAlgorithm(ctx context.Context, p domain.Principal, owner, repo string) (string, error)
68 // Tarball resolves ref (a branch, a tag or a commit id; empty means the
69 // default branch) and writes the gzip-compressed tar of the commit to the
70 // writer that begin returns; the archive token of an action (see
71 // domain.RepoTokenPrincipal) gets the commit it was issued for and no other.
72 // begin is called once, with the file name of the
73 // archive, before the first byte and not at all when the ref does not
74 // resolve (domain.ErrNotFound).
75 Tarball(ctx context.Context, p domain.Principal, owner, repo, ref string, begin func(filename string) io.Writer) error
76 // TarballName is Tarball for a HEAD request: the same access and the same
77 // resolution of ref, then the file name, without producing the archive.
78 TarballName(ctx context.Context, p domain.Principal, owner, repo, ref string) (string, error)
79}
80
81// BrowseService is the read side of a repository's content. *usecase.Browse
82// implements it.
83type BrowseService interface {
84 ListRefs(ctx context.Context, p domain.Principal, repo domain.RepoName, params ListRefsParams) (RefPage, error)
85 ResolveRevision(ctx context.Context, p domain.Principal, repo domain.RepoName, rev domain.Revision) (domain.ResolvedRevision, error)
86 GetTree(ctx context.Context, p domain.Principal, repo domain.RepoName, rev domain.Revision, path domain.TreePath, includeLastCommit bool) (domain.Tree, error)
87 ListPaths(ctx context.Context, p domain.Principal, repo domain.RepoName, rev domain.Revision) (domain.PathList, error)
88 OpenBlob(ctx context.Context, p domain.Principal, repo domain.RepoName, rev domain.Revision, path domain.TreePath) (domain.BlobInfo, io.ReadCloser, error)
89 ListCommits(ctx context.Context, p domain.Principal, repo domain.RepoName, params ListCommitsParams) (HistoryPage, error)
90 GetCommit(ctx context.Context, p domain.Principal, repo domain.RepoName, rev domain.Revision) (domain.CommitDetail, error)
91}
92
93// EventService streams the events of the forge. *usecase.Events implements it.
94type EventService interface {
95 Watch(ctx context.Context, p domain.Principal, params WatchParams, send func(WatchEvent) error) error
96}
97
98// MergeRequestService is the merge request use cases. *usecase.MergeRequests
99// implements it.
100type MergeRequestService interface {
101 Create(ctx context.Context, p domain.Principal, name domain.RepoName, params CreateMergeRequestParams) (domain.MergeRequest, error)
102 List(ctx context.Context, p domain.Principal, name domain.RepoName, params ListMergeRequestsParams) (MergeRequestPage, error)
103 Get(ctx context.Context, p domain.Principal, name domain.RepoName, number int64, sinceLastRead bool) (MergeRequestDetail, error)
104 AddComment(ctx context.Context, p domain.Principal, name domain.RepoName, number int64, params AddCommentParams) (domain.Comment, error)
105 ResolveComment(ctx context.Context, p domain.Principal, name domain.RepoName, number, commentID int64, resolved bool) (domain.Comment, error)
106 Close(ctx context.Context, p domain.Principal, name domain.RepoName, number int64) (domain.MergeRequest, error)
107 MarkRead(ctx context.Context, p domain.Principal, name domain.RepoName, number int64, head domain.ObjectID) (domain.ObjectID, error)
108 Merge(ctx context.Context, p domain.Principal, name domain.RepoName, number int64, params MergeParams) (MergeResult, error)
109}
110
111// SigningKeyService tells which key signs the commits of the forge.
112// *usecase.SigningKey implements it.
113type SigningKeyService interface {
114 Info() domain.SigningKeyInfo
115}
116
117// SessionService is the owner's web session use cases the API serves.
118// *usecase.Sessions implements it.
119type SessionService interface {
120 CreateLoginLink(ctx context.Context, p domain.Principal) (LoginLink, error)
121 SignOutEverywhere(ctx context.Context, p domain.Principal) error
122}
123
124// ErrLinkRejected is what WebSessionService.Login returns for a link that is
125// unknown, expired or already used.
126var ErrLinkRejected = errors.New("login link rejected")
127
128// WebSessionService is the session side of the use cases, as the web needs
129// it. The composition root implements it over *usecase.Sessions.
130type WebSessionService interface {
131 // LoginLinkValid reports whether the link is pending, without using it.
132 LoginLinkValid(nonce string) bool
133 // Login uses the link and returns the session token and how long it
134 // lasts, or ErrLinkRejected.
135 Login(ctx context.Context, nonce string) (token string, lifetime time.Duration, err error)
136 // Verify checks a session token. When it is valid it returns the owner,
137 // the principal the web passes to the use cases for that request; when it
138 // is not, ok is false and err nil. An error means the check could not be
139 // made (the request then runs as anonymous).
140 Verify(ctx context.Context, token string) (owner domain.Principal, ok bool, err error)
141}
142
143// PasskeyService is the owner's passkey use cases the API serves.
144// *usecase.Passkeys implements it. Registering a passkey and signing in with
145// one are browser ceremonies and are not part of it.
146type PasskeyService interface {
147 // List returns the passkeys, oldest first.
148 List(ctx context.Context, p domain.Principal) ([]domain.Passkey, error)
149 // Remove deletes the passkey with that credential id, or returns
150 // domain.ErrNotFound, and signs every browser out.
151 Remove(ctx context.Context, p domain.Principal, id []byte) error
152}
153
154// WebPasskeyService is the passkey side of the use cases, as the web needs
155// it: the API's List and Remove, and the browser ceremonies. The composition
156// root implements it over *usecase.Passkeys. A ceremony is the opaque
157// identifier BeginLogin and BeginRegistration return; options is the JSON the
158// browser passes to the WebAuthn API.
159type WebPasskeyService interface {
160 PasskeyService
161 // BeginLogin starts a sign-in. Anonymous callers may. client is the client
162 // key of the request (clientlimit.Key of the address the failure limiter
163 // uses); it bounds how many sign-ins a client keeps waiting.
164 BeginLogin(ctx context.Context, client string) (ceremony string, options []byte, err error)
165 // FinishLogin checks the browser's response and returns the session token
166 // and how long it lasts, or ErrLinkRejected for any refusal.
167 FinishLogin(ctx context.Context, ceremony string, response []byte) (token string, lifetime time.Duration, err error)
168 // BeginRegistration starts adding a passkey. Only the owner may. name is
169 // the name the passkey will get (empty means the default): a name that
170 // breaks the rules is refused here, before any ceremony starts, and is the
171 // one FinishRegistration stores.
172 BeginRegistration(ctx context.Context, p domain.Principal, name string) (ceremony string, options []byte, err error)
173 // FinishRegistration checks the browser's response and stores the passkey
174 // under the name given to BeginRegistration.
175 FinishRegistration(ctx context.Context, p domain.Principal, ceremony string, response []byte) error
176}
177
178// PushService opens a repository for a push: it is domain.ErrUnauthenticated
179// for an anonymous caller, domain.ErrNotFound for a repository the caller may
180// not write and cannot see (or that is missing and may not be created),
181// domain.ErrForbidden for one it can see but not write. With create, a
182// missing repository the principal may write is created. *usecase.Pushes
183// implements it.
184type PushService interface {
185 Open(ctx context.Context, p domain.Principal, name domain.RepoName, create bool) error
186}
187
188// PushHookService is what the hook socket asks of the use cases.
189// *usecase.Pushes implements it.
190type PushHookService interface {
191 // Check decides a push before Git applies it; an error matching
192 // domain.ErrRejected refuses it, any other error refuses it as a failure.
193 // objects are the objects of the push in progress (the quarantine of git).
194 Check(ctx context.Context, p domain.Principal, name domain.RepoName, updates []domain.RefUpdate, objects PushObjects) error
195 // Record handles an accepted push.
196 Record(ctx context.Context, p domain.Principal, name domain.RepoName, updates []domain.RefUpdate) error
197}
198
199// MaintenanceScheduler queues repository maintenance. *usecase.Maintainer
200// implements it.
201type MaintenanceScheduler interface {
202 Schedule(ctx context.Context, name domain.RepoName)
203}
204
205// HookTokens hands out the per-request tokens the hooks of a push present
206// back to ermite, and the socket they present them on. The Git HTTP adapter
207// implements it.
208type HookTokens interface {
209 // Register binds a new token to the repository and principal of a push.
210 // release revokes it and must be called when the request ends.
211 Register(ctx context.Context, repo domain.RepoName, p domain.Principal) (token string, release func())
212 // Socket is the path of the hook socket.
213 Socket() string
214}
215
216// FailureLimiter counts the failed authentications per client. The adapters
217// that authenticate share one, so that a client has one budget of failures.
218// *clientlimit.Limiter implements it.
219type FailureLimiter interface {
220 Blocked(ctx context.Context, addr string) (bool, time.Duration)
221 Fail(ctx context.Context, addr string)
222}
223
224// SecretPage is one page of secrets.
225type SecretPage struct {
226 Secrets []domain.Secret
227 NextPageToken string
228}
229
230// VariablePage is one page of variables.
231type VariablePage struct {
232 Variables []domain.Variable
233 NextPageToken string
234}
235
236// EnvironmentPage is one page of environments.
237type EnvironmentPage struct {
238 Environments []domain.Environment
239 NextPageToken string
240}
241
242// SecretService is the secret use cases the API serves. They need the
243// secrets:write scope, never on a token limited to branches. Values are never
244// returned. *usecase.CISettings implements it.
245type SecretService interface {
246 SetSecret(ctx context.Context, p domain.Principal, scope domain.SettingsScope, name, value string) (domain.Secret, error)
247 ListSecrets(ctx context.Context, p domain.Principal, scope domain.SettingsScope, size int, token string) (SecretPage, error)
248 DeleteSecret(ctx context.Context, p domain.Principal, scope domain.SettingsScope, name string) error
249}
250
251// VariableService is the variable use cases the API serves, with the access
252// rules of SecretService. *usecase.CISettings implements it.
253type VariableService interface {
254 SetVariable(ctx context.Context, p domain.Principal, scope domain.SettingsScope, name, value string) (domain.Variable, error)
255 GetVariable(ctx context.Context, p domain.Principal, scope domain.SettingsScope, name string) (domain.Variable, error)
256 ListVariables(ctx context.Context, p domain.Principal, scope domain.SettingsScope, size int, token string) (VariablePage, error)
257 DeleteVariable(ctx context.Context, p domain.Principal, scope domain.SettingsScope, name string) error
258}
259
260// EnvironmentService is the environment use cases the API serves, with the
261// access rules of SecretService. *usecase.CISettings implements it.
262type EnvironmentService interface {
263 CreateEnvironment(ctx context.Context, p domain.Principal, repo domain.RepoName, name string) (domain.Environment, error)
264 ListEnvironments(ctx context.Context, p domain.Principal, repo domain.RepoName, size int, token string) (EnvironmentPage, error)
265 DeleteEnvironment(ctx context.Context, p domain.Principal, repo domain.RepoName, name string) error
266}