chrome.platformKeys

Properties

• certificateAuthorities

  ArrayBuffer[]

  List of distinguished names of certificate authorities allowed by the server. Each entry must be a DER-encoded X.509 DistinguishedName.

• certificateTypes

  ClientCertificateType[]

  This field is a list of the types of certificates requested, sorted in order of the server's preference. Only certificates of a type contained in this list will be retrieved. If certificateTypes is the empty list, however, certificates of any type will be returned.

Enum

Properties

• certificate

  ArrayBuffer

  The DER encoding of a X.509 certificate.

• keyAlgorithm

  object

  The KeyAlgorithm of the certified key. This contains algorithm parameters that are inherent to the key of the certificate (e.g. the key length). Other parameters like the hash function used by the sign function are not included.

Properties

• clientCerts

  ArrayBuffer[] optional

  If given, the selectClientCertificates operates on this list. Otherwise, obtains the list of all certificates from the platform's certificate stores that are available to this extensions. Entries that the extension doesn't have permission for or which doesn't match the request, are removed.

• interactive

  boolean

  If true, the filtered list is presented to the user to manually select a certificate and thereby granting the extension access to the certificate(s) and key(s). Only the selected certificate(s) will be returned. If is false, the list is reduced to all certificates that the extension has been granted access to (automatically or manually).

• request

  ClientCertificateRequest

  Only certificates that match this request will be returned.

Properties

• hostname

  string

  The hostname of the server to verify the certificate for, e.g. the server that presented the serverCertificateChain.

• serverCertificateChain

  ArrayBuffer[]

  Each chain entry must be the DER encoding of a X.509 certificate, the first entry must be the server certificate and each entry must certify the entry preceding it.

Properties

• debug_errors

  string[]

  If the trust verification failed, this array contains the errors reported by the underlying network layer. Otherwise, this array is empty.

  Note: This list is meant for debugging only and may not contain all relevant errors. The errors returned may change in future revisions of this API, and are not guaranteed to be forwards or backwards compatible.

• trusted

  boolean

  The result of the trust verification: true if trust for the given verification details could be established and false if trust is rejected for any reason.

Parameters

• certificate

  ArrayBuffer

  The certificate of a Match returned by selectClientCertificates.

• parameters

  object

  Determines signature/hash algorithm parameters additionally to the parameters fixed by the key itself. The same parameters are accepted as by WebCrypto's importKey function, e.g. RsaHashedImportParams for a RSASSA-PKCS1-v1_5 key and EcKeyImportParams for EC key. Additionally for RSASSA-PKCS1-v1_5 keys, hashing algorithm name parameter can be specified with one of the following values: "none", "SHA-1", "SHA-256", "SHA-384", or "SHA-512", e.g. {"hash": { "name": "none" } }. The sign function will then apply PKCS#1 v1.5 padding but not hash the given data.

  Currently, this method only supports the "RSASSA-PKCS1-v1_5" and "ECDSA" algorithms.

• callback

  function

  The callback parameter looks like:

  (publicKey: object, privateKey?: object) => void

  • publicKey

    object

  • privateKey

    object optional

    Might be null if this extension does not have access to it.

Parameters

• publicKeySpkiDer

  ArrayBuffer

  A DER-encoded X.509 SubjectPublicKeyInfo, obtained e.g. by calling WebCrypto's exportKey function with format="spki".

• parameters

  object

  Provides signature and hash algorithm parameters, in addition to those fixed by the key itself. The same parameters are accepted as by WebCrypto's importKey function, e.g. RsaHashedImportParams for a RSASSA-PKCS1-v1_5 key. For RSASSA-PKCS1-v1_5 keys, we need to also pass a "hash" parameter { "hash": { "name": string } }. The "hash" parameter represents the name of the hashing algorithm to be used in the digest operation before a sign. It is possible to pass "none" as the hash name, in which case the sign function will apply PKCS#1 v1.5 padding and but not hash the given data.

  Currently, this method supports the "ECDSA" algorithm with named-curve P-256 and "RSASSA-PKCS1-v1_5" algorithm with one of the hashing algorithms "none", "SHA-1", "SHA-256", "SHA-384", and "SHA-512".

• callback

  function

  The callback parameter looks like:

  (publicKey: object, privateKey?: object) => void

  • publicKey

    object

  • privateKey

    object optional

    Might be null if this extension does not have access to it.

Parameters

• details

  SelectDetails

• callback

  function optional

  The callback parameter looks like:

  (matches: Match[]) => void

  • matches

    Match[]

    The list of certificates that match the request, that the extension has permission for and, if interactive is true, that were selected by the user.

Returns

• Promise<Match[]>

  Chrome 121+

  Promises are only supported for Manifest V3 and later, other platforms need to use callbacks.

Returns

• object | undefined

Parameters

• details

  VerificationDetails

• callback

  function optional

  The callback parameter looks like:

  (result: VerificationResult) => void

  • result

    VerificationResult

Returns

• Promise<VerificationResult>

  Chrome 121+

  Promises are only supported for Manifest V3 and later, other platforms need to use callbacks.