runner: beschermde geheimen ook op tags die op een beschermd tagpatroon passen
@@ -16,7 +16,7 @@ Het logo is de blauwe ster: [`assets/logo.svg`](assets/logo.svg).
16
16
- Een ingebouwde CI-runner, Steve. Het bestand is `blue-ci-cd.yml`. Elke job draait in een eigen container. `image: bluegit/base` en de andere aliassen zijn image-presets die Steve lokaal bouwt.
17
17
- Jobs die je niet halverwege wilt stoppen (FTP-upload, databasemigratie) markeer je met `doNotInterrupt: true`: BlueGit stopt ze nooit automatisch, een nieuwere pipeline op dezelfde ref wacht erop, en handmatig stoppen vraagt om bevestiging. Zie [docs/CI.md](docs/CI.md#donotinterrupt).
18
18
- Webhooks op een repository of een groep, met presets, een eigen body en een overzicht van de laatste afleveringen.
19
- Geheimen als omgevingsvariabelen in een job. Een beschermd geheim gaat alleen mee op een beschermde branch.
19
- Geheimen als omgevingsvariabelen in een job. Een beschermd geheim gaat alleen mee op een beschermde branch of een tag die op een beschermd tagpatroon past.
20
20
- Groepen, met eigen leden, geheimen en webhooks.
21
21
- Git over SSH en over HTTPS.
22
22
- REST-API. Het schema staat op `/api/v1/openapi.json`.
@@ -16,7 +16,7 @@ Het logo is de blauwe ster: [`assets/logo.svg`](assets/logo.svg).16
- Een ingebouwde CI-runner, Steve. Het bestand is `blue-ci-cd.yml`. Elke job draait in een eigen container. `image: bluegit/base` en de andere aliassen zijn image-presets die Steve lokaal bouwt.16
- Een ingebouwde CI-runner, Steve. Het bestand is `blue-ci-cd.yml`. Elke job draait in een eigen container. `image: bluegit/base` en de andere aliassen zijn image-presets die Steve lokaal bouwt.17
- Jobs die je niet halverwege wilt stoppen (FTP-upload, databasemigratie) markeer je met `doNotInterrupt: true`: BlueGit stopt ze nooit automatisch, een nieuwere pipeline op dezelfde ref wacht erop, en handmatig stoppen vraagt om bevestiging. Zie [docs/CI.md](docs/CI.md#donotinterrupt).17
- Jobs die je niet halverwege wilt stoppen (FTP-upload, databasemigratie) markeer je met `doNotInterrupt: true`: BlueGit stopt ze nooit automatisch, een nieuwere pipeline op dezelfde ref wacht erop, en handmatig stoppen vraagt om bevestiging. Zie [docs/CI.md](docs/CI.md#donotinterrupt).18
- Webhooks op een repository of een groep, met presets, een eigen body en een overzicht van de laatste afleveringen.18
- Webhooks op een repository of een groep, met presets, een eigen body en een overzicht van de laatste afleveringen.19
- Geheimen als omgevingsvariabelen in een job. Een beschermd geheim gaat alleen mee op een beschermde branch.19
- Geheimen als omgevingsvariabelen in een job. Een beschermd geheim gaat alleen mee op een beschermde branch of een tag die op een beschermd tagpatroon past.20
- Groepen, met eigen leden, geheimen en webhooks.20
- Groepen, met eigen leden, geheimen en webhooks.21
- Git over SSH en over HTTPS.21
- Git over SSH en over HTTPS.22
- REST-API. Het schema staat op `/api/v1/openapi.json`.22
- REST-API. Het schema staat op `/api/v1/openapi.json`.@@ -31,7 +31,7 @@ Eén statische Go-binary, SQLite voor de metadata, de gewone `git` voor de objec
31
31
32
32
## Rollen en geheimen
33
33
34
Een ontwikkelaar ziet geheimen niet terug. Een job krijgt ze wel als omgevingsvariabele, anders kan CI er niets mee. Wie een pipeline mag starten, kan een onbeschermd geheim dus uitlezen via `blue-ci-cd.yml`. Markeer een geheim als beschermd als het alleen op een beschermde branch mee mag, en bescherm `master`.
34
Een ontwikkelaar ziet geheimen niet terug. Een job krijgt ze wel als omgevingsvariabele, anders kan CI er niets mee. Wie een pipeline mag starten, kan een onbeschermd geheim dus uitlezen via `blue-ci-cd.yml`. Markeer een geheim als beschermd als het alleen op een beschermde branch (of een tag op een beschermd tagpatroon, bijvoorbeeld `v*` voor releases) mee mag, en bescherm `master`.
35
35
36
36
De installatiebeheerder is geen beheerder van andermans repository. Geheimen, groepen en privérepositories blijven bij de leden.
37
37
@@ -31,7 +31,7 @@ Eén statische Go-binary, SQLite voor de metadata, de gewone `git` voor de objec31
31
32
## Rollen en geheimen32
## Rollen en geheimen33
33
34
Een ontwikkelaar ziet geheimen niet terug. Een job krijgt ze wel als omgevingsvariabele, anders kan CI er niets mee. Wie een pipeline mag starten, kan een onbeschermd geheim dus uitlezen via `blue-ci-cd.yml`. Markeer een geheim als beschermd als het alleen op een beschermde branch mee mag, en bescherm `master`.34
Een ontwikkelaar ziet geheimen niet terug. Een job krijgt ze wel als omgevingsvariabele, anders kan CI er niets mee. Wie een pipeline mag starten, kan een onbeschermd geheim dus uitlezen via `blue-ci-cd.yml`. Markeer een geheim als beschermd als het alleen op een beschermde branch (of een tag op een beschermd tagpatroon, bijvoorbeeld `v*` voor releases) mee mag, en bescherm `master`.35
35
36
De installatiebeheerder is geen beheerder van andermans repository. Geheimen, groepen en privérepositories blijven bij de leden.36
De installatiebeheerder is geen beheerder van andermans repository. Geheimen, groepen en privérepositories blijven bij de leden.37
37
@@ -114,7 +114,7 @@ A job can reach its own repo without its own login, also when the repo is privat
114
114
115
115
## Protected branches
116
116
117
A job on a protected branch receives protected secrets. It only runs on the built-in runner, global runners, group runners and account runners of users who are maintainer (or owner) of that repo, or instance admin. Opt-in runners of regular members/developers are skipped for such jobs: the job falls through to the next allowed tier (eventually the built-in runner), never to a disallowed runner, and the job log names the skipped runners. This is checked at every assignment (also on retry), so revoked rights apply immediately. Unprotected branches are unchanged.
117
A job on a protected branch, or on a tag matching a protected tag pattern, receives protected secrets (a tag never counts via a branch pattern). It only runs on the built-in runner, global runners, group runners and account runners of users who are maintainer (or owner) of that repo, or instance admin. Opt-in runners of regular members/developers are skipped for such jobs: the job falls through to the next allowed tier (eventually the built-in runner), never to a disallowed runner, and the job log names the skipped runners. This is checked at every assignment (also on retry), so revoked rights apply immediately. Unprotected branches are unchanged.
118
118
119
119
## Global runners
120
120
@@ -114,7 +114,7 @@ A job can reach its own repo without its own login, also when the repo is privat114
114
115
## Protected branches115
## Protected branches116
116
117
A job on a protected branch receives protected secrets. It only runs on the built-in runner, global runners, group runners and account runners of users who are maintainer (or owner) of that repo, or instance admin. Opt-in runners of regular members/developers are skipped for such jobs: the job falls through to the next allowed tier (eventually the built-in runner), never to a disallowed runner, and the job log names the skipped runners. This is checked at every assignment (also on retry), so revoked rights apply immediately. Unprotected branches are unchanged.117
A job on a protected branch, or on a tag matching a protected tag pattern, receives protected secrets (a tag never counts via a branch pattern). It only runs on the built-in runner, global runners, group runners and account runners of users who are maintainer (or owner) of that repo, or instance admin. Opt-in runners of regular members/developers are skipped for such jobs: the job falls through to the next allowed tier (eventually the built-in runner), never to a disallowed runner, and the job log names the skipped runners. This is checked at every assignment (also on retry), so revoked rights apply immediately. Unprotected branches are unchanged.118
118
119
## Global runners119
## Global runners120
120
@@ -111,8 +111,9 @@ Toestemming van een groepslid telt alleen zolang die lid is, en
111
111
alleen voor repo's die dat lid zelf mag lezen (bij elke toewijzing
112
112
opnieuw gecontroleerd).
113
113
114
**Beschermde branches**: een job op een beschermde branch krijgt
115
beschermde geheimen. Die job draait alleen op de BlueGit-runner, globale
114
**Beschermde branches en tags**: een job op een beschermde branch, of op
115
een tag die op een beschermd tagpatroon past, krijgt beschermde geheimen
116
(een tag telt nooit via een branchpatroon). Die job draait alleen op de BlueGit-runner, globale
116
117
runners, groepsrunners en account-runners van gebruikers die maintainer
117
118
(of eigenaar) van die repo zijn, of instance-admin. Opt-in-runners van
118
119
gewone leden/developers worden voor zo'n job overgeslagen: de job valt door
@@ -111,8 +111,9 @@ Toestemming van een groepslid telt alleen zolang die lid is, en111
alleen voor repo's die dat lid zelf mag lezen (bij elke toewijzing111
alleen voor repo's die dat lid zelf mag lezen (bij elke toewijzing112
opnieuw gecontroleerd).112
opnieuw gecontroleerd).113
113
114
**Beschermde branches**: een job op een beschermde branch krijgt114
**Beschermde branches en tags**: een job op een beschermde branch, of op115
beschermde geheimen. Die job draait alleen op de BlueGit-runner, globale115
een tag die op een beschermd tagpatroon past, krijgt beschermde geheimen116
(een tag telt nooit via een branchpatroon). Die job draait alleen op de BlueGit-runner, globale116
runners, groepsrunners en account-runners van gebruikers die maintainer117
runners, groepsrunners en account-runners van gebruikers die maintainer117
(of eigenaar) van die repo zijn, of instance-admin. Opt-in-runners van118
(of eigenaar) van die repo zijn, of instance-admin. Opt-in-runners van118
gewone leden/developers worden voor zo'n job overgeslagen: de job valt door119
gewone leden/developers worden voor zo'n job overgeslagen: de job valt door@@ -300,15 +300,34 @@ func (r *Runner) tiersFor(ctx context.Context, cache map[int64][]Tier, repoID in
300
300
return tiers
301
301
}
302
302
303
// refProtected: draait een pipeline op een beschermde branch (en krijgt
303
// refProtected: draait een pipeline op een beschermde ref (en krijgt
304
304
// hij dus beschermde geheimen)?
305
305
func (r *Runner) refProtected(ctx context.Context, repoID int64, ref string) bool {
306
name, _ := ci.SplitRef(ref)
307
patterns, err := r.Store.ProtectedPatterns(ctx, repoID)
306
prot, err := r.refIsProtected(ctx, repoID, ref)
308
307
if err != nil {
309
308
return true // bij twijfel streng
310
309
}
311
return access.BranchProtected(patterns, name)
310
return prot
311
}
312
313
// refIsProtected: een branch is beschermd als hij op een beschermd
314
// branchpatroon past, een tag als hij op een beschermd tagpatroon past
315
// (alleen maintainers mogen zo'n tag pushen). Een tag telt nooit via een
316
// branchpatroon, een branch nooit via een tagpatroon.
317
func (r *Runner) refIsProtected(ctx context.Context, repoID int64, ref string) (bool, error) {
318
name, kind := ci.SplitRef(ref)
319
if kind == "tag" {
320
patterns, err := r.Store.ProtectedTagPatterns(ctx, repoID)
321
if err != nil {
322
return false, err
323
}
324
return access.BranchProtected(patterns, name), nil
325
}
326
patterns, err := r.Store.ProtectedPatterns(ctx, repoID)
327
if err != nil {
328
return false, err
329
}
330
return access.BranchProtected(patterns, name), nil
312
331
}
313
332
314
333
var protectedNoted sync.Map // job id → melding al in het log
@@ -938,11 +957,10 @@ func (r *Runner) collect(ctx context.Context, job store.Job, work string) error
938
957
939
958
func (r *Runner) environment(ctx context.Context, repo store.Repo, p store.Pipeline, job store.Job, token string) (map[string]string, []string, error) {
940
959
name, _ := ci.SplitRef(p.Ref)
941
patterns, err := r.Store.ProtectedPatterns(ctx, repo.ID)
960
refProtected, err := r.refIsProtected(ctx, repo.ID, p.Ref)
942
961
if err != nil {
943
962
return nil, nil, err
944
963
}
945
refProtected := access.BranchProtected(patterns, name)
946
964
// Fork-MR's draaien op refs/heads/forks/...: code van buiten, dus
947
965
// nooit groeps- of projectgeheimen en nooit als beschermde ref.
948
966
forkRef := ci.IsForkBranch(name)
@@ -300,15 +300,34 @@ func (r *Runner) tiersFor(ctx context.Context, cache map[int64][]Tier, repoID in300
return tiers300
return tiers301
}301
}302
302
303
// refProtected: draait een pipeline op een beschermde branch (en krijgt303
// refProtected: draait een pipeline op een beschermde ref (en krijgt304
// hij dus beschermde geheimen)?304
// hij dus beschermde geheimen)?305
func (r *Runner) refProtected(ctx context.Context, repoID int64, ref string) bool {305
func (r *Runner) refProtected(ctx context.Context, repoID int64, ref string) bool {306
name, _ := ci.SplitRef(ref)306
prot, err := r.refIsProtected(ctx, repoID, ref)307
patterns, err := r.Store.ProtectedPatterns(ctx, repoID)308
if err != nil {307
if err != nil {309
return true // bij twijfel streng308
return true // bij twijfel streng310
}309
}311
return access.BranchProtected(patterns, name)310
return prot311
}312
313
// refIsProtected: een branch is beschermd als hij op een beschermd314
// branchpatroon past, een tag als hij op een beschermd tagpatroon past315
// (alleen maintainers mogen zo'n tag pushen). Een tag telt nooit via een316
// branchpatroon, een branch nooit via een tagpatroon.317
func (r *Runner) refIsProtected(ctx context.Context, repoID int64, ref string) (bool, error) {318
name, kind := ci.SplitRef(ref)319
if kind == "tag" {320
patterns, err := r.Store.ProtectedTagPatterns(ctx, repoID)321
if err != nil {322
return false, err323
}324
return access.BranchProtected(patterns, name), nil325
}326
patterns, err := r.Store.ProtectedPatterns(ctx, repoID)327
if err != nil {328
return false, err329
}330
return access.BranchProtected(patterns, name), nil312
}331
}313
332
314
var protectedNoted sync.Map // job id → melding al in het log333
var protectedNoted sync.Map // job id → melding al in het log@@ -938,11 +957,10 @@ func (r *Runner) collect(ctx context.Context, job store.Job, work string) error938
957
939
func (r *Runner) environment(ctx context.Context, repo store.Repo, p store.Pipeline, job store.Job, token string) (map[string]string, []string, error) {958
func (r *Runner) environment(ctx context.Context, repo store.Repo, p store.Pipeline, job store.Job, token string) (map[string]string, []string, error) {940
name, _ := ci.SplitRef(p.Ref)959
name, _ := ci.SplitRef(p.Ref)941
patterns, err := r.Store.ProtectedPatterns(ctx, repo.ID)960
refProtected, err := r.refIsProtected(ctx, repo.ID, p.Ref)942
if err != nil {961
if err != nil {943
return nil, nil, err962
return nil, nil, err944
}963
}945
refProtected := access.BranchProtected(patterns, name)946
// Fork-MR's draaien op refs/heads/forks/...: code van buiten, dus964
// Fork-MR's draaien op refs/heads/forks/...: code van buiten, dus947
// nooit groeps- of projectgeheimen en nooit als beschermde ref.965
// nooit groeps- of projectgeheimen en nooit als beschermde ref.948
forkRef := ci.IsForkBranch(name)966
forkRef := ci.IsForkBranch(name)@@ -0,0 +1,68 @@
1
package runner
2
3
import (
4
"context"
5
"path/filepath"
6
"testing"
7
8
"gitlab.com/Timfa/bluegit/internal/store"
9
)
10
11
// Een tag die op een beschermd tagpatroon past krijgt beschermde geheimen;
12
// een onbeschermde tag niet, en een tag telt niet via een branchpatroon.
13
func TestProtectedTagRefGetsProtectedSecrets(t *testing.T) {
14
s, err := store.Open(filepath.Join(t.TempDir(), "b.db"), make([]byte, 32))
15
if err != nil {
16
t.Fatal(err)
17
}
18
defer s.Close()
19
ctx := context.Background()
20
tim, _ := s.UpsertUser(ctx, 1, "tim", "", false)
21
repo, _ := s.CreateRepo(ctx, "user", tim.ID, "app", "", "master", "private")
22
_ = s.PutSecret(ctx, "repo", repo.ID, "AUR_KEY", "beschermd-789", true)
23
_ = s.PutSecret(ctx, "repo", repo.ID, "PLAIN", "open-123", false)
24
if err := s.AddProtectedTag(ctx, repo.ID, "v*"); err != nil {
25
t.Fatal(err)
26
}
27
if err := s.AddProtected(ctx, repo.ID, "master"); err != nil {
28
t.Fatal(err)
29
}
30
r := &Runner{Store: s}
31
env := func(ref string) (map[string]string, []string) {
32
t.Helper()
33
e, mask, err := r.environment(ctx, repo, store.Pipeline{Ref: ref}, store.Job{Name: "t"}, "")
34
if err != nil {
35
t.Fatal(err)
36
}
37
return e, mask
38
}
39
e, mask := env("refs/tags/v0.1.1")
40
if e["AUR_KEY"] != "beschermd-789" || e["PLAIN"] != "open-123" {
41
t.Fatal("beschermde tag moet beschermde en gewone geheimen krijgen")
42
}
43
masked := false
44
for _, m := range mask {
45
masked = masked || m == "beschermd-789"
46
}
47
if !masked {
48
t.Fatal("beschermd geheim niet gemaskeerd")
49
}
50
if !r.refProtected(ctx, repo.ID, "refs/tags/v0.1.1") {
51
t.Fatal("refProtected: beschermde tag")
52
}
53
for _, ref := range []string{"refs/tags/nightly", "refs/tags/master", "refs/heads/v2", "refs/heads/feat"} {
54
e, _ := env(ref)
55
if _, ok := e["AUR_KEY"]; ok {
56
t.Fatalf("%s mag geen beschermd geheim krijgen", ref)
57
}
58
if e["PLAIN"] != "open-123" {
59
t.Fatalf("%s moet gewone geheimen houden", ref)
60
}
61
if r.refProtected(ctx, repo.ID, ref) {
62
t.Fatalf("refProtected(%s) moet false zijn", ref)
63
}
64
}
65
if e, _ := env("refs/heads/master"); e["AUR_KEY"] == "" {
66
t.Fatal("beschermde branch moet beschermde geheimen houden")
67
}
68
}
@@ -0,0 +1,68 @@1
package runner2
3
import (4
"context"5
"path/filepath"6
"testing"7
8
"gitlab.com/Timfa/bluegit/internal/store"9
)10
11
// Een tag die op een beschermd tagpatroon past krijgt beschermde geheimen;12
// een onbeschermde tag niet, en een tag telt niet via een branchpatroon.13
func TestProtectedTagRefGetsProtectedSecrets(t *testing.T) {14
s, err := store.Open(filepath.Join(t.TempDir(), "b.db"), make([]byte, 32))15
if err != nil {16
t.Fatal(err)17
}18
defer s.Close()19
ctx := context.Background()20
tim, _ := s.UpsertUser(ctx, 1, "tim", "", false)21
repo, _ := s.CreateRepo(ctx, "user", tim.ID, "app", "", "master", "private")22
_ = s.PutSecret(ctx, "repo", repo.ID, "AUR_KEY", "beschermd-789", true)23
_ = s.PutSecret(ctx, "repo", repo.ID, "PLAIN", "open-123", false)24
if err := s.AddProtectedTag(ctx, repo.ID, "v*"); err != nil {25
t.Fatal(err)26
}27
if err := s.AddProtected(ctx, repo.ID, "master"); err != nil {28
t.Fatal(err)29
}30
r := &Runner{Store: s}31
env := func(ref string) (map[string]string, []string) {32
t.Helper()33
e, mask, err := r.environment(ctx, repo, store.Pipeline{Ref: ref}, store.Job{Name: "t"}, "")34
if err != nil {35
t.Fatal(err)36
}37
return e, mask38
}39
e, mask := env("refs/tags/v0.1.1")40
if e["AUR_KEY"] != "beschermd-789" || e["PLAIN"] != "open-123" {41
t.Fatal("beschermde tag moet beschermde en gewone geheimen krijgen")42
}43
masked := false44
for _, m := range mask {45
masked = masked || m == "beschermd-789"46
}47
if !masked {48
t.Fatal("beschermd geheim niet gemaskeerd")49
}50
if !r.refProtected(ctx, repo.ID, "refs/tags/v0.1.1") {51
t.Fatal("refProtected: beschermde tag")52
}53
for _, ref := range []string{"refs/tags/nightly", "refs/tags/master", "refs/heads/v2", "refs/heads/feat"} {54
e, _ := env(ref)55
if _, ok := e["AUR_KEY"]; ok {56
t.Fatalf("%s mag geen beschermd geheim krijgen", ref)57
}58
if e["PLAIN"] != "open-123" {59
t.Fatalf("%s moet gewone geheimen houden", ref)60
}61
if r.refProtected(ctx, repo.ID, ref) {62
t.Fatalf("refProtected(%s) moet false zijn", ref)63
}64
}65
if e, _ := env("refs/heads/master"); e["AUR_KEY"] == "" {66
t.Fatal("beschermde branch moet beschermde geheimen houden")67
}68
}