browser.certificateProvider

Descrição

Use essa API para expor certificados à plataforma, que pode usá-los para autenticações TLS.

Permissões

certificateProvider

Disponibilidade

Chrome 46+ browser.* desde o Chrome 148 Somente ChromeOS

Conceitos e uso

O uso típico dessa API para expor certificados do cliente ao ChromeOS segue estas etapas:

  • A extensão se registra para os eventos onCertificatesUpdateRequested e onSignatureRequested.
  • A extensão chama setCertificates() para fornecer a lista inicial de certificados após a inicialização.
  • A extensão monitora as mudanças na lista de certificados disponíveis e chama setCertificates() para notificar o navegador sobre cada uma delas.
  • Durante um handshake de TLS, o navegador recebe uma solicitação de certificado do cliente. Com um evento onCertificatesUpdateRequested, o navegador pede que a extensão informe todos os certificados que ela fornece no momento.
  • A extensão informa os certificados disponíveis no momento usando o método setCertificates().
  • O navegador faz a correspondência de todos os certificados disponíveis com a solicitação de certificado do cliente do host remoto. As correspondências são apresentadas ao usuário em uma caixa de diálogo de seleção.
  • O usuário pode selecionar um certificado e, assim, aprovar ou cancelar a autenticação.
Caixa de diálogo de seleção de certificado
Caixa de diálogo de seleção de certificado.
  • Se o usuário cancelar a autenticação ou nenhum certificado corresponder à solicitação, a autenticação do cliente TLS será cancelada.
  • Caso contrário, se o usuário aprovar a autenticação com um certificado fornecido por esta extensão, o navegador vai solicitar que a extensão assine os dados para continuar o handshake de TLS. A solicitação é enviada como um evento onSignatureRequested.
  • Esse evento contém dados de entrada, declara qual algoritmo precisa ser usado para gerar a assinatura e se refere a um dos certificados informados por essa extensão. A extensão precisa criar uma assinatura para os dados fornecidos usando a chave privada associada ao certificado referenciado. A criação da assinatura pode exigir a adição de um DigestInfo e o preenchimento do resultado antes da assinatura real.
  • A extensão envia a assinatura de volta ao navegador usando o método reportSignature(). Se não for possível calcular a assinatura, o método precisará ser chamado sem ela.
  • Se a assinatura for fornecida, o navegador vai concluir o handshake de TLS.

A sequência real de etapas pode ser diferente. Por exemplo, o usuário não precisará selecionar um certificado se a política corporativa para selecionar um certificado automaticamente for usada (consulte AutoSelectCertificateForUrls e Políticas do Chrome para usuários).

Na extensão, isso pode ser semelhante ao seguinte snippet:

function collectAvailableCertificates() {
  // Return all certificates that this Extension can currently provide.
  // For example:
  return [{
    certificateChain: [new Uint8Array(...)],
    supportedAlgorithms: ['RSASSA_PKCS1_v1_5_SHA256']
  }];
}

// The Extension calls this function every time the currently available list of
// certificates changes, and also once after the Extension's initialization.
function onAvailableCertificatesChanged() {
  browser.certificateProvider.setCertificates({
    clientCertificates: collectAvailableCertificates()
  });
}

function handleCertificatesUpdateRequest(request) {
  // Report the currently available certificates as a response to the request
  // event. This is important for supporting the case when the Extension is
  // unable to detect the changes proactively.
  browser.certificateProvider.setCertificates({
    certificatesRequestId: request.certificatesRequestId,
    clientCertificates: collectAvailableCertificates()
  });
}

// Returns a private key handle for the given DER-encoded certificate.
// |certificate| is an ArrayBuffer.
function getPrivateKeyHandle(certificate) {...}

// Digests and signs |input| with the given private key. |input| is an
// ArrayBuffer. |algorithm| is an Algorithm.
// Returns the signature as ArrayBuffer.
function signUnhashedData(privateKey, input, algorithm) {...}

function handleSignatureRequest(request) {
  // Look up the handle to the private key of |request.certificate|.
  const key = getPrivateKeyHandle(request.certificate);
  if (!key) {
    // Handle if the key isn't available.
    console.error('Key for requested certificate no available.');

    // Abort the request by reporting the error to the API.
    browser.certificateProvider.reportSignature({
      signRequestId: request.signRequestId,
      error: 'GENERAL_ERROR'
    });
    return;
  }

  const signature = signUnhashedData(key, request.input, request.algorithm);
  browser.certificateProvider.reportSignature({
    signRequestId: request.signRequestId,
    signature: signature
  });
}

browser.certificateProvider.onCertificatesUpdateRequested.addListener(
    handleCertificatesUpdateRequest);
browser.certificateProvider.onSignatureRequested.addListener(
    handleSignatureRequest);

Tipos

Algorithm

Chrome 86+ browser.* desde o Chrome 148

Tipos de algoritmos de assinatura criptográfica compatíveis.

Enumeração

"RSASSA_PKCS1_v1_5_MD5_SHA1"
Especifica o algoritmo de assinatura RSASSA PKCS#1 v1.5 com o hash MD5-SHA-1. A extensão não pode adicionar um prefixo DigestInfo, apenas um padding PKCS#1. Esse algoritmo foi descontinuado e não será mais solicitado pelo Chrome a partir da versão 109.

"RSASSA_PKCS1_v1_5_SHA1"
Especifica o algoritmo de assinatura RSASSA PKCS#1 v1.5 com a função hash SHA-1.

"RSASSA_PKCS1_v1_5_SHA256"
Especifica o algoritmo de assinatura RSASSA PKCS#1 v1.5 com a função hash SHA-256.

"RSASSA_PKCS1_v1_5_SHA384"
Especifica o algoritmo de assinatura RSASSA PKCS#1 v1.5 com a função hash SHA-384.

"RSASSA_PKCS1_v1_5_SHA512"
Especifica o algoritmo de assinatura RSASSA PKCS#1 v1.5 com a função hash SHA-512.

"RSASSA_PSS_SHA256"
Especifica o algoritmo de assinatura RSASSA PSS com a função hash SHA-256, a função de geração de máscara MGF1 e o salt do mesmo tamanho do hash.

"RSASSA_PSS_SHA384"
Especifica o algoritmo de assinatura RSASSA PSS com a função hash SHA-384, a função de geração de máscara MGF1 e o salt do mesmo tamanho do hash.

"RSASSA_PSS_SHA512"
Especifica o algoritmo de assinatura RSASSA PSS com a função hash SHA-512, a função de geração de máscara MGF1 e o salt do mesmo tamanho do hash.

CertificateInfo

Propriedades

  • certificado

    ArrayBuffer

    Precisa ser a codificação DER de um certificado X.509. No momento, apenas certificados de chaves RSA são aceitos.

  • supportedHashes

    Hash[]

    Precisa ser definido para todos os hashes compatíveis com esse certificado. Essa extensão só vai solicitar assinaturas de resumos calculados com um desses algoritmos de hash. Isso precisa estar em ordem decrescente de preferência de hash.

CertificatesUpdateRequest

Chrome 86+ browser.* desde o Chrome 148

Propriedades

  • certificatesRequestId

    número

    Identificador de solicitação a ser transmitido para setCertificates.

ClientCertificateInfo

Chrome 86+ browser.* desde o Chrome 148

Propriedades

  • certificateChain

    ArrayBuffer[]

    A matriz precisa conter a codificação DER do certificado do cliente X.509 como o primeiro elemento.

    Ele precisa incluir exatamente um certificado.

  • supportedAlgorithms

    Algoritmo[]

    Todos os algoritmos compatíveis com este certificado. A extensão só vai solicitar assinaturas usando um desses algoritmos.

Error

Chrome 86+ browser.* desde o Chrome 148

Tipos de erros que a extensão pode informar.

Valor

"GENERAL_ERROR"

Hash

Obsoleto. Substituído por Algorithm.

Enumeração

"MD5_SHA1"
Especifica os algoritmos de hash MD5 e SHA1.

"SHA1"
Especifica o algoritmo de hash SHA1.

"SHA256"
Especifica o algoritmo de hash SHA256.

"SHA384"
Especifica o algoritmo de hash SHA384.

"SHA512"
Especifica o algoritmo de hash SHA512.

PinRequestErrorType

Chrome 57+ browser.* desde o Chrome 148

Os tipos de erros que podem ser apresentados ao usuário pela função requestPin.

Enumeração

"INVALID_PIN"
Especifica que o PIN é inválido.

"INVALID_PUK"
Especifica que o PUK é inválido.

"MAX_ATTEMPTS_EXCEEDED"
Especifica que o número máximo de tentativas foi excedido.

"UNKNOWN_ERROR"
Especifica que o erro não pode ser representado pelos tipos acima.

PinRequestType

Chrome 57+ browser.* desde o Chrome 148

O tipo de código solicitado pela extensão com a função requestPin.

Enumeração

"PIN"
Especifica que o código solicitado é um PIN.

"PUK"
Especifica que o código solicitado é um PUK.

PinResponseDetails

Chrome 57+ browser.* desde o Chrome 148

Propriedades

  • userInput

    string opcional

    O código fornecido pelo usuário. Fica vazio se o usuário fechar a caixa de diálogo ou se ocorrer algum outro erro.

ReportSignatureDetails

Chrome 86+ browser.* desde o Chrome 148

Propriedades

  • erro

    "GENERAL_ERROR"
     opcional

    Erro que ocorreu ao gerar a assinatura, se houver.

  • signRequestId

    número

    Identificador de solicitação recebido pelo evento onSignatureRequested.

  • assinatura

    ArrayBuffer opcional

    A assinatura, se gerada com sucesso.

RequestPinDetails

Chrome 57+ browser.* desde o Chrome 148

Propriedades

  • attemptsLeft

    número optional

    O número de tentativas restantes. Isso é fornecido para que qualquer interface possa apresentar essas informações ao usuário. O Chrome não deve aplicar isso. Em vez disso, stopPinRequest precisa ser chamado pela extensão com errorType = MAX_ATTEMPTS_EXCEEDED quando o número de solicitações de PIN for excedido.

  • errorType

    PinRequestErrorType opcional

    O modelo de erro exibido ao usuário. Isso precisa ser definido se a solicitação anterior falhar, para notificar o usuário sobre o motivo da falha.

  • requestType

    PinRequestType opcional

    O tipo de código solicitado. O padrão é PIN.

  • signRequestId

    número

    O ID fornecido pelo Chrome em SignRequest.

SetCertificatesDetails

Chrome 86+ browser.* desde o Chrome 148

Propriedades

  • certificatesRequestId

    número optional

    Quando chamado em resposta a onCertificatesUpdateRequested, precisa conter o valor certificatesRequestId recebido. Caso contrário, não deve ser definido.

  • clientCertificates

    ClientCertificateInfo[]

    Lista de certificados do cliente disponíveis no momento.

  • erro

    "GENERAL_ERROR"
     opcional

    Erro que ocorreu ao extrair os certificados, se houver. Esse erro será exibido ao usuário quando apropriado.

SignatureRequest

Chrome 86+ browser.* desde o Chrome 148

Propriedades

  • algoritmo

    Algorithm

    Algoritmo de assinatura a ser usado.

  • certificado

    ArrayBuffer

    A codificação DER de um certificado X.509. A extensão precisa assinar input usando a chave privada associada.

  • entrada

    ArrayBuffer

    Dados a serem assinados. Os dados não são criptografados com hash.

  • signRequestId

    número

    Identificador de solicitação a ser transmitido para reportSignature.

SignRequest

Propriedades

  • certificado

    ArrayBuffer

    A codificação DER de um certificado X.509. A extensão precisa assinar digest usando a chave privada associada.

  • resumo

    ArrayBuffer

    O resumo que precisa ser assinado.

  • jogo da velha

    Hash

    Refere-se ao algoritmo de hash usado para criar digest.

  • signRequestId

    número

    Chrome 57+ browser.* desde o Chrome 148

    O ID exclusivo que será usado pela extensão se ela precisar chamar um método que o exija, por exemplo, requestPin.

StopPinRequestDetails

Chrome 57+ browser.* desde o Chrome 148

Propriedades

  • errorType

    PinRequestErrorType opcional

    O modelo de erro. Se estiver presente, ele será exibido ao usuário. Destinado a conter o motivo da interrupção do fluxo se ele tiver sido causado por um erro, por exemplo, MAX_ATTEMPTS_EXCEEDED.

  • signRequestId

    número

    O ID fornecido pelo Chrome em SignRequest.

Métodos

reportSignature()

Chrome 86+ browser.* desde o Chrome 148 
browser.certificateProvider.reportSignature(
  details: ReportSignatureDetails,
): Promise<void>

Precisa ser chamado como uma resposta a onSignatureRequested.

A extensão precisa chamar essa função para cada evento onSignatureRequested. A implementação da API vai parar de esperar por essa chamada depois de algum tempo e responder com um erro de tempo limite quando essa função for chamada.

Parâmetros

Retorna

  • Promessa<void>

    Chrome 96+ browser.* desde o Chrome 148

requestPin()

Chrome 57+ browser.* desde o Chrome 148 
browser.certificateProvider.requestPin(
  details: RequestPinDetails,
): Promise<PinResponseDetails | undefined>

Solicita o PIN ao usuário. Só é permitido um pedido em andamento por vez. As solicitações emitidas enquanto outro fluxo está em andamento são rejeitadas. É responsabilidade da extensão tentar novamente mais tarde se outro fluxo estiver em andamento.

Parâmetros

  • Contém os detalhes sobre a caixa de diálogo solicitada.

Retorna

  • Promise<PinResponseDetails | undefined>

    Chrome 96+ browser.* desde o Chrome 148

    Retorna uma promessa que é resolvida quando o PIN é fornecido pelo usuário. Rejeita com um erro se a solicitação de caixa de diálogo não for concluída (por exemplo, se a caixa de diálogo foi cancelada pelo usuário ou não foi permitida).

setCertificates()

Chrome 86+ browser.* desde o Chrome 148 
browser.certificateProvider.setCertificates(
  details: SetCertificatesDetails,
): Promise<void>

Define uma lista de certificados para usar no navegador.

A extensão precisa chamar essa função após a inicialização e em cada mudança no conjunto de certificados disponíveis no momento. A extensão também precisa chamar essa função em resposta a onCertificatesUpdateRequested sempre que esse evento for recebido.

Parâmetros

  • Os certificados a serem definidos. Os certificados inválidos serão ignorados.

Retorna

  • Promessa<void>

    Chrome 96+ browser.* desde o Chrome 148

    Retorna uma promessa que é resolvida após a conclusão.

stopPinRequest()

Chrome 57+ browser.* desde o Chrome 148 
browser.certificateProvider.stopPinRequest(
  details: StopPinRequestDetails,
): Promise<void>

Interrompe a solicitação de fixação iniciada pela função requestPin.

Parâmetros

  • Contém os detalhes sobre o motivo da interrupção do fluxo de solicitação.

Retorna

  • Promessa<void>

    Chrome 96+ browser.* desde o Chrome 148

    Retorna uma promessa que é resolvida quando a solicitação para fechar a caixa de diálogo do PIN é concluída.

Eventos

onCertificatesUpdateRequested

Chrome 86+ browser.* desde o Chrome 148 
browser.certificateProvider.onCertificatesUpdateRequested.addListener(
  callback: function,
)

Esse evento é acionado se os certificados definidos por setCertificates forem insuficientes ou se o navegador solicitar informações atualizadas. A extensão precisa chamar setCertificates com a lista atualizada de certificados e o certificatesRequestId recebido.

Parâmetros

onSignatureRequested

Chrome 86+ browser.* desde o Chrome 148 
browser.certificateProvider.onSignatureRequested.addListener(
  callback: function,
)

Esse evento é acionado sempre que o navegador precisa assinar uma mensagem usando um certificado fornecido por essa extensão via setCertificates.

A extensão precisa assinar os dados de entrada de request usando o algoritmo e a chave privada adequados e retorná-los chamando reportSignature com o signRequestId recebido.

Parâmetros