View a markdown version of this page

Jenkins Token API - AWS Secrets Manager
Bidang Nilai RahasiaBidang Metadata RahasiaAlur Penggunaan

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Jenkins Token API

Bidang Nilai Rahasia

Berikut ini adalah bidang yang harus terkandung dalam rahasia Manajer Rahasia:

{
  "apiToken": "API token value",
  "tokenUuid": "token UUID",
  "username": "user that owns the token",
  "jenkinsUrl": "https://jenkins.example.com"
}
APIToken

Nilai token Jenkins API (string heksadesimal 32-34 karakter). Proses rotasi memperbarui bidang ini.

TokenUUID

Pengidentifikasi unik universal (UUID) dari token API. Rotasi menggunakan UUID ini untuk mencabut token lama, dan memperbarui bidang ini dengan UUID token baru setelah setiap rotasi.

nama pengguna

JenkinsPengguna yang memiliki token.

JenkinSurl

URL Jenkins instans Anda (misalnya,https://jenkins.example.com). URL harus menggunakan HTTPS dan tidak boleh diakhiri dengan garis miring.

Bidang Metadata Rahasia

Berikut ini adalah bidang metadata untuk Token Jenkins API:

{
  "adminSecretArn": "arn:aws:secretsmanager:us-east-1:111122223333:secret:JenkinsAdmin"
}
admin SecretArn

(Opsional) Nama Sumber Daya Amazon (ARN) untuk jenis rahasia JenkinsApiToken yang berisi token admin. Token admin dapat menghasilkan dan mencabut token API untuk pengguna target. Jika dihilangkan, token berputar sendiri (rotasi sendiri).

Alur Penggunaan

Rotasi ini mendukung arsitektur rahasia tunggal (rotasi diri) dan dua rahasia (bantuan admin). Saat Anda memberikanadminSecretArn, token admin menghasilkan dan mencabut token pengguna target. Jika Anda menghilangkannya, token saat ini berputar sendiri.

Untuk membuat rahasia Anda, gunakan panggilan CreateSecret API. Atur nilai rahasia ke bidang yang dijelaskan di atas dan atur tipe rahasia ke JenkinsApiToken. Untuk mengkonfigurasi rotasi, gunakan panggilan RotateSecret API. Dalam RotateSecret panggilan, berikan peran ARN yang memberikan izin layanan untuk memutar rahasia. Untuk contoh kebijakan izin, lihat Keamanan dan Izin. Saat menggunakan rotasi yang dibantu admin, secara eksplisit berikan akses peran rotasi ke ARN rahasia admin.

Selama rotasi, pengemudi memvalidasi token saat ini dan memperoleh remah Re Cross-Site quest Forgery (CSRF) dari. Jenkins Kemudian menghasilkan token API baru dan menyimpannya sebagai versi yang tertunda. Ini memverifikasi token baru terhadap Jenkins API, mempromosikannya ke saat ini, lalu mencabut token lama olehnya. tokenUuid Aplikasi yang menggunakan perpustakaan caching Secrets Manager mengambil token baru pada penyegaran berikutnya.

Jenkinsdi-host pelanggan, jadi Jenkins instans Anda harus dapat dijangkau melalui HTTPS dari layanan rotasi Manajer Rahasia. Panggilan rotasi berasal dari daftar com.amazonaws.region.secretsmanager-managed-external-secrets awalan AWS-managed. Izinkan akses masuk dari daftar awalan ini pada grup keamanan instans atau firewall, dan pastikan instans menampilkan sertifikat TLS yang dipercaya secara publik. Untuk informasi selengkapnya, lihat AWS daftar awalan yang dikelola di Panduan Pengguna Amazon VPC. Instans yang tidak dapat dijangkau melalui internet publik tidak didukung.