API anahtarı hijyeni
API anahtarları, OWASP'ın secrets management kapsamında ele aldığı gizli bilgiler arasındadır. OWASP, bir secret'ın yaşam döngüsünü creation, rotation, revocation ve expiration aşamalarıyla açıklar. Oluşturulan secret'ın kullanım amacı için yeterli kriptografik sağlamlıkta ve gerekli iş için asgari yetkilerle tanımlanmış olması gerektiğini belirtir.
Yetkileri ve erişimi sınırlama
OWASP'a göre bir secret'ı okuma veya değiştirme yetkisi olan kullanıcı ve bu kullanıcının erişim için kullandığı sistem, secret'ın açığa çıkabileceği noktalardır. OWASP, secret management sistemindeki her nesne ve bileşen için ayrıntılı erişim yetkileri tanımlanmasını ve Least Privilege ilkesinin uygulanmasını önerir.
GitHub, personal access token oluştururken yalnızca gerekli izinlerin veya scope'ların seçilmesini söyler. Token'ın son kullanma tarihi de ihtiyaç duyulan süreyle sınırlı tutulmalıdır. GitHub App oluştururken uygulamaya, GitHub Actions workflow içinde GITHUB_TOKEN kullanırken de workflow'a yalnızca gerekli asgari izinler verilmelidir.
GitHub'a göre bir token, sahibinin erişebildiği ve işlem yapabildiği alanlarla sınırlıdır. Token'a verilen scope ve izinler bu erişimi daha da sınırlar. Token, kullanıcıya normalde sahip olmadığı ek erişim yetkileri kazandırmaz.
GitHub, personal access token'ın başka kişilerle paylaşılmamasını söyler. Bir ekibin kimlik bilgilerini paylaşması gerekiyorsa bunlar güvenli bir ortak sistemde tutulabilir. API erişimi gereken bir GitHub Actions workflow için kimlik bilgileri şifrelenmiş bir secret içinde saklanabilir ve workflow tarafından kullanılabilir.
Anahtarları koddan ayrı tutma
GitHub, token, anahtar ve uygulamaya ait secret'ların koda sabit değer olarak yazılmamasını söyler. Şifrelenmemiş token ve anahtarların, özel repository dahil hiçbir repository'ye gönderilmemesi gerektiğini belirtir. GitHub Actions secret ve Codespaces secret, GitHub'ın bu iş için sunduğu seçenekler arasındadır.
GitHub, personal access token'ın command line üzerinde düz metin olarak aktarılmamasını da ister. Kimlik bilgileri şifrelenmemiş mesajlaşma veya e-posta sistemleriyle paylaşılmamalıdır. OWASP da secret'ların düz metin olarak iletilmemesini belirtir.
GitHub'a göre bir script içinde personal access token kullanılırken token GitHub Actions secret olarak saklanıp script GitHub Actions üzerinden çalıştırılabilir. Token, Codespaces secret olarak saklanıp script Codespaces içinde de çalıştırılabilir. GitHub, bu seçenekler mümkün değilse kimlik bilgilerinin .env dosyasında tutulabileceğini söyler. Bu dosya şifrelenmeli ve hiçbir repository'ye gönderilmemelidir.
Container ortamında OWASP, secret içeren bir dosyanın mounted volume olarak uygulamaya sunulabileceğini açıklar. Volume, container tanımına yerleştirilmek yerine gerektiğinde orchestrator tarafından bağlanmalıdır. Container tanımına yerleştirilmesi, secret'ın bu tanımla birlikte açığa çıkmasına yol açabilir.
OWASP'a göre environment variable'lara genellikle tüm process'ler erişebilir. Bunlar log veya system dump içinde de yer alabilir. OWASP, diğer yöntemler mümkün olmadıkça environment variable kullanılmasını önermez. Secret'ların Docker ENV veya ARG komutlarında sabit değer olarak yazılmaması gerektiğini de belirtir.
OWASP'ın anlattığı başka bir yöntemde sidecar container, secret'ı bir secret manager'dan alır ve paylaşılan bir volume'a yazar. Uygulama container'ı secret'ı bu volume'dan okur. Sidecar, secret'ı belirli aralıklarla yenileyebilir. OWASP, bu düzenin uygulamayı secret management çözümünün ayrıntılarından ayırdığını belirtir.
Süre, rotation ve iptal
OWASP, mümkün olduğunda secret'ların belirli bir sürenin sonunda sona erecek biçimde oluşturulmasını önerir. Süre sonu, secret'ı kullanan sistem tarafından uygulanabilir. Secret management sisteminde belirlenen bir son kullanma zamanı da rotation sürecini başlatabilir. OWASP, uygulamaların bir secret'a güvenmeden önce onun hâlâ etkin olduğunu doğrulaması gerektiğini söyler.
Dynamic secret kullanımında OWASP, mümkün olduğunda kısa bir lease süresi tanımlanmasını ve artık ihtiyaç duyulmayan kimlik bilgilerinin iptal edilmesini önerir. Bir uygulamanın yeniden başlatılması, çalınmış kimlik bilgisini kendiliğinden iptal etmez. Bu bilgi, bağlı olduğu servis tarafından süresi sona erdirilene veya iptal edilene kadar kullanılabilir.
OWASP, statik anahtarların elle rotation işleminde hata yapılabileceğini belirtir. Rotation işleminin otomatikleştirilmesini veya en azından yeterli teknik destekle yürütülmesini önerir. Anlattığı yöntemler arasında aşamalı rotation ve yeni anahtarın Write, eski anahtarın Read işlemlerinde kullanılması bulunur.
CI/CD için OWASP, pipeline'ın uygulamayı bir platform kimliğiyle dağıttığı bir yaklaşımı açıklar. Dağıtılan servis, çalışma zamanında kendi secret'larını doğrudan secret manager'dan alır. Böylece uygulamanın çalışma zamanındaki secret'ları CI/CD pipeline üzerinden geçirilmez.
OWASP'a göre pipeline bir secret manager'dan dynamic kimlik bilgileri aldığında runner'ın durması veya build işleminin tamamlanması bu bilgileri kendiliğinden iptal etmez. Kimlik bilgileri yapılandırılmış lease süresinin sonunda sona erer veya artık gerekmediğinde açıkça iptal edilir.
Sızıntıları tespit etme
GitHub secret scanning, repository'nin bütün branch'lerindeki Git geçmişini sabit değer olarak yazılmış kimlik bilgileri için tarar. Kapsamına API anahtarları, parolalar, token'lar ve bilinen diğer secret türleri girer. GitHub ayrıca secret türleri eklendiğinde repository'leri belirli aralıklarla yeniden tarar.
GitHub'ın otomatik taraması yalnızca kodla sınırlı değildir. Issue ve pull request başlıkları, açıklamaları ve yorumları; GitHub Discussions içeriği; wiki'ler ve secret gist'ler de taranan alanlar arasındadır. Bir repository'de kimlik bilgisi sızıntısı saptandığında GitHub, Security and quality sekmesinde açığa çıkan bilgiye ilişkin ayrıntıları içeren bir alert oluşturur.
GitHub, secret scanning kapsamının generic patterns ve custom patterns ile genişletilebildiğini açıklar. Generic patterns, belirli bir servis sağlayıcıya bağlı olmayan private key, connection string ve genel API anahtarlarını kapsayabilir. Custom patterns ise varsayılan pattern'ların kapsamadığı, kuruluşa özgü secret'ları saptamak için regular expression tanımlamaya yarar.
Validity checks, GitHub'a göre tespit edilen bir secret'ın hâlâ etkin olup olmadığını doğrulayarak müdahale sırasının belirlenmesine yardımcı olur. Bu özellik etkinleştirildiğinde secret scanning, kimlik bilgisinin iptal edilip edilmediğini belirlemek için onu veren servisle iletişime geçebilir.
GitHub, secret scanning ile tespit edilen bazı secret'ların servis sağlayıcılarla yapılan iş ortaklığı kapsamında ele alındığını belirtir. Böyle bir secret saptandığında sağlayıcıya bildirim gönderilir. Sağlayıcı, kimlik bilgisini iptal etmek gibi bir işlem yapabilir. Bu secret'lar repository alert'lerinde gösterilmez.
Açığa çıkan anahtara yanıt
OWASP, açığa çıkan anahtarların derhal iptal edilmesi gerektiğini söyler. Yeni bir secret'ın hızla oluşturulup uygulanabilmesi de müdahale sürecinin bir parçasıdır. OWASP, yeni secret'ın oluşturulması ve uygulanmasında tekrarlanabilirliği desteklemek ve uygulama hatalarını azaltmak için otomatik bir süreç kullanılmasını önerir.
GitHub, sızan bir token veya diğer kimlik bilgisi için yeni bir kimlik bilgisi oluşturulmasını söyler. Ardından eski bilgi, saklandığı veya kullanıldığı her yerde yenisiyle değiştirilir ve ele geçirilmiş eski bilgi silinir. GitHub'ın tarif ettiği işlem, eski bilginin kullanıldığı ve saklandığı yerlerin tamamını kapsar.
OWASP, iptal edilen veya rotation yapılan secret'ların açığa çıktıkları sistemden hemen kaldırılmasını ister. Buna kodda veya log'larda bulunan secret'lar da dahildir. Log içindeki bir secret kaldırılırken log bütünlüğünün korunmasına yönelik bir süreç bulunması gerektiğini belirtir.
Git geçmişindeki bir secret da kaldırılabilir. Ancak GitHub, kimlik bilgisi zaten iptal edilmişse geçmişten kaldırmanın zaman alıcı ve çoğu durumda gereksiz olabileceğini söyler. OWASP ise geçmişi yeniden yazmanın ilgili commit'e verilen başka bağlantıları bozabileceğini belirtir.
Başka bir kullanıcının personal access token'ı GitHub'da veya başka bir yerde açığa çıkmışsa GitHub, REST API üzerinden bir iptal isteği gönderilebileceğini belirtir.
Kayıtlar ve sınırlar
OWASP, secret management denetim kayıtlarında secret'ı kimin ve hangi sistem ile rol için istediğinin, isteğin kabul edilip edilmediğinin ve secret'ın ne zaman, kim veya ne tarafından kullanıldığının tutulmasını ister. Süre sonu, süresi dolmuş bir secret'ı yeniden kullanma girişimleri, authentication ve authorization hataları ile yönetim işlemleri de kaydedilecek olaylar arasındadır.
OWASP'a göre denetim kayıtları, değiştirilme veya silinme girişimlerine dayanıklı olmalıdır. Kayıtlardaki zaman bilgilerinin doğru olması gerekir. OWASP, altyapıda zaman eşitlemesi yapılmasını ve saat kayması ile elle yapılan saat değişikliklerinin izlenmesini söyler.
OWASP, bir secret hakkında kullanım amacı, türü, kim tarafından oluşturulduğu ve kullanıldığı gibi metadata'nın tutulmasını da ister. Elle rotation yapılan bir secret için rotation zamanının ve sorun yaşandığında iletişim kurulacak kişinin kaydı da bu bilgiler arasındadır.
Dynamic secret'lar her servise uygun değildir. OWASP, bağlanılacak servisin geçici rol veya kimlik bilgisi oluşturmayı desteklemeyebileceğini belirtir. Ayrıca dynamic secret oluşturmak için çoğu zaman uzun ömürlü statik bir secret gerekir. OWASP'a göre OpenID Connect de API anahtarları gibi diğer uygulama secret'larının yerini almaz.