Mecanismos de autenticação

MongoDB\ClientCredentials

Primeiro, o driver verifica se você passou as credenciais do Amazon Web Services para o construtor MongoDB\Client, como parte do URI de conexão ou do parâmetro da array $uriOptions. Para passar suas credenciais para MongoDB\Client, defina as seguintes opções de conexão:

• username: O ID da chave de acesso do Amazon Web Services IAM para autenticar. Porcentagem Codifique esse valor antes de incluí-lo em um URI de conexão.

• password: A chave de acesso secreto IAM do Amazon Web Services. Porcentagem Codifique esse valor antes de incluí-lo em um URI de conexão.

• authMechanism: Defina como 'MONGODB-AWS'.

Você pode definir essas opções de duas maneiras: passando uma array de opções para o construtor MongoDB\Client ou por meio de parâmetros em seu URI de conexão.

$uriOptions = [
    'username' => '<AWS IAM access key ID>',
    'password' => '<AWS IAM secret access key>',
    'authMechanism' => 'MONGODB-AWS',
];
$client = new MongoDB\Client(
    'mongodb://<hostname>:<port>',
    $uriOptions,
);

$uri = 'mongodb://<AWS IAM access key ID>:<AWS IAM secret access key>@<hostname>:<port>/?authMechanism=MONGODB-AWS';
$client = new MongoDB\Client($uri);

Variáveis de ambiente

Se você não fornecer um nome de usuário e senha ao construir seu objeto MongoDB\Client , o driver tentará recuperar as credenciais do Amazon Web Services a partir das seguintes variáveis de ambiente:

• AWS_ACCESS_KEY_ID

• AWS_SECRET_ACCESS_KEY

• AWS_SESSION_TOKEN

Para usar essas variáveis de ambiente para autenticar seu aplicação, primeiro defina-as para os valores do Amazon Web Services IAM necessários para a autenticação. Você pode executar o comando export em seu shell ou adicionar as variáveis a um arquivo .env , conforme mostrado no exemplo de código a seguir:

export AWS_ACCESS_KEY_ID=<AWS IAM access key ID>
export AWS_SECRET_ACCESS_KEY=<AWS IAM secret access key>
export AWS_SESSION_TOKEN=<AWS session token>

AWS_ACCESS_KEY_ID=<AWS IAM access key ID>
AWS_SECRET_ACCESS_KEY=<AWS IAM secret access key>
AWS_SESSION_TOKEN=<AWS session token>

Após configurar estas variáveis de ambiente, configure a opção de conexão do authMechanism para 'MONGODB-AWS'.

$client = new MongoDB\Client(
    'mongodb://<hostname>:<port>',
    ['authMechanism' => 'MONGODB-AWS']
);

$uri = 'mongodb://<hostname>:<port>/?authMechanism=MONGODB-AWS';
$client = new MongoDB\Client($uri);

Solicitação AssumeRoleWithWebIdentity

Se o seu aplicação autenticar usuários para o seu cluster EKS a partir de um provedor de identidade OpenID Connect (OIDC), o driver poderá fazer uma solicitação do AssumeRoleWithWebIdentity para trocar o token OIDC por credenciais temporárias do Amazon Web Services para seu aplicação.

Para autenticar com credenciais temporárias Amazon Web Services IAM retornadas por uma solicitação de AssumeRoleWithWebIdentity, verifique se o arquivo de configuração do Amazon Web Services existe em seu ambiente e está configurado corretamente. Para saber como criar e configurar um Amazon Web Services arquivo de configuração do , consulte Configuração na documentação do Amazon Web Services .

Após configurar seu ambiente para uma solicitação do AssumeRoleWithWebIdentity , configure a opção de conexão do authMechanism para 'MONGODB-AWS'. Para visualizar um exemplo que define a opção authMechanism , consulte o exemplo authMechanism nesta página.

ECS Metadata

Se o seu aplicação for executado em um container do Elastic Container Service (ECS), o driver poderá recuperar automaticamente credenciais temporárias Amazon Web Services de um endpoint do ECS. Para fazer isso, especifique o URI do ponto de extremidade ECS em uma variável de ambiente chamada AWS_CONTAINER_CREDENTIALS_RELATIVE_URI. Você pode definir essa variável executando o comando shell export ou adicionando-a ao arquivo .env , conforme mostrado no exemplo a seguir:

export AWS_CONTAINER_CREDENTIALS_RELATIVE_URI=<URI of the ECS endpoint>

AWS_CONTAINER_CREDENTIALS_RELATIVE_URI=<URI of the ECS endpoint>

Após configurar a variável de ambiente, configure a opção de conexão do authMechanism para 'MONGODB-AWS'. Para visualizar um exemplo que define a opção authMechanism , consulte o exemplo authMechanism nesta página.

EC2 Metadados de instância

O driver pode recuperar automaticamente credenciais temporárias Amazon Web Services de uma instância do Amazon Elastic Cloud Compute (EC2). Para usar credenciais temporárias de dentro de uma instância do EC2 , configure a opção de conexão do authMechanism para 'MONGODB-AWS'. Para visualizar um exemplo que define a opção authMechanism , consulte o exemplo authMechanism nesta página.

Documentação da API

Para saber mais sobre a classe MongoDB\Client , consulte MongoDB\Client na documentação da API da biblioteca.

Para ver uma lista completa de opções de URI que você pode passar para um MongoDB\Client, consulte MongoDB\Driver\Manager::__construct() Parameters na documentação da API da extensão.