View a markdown version of this page

SonarQube Jeton - AWS Secrets Manager
Champs de valeur secrèteChamps de métadonnées secretsFlux d'utilisation

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

SonarQube Jeton

Champs de valeur secrète

Les champs suivants doivent figurer dans le secret du Secrets Manager :

{
  "token": "token value",
  "tokenName": "token name",
  "login": "user that owns the token",
  "sonarqubeUrl": "https://sonarqube.example.com",
  "tokenType": "USER_TOKEN",
  "projectKey": "project key"
}
jeton

La valeur du SonarQube jeton (commence par squ_sqa_, ousqp_). Le processus de rotation met à jour ce champ.

Nom du jeton

Le nom du jeton (unique par utilisateur). Rotation utilise ce nom pour révoquer l'ancien jeton.

login

L'SonarQubeutilisateur propriétaire du jeton.

URL de SonarQube

L'URL de votre SonarQube instance (par exemple,https://sonarqube.example.com). L'URL doit utiliser le protocole HTTPS et ne doit pas se terminer par une barre oblique.

Type de jeton

(Facultatif) Type de jeton : USER_TOKEN (par défaut)GLOBAL_ANALYSIS_TOKEN, ouPROJECT_ANALYSIS_TOKEN.

projectKey

(Facultatif) La clé SonarQube du projet. Obligatoire uniquement lorsque tokenType c'est le casPROJECT_ANALYSIS_TOKEN.

Champs de métadonnées secrets

Les champs de métadonnées pour SonarQube Token sont les suivants :

{
  "adminSecretArn": "arn:aws:secretsmanager:us-east-1:111122223333:secret:SonarQubeAdmin"
}
administrateur SecretArn

(Facultatif) Le nom de ressource Amazon (ARN) pour un secret de type SonarQubeToken contenant un jeton d'administration. Ce champ est obligatoire pour les jetons d'analyse globale et d'analyse de projet. Il est facultatif pour les jetons utilisateur ; omettez-le pour activer la rotation automatique, où le jeton actuel génère et révoque son propre remplacement.

Flux d'utilisation

Cette rotation prend en charge la rotation à secret unique (rotation automatique) pour les jetons utilisateur et la rotation à deux secrets (assistée par l'administrateur) pour les jetons d'analyse globale et d'analyse de projet. La tokenType valeur détermine la portée du jeton.

Pour créer votre secret, utilisez l'appel CreateSecret d'API. Définissez la valeur secrète dans les champs décrits ci-dessus et définissez le type de secret sur SonarQubeToken. Pour configurer la rotation, utilisez l'appel RotateSecret d'API. Dans l' RotateSecret appel, indiquez un rôle ARN qui autorise le service à alterner le secret. Pour un exemple de politique d'autorisations, voir Sécurité et autorisations. Lorsque vous utilisez la rotation assistée par administrateur, accordez explicitement au rôle de rotation l'accès à l'ARN secret d'administrateur.

Pendant la rotation, le pilote génère un nouveau jeton, le stocke en tant que version en attente, le vérifie par rapport à l'SonarQubeAPI, le promeut comme étant à jour, puis révoque l'ancien jeton par le sien. tokenName Les applications utilisant la bibliothèque de mise en cache de Secrets Manager récupèrent le nouveau jeton lors de leur prochaine actualisation.

SonarQubeLe serveur étant hébergé par le client, votre SonarQube instance doit être accessible via HTTPS à partir du service de rotation Secrets Manager. Les appels de rotation proviennent de la liste de AWS préfixes -managed. com.amazonaws.region.secretsmanager-managed-external-secrets Autorisez l'accès entrant à partir de cette liste de préfixes sur le groupe de sécurité ou le pare-feu de votre instance, et assurez-vous que l'instance présente un certificat TLS approuvé publiquement. Pour plus d’informations, consultez les listes de préfixes gérés par AWS dans le Guide de l’utilisateur Amazon VPC. Les instances qui ne sont pas accessibles via Internet public ne sont pas prises en charge.