Sprawdzaj bezpieczeństwo API

Znajdź luki w bezpieczeństwie API przed pentestem

Raport z pentestu wymienia token w query stringu i trasę, której nikt nie udokumentował, kilka tygodni po wydaniu. Sprawdzaj kontrakt w każdym pull requeście, a ruch na proxy przed stagingiem.

Dodaj sprawdzenia bezpieczeństwa do CIZainstaluj API Genie

Poświadczenie w URL-u, potem nieudokumentowana trasa

Z zestawem privacy obok recommended linter wskazuje token w query stringu (privacy/no-credentials-in-url), adres e-mail (privacy/no-personal-data-in-url) i dwie operacje bez wymagań bezpieczeństwa (operation-security-defined), po czym kończy się kodem 1. Potem proxy stoi przed stagingiem, gdy działają testy. Po zatrzymaniu wymienia GET /v1/internal/debug, którego kontrakt nie deklaruje, i żądanie, które przyszło bez tokenu. Z --fail-on errors kończy się kodem 5. API Genie sprawdza kontrakt i ruch względem niego, bez ładunków ataków: wstrzyknięcia i błędy autoryzacji na poziomie obiektów zostają dla pentestu.

$ cat apigenie.yaml
version: '1.0'
commands:
  lint:
    extends: [recommended, privacy]
$ apigenie lint api/orders.yaml; echo $?
  19:11  warning  Query parameter 'email' puts personal data (e-mail address) in the URL; send it in the request body instead  privacy/no-personal-data-in-url
  50:7   warning  Security requirement is not defined                                                                          operation-security-defined
  68:7   warning  Security requirement is not defined                                                                          operation-security-defined
  73:11  error    Query parameter 'token' puts a credential (token) in the URL; send it in a header instead                    privacy/no-credentials-in-url

  4 issues (1 errors, 3 warnings)

1
$ apigenie-server api/orders.yaml --proxy-to http://localhost:8080 \
    --report contract.json --record-har staging.har --fail-on errors &
$ # run the tests against http://127.0.0.1:4010/v1, then
$ curl -s -X POST http://127.0.0.1:4010/__apigenie/shutdown
Contract: 3 requests (1 undocumented), 1 errors, 1 warnings
Coverage: 37.5% of 8 branches, 1 of 3 operations
  not tested: GET /orders/{order_id} (getOrder), GET /exports (exportOrders)
  undocumented: GET /v1/internal/debug (1)
  error GET /orders: security: a bearer token (oauth) are missing (unauthorized; request.authorization.missing)
  warn GET /v1/internal/debug: path: GET /v1/internal/debug matches no path of the document (unknown-path; request.path-or-method.unknown)
Contract failed: 1 error violations
$ wait $!; echo $?
5

Co obejmuje

  • Zestaw privacyPoświadczenia i dane osobowe w URL-ach, z odwołaniami do OWASP, CWE i RODO, które podaje każda reguła.
  • Zestaw owaspZestaw OWASP ze Spectral, wbudowany: 8 z 10 ryzyk OWASP API Security Top 10 (2023), dla OpenAPI i Swagger 2.0.
  • Skanowanie koduSARIF 2.1.0 z apigenie lint, wysyłany przez GitHub Action z sarif: true.
  • Walidujące proxyBrakujące poświadczenia, inne niż skonfigurowane przy security.mode: enforce, nieudokumentowane trasy oraz raport JSON lub JUnit dla CI.
  • Każda operacja, z tokenem OAuth 2apigenie test --generate wysyła żądanie na każdą operację, z tokenem z Twojego endpointu tokenów OAuth 2.
  • Inwentarz z właścicielamiapigenie-catalog list odpowiada, jakie API są w repozytorium i kto jest właścicielem każdego z nich.

Narzędzia, które to robią

Krok po kroku (przewodnik po angielsku)

Review an API for security: Lint the contract for security and privacy issues in every pull request, check staging's traffic against it at a proxy, test every operation with a token, and keep an inventory of the APIs.

Działa tam, gdzie są Twoje kontrakty

CLI, serwer i katalog działają na Twoich maszynach i w Twoim CI, bez konta i bez usługi API Genie, do której trzeba by cokolwiek wysyłać. Funkcje lintera i skrypty serwera działają w piaskownicy bez dostępu do systemu plików i sieci.

Inne zastosowania