Przejdź do treści

Ochrona wdrożeń produkcyjnych za pomocą DueReason

Spraw, by sam pipeline wdrożeniowy odmawiał bez zatwierdzonego grantu: wymagany status check na GitHubie, krok verify w pipeline i duereason-gate dla innych CI.

Aktualizacja · 8 min czytania

W skrócie

  • Lokalna bramka działa na maszynie, która składa wniosek; każdy z dostępem do powłoki na tej maszynie może ją ominąć. System, który naprawdę scala kod lub wdraża, musi sam odmówić, bez grantu do sprawdzenia.
  • Tryb verify w duereason/approve, bez podanego grant, wyszukuje najnowszy wniosek ze statusem APPROVED dla dokładnie tej akcji i payloadu, po czym weryfikuje jego grant offline -- dokładnie ten sam test może uruchomić wymagany status check na GitHubie albo niezależny krok wdrożenia, mimo że żaden z nich nigdy nie dostał wyniku grant z innego miejsca.
  • Trzy miejsca, w których to umieścić: wymagany status check na pull requestach, krok verify na początku joba wdrożeniowego i duereason-gate verify dla systemu CI innego niż GitHub Actions.
  • request-if-missing zamienia brak zatwierdzenia w jasny, powtarzalny błąd zamiast cichego przejścia: składa wniosek i kończy się niepowodzeniem, więc ten sam check zmienia się na zielony w chwili zatwierdzenia.

Bramka, która działa tylko tam, gdzie akurat wykonuje się agent lub deweloper, to bramka, którą każdy z dostępem do powłoki na tej maszynie może ominąć: zakomentować, uruchomić skrypt wdrożeniowy bezpośrednio, scalić z --admin. Ochrona produkcji oznacza, że system wykonujący chronioną akcję -- GitHub scalający pull request, pipeline uruchamiający wdrożenie -- sam odmawia, gdy nic nie zatwierdziło dokładnie tego. To drugi, niezależny test w miejscu docelowym, a nie zamiennik tego bliżej agenta.

Co sprawdza wyszukiwanie

Tryb verify w duereason/approve normalnie sprawdza posiadany już grant, offline, względem payloadu: te same testy podpisu, wygaśnięcia, organizacji i hasha payloadu, opisane w przewodniku o weryfikacji grantu. Zostaw grant puste, a zrobi coś nowego: zapyta DueReason o najnowszy wniosek ze status=approved dla dokładnie tej akcji i hasha payloadu (endpoint API GET /approvals przyjmuje teraz w tym celu filtr payloadHash), weźmie grant tego wniosku i zweryfikuje go offline dokładnie tak samo. Nic przed samym wywołaniem HTTP nie musi być zaufane: wyszukiwanie jest ograniczone do klucza API Twojej organizacji, a późniejszy test offline odrzuca grant innej organizacji, innej akcji, zmienionego payloadu albo takiego, który już wygasł -- niezależnie od tego, czy samo wyszukiwanie jest atakowane.

Właśnie to pozwala użyć verify tam, gdzie nigdy nie przekazano wyniku grant z innego miejsca -- w wymaganym status checku działającym we własnym jobie, w pipeline wdrożeniowym, którego jedynym wejściem jest commit, na którym został uruchomiony.

1. Wymagany status check w repozytorium wdrożeniowym

Dodaj workflow uruchamiany na pull_request, pull_request_review (żeby późniejsze zatwierdzenie uruchomiło go ponownie) i workflow_dispatch (żeby można go było uruchomić ręcznie po zatwierdzeniu), z jobem uruchamiającym duereason/approve w trybie verify z payloadem zbudowanym z PR-a: repozytorium, numer PR, head SHA i docelowe środowisko. Nazwij job czymś stałym (np. duereason-verify) i dodaj dokładnie tę nazwę jako wymagany status check w ustawieniach ochrony chronionej gałęzi repozytorium, z włączoną opcją Include administrators -- chodzi o to, by nikt, łącznie z właścicielem, nie scalił przypadkiem z pominięciem checku. Gotowa do skopiowania wersja tego workflow jest w README Akcji wewnątrz monorepo cra-platform, obok przykładu użycia trybu verify -- uses: duereason/approve@v1 nie da się jeszcze rozwiązać jako referencja GitHub Actions, dopóki to repozytorium Akcji nie jest publiczne (w odróżnieniu od @duereason/gate, już dostępnego w npm). Jeśli korzystasz już z wymaganych recenzentów GitHub Environments w tym celu, przewodnik porównujący wbudowaną recenzję GitHuba z bramką akceptacji opisuje dokładnie, gdzie ona się kończy i co dokłada ten status check.

2. Krok verify na początku joba wdrożeniowego

Nawet z powyższym status checkiem, job, który faktycznie wykonuje wdrożenie, powinien sprawdzić jeszcze raz tuż przed uruchomieniem: reguła ochrony gałęzi zatrzymuje tylko scalenie, nie późniejsze ponowne uruchomienie już scalonego workflow, ręcznie wywołane wdrożenie ani rollback do starszego commita. Umieść krok verify jako dosłownie pierwszy krok joba wdrożeniowego, z tym samym kształtem payloadu (repozytorium, SHA commita, docelowe środowisko), którego użył status check; jeśli odpowiedź DueReason i wynik ochrony gałęzi kiedykolwiek się nie zgodzą, to właśnie ten krok ma realną władzę, by zatrzymać wdrożenie.

3. CI inne niż GitHub: duereason-gate verify

GitLab CI, Jenkins czy hook pre-sync Argo CD nigdy wcześniej nie uruchomiły duereason/approve, więc nie ma wyniku grant do przekazania dalej. CLI @duereason/gate (duereason-gate) ma właśnie do tego podkomendę verify: npm install -g @duereason/gate instaluje go, ten sam command widoczny w Ustawieniach > Brama agentów przy każdym narzędziu, a duereason-gate verify --action production-deploy --payload '{"repo":"acme/shop","sha":"abc123","environment":"production"}' czyta DUEREASON_API_KEY, DUEREASON_ORG i (tylko self-host) DUEREASON_URL ze zmiennych środowiskowych albo ~/.config/duereason/credentials, wykonuje identyczny test wyszukaj-i-zweryfikuj-offline, wypisuje id dopasowanego wniosku przy sukcesie i kończy się kodem 2 z powodem w przeciwnym razie -- zwykły kod wyjścia procesu, na którym każdy system CI może oprzeć bramkę etapu. Nigdy nie składa wniosku: to check i exec są komendami, które składają wniosek i czekają.

Gdy nic jeszcze nie jest zatwierdzone: request-if-missing

Status check, który po prostu cicho kończy się niepowodzeniem przy pierwszym otwarciu PR-a, jest mylący: czy coś jest nie tak, czy po prostu nikt jeszcze nie zatwierdził? Ustaw request-if-missing: "true" na kroku verify, a gdy wyszukiwanie nic nie znajdzie, złoży ten sam wniosek, który złożyłby mode: request (używając wejścia reason), i nadal zakończy job niepowodzeniem -- ale teraz z linkiem do właśnie złożonego wniosku. Ponowne uruchomienie checku (powyższy trigger pull_request_review robi to automatycznie przy każdej recenzji) przechodzi w chwili zatwierdzenia tego wniosku, bez osobnego kroku request do utrzymywania w zgodzie.

Strona DueReason: workflow z więcej niż jednym krokiem

Nic z tego nie ma znaczenia, jeśli workflow stojący za akcją sam siebie zatwierdza. Skonfiguruj akcję production-deploy w DueReason z workflow, który naprawdę zmusza kogoś do decyzji: pierwszy krok wskazujący właściciela wydania i wymagający pisemnego powodu, drugi krok wymagający dwóch osób z grupy Ops. Grant, który z tego powstaje, istnieje dopiero, gdy odpowiedziano na każdy krok, a wyszukiwanie verify dopasowuje wyłącznie wniosek, którego status to approved -- wniosek czekający jeszcze na drugi krok jest dla niego niewidoczny, dokładnie jak odrzucony czy wygasły.

Pytania

Czy wymagany status check potrzebuje wyniku grant z innego miejsca w workflow?
Nie. Na tym polega wyszukiwanie: zostaw puste wejście grant w kroku verify, a zapyta DueReason o najnowszy zatwierdzony wniosek pasujący do dokładnej akcji i hasha payloadu, zamiast ufać wartości przekazanej przez inny job.
Co powstrzymuje kogoś przed zatwierdzeniem własnego wdrożenia?
Workflow skonfigurowany dla danej akcji, tak jak przy każdym innym zatwierdzeniu w DueReason: nazwij grupy i liczbę odrębnych zatwierdzających wymaganych na danym kroku, a wnioskodawca spoza uprawnionej grupy (albo ten, kto odpowiedział już na wcześniejszy krok) nie może odpowiedzieć też na kolejny.
Czy request-if-missing można użyć, żeby całkiem pominąć recenzję?
Nie: składa jedynie ten sam wniosek, który złożyłby zwykły krok mode: request, i nadal natychmiast kończy job niepowodzeniem. Nic się nie scala ani nie wdraża, dopóki ktoś naprawdę nie zatwierdzi tego wniosku przez workflow skonfigurowany dla danej akcji.
Czy to zastępuje lokalną bramkę (duereason-gate check / exec)?
Nie, uzupełnia ją. Lokalna bramka powstrzymuje agenta przed samą próbą akcji; weryfikacja po stronie docelowej powstrzymuje samą akcję przed powodzeniem, jeśli lokalna bramka została ominięta, źle skonfigurowana albo po prostu nigdy nie zainstalowana na tym, co uruchamia wdrożenie.
Co jeśli status check i własny krok verify wdrożenia się nie zgadzają?
Nie powinny, bo oba pytają to samo API o to samo, ale to własny krok verify wdrożenia ma realną władzę: reguła ochrony gałęzi zatrzymuje tylko scalenie, nigdy późniejsze ponowne uruchomienie, ręczne wywołanie ani rollback do starszego, zatwierdzonego lub niezatwierdzonego commita.

Przeczytaj pełny opis grantu i referencję API

Filtr payloadHash dla GET /approvals, wejścia i wyjścia trybu verify oraz każde pole grantu, jakie może sprawdzić wykonawca, są opisane w referencji API.

Czytaj dokumentację API

Źródła

Poradnik wyjaśnia przepisy tak, jak je rozumiemy; nie jest poradą prawną. Sprawdź tekst urzędowy i prawo krajowe, które może dodać obowiązki.

Zacznij z DueReason

Załóż bezpłatne konto, wypróbuj na żywo albo porozmawiaj z nami o swoim procesie.

Otrzymuj nowości o produkcie