View a markdown version of this page

SonarQube Token - AWS Secrets Manager
Felder für geheime WerteGeheime MetadatenfelderAblauf der Nutzung

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

SonarQube Token

Felder für geheime Werte

Die folgenden Felder müssen im Secrets Manager-Schlüssel enthalten sein:

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

Der SonarQube Token-Wert (beginnt mit squ_sqa_, odersqp_). Durch den Rotationsvorgang wird dieses Feld aktualisiert.

Token-Name

Der Token-Name (eindeutig pro Benutzer). Rotation verwendet diesen Namen, um das alte Token zu widerrufen.

login

Der SonarQube Benutzer, dem das Token gehört.

SonarQube-URL

Ihre SonarQube Instanz-URL (zum Beispiel). https://sonarqube.example.com Die URL muss HTTPS verwenden und darf nicht mit einem abschließenden Schrägstrich enden.

Token-Typ

(Optional) Der Tokentyp: USER_TOKEN (Standard)GLOBAL_ANALYSIS_TOKEN, oder. PROJECT_ANALYSIS_TOKEN

projectKey

(Optional) Der SonarQube Projektschlüssel. Nur erforderlich, wenn tokenType es istPROJECT_ANALYSIS_TOKEN.

Geheime Metadatenfelder

Im Folgenden sind die Metadatenfelder für SonarQube Token aufgeführt:

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

(Optional) Der Amazon-Ressourcenname (ARN) für einen geheimen Schlüssel SonarQubeToken , der ein Admin-Token enthält. Dieses Feld ist für globale Analyse- und Projektanalyse-Token erforderlich. Es ist optional für Benutzer-Tokens. Lassen Sie es weg, um die Selbstrotation zu aktivieren, bei der das aktuelle Token seinen eigenen Ersatz generiert und widerruft.

Ablauf der Nutzung

Diese Rotation unterstützt die Rotation mit nur einem Schlüssel (Selbstrotation) für Benutzer-Tokens und die Rotation mit zwei Geheimwerten (vom Administrator unterstützt) für globale Analyse- und Projektanalyse-Token. Der tokenType Wert bestimmt den Umfang des Tokens.

Verwenden Sie den CreateSecret API-Aufruf, um Ihr Geheimnis zu erstellen. Geben Sie den Geheimwert in die oben beschriebenen Felder ein und legen Sie den Geheimtyp auf fest SonarQubeToken. Verwenden Sie den RotateSecret API-Aufruf, um die Rotation zu konfigurieren. Geben RotateSecret Sie im Aufruf einen Rollen-ARN an, der dem Dienst die Erlaubnis erteilt, den Secret zu rotieren. Ein Beispiel für eine Berechtigungsrichtlinie finden Sie unter Sicherheit und Berechtigungen. Wenn Sie die administratorgestützte Rotation verwenden, gewähren Sie der Rotationsrolle explizit Zugriff auf den geheimen Admin-ARN.

Während der Rotation generiert der Treiber ein neues Token, speichert es als ausstehende Version, verifiziert es anhand der SonarQube API, stuft es auf das aktuelle Token hoch und widerruft dann das alte Token mit seinem. tokenName Anwendungen, die die Secrets Manager-Caching-Bibliothek verwenden, erkennen das neue Token bei ihrer nächsten Aktualisierung.

SonarQubeDer Server wird vom Kunden gehostet, daher muss Ihre SonarQube Instance über HTTPS vom Secrets Manager-Rotationsdienst aus erreichbar sein. Rotationsaufrufe stammen aus der AWS-managed-Präfixliste. com.amazonaws.region.secretsmanager-managed-external-secrets Erlauben Sie den eingehenden Zugriff von dieser Präfixliste auf die Sicherheitsgruppe oder Firewall Ihrer Instanz und stellen Sie sicher, dass die Instance ein öffentlich vertrauenswürdiges TLS-Zertifikat vorlegt. Weitere Informationen finden Sie im Abschnitt zur AWS-verwalteten Präfixliste im Amazon-VPC-Benutzerhandbuch. Instanzen, die nicht über das öffentliche Internet erreichbar sind, werden nicht unterstützt.