chromex.app.enterprise.platform-keys — binaryage/chromex 0.9.3

clj

Use the chrome.enterprise.platformKeys API to generate hardware-backed keys and to install certificates for these keys. The certificates will be managed by the platform and can be used for TLS authentication, network access or by other extension through 'platformKeys chrome.platformKeys'.

• available since Chrome 37
• https://developer.chrome.com/apps/enterprise.platformKeys

api-table clj

challenge-machine-key clj/s macro

(challenge-machine-key challenge)

(challenge-machine-key challenge register-key)

Challenges a hardware-backed Enterprise Machine Key and emits the response as part of a remote attestation protocol. Only useful on Chrome OS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: * The current device is a legitimate Chrome OS device. * The current device is managed by the domain specified during verification. * The current signed-in user is managed by the domain specified during verification. * The current device state complies with enterprise device policy. For example, a policy may specify that the device must not be in developer mode. * Any device identity emitted by the verification is tightly bound to the hardware of the current device. This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise device policy. The Enterprise Machine Key does not reside in the 'system' token and is not accessible by any other API.

|challenge| - A challenge as emitted by the Verified Access Web API. |register-key| - If set, the current Enterprise Machine Key is registered with the 'system' token and relinquishes the Enterprise Machine Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise Machine Key.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [response] where:

|response| - The challenge response.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/enterprise.platformKeys#method-challengeMachineKey.

challenge-machine-key* cljs

(challenge-machine-key* config challenge register-key)

challenge-user-key clj/s macro

(challenge-user-key challenge register-key)

Challenges a hardware-backed Enterprise User Key and emits the response as part of a remote attestation protocol. Only useful on Chrome OS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: * The current device is a legitimate Chrome OS device. * The current device is managed by the domain specified during verification. * The current signed-in user is managed by the domain specified during verification. * The current device state complies with enterprise user policy. For example, a policy may specify that the device must not be in developer mode. * The public key emitted by the verification is tightly bound to the hardware of the current device and to the current signed-in user. This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise user policy. The Enterprise User Key does not reside in the 'user' token and is not accessible by any other API.

|challenge| - A challenge as emitted by the Verified Access Web API. |register-key| - If set, the current Enterprise User Key is registered with the 'user' token and relinquishes the Enterprise User Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise User Key.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [response] where:

|response| - The challenge response.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/enterprise.platformKeys#method-challengeUserKey.

challenge-user-key* cljs

(challenge-user-key* config challenge register-key)

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-certificates clj/s macro

(get-certificates token-id)

Returns the list of all client certificates available from the given token. Can be used to check for the existence and expiration of client certificates that are usable for a certain authentication.

|token-id| - The id of a Token returned by getTokens.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [certificates] where:

|certificates| - The list of certificates, each in DER encoding of a X.509 certificate.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/enterprise.platformKeys#method-getCertificates.

get-certificates* cljs

(get-certificates* config token-id)

get-tokens clj/s macro

(get-tokens)

Returns the available Tokens. In a regular user's session the list will always contain the user's token with id 'user'. If a system-wide TPM token is available, the returned list will also contain the system-wide token with id 'system'. The system-wide token will be the same for all sessions on this device (device in the sense of e.g. a Chromebook).

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [tokens] where:

|tokens| - The list of available tokens.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/enterprise.platformKeys#method-getTokens.

get-tokens* cljs

(get-tokens* config)

import-certificate clj/s macro

(import-certificate token-id certificate)

Imports certificate to the given token if the certified key is already stored in this token. After a successful certification request, this function should be used to store the obtained certificate and to make it available to the operating system and browser for authentication.

|token-id| - The id of a Token returned by getTokens. |certificate| - The DER encoding of a X.509 certificate.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/enterprise.platformKeys#method-importCertificate.

import-certificate* cljs

(import-certificate* config token-id certificate)

remove-certificate clj/s macro

(remove-certificate token-id certificate)

Removes certificate from the given token if present. Should be used to remove obsolete certificates so that they are not considered during authentication and do not clutter the certificate choice. Should be used to free storage in the certificate store.

|token-id| - The id of a Token returned by getTokens. |certificate| - The DER encoding of a X.509 certificate.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/enterprise.platformKeys#method-removeCertificate.

remove-certificate* cljs

(remove-certificate* config token-id certificate)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.enterprise.platform-keys namespace.