View a markdown version of this page

SonarQube Token - AWS Secrets Manager
Campos de valores secretosCampos de metadados secretosFluxo de uso

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

SonarQube Token

Campos de valores secretos

A seguir estão os campos que devem estar contidos no segredo do 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"
}
token

O valor do SonarQube token (começa comsqu_,sqa_, ousqp_). O processo de rotação atualiza esse campo.

Nome do token

O nome do token (exclusivo por usuário). O Rotation usa esse nome para revogar o token antigo.

login

O SonarQube usuário que possui o token.

URL do SonarQube

O URL da sua SonarQube instância (por exemplo,https://sonarqube.example.com). O URL deve usar HTTPS e não deve terminar com uma barra final.

tokenType

(Opcional) O tipo de token: USER_TOKEN (padrão) ouPROJECT_ANALYSIS_TOKEN. GLOBAL_ANALYSIS_TOKEN

projectKey

(Opcional) A chave SonarQube do projeto. Exigido somente quando tokenType éPROJECT_ANALYSIS_TOKEN.

Campos de metadados secretos

A seguir estão os campos de metadados para SonarQube Token:

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

(Opcional) O nome de recurso da Amazon (ARN) para um segredo do tipo SonarQubeToken que contém um token de administrador. Esse campo é obrigatório para tokens de Análise Global e Análise de Projeto. É opcional para tokens de usuário; omita-o para ativar a rotação automática, onde o token atual gera e revoga sua própria substituição.

Fluxo de uso

Essa rotação suporta um único segredo (rotação automática) para tokens de usuário e rotação de dois segredos (assistida pelo administrador) para tokens de análise global e análise de projetos. O tokenType valor determina o escopo do token.

Para criar seu segredo, use a chamada de CreateSecret API. Defina o valor secreto para os campos descritos acima e defina o tipo secreto como SonarQubeToken. Para configurar a rotação, use a chamada de RotateSecret API. Na RotateSecret chamada, forneça uma função ARN que conceda ao serviço permissão para alternar o segredo. Para ver um exemplo de política de permissões, consulte Segurança e permissões. Ao usar a rotação assistida pelo administrador, conceda explicitamente à função rotativa acesso ao ARN secreto do administrador.

Durante a rotação, o driver gera um novo token, o armazena como a versão pendente, o verifica na SonarQube API, o promove para o atual e, em seguida, revoga o token antigo por meio dele. tokenName Os aplicativos que usam a biblioteca de cache do Secrets Manager recebem o novo token na próxima atualização.

SonarQubeO servidor é hospedado pelo cliente, portanto, sua SonarQube instância deve ser acessada por HTTPS a partir do serviço de rotação do Secrets Manager. As chamadas de rotação são originadas da lista de AWS prefixos -managed. com.amazonaws.region.secretsmanager-managed-external-secrets Permita o acesso de entrada dessa lista de prefixos no grupo de segurança ou firewall da sua instância e garanta que a instância apresente um certificado TLS publicamente confiável. Para obter mais informações, consulte listaS de prefixos gerenciados da AWS no Guia do usuário da Amazon VPC. Instâncias que não podem ser acessadas pela Internet pública não são suportadas.