chrome.platformKeys

Description: Use the chrome.platformKeys API to access client certificates managed by the platform. If the user or policy grants the permission, an extension can use such a certficate in its custom authentication protocol. E.g. this allows usage of platform managed certificates in third party VPNs (see chrome.vpnProvider).
Availability: Since Chrome 45.
Permissions: "platformKeys"

Important: This API works only on Chrome OS.

Summary

Types
Match
Methods
selectClientCertificates − chrome.platformKeys.selectClientCertificates(object details, function callback)
getKeyPair − chrome.platformKeys.getKeyPair(ArrayBuffer certificate, object parameters, function callback)
getKeyPairBySpki − chrome.platformKeys.getKeyPairBySpki(ArrayBuffer publicKeySpkiDer, object parameters, function callback)
subtleCrypto − object chrome.platformKeys.subtleCrypto()
verifyTLSServerCertificate − chrome.platformKeys.verifyTLSServerCertificate(object details, function callback)

Types

Match

properties
ArrayBuffer certificate

The DER encoding of a X.509 certificate.

object keyAlgorithm

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.

Methods

selectClientCertificates

chrome.platformKeys.selectClientCertificates(object details, function callback)

This function filters from a list of client certificates the ones that are known to the platform, match request and for which the extension has permission to access the certificate and its private key. If interactive is true, the user is presented a dialog where they can select from matching certificates and grant the extension access to the certificate. The selected/filtered client certificates will be passed to callback.

Parameters
object details
object request

Only certificates that match this request will be returned.

array of enum of "rsaSign", or "ecdsaSign" certificateTypes

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.

array of ArrayBuffer certificateAuthorities

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

array of ArrayBuffer (optional) clientCerts

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.

boolean interactive

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).

function callback

The callback parameter should be a function that looks like this:

function(array of Match matches) {...};
array of Match matches

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.

getKeyPair

chrome.platformKeys.getKeyPair(ArrayBuffer certificate, object parameters, function callback)

Passes the key pair of certificate for usage with platformKeys.subtleCrypto to callback.

Parameters
ArrayBuffer certificate

The certificate of a Match returned by selectClientCertificates.

object parameters

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 function only supports the "RSASSA-PKCS1-v1_5" and "ECDSA" algorithms.
function callback

The public and private CryptoKey of a certificate which can only be used with platformKeys.subtleCrypto.

The callback parameter should be a function that looks like this:

function(object publicKey, object privateKey) {...};
object publicKey
object (optional) privateKey

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

getKeyPairBySpki

chrome.platformKeys.getKeyPairBySpki(ArrayBuffer publicKeySpkiDer, object parameters, function callback)

Since Chrome 85. Warning: this is the current Beta channel. Learn more.

Passes the key pair identified by publicKeySpkiDer for usage with platformKeys.subtleCrypto to callback.

Parameters
ArrayBuffer publicKeySpkiDer

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

object parameters

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 function only supports the "RSASSA-PKCS1-v1_5" algorithm with one of the hashing algorithms "none", "SHA-1", "SHA-256", "SHA-384", and "SHA-512".
function callback

The public and private CryptoKey of a certificate which can only be used with platformKeys.subtleCrypto.

The callback parameter should be a function that looks like this:

function(object publicKey, object privateKey) {...};
object publicKey
object (optional) privateKey

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

subtleCrypto

object chrome.platformKeys.subtleCrypto()

An implementation of WebCrypto's SubtleCrypto that allows crypto operations on keys of client certificates that are available to this extension.

Returns

verifyTLSServerCertificate

chrome.platformKeys.verifyTLSServerCertificate(object details, function callback)

Checks whether details.serverCertificateChain can be trusted for details.hostname according to the trust settings of the platform. Note: The actual behavior of the trust verification is not fully specified and might change in the future. The API implementation verifies certificate expiration, validates the certification path and checks trust by a known CA. The implementation is supposed to respect the EKU serverAuth and to support subject alternative names.

Parameters
object details
array of ArrayBuffer serverCertificateChain

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.

string hostname

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

function callback

The callback parameter should be a function that looks like this:

function(object result) {...};
object result
boolean trusted

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.

array of string debug_errors

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.