Pular para o conteúdo principal
Versão: Next

Authentication Settings

The settings on this page contain sensitive credentials and are stored in INI-formatted files. Do not commit these files to your repository.

For non-sensitive settings (proxy, SSL, registries, etc.), see Settings (pnpm-workspace.yaml).

Auth file locations​

pnpm reads authentication settings from the following files, in order of priority (highest first):

  1. <workspace root>/.npmrc — project-level auth. This file should be listed in .gitignore.
  2. <pnpm config>/auth.ini — the primary user-level auth file. pnpm login writes tokens here.
  3. ~/.npmrc — read as a fallback for easier migration from npm. Use the npmrcAuthFile setting to point to a different file.

The <pnpm config> directory is:

  • If the $XDG_CONFIG_HOME env variable is set: $XDG_CONFIG_HOME/pnpm/
  • On Windows: ~/AppData/Local/pnpm/config/
  • On macOS: ~/Library/Preferences/pnpm/
  • On Linux: ~/.config/pnpm/

Authentication Settings​

<URL>:_authToken​

Define o token de autenticação bearer ao acessar o registro especificado. Por exemplo:

//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Você também pode usar uma variável de ambiente. Por exemplo:

//registry.npmjs.org/:_authToken=${NPM_TOKEN}

<URL>:tokenHelper​

Um token helper é um executável que gera um token de autenticação. Isso pode ser utilizado em situação onde o authToken não é um valor constante, mas é algo que é atualizado regularmente, onde um script ou outra ferramenta pode utilizar um refresh token para obter um novo token de acesso.

A configuração para o caminho do helper deve ser um caminho absoluto, sem argumentos. Para que seja seguro, só é permitido definir esse valor no arquivo .npmrc do usuário. Caso contrário, um projeto pode colocar um valor no .npmrc do projeto local e iniciar executáveis arbitrários.

Definindo um token helper para o registro padrão:

tokenHelper=/home/ivan/token-generator

Definindo um token helper para o registro especificado:

//registry.corp.com:tokenHelper=/home/ivan/token-generator

Certificate Settings​

ca​

  • Padrão: O certificado CA do npm
  • Tipo: String, Array ou null

O certificado de assinatura da Autoridade Certificadora que é confiável para conexões SSL com o registro. Os valores podem ser no formato PEM (também conhecido como "Base-64 encoded X.509 (.CER)"). Por exemplo:

ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"

Defina como "null" para permitir apenas registros conhecidos, ou um certificado de CA específico para confiar apenas naquela autoridade de assinatura específica.

Múltiplos CAs confiáveis podem especificados em um array de certificados:

ca[]="..."
ca[]="..."

See also the strictSsl setting.

cafile​

  • Default: null
  • Tipo: caminho

O caminho de um arquivo contendo um ou mais certificados de assinatura de Autoridade Certificadora. Semelhante à configuração de ca, mas permite vários CAs, assim como para que as informações da CA sejam armazenadas em um arquivo em vez de serem especificadas via CLI.

<URL>:cafile​

Define the path to a Certificate Authority file to use when accessing the specified registry. Por exemplo:

//registry.npmjs.org/:cafile=ca-cert.pem

<URL>:ca​

Added in: v10.25.0

Define an inline Certificate Authority certificate for the specified registry. The value must be PEM-encoded, like the global ca setting, but it only applies to the matching registry URL.

//registry.example.com/:ca=-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----

cert​

  • Default: null
  • Tipo: String

Um certificado de cliente a ser aprovado ao acessar o registro. Os valores devem estar em formato PEM (também conhecido como "Base-64 codificado X.509 (. CER)"). Por exemplo:

cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"

It is not the path to a certificate file.

<URL>:cert​

Added in: v10.25.0

Define an inline client certificate to use when accessing the specified registry. Exemplo:

//registry.example.com/:cert=-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----

<URL>:certfile​

Define the path to a certificate file to use when accessing the specified registry. Por exemplo:

//registry.npmjs.org/:certfile=server-cert.pem

key​

  • Padrão: null
  • Tipo: String

Uma chave de cliente a ser passada para acessar o registry. Os valores devem estar no formato PEM (X.509 codificado em Base-64 (.CER)). Por exemplo:

key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"

It is not the path to a key file. Use <URL>&#58;keyfile if you need to reference the file system instead of inlining the key.

Essa configuração contém informações confidenciais. Não o grave em um arquivo local .npmrc confirmado no repositório.

<URL>:key​

Added in: v10.25.0

Define an inline client key for the specified registry URL.

//registry.example.com/:key=-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----

<URL>:keyfile​

Define the path to a client key file to use when accessing the specified registry. Por exemplo:

//registry.npmjs.org/:keyfile=server-key.pem