1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package app
4
5import (
6 "context"
7 "crypto/ed25519"
8 "crypto/rand"
9 "crypto/rsa"
10 "errors"
11 "fmt"
12 "net"
13 "os"
14 "path/filepath"
15 "strings"
16 "time"
17
18 "github.com/bnema/zerowrap"
19
20 "bnema.dev/ermite/internal/adapters/ciartifacts"
21 "bnema.dev/ermite/internal/adapters/cilogs"
22 "bnema.dev/ermite/internal/adapters/cisummaries"
23 "bnema.dev/ermite/internal/adapters/ermitegit"
24 "bnema.dev/ermite/internal/adapters/eventbus"
25 "bnema.dev/ermite/internal/adapters/gitcli"
26 "bnema.dev/ermite/internal/adapters/githttp"
27 "bnema.dev/ermite/internal/adapters/githubapi"
28 "bnema.dev/ermite/internal/adapters/githubraw"
29 "bnema.dev/ermite/internal/adapters/gitpush"
30 "bnema.dev/ermite/internal/adapters/gitremote"
31 "bnema.dev/ermite/internal/adapters/httpserver"
32 "bnema.dev/ermite/internal/adapters/kvstore"
33 "bnema.dev/ermite/internal/adapters/oidchttp"
34 "bnema.dev/ermite/internal/adapters/rpc"
35 "bnema.dev/ermite/internal/adapters/secretbox"
36 "bnema.dev/ermite/internal/adapters/sigverify"
37 "bnema.dev/ermite/internal/adapters/sshsig"
38 "bnema.dev/ermite/internal/adapters/web"
39 "bnema.dev/ermite/internal/adapters/webauthn"
40 "bnema.dev/ermite/internal/clientlimit"
41 "bnema.dev/ermite/internal/config"
42 "bnema.dev/ermite/internal/domain"
43 "bnema.dev/ermite/internal/ports"
44 "bnema.dev/ermite/internal/usecase"
45)
46
47// maxReceiveBytes bounds the body of a push, both at the HTTP handler and in
48// Git (receive.maxInputSize).
49const maxReceiveBytes = githttp.DefaultMaxBodyBytes
50
51// options are the parts of the wiring that tests replace.
52type options struct {
53 // pusher and mirrors override mirror transport/settings in local tests only.
54 pusher ports.MirrorPusher
55 mirrors func(*usecase.MirrorsConfig)
56 // hookExe is the executable the hook scripts exec; empty means this
57 // process's own executable.
58 hookExe string
59 // maintenanceDelay overrides usecase.MaintenanceDelay when positive.
60 maintenanceDelay time.Duration
61 // maxBodyBytes overrides the limit of a push body when positive.
62 maxBodyBytes int64
63 // eventBuffer overrides usecase.DefaultEventBuffer when positive.
64 eventBuffer int
65 // revalidateEvery overrides usecase.DefaultRevalidateEvery when not zero.
66 revalidateEvery time.Duration
67 // archivesPerClient overrides the archives one client downloads at once
68 // when positive.
69 archivesPerClient int
70 // receivePacks overrides the git-receive-pack backends running at once
71 // when positive (the default follows GOMAXPROCS).
72 receivePacks int
73 // remote replaces the lister of github.com refs (tests never reach the
74 // network).
75 remoteLister ports.GitRemote
76 // workflowFetcher replaces the downloader of github.com reusable workflows
77 // (tests never reach the network).
78 workflowFetcher ports.WorkflowFetcher
79 // ci overrides the settings of the CI engine (tests shorten its
80 // durations).
81 ci func(*usecase.CIConfig)
82 // oidcKey generates the signing keys of the ID tokens; nil generates RSA
83 // keys (tests give prepared ones: a 3072-bit key takes a while).
84 oidcKey func() (*rsa.PrivateKey, error)
85 // issuePoW lowers the proof of work of the public issue form (the base
86 // and the highest difficulty, in bits) when positive, and shortens the
87 // minimum fill time to a nanosecond; tests only.
88 issuePoW int
89}
90
91// remote returns the lister of github.com refs: the test's, else def.
92func (o options) remote(def ports.GitRemote) ports.GitRemote {
93 if o.remoteLister != nil {
94 return o.remoteLister
95 }
96 return def
97}
98
99// workflows returns the downloader of github.com reusable workflows: the
100// test's, else def.
101func (o options) workflows(def ports.WorkflowFetcher) ports.WorkflowFetcher {
102 if o.workflowFetcher != nil {
103 return o.workflowFetcher
104 }
105 return def
106}
107
108// forge is the wired server: every adapter and use case, ready to serve.
109type forge struct {
110 cfg config.Config
111 store *kvstore.Store
112 server *httpserver.Server
113 hooks *githttp.HookServer
114 maint *usecase.Maintainer
115 git *gitcli.Git
116 // reader is the ermite-git reader when ERMITE_GIT_READER selects it.
117 reader *ermitegit.Adapter
118
119 // The use cases and the API are exposed for tests and for the phases
120 // that add the web.
121 Repos *usecase.Repos
122 Tokens *usecase.Tokens
123 Auth *usecase.Auth
124 Pushes *usecase.Pushes
125 Browse *usecase.Browse
126 // MergeRequests and SigningKey serve MergeRequestService and
127 // ServerService.GetSigningKey.
128 MergeRequests *usecase.MergeRequests
129 // Issues serves IssueService, and tells what a number names.
130 Issues *usecase.Issues
131 // IssueModeration serves the moderation calls of IssueService.
132 IssueModeration *usecase.IssueModeration
133 // IssueKeys are the subkeys of the public issue form, and the stores and
134 // the limiter its submissions use (the form itself comes later).
135 IssueKeys *usecase.IssueKeys
136 // IssueSubmissions serves the anonymous submission of issues.
137 IssueSubmissions *usecase.IssueSubmissions
138 SubmissionLimiter *clientlimit.SubmissionLimiter
139 PendingIssues ports.PendingIssueStore
140 IssueBans ports.IssueBanStore
141 // Inbox serves the owner's inbox of the web.
142 Inbox *usecase.Inbox
143 SigningKey *usecase.SigningKey
144 // Mergeability keeps the mergeability of the open merge requests up to date.
145 Mergeability *usecase.Mergeability
146 // Signatures are the trusted keys and the commit signature checks
147 // (ADR 0030).
148 Signatures *usecase.Signatures
149 Sessions *usecase.Sessions
150 // Passkeys is nil when passkeys are not available (passkeysAvailable).
151 Passkeys *usecase.Passkeys
152 EventLog *usecase.Events
153 // CI is the CI engine: workflow trigger, planner, runner protocol and the
154 // owner side. It starts with the server and stops with it.
155 CI *usecase.CI
156 // Settings are the secrets, variables and environments of CI.
157 Settings *usecase.CISettings
158 // Mirrors exposes Warning and Badge for the hook server and web composition.
159 Mirrors *usecase.Mirrors
160 // OIDC is the provider of ID tokens, disabled without a secrets key.
161 OIDC *usecase.OIDC
162 API *rpc.API
163 Bus ports.EventBus
164}
165
166// newSigningSeed makes the seed of a new ed25519 signing key.
167func newSigningSeed() ([]byte, error) {
168 seed := make([]byte, ed25519.SeedSize)
169 if _, err := rand.Read(seed); err != nil {
170 return nil, err
171 }
172 return seed, nil
173}
174
175// serverVersion is the version GetVersion reports: the module version of the
176// build, or "devel" for an untagged one.
177func serverVersion() string {
178 if v := buildVersion(); v != "(devel)" {
179 return v
180 }
181 return "devel"
182}
183
184// newForge opens the metadata store, resets run/, checks git, reconciles the repositories,
185// writes the hook scripts, opens the hook socket and builds the HTTP server.
186// The data directory must be prepared (prepareDataDir). Close it after the
187// server stopped.
188func newForge(ctx context.Context, cfg config.Config, opts options) (_ *forge, err error) {
189 log := zerowrap.FromCtx(ctx)
190 store, err := kvstore.Open(ctx, filepath.Join(cfg.DataDir, "kv"))
191 if err != nil {
192 return nil, err
193 }
194 f := &forge{cfg: cfg, store: store}
195 defer func() {
196 if err != nil {
197 f.Close(context.WithoutCancel(ctx))
198 }
199 }()
200 // The kv store holds the directory lock: only now is run/ ours to reset.
201 // The hook scripts and the socket are written into it afterwards.
202 if err := resetRunDir(cfg.DataDir); err != nil {
203 return nil, err
204 }
205
206 path := os.Getenv("PATH")
207 if path == "" {
208 path = "/usr/local/bin:/usr/bin:/bin"
209 }
210 maxBody := maxReceiveBytes
211 if opts.maxBodyBytes > 0 {
212 maxBody = opts.maxBodyBytes
213 }
214 git := gitcli.New(gitcli.Config{Bin: cfg.Git, DataDir: cfg.DataDir, Path: path, MaxReceiveBytes: maxBody})
215 f.git = git
216 gitVersion, err := git.CheckVersion(ctx)
217 if err != nil {
218 return nil, fmt.Errorf("%s=%q: %w", config.EnvGit, cfg.Git, err)
219 }
220 log.Info().Str("git", gitVersion.String()).Msg("git checked")
221 if _, err := git.HTTPBackend(ctx, false); err != nil {
222 return nil, fmt.Errorf("%s=%q: %w", config.EnvGit, cfg.Git, err)
223 }
224
225 clock := systemClock{}
226 f.Bus = eventbus.New()
227 f.Repos = usecase.NewRepos(store, git, f.Bus, clock)
228 report, err := f.Repos.Reconcile(ctx)
229 if err != nil {
230 return nil, fmt.Errorf("reconcile repositories: %w", err)
231 }
232 log.Info().
233 Int("registered", len(report.Registered)).
234 Int("missing_dirs", len(report.MissingDirs)).
235 Int("invalid_dirs", len(report.InvalidDirs)).
236 Msg("repositories reconciled")
237
238 f.Tokens = usecase.NewTokens(store.Tokens(), clock, store.Sessions())
239 f.Auth = usecase.NewAuth(cfg.AdminTokenHash, store.Tokens(), clock).WithRepoTokens(store.CI())
240 f.maint = usecase.NewMaintainer(ctx, git, opts.maintenanceDelay)
241 f.Pushes = usecase.NewPushes(store, f.Repos, git, f.Bus, clock, f.maint, f.Auth)
242
243 exe := opts.hookExe
244 if exe == "" {
245 if exe, err = os.Executable(); err != nil {
246 return nil, fmt.Errorf("find the ermite executable for the hooks: %w", err)
247 }
248 }
249 if err := githttp.WriteHookScripts(gitcli.HooksDir(cfg.DataDir), exe); err != nil {
250 return nil, err
251 }
252 f.hooks = githttp.NewHookServer(filepath.Join(cfg.DataDir, "run", "hook.sock"), f.Pushes)
253 if err := f.hooks.Listen(ctx); err != nil {
254 return nil, err
255 }
256
257 var reader ports.RepoReader = git
258 if cfg.GitReader == config.GitReaderErmiteGit {
259 f.reader = ermitegit.New(ermitegit.Config{
260 Fallback: git,
261 RepoDir: func(name domain.RepoName) string { return gitcli.RepoDir(cfg.DataDir, name) },
262 })
263 git.OnTrash(f.reader.Forget)
264 f.maint.WithFreshener(f.reader)
265 f.Pushes.WithFreshener(f.reader)
266 reader = f.reader
267 }
268 log.Info().Str("reader", cfg.GitReader).Msg("git reader selected")
269 f.Browse = usecase.NewBrowse(store, reader)
270
271 // Secrets, variables and environments (ADR 0019, CI-3). With a key the
272 // secrets are sealed under it, and the server refuses to start when the
273 // key is not the one they were sealed with; without one they cannot be set
274 // and jobs receive none.
275 var sealer ports.SecretSealer // a nil *secretbox.Box must not become a non-nil interface
276 if cfg.SecretsKey != nil {
277 box, err := secretbox.New(cfg.SecretsKey)
278 if err != nil {
279 return nil, fmt.Errorf("%s: %w", config.EnvSecretsKey, err)
280 }
281 sealer = box
282 }
283 pusher := opts.pusher
284 if pusher == nil {
285 pusher = gitpush.New(gitpush.Config{
286 Bin: cfg.Git, Path: path, Home: filepath.Join(cfg.DataDir, "run", "git-home"),
287 KnownHosts: filepath.Join(cfg.DataDir, "mirror_known_hosts"),
288 TempDir: filepath.Join(cfg.DataDir, "run", "mirror"),
289 RepoDir: func(name domain.RepoName) string { return gitcli.RepoDir(cfg.DataDir, name) },
290 })
291 }
292 mirrorCfg := usecase.MirrorsConfig{
293 Store: store, Keys: store, Sealer: sealer, Pusher: pusher,
294 Meta: store, Git: git, Reader: reader, Bus: f.Bus, Clock: clock, PublicURL: cfg.PublicURL,
295 }
296 if opts.mirrors != nil {
297 opts.mirrors(&mirrorCfg)
298 }
299 f.Mirrors = usecase.NewMirrors(mirrorCfg)
300 f.Pushes.WithMirror(f.Mirrors)
301 f.Repos.WithMirror(f.Mirrors)
302 f.hooks.WithMirrorWarner(f.Mirrors)
303
304 f.Settings, err = usecase.NewCISettings(ctx, store, store.Settings(), sealer, clock)
305 if err != nil {
306 return nil, fmt.Errorf("%s: %w", config.EnvSecretsKey, err)
307 }
308 // The OIDC provider of CI jobs (CI-4): its signing key is sealed with the
309 // secrets key, so there is none without one.
310 f.OIDC, err = usecase.NewOIDC(ctx, usecase.OIDCConfig{
311 Store: store, Sealer: sealer, Tokens: store.CI(), Clock: clock, PublicURL: cfg.PublicURL, NewKey: opts.oidcKey,
312 })
313 if err != nil {
314 return nil, fmt.Errorf("oidc: %w", err)
315 }
316
317 // CI (ADR 0025): the engine reads workflows through the reader, and plans
318 // them in the background; a push only queues its refs.
319 committer := domain.Identity{Name: cfg.CommitterName, Email: cfg.CommitterEmail}
320 ciCfg := usecase.CIConfig{
321 Store: store.CI(), Logs: cilogs.New(cilogs.Dir(cfg.DataDir)), Summaries: cisummaries.New(cisummaries.Dir(cfg.DataDir)), Meta: store, Repos: git, Reader: reader,
322 Git: git, Diff: git, Bus: f.Bus, Clock: clock, Auth: f.Auth,
323 Owner: cfg.Owner, PublicURL: cfg.PublicURL, Retention: cfg.CIRetention,
324 PollTimeout: cfg.CIPollTimeout, Archive: git,
325 Remote: opts.remote(gitremote.New(gitremote.Config{
326 Bin: cfg.Git, Path: path, Home: filepath.Join(cfg.DataDir, "run", "git-home"),
327 Proxy: gitremote.ProxyEnv(os.Getenv),
328 })),
329 Tokens: store.Tokens(),
330 RefTips: store.CI(),
331 WorkflowState: store.CI(),
332 Settings: f.Settings,
333 Workflows: opts.workflows(githubraw.New(githubraw.Config{})),
334 OIDC: f.OIDC,
335 }
336 artifacts(&ciCfg, cfg, store)
337 f.pullRequests(&ciCfg, store, git, committer)
338 if opts.ci != nil {
339 opts.ci(&ciCfg)
340 }
341 f.CI = usecase.NewCI(ctx, ciCfg)
342 f.Pushes.WithWorkflowTrigger(f.CI).WithPushTreeReader(git).WithRefTips(store.CI())
343 f.Repos.WithCIRunCleaner(f.CI)
344 f.CI.Start()
345 f.EventLog = usecase.NewEvents(ctx, f.Repos, f.Bus, clock, usecase.EventsConfig{
346 Size: opts.eventBuffer, Auth: f.Auth, RevalidateEvery: opts.revalidateEvery,
347 })
348
349 // The instance signing key (ADR 0022): generated on the first start.
350 seed, err := store.SigningSeed(ctx, newSigningSeed, clock.Now().UTC())
351 if err != nil {
352 return nil, err
353 }
354 signer, err := sshsig.New(seed)
355 if err != nil {
356 return nil, err
357 }
358 f.SigningKey = usecase.NewSigningKey(signer, committer)
359 if err := f.signatures(store, reader, signer.PublicKey(), committer, clock); err != nil {
360 return nil, err
361 }
362 f.Mergeability = usecase.NewMergeability(ctx, usecase.MergeabilityConfig{
363 Store: store.MergeRequests(), Meta: store, Git: git, Bus: f.Bus, Clock: clock,
364 })
365 f.Pushes.WithMergeability(f.Mergeability)
366 links := usecase.NewIssueLinks(usecase.IssueLinksConfig{Meta: store, Issues: store.Issues(), MRs: store.MergeRequests(), Links: store.IssueLinks(), Git: git, Bus: f.Bus, Clock: clock})
367 f.Pushes.WithIssueLinks(links)
368 f.MergeRequests = usecase.NewMergeRequests(usecase.MergeRequestsConfig{
369 Links: links, Meta: store, Store: store.MergeRequests(), Repos: git, Git: git, Signer: signer,
370 Committer: committer, Bus: f.Bus, Clock: clock, Maint: f.maint,
371 CI: f.CI, Checks: f.CI, PullRequests: f.CI, RefTips: store.CI(), Mergeability: f.Mergeability,
372 })
373 f.Mergeability.Start()
374 f.MergeRequests.WithVerifier(f.Signatures).WithMirror(f.Mirrors)
375 f.Issues = usecase.NewIssues(usecase.IssuesConfig{
376 Links: store.IssueLinks(), Meta: store, Store: store.Issues(), MergeRequests: store.MergeRequests(), Bus: f.Bus, Clock: clock,
377 })
378 f.IssueModeration = usecase.NewIssueModeration(usecase.IssueModerationConfig{
379 Meta: store, Pending: store.PendingIssues(), Bans: store.IssueBans(), Bus: f.Bus, Clock: clock,
380 })
381 f.SubmissionLimiter = clientlimit.NewSubmissionLimiter(nil)
382 f.PendingIssues, f.IssueBans = store.PendingIssues(), store.IssueBans()
383 f.IssueKeys, err = usecase.NewIssueKeys(ctx, store.IssueKeys())
384 if err != nil {
385 return nil, err
386 }
387 f.IssueSubmissions = usecase.NewIssueSubmissions(usecase.IssueSubmissionsConfig{
388 Meta: store, Pending: f.PendingIssues, Bans: f.IssueBans, Limiter: f.SubmissionLimiter,
389 Keys: f.IssueKeys, Bus: f.Bus, Clock: clock,
390 BaseDifficulty: opts.issuePoW, MaxDifficulty: opts.issuePoW, MinFillTime: fastFill(opts.issuePoW),
391 })
392 f.Inbox = usecase.NewInbox(usecase.InboxConfig{
393 Meta: store, MergeRequests: store.MergeRequests(), Issues: store.Issues(), Pending: store.PendingIssues(),
394 })
395 f.CI.SetPullGate(f.MergeRequests)
396 log.Info().Str("fingerprint", signer.PublicKey().Fingerprint).Msg("commit signing key ready")
397
398 f.Sessions, err = usecase.NewSessions(ctx, store.Sessions(), clock, cfg.PublicURL)
399 if err != nil {
400 return nil, err
401 }
402
403 // Owner passkeys (ADR 0026): built only when the public URL allows them.
404 // When it does, a verifier that cannot be built is fatal.
405 if ok, reason := passkeysAvailable(cfg.PublicURL); ok {
406 verifier, err := webauthn.New(cfg.PublicURL, cfg.Owner)
407 if err != nil {
408 return nil, fmt.Errorf("passkeys: %w", err)
409 }
410 f.Passkeys = usecase.NewPasskeys(store.Passkeys(), verifier, f.Sessions, clock)
411 log.Info().Str("public_url", cfg.PublicURL).Msg("passkeys enabled")
412 } else {
413 log.Info().Str("reason", reason).Msg("passkeys disabled")
414 }
415
416 // One budget of failed authentications per client, for Git, the API and
417 // the web login.
418 limiter := clientlimit.NewLimiter(nil)
419 // A nil *usecase.Passkeys must not become a non-nil interface: the API
420 // tests for nil to answer failed_precondition and to leave the feature out.
421 var apiPasskeys ports.PasskeyService
422 if f.Passkeys != nil {
423 apiPasskeys = f.Passkeys
424 }
425 var jobArtifacts ports.JobArtifactService
426 var artifacts ports.ArtifactService
427 if cfg.CIArtifacts {
428 jobArtifacts, artifacts = f.CI, f.CI
429 }
430 f.API = rpc.New(rpc.Config{
431 Auth: f.Auth,
432 Mirrors: f.Mirrors,
433 Repos: f.Repos,
434 Tokens: f.Tokens,
435 Browse: f.Browse,
436 Events: f.EventLog,
437 MergeRequests: f.MergeRequests,
438 Issues: f.Issues,
439 IssueModeration: f.IssueModeration,
440 SigningKey: f.SigningKey,
441 TrustedKeys: f.Signatures,
442 Sessions: f.Sessions,
443 Passkeys: apiPasskeys,
444 Runner: f.CI,
445 Runs: f.CI,
446 Secrets: f.Settings,
447 Variables: f.Settings,
448 Environments: f.Settings,
449 OIDCKeys: f.OIDC,
450 JobArtifacts: jobArtifacts,
451 Artifacts: artifacts,
452 Version: serverVersion(),
453 TrustedProxies: cfg.TrustedProxies,
454 Limiter: limiter,
455 })
456
457 gh := githttp.New(githttp.Config{
458 Auth: f.Auth,
459 Repos: f.Repos,
460 Pushes: f.Pushes,
461 Backend: git,
462 Owner: cfg.Owner,
463 Hooks: f.hooks,
464 TrustedProxies: cfg.TrustedProxies,
465 Limiter: limiter,
466 MaxBodyBytes: maxBody,
467 MaxReceivePacks: opts.receivePacks,
468 })
469 routes := make([]httpserver.Route, 0, 2*len(githttp.Patterns)+len(githubapi.Patterns)+len(oidchttp.Patterns)+len(web.Patterns))
470 for _, p := range githttp.Patterns {
471 routes = append(routes, httpserver.Route{Pattern: p, Handler: gh})
472 }
473 // The owner form of the clone URL (github.repository), which GitHub's
474 // actions use. config.Owner follows the rules of repository names, so it is
475 // a literal segment that never overlaps /-/.
476 for _, p := range githttp.OwnerPatterns(cfg.Owner) {
477 routes = append(routes, httpserver.Route{Pattern: p, Handler: gh})
478 }
479 // The REST subset the actions call on github.api_url.
480 api := githubapi.New(githubapi.Config{Auth: f.Auth, API: f.CI, TrustedProxies: cfg.TrustedProxies, Limiter: limiter, MaxArchivesPerClient: opts.archivesPerClient})
481 for _, p := range githubapi.Patterns {
482 routes = append(routes, httpserver.Route{Pattern: p, Handler: api})
483 }
484 // The OIDC provider of CI jobs (issuer <public URL>/-/oidc).
485 idp := oidchttp.New(oidchttp.Config{OIDC: f.CI, TrustedProxies: cfg.TrustedProxies, Limiter: limiter})
486 for _, p := range oidchttp.Patterns {
487 routes = append(routes, httpserver.Route{Pattern: p, Handler: idp})
488 }
489 warnSessionsNeedHTTPS(ctx, cfg.PublicURL)
490 warnSharedClientKey(ctx, cfg.TrustedProxies, githttp.DefaultMaxPerClient)
491 site, err := newWeb(cfg, f, limiter)
492 if err != nil {
493 return nil, fmt.Errorf("web: %w", err)
494 }
495 routes = append(routes, webRoutes(site)...)
496 f.server = httpserver.New(httpserver.Config{
497 Addr: cfg.Addr,
498 PublicURL: cfg.PublicURL,
499 HealthChecks: []httpserver.Check{store.Check, httpserver.DirWritable(cfg.DataDir)},
500 Routes: routes,
501 API: f.API.Handler(),
502 // Event streams never end by themselves: close them when the
503 // shutdown begins, or it would wait for them until its timeout.
504 OnShutdown: []func(){func() { f.EventLog.Close(context.WithoutCancel(ctx)) }},
505 })
506 return f, nil
507}
508
509// Run listens on the configured address and serves until ctx ends.
510func (f *forge) Run(ctx context.Context) error {
511 ln, err := net.Listen("tcp", f.cfg.Addr)
512 if err != nil {
513 return fmt.Errorf("listen on %s: %w", f.cfg.Addr, err)
514 }
515 return f.Serve(ctx, ln)
516}
517
518// Serve serves HTTP on ln and the hook socket until ctx ends. The hook socket
519// outlives the HTTP server: requests still in flight while it drains are
520// pushes whose hooks need it. A failure of either stops both.
521func (f *forge) Serve(ctx context.Context, ln net.Listener) error {
522 f.Mirrors.Start()
523 ctx, cancel := context.WithCancel(ctx)
524 defer cancel()
525 hookCtx, stopHooks := context.WithCancel(context.WithoutCancel(ctx))
526 defer stopHooks()
527
528 hookErr := make(chan error, 1)
529 go func() {
530 err := f.hooks.Serve(hookCtx)
531 cancel() // a dead hook socket would reject every push: stop serving
532 hookErr <- err
533 }()
534
535 httpErr := f.server.Serve(ctx, ln)
536 stopHooks()
537 return errors.Join(httpErr, <-hookErr)
538}
539
540// Close releases what newForge opened. It is safe to call twice. Call it after
541// the HTTP server stopped: it stops the event log and the long-lived Git
542// processes of the read side, which requests in flight may still use.
543func (f *forge) Close(ctx context.Context) {
544 log := zerowrap.FromCtx(ctx)
545 if f.hooks != nil {
546 f.hooks.Close(ctx)
547 }
548 if f.MergeRequests != nil {
549 f.MergeRequests.Wait(ctx) // its side effects use CI and Mergeability
550 }
551 if f.Mirrors != nil {
552 f.Mirrors.Close(ctx)
553 }
554 if f.CI != nil {
555 f.CI.Close(ctx)
556 }
557 if f.Mergeability != nil {
558 f.Mergeability.Close(ctx)
559 }
560 if f.EventLog != nil {
561 f.EventLog.Close(ctx)
562 }
563 if f.reader != nil {
564 f.reader.Close()
565 }
566 if f.git != nil {
567 if err := f.git.Close(ctx); err != nil {
568 log.Error().Err(err).Msg("close git reader")
569 }
570 }
571 if f.maint != nil {
572 f.maint.Close(ctx)
573 }
574 if f.store != nil {
575 if err := f.store.Close(ctx); err != nil {
576 log.Error().Err(err).Msg("close metadata store")
577 }
578 f.store = nil
579 }
580}
581
582// artifacts gives the CI the stores and limits of the artifacts (CI-4 D3):
583// records in the kv store, contents under ci/artifacts. ERMITE_CI_ARTIFACTS=0
584// gives none, and the API then serves no artifact service.
585func artifacts(ci *usecase.CIConfig, cfg config.Config, store *kvstore.Store) {
586 if !cfg.CIArtifacts {
587 return
588 }
589 ci.Artifacts, ci.ArtifactFiles = store.Artifacts(), ciartifacts.New(ciartifacts.Dir(cfg.DataDir))
590 ci.ArtifactLimits = ports.ArtifactLimits{Retention: cfg.CIArtifactRetention, Quota: cfg.CIArtifactQuota, MaxSize: cfg.CIArtifactMax}
591}
592
593// pullRequests gives the CI the merge requests, the refs/pull refs and the
594// identity of the test merge commits (CI-3, D5).
595func (f *forge) pullRequests(cfg *usecase.CIConfig, store *kvstore.Store, git *gitcli.Git, committer domain.Identity) {
596 cfg.MRs, cfg.Pull, cfg.Committer = store.MergeRequests(), git, committer
597 if f.reader != nil {
598 cfg.Fresh = f.reader // a nil *ermitegit.Adapter must not become a non-nil interface
599 }
600}
601
602// signatures wires the commit signature checks (ADR 0030): the stored trusted
603// keys, the instance key as a builtin one for the committer email, the SSH and
604// OpenPGP verifiers, and the raw commit objects of the selected reader.
605func (f *forge) signatures(store *kvstore.Store, reader ports.RepoReader, key domain.SigningPublicKey, committer domain.Identity, clock ports.Clock) error {
606 objects, ok := reader.(ports.CommitObjectReader)
607 if !ok {
608 return errors.New("the git reader cannot read raw commit objects")
609 }
610 builtin := domain.TrustedKey{
611 ID: key.Fingerprint, Format: domain.FormatSSH, Title: "ermite instance key",
612 PublicKey: key.AuthorizedKey, Emails: []string{strings.ToLower(committer.Email)}, Builtin: true,
613 }
614 verifiers := map[domain.SignatureFormat]ports.SignatureVerifier{
615 domain.FormatSSH: sigverify.SSH{}, domain.FormatGPG: sigverify.GPG{},
616 }
617 sigs, err := usecase.NewSignatures(store.TrustedKeys(), sigverify.Inspector{}, verifiers, objects, builtin, clock)
618 if err != nil {
619 return err
620 }
621 f.Signatures = sigs
622 f.Browse.WithVerifier(sigs)
623 return nil
624}
625
626// fastFill is the minimum fill time of the public issue form for a test that
627// lowers the proof of work: next to none. Zero keeps the production value.
628func fastFill(issuePoW int) time.Duration {
629 if issuePoW > 0 {
630 return time.Nanosecond
631 }
632 return 0
633}