Depodaki sırlar: ön taahhütte ve CI'da gitleaks ve sızıntı olması durumunda ne yapılması gerektiği
Anahtar zaten sızdırılmışsa, önce bu
Eylemlerin sırası araçlardan daha önemlidir, o yüzden sondan başlayalım.
- 1.Anahtarı sağlayıcıdan iptal edin ve yeniden verin. Geçmişi ve analizi temizlemeden hemen önce. Herkese açık depolar, botlar tarafından sürekli olarak taranır ve halka açık bir taahhütle sonuçlanan bir anahtarın, gönderildiği andan itibaren tehlikeye atılmış olduğu düşünülmelidir.
- 2.Anahtarı tüm ortamlarda güncelleyin (CI gizli dizileri, barındırma değişkenleri, gizli dizi yöneticisi) ve hizmetleri yeniden başlatın.
- 3.Sağlayıcınızla anahtar kullanım günlüğünü kontrol edin: bilmediğiniz adreslerden, alışılmadık hacimlerden, oluşturulan kaynaklardan gelen çağrılar. Bulut anahtarları için - yeni örnekler ve IAM kullanıcıları.
- 4.Ancak bundan sonra geçmişi temizleyip temizleyeceğinize karar verin. Bunu
git filter-repoaracılığıyla yeniden yazabilirsiniz, ancak klonları, çatalları, CI önbelleklerini ve ayna hizmetlerinin kopyalarını kontrol edemezsiniz. Tarihten silmek hijyenle ilgilidir, sızıntıyı düzeltmekle değil. Bir anahtar iptal edilirse nerede olursa olsun zararsızdır.
Yaygın bir hata, dosyayı yeni bir taahhütle silmek ve sorunun çözülmüş olduğunu düşünmektir. Değer geçmişte kalır ve tek bir komutla git log -p bulunur.
Önleme: yerel olarak gitleaks
gitleaks, bir dizi kurala göre bilinen hizmetlerin anahtarlarına benzer dizeler ve yüksek entropi değerleri için kodda ve geçmişte arama yapar. Ön taahhüt çerçevesi aracılığıyla bağlantı:
# .pre-commit-config.yaml
repos:
- repo: https://github.com/gitleaks/gitleaks
rev: v8.30.1 # конкретный тег; pre-commit autoupdate обновит его
hooks:
- id: gitleakspip install pre-commit # или brew install pre-commit pre-commit install # ставит хук в .git/hooks pre-commit run gitleaks --all-files
Kanca yalnızca ne yaptığınızı kontrol eder, bu nedenle hızlıdır. Ancak yereldir: pre-commit install çalıştırmayan iş arkadaşında bu özellik yoktur ve git commit --no-verify tarafından devre dışı bırakılmıştır. Bu nedenle, ön taahhüt geliştirici için bir kolaylıktır ve asıl engel CI'da doğrulamadır.
Mevcut bir havuzun tüm geçmişinin tek seferlik kontrolü (sürüm 8.19 ve sonraki sürümlerde komutlar git ve dir olarak adlandırılır; eski detect ve protect uyumluluk için korunur):
gitleaks git --redact -v .
--redact bayrağı çıktıda bulunan değerleri gizler; bu bayrak olmadan, bir bilete kopyalanırsa raporun kendisi bir sızıntı haline gelir.
CI'da doğrulama
# .github/workflows/secrets.yml
name: secrets
on: [pull_request, push]
permissions:
contents: read
jobs:
gitleaks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # полная история, иначе проверяется только последний коммит
- uses: gitleaks/gitleaks-action@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}Kurumsal depolar için, gitleaks-action, GITLEAKS_LICENSE değişkeninde bir lisans anahtarı (ücretsiz, istek üzerine sağlanır) gerektirir. Anahtarsız bir alternatif, ikili dosyanın kendisini veya gitleaks Docker görüntüsünü run adımında çalıştırmaktır.
Bu görevi şube koruma kurallarında zorunlu bir kontrol haline getirin. O zaman yerel olarak sızdırılan bir sır, ana şubeye ulaşmadan önce bile PR'da duracaktır.
Yanlış pozitifler
Test donanımları, belgelerdeki örnek anahtarlar ve kilit dosyalarındaki karmalar bazen sır gibi görünür. Seçenekler:
- Satırdaki
gitleaks:allowyorumu, incelemede görülebilen, hedeflenen bir istisnadır. - Rapordaki belirli bulguların parmak izlerini
.gitleaksignoredosyalayın. .gitleaks.toml'a sahip olun, standart kuralları genişletin ve yollar boyunca istisnalar belirleyin.
config/ gibi dizinlerin tamamını hariç tutmayın; sırlar burada sona erer.
GitHub itme koruması
GitHub, bilinen token formatları için push engellemeli yerleşik gizli tarama özelliğine sahiptir. Ücretli GitHub Gizli Korumasının bir parçası olarak halka açık depolarda ve özel depolarda ücretsiz olarak mevcuttur. Gitleaks'i tamamlar: sunucu tarafında çalışır ve bir işaret tarafından gözden kaçırılamaz, ancak yalnızca GitHub ortaklarının formatlarını bilir ve kendi sırlarınızı görmez.
Prensipte sızıntılar nasıl önlenir
- İlk kayıttan
.gitignoreiçindeki.env*, depoda yalnızca boş değerlere sahip.env.examplevar. - Minimum haklara sahip ve her ortam için ayrı olan anahtarlar: Bir test anahtarının sızdırılması, üretimin açılmasına neden olmamalıdır.
- CI'daki sırlar - yerleşik sırlar deposu aracılığıyla, asla YAML'de.
- Günlüklere dikkat: Yapıda hata ayıklama sırasında yazdırılan ortam değişkenlerinin değerleri CI günlüklerinde kalır.
Ne yapılmamalı
- İşlemden önce base64 anahtarını "şifrelemeyin". Tarayıcılar bunu her zaman yakalayamayabilir ancak saldırgan bunu bir saniye içinde çözecektir.
- Birisinin anahtarı kullanıp kullanmadığı netleşinceye kadar rotasyonu geciktirmeyin. Açıklama saatler alır, rotasyon ise dakikalar alır.
- Paylaşılan bir konunun geçmişini sessizce yeniden yazmayın. Yerel kopyalara sahip iş arkadaşları bir sonraki gönderimde eski taahhütleri geri alacak; kabul edin ve deponun yeniden klonlanmasını isteyin.