Tokeny, które mogła odczytać każda gałąź
Krótka historia o dwóch checkboxach w GitLabie, jednym błędnym założeniu o tym, kto tworzy tagi, i bocie, który po cichu zepsułby każde wydanie.
Linijka w dokumentacji
Nie szukaliśmy problemu z bezpieczeństwem. Przenosiliśmy dziewięć wewnętrznych bibliotek Pythona w Firmie tak, żeby pobierały zależności z repozytorium artefaktów zamiast z indeksu pakietów GitLaba. Zwykła hydraulika.
Dokumentacja współdzielonego szablonu CI miała uspokajającą linijkę o poświadczeniach, którymi te biblioteki są publikowane:
Wymagane zmienne … ustawione na poziomie grupy, Masked + Protected.
Ticket projektu mówił to samo. Zanim na tym polegaliśmy, zapytaliśmy API GitLaba o flagi zmiennych — tylko nazwy i flagi, nigdy wartości:
PUBLISH_USER protected=false masked=true PUBLISH_TOKEN protected=false masked=true PROMOTE_USER protected=false masked=true PROMOTE_TOKEN protected=false masked=true
Masked — tak. Protected — nie. I żadna z dziewięciu bibliotek nie miała reguły chronionych tagów.
Ta różnica ma większe znaczenie, niż się wydaje. Masked ukrywa wartość tylko w logach joba. Nie przeszkadza jobowi jej użyć. To Protected ogranicza zmienną do chronionych gałęzi i chronionych tagów. Bez tej flagi token dostaje każdy pipeline — także pipeline merge requesta na dowolnej gałęzi.
Około siedemdziesięciu osób miało w tych repozytoriach dostęp na poziomie Developer. Każda z nich mogła otworzyć merge request, dodać jedną linijkę do .gitlab-ci.yml i jej pipeline miałby w ręku token z prawem zapisu do repozytorium artefaktów. Z tego samego repozytorium każdy serwis w Firmie instaluje swoje pakiety.
Nikt tego nie zrobił. Ale też nic tego nie blokowało.
Dwa checkboxy i kolejność
Poprawka jest znana z prostoty: zaznaczyć „Protect variable”. Równie łatwo ją zepsuć, bo job publikujący działa na tagach, a GitLab przekazuje chronione zmienne tylko do chronionych refów.
Chronisz tylko zmienne ─► pipeline'y tagów nic nie dostają ─► każde wydanie pada
Chronisz tylko tagi ─► pipeline'y MR dalej czytają token ─► nic nie naprawione
Chronisz oba ─► pipeline'y MR: pusto
pipeline tagu na chronionym tagu: token jest
To więc para i kolejność ma znaczenie: najpierw chronione tagi, potem zmienne. W odwrotnej kolejności każde wydanie w tym okienku pada na kroku publikacji z „token not set”.
Plan, który spisaliśmy, mówił: dodać regułę chronionych tagów v*, potem chronić zmienne. Wyglądało to oczywiście poprawnie. Tagi wydań to przecież v1.2.3, prawda?
Dane się nie zgodziły
Zanim cokolwiek kliknęliśmy, sprawdziliśmy, co faktycznie tworzy tagi w tych repozytoriach. Wyszły trzy rzeczy.
- Walidator wydania obcina prefiks. Job walidujący tag robi
TAG="${CI_COMMIT_TAG#v}". Akceptuje zarównov3.0.1, jak i3.0.1. - Szablon mówił ludziom, żeby tagowali bez niego. Przy każdym merge requeście komentarz bota z tego samego szablonu brzmiał: *„Żeby opublikować, utwórz tag git
3.0.1na main.”* Bezv. - Ludzie się do tego stosowali. Wśród tagów wydań były
2.2.2i2.8.3.
Przy regule v* następna osoba, która posłuchałaby bota, wypchnęłaby 3.0.2. Tag nie byłby chroniony, nie dostałby tokenu i wydanie by padło. Poprawka zepsułaby wydania dokładnie tym, którzy czytają naszą własną dokumentację.
Dla tych bibliotek właściwym wzorcem było *****, czyli wszystkie tagi. Używają tagów tylko do wydań, więc nic innego na tym nie traci.
Zły trop
Kolejne pytanie: kto straci możliwość tworzenia tagów? Reguła chronionych tagów z ustawieniem „allowed to create: Maintainers” blokuje wszystkich poniżej tej roli.
Pobraliśmy członków grupy z poziomem dostępu 40 i wyżej, zobaczyliśmy pięć nazwisk z poziomem 40 i napisaliśmy w tickecie: „Tych pięciu Developerów nie będzie mogło tworzyć tagów.”
Kolega zadał niewinne pytanie: „Maintainerzy i Ownerzy dalej mogą tworzyć tagi, prawda?”
Prawda. A poziom 40 to Maintainer. Developer to 30. Nasz filtr całkowicie pominął prawdziwych Developerów i źle podpisał Maintainerów. Poprawiony obraz był odwrotnością tego, co opublikowaliśmy:
- Owner (50): dalej może tworzyć tagi wydań. To wszyscy, którzy wydawali w ostatnich sześciu miesiącach.
- Maintainer (40): dalej może tworzyć tagi wydań. To tych pięciu, których niesłusznie ostrzegliśmy.
- Developer (30): nie może już tworzyć tagów wydań. Około siedemdziesięciu osób plus jeden bot.
Żeby mieć pewność, że nikt, kto naprawdę wydaje, nie zostanie zablokowany, przeszliśmy tag po tagu przez API. Tag nie zapisuje, kto go wypchnął, ale jego pipeline już tak: tag → pipeline dla tego refa → użytkownik pipeline'u. Każdy tag wydania z ostatnich sześciu miesięcy utworzył Owner.
Korektę opublikowaliśmy w tickecie tego samego popołudnia. Napisanie „pomyliłem się, oto prawdziwa lista” jest lepsze niż ticket, który wysyła ludzi w pogoń za niewłaściwą piątką.
Drugie repozytorium
Okazało się, że te same poświadczenia do publikacji mają drugi dom. Inne repozytorium, projekt z definicjami protokołów spoza grupy bibliotek, trzymało własną kopię na poziomie projektu obu par tokenów. Też niechronionych, też czytelnych z merge requestów około siedemdziesięciu Developerów. Ochrona kopii w grupie nic nie dawała, dopóki ta kopia była czytelna.
Oczywistym ruchem było powtórzyć poprawkę z bibliotek: *, potem ochrona. Dane znów powiedziały co innego.
Ten projekt wydaje się w bardziej złożony sposób. Człowiek wypycha v2.75.1. Pipeline tego tagu uruchamia potem joba, który przy użyciu tokenu bota z uprawnieniami Developer robi to:
człowiek ──push──► v2.75.1 ──pipeline──► job:
git tag -f go/v2.75.1
git push -f origin go/v2.75.1 ← bot, Developer
trigger pipeline on main ← tu jest publikacja
Reguła * zrobiłaby z go/v2.75.1 chroniony tag. Bot jako Developer nie mógłby go utworzyć. A nawet gdyby mógł, chronionych tagów nie da się nadpisać przez force-push, więc ponowne uruchomienie też by padło. Job wypycha tag zanim wyzwoli pipeline publikujący, więc całe wydanie zatrzymałoby się po cichu w połowie.
Tutaj właściwym wzorcem było więc **v***:
- Workflow uruchamia pipeline'y tylko dla tagów pasujących do
^v[0-9]+…, więc żaden inny tag nigdy nie widzi tokenu. - Tagi
go/w ogóle nie uruchamiają pipeline'u, więc nie trzeba ich chronić. - Publikacja dzieje się w pipelinie na
main, a to już była chroniona gałąź.
Dwa repozytoria, te same poświadczenia, przeciwne wzorce. Obie odpowiedzi wzięły się z patrzenia na to, co tworzy tagi, a nie na to, jak tagi zwykle wyglądają.
Jeszcze jedno znalezisko: druga para tokenów w tym repozytorium nie była nigdzie używana — żaden plik, żaden include, żadna ostatnia gałąź. Nie chroniliśmy jej, tylko usunęliśmy. Nieużywane poświadczenie z prawem zapisu to czyste ryzyko.
Dowód bez wypisywania tokenu
„Zaznaczyłem checkbox” to nie dowód. Chcieliśmy zobaczyć, jak pipeline merge requesta nie może odczytać tokenu, i to tak, żeby token nigdy nie pojawił się w logu. Wystarczył jeden jednorazowy job w szkicu MR:
check-token-visibility:
rules:
- if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
script:
- for v in PUBLISH_TOKEN PROMOTE_TOKEN READ_ONLY_TOKEN; do
eval "val=\${$v:-}";
[ -n "$val" ] && echo "$v=set" || echo "$v=empty";
done
Kluczowa jest kontrola: token tylko do odczytu, który musi zostać widoczny, bo zwykłe buildy go potrzebują. Gdyby wszystko wypisało empty, test nie udowodniłby niczego poza tym, że job jest zepsuty.
PUBLISH_TOKEN=empty PROMOTE_TOKEN=empty READ_ONLY_TOKEN=set
W drugim repozytorium wynik był taki sam, a wszystkie zwykłe joby w obu merge requestach zostały zielone. Szkice MR zamknęliśmy.
Tego, czego ten test nie dowodzi, to sama ścieżka wydania. Dlatego ticket został otwarty do następnego prawdziwego wydania repozytorium z botem: ma pokazać wypchnięty tag go/ i zieloną publikację. Wtedy go zamkniemy.
Wskazówki dla czytelnika
- Masked to nie protected. Maskowanie ukrywa wartość w logach. Tylko Protected trzyma ją z dala od pipeline'ów na niechronionych gałęziach. Sprawdzaj flagi przez API, zamiast ufać dokumentacji.
- Ochrona sekretu do wydań to dwa ustawienia: chronione tagi i chronione zmienne. Najpierw tagi. Ochrona samych zmiennych psuje wydania, ochrona samych tagów niczego nie naprawia.
- Wzorzec tagu dobieraj z danych, osobno dla każdego repozytorium. Sprawdź, co akceptuje walidator wydania, co twoje własne narzędzia każą ludziom wpisywać i czy jakiś job CI tworzy albo nadpisuje tagi.
v*i*mogą być oba poprawne — i oba błędne w repozytorium obok. - Boty z niskimi uprawnieniami to miejsce, gdzie chronione tagi gryzą. Job CI, który tworzy albo nadpisuje tagi tokenem z poziomem Developer, padnie na chronionym tagu, często w połowie wydania.
- Znaj poziomy dostępu: 30 Developer, 40 Maintainer, 50 Owner. „Allowed to create: Maintainers” obejmuje też Ownerów.
- Szukaj kopii poświadczeń. Ochrona jednej kopii tokenu nic nie daje, dopóki inna kopia jest czytelna. Kopie, których nikt nie używa, usuń.
- Udowodnij wynik zmienną kontrolną. Sprawdzenie set/empty w jednorazowym MR, z jedną zmienną, która musi zostać
set, to dowód. Zaznaczony checkbox nim nie jest. - Jeśli się pomylisz, popraw to tam, gdzie to napisałeś. Komentarz „pomyliłem się, oto prawdziwa lista” kosztuje minutę. Zostawienie błędnej listy w tickecie wysyła ludzi w pogoń za niewłaściwą piątką.