chromex.app.certificate-provider — binaryage/chromex 0.9.3

clj

Use this API to expose certificates to the platform which can use these certificates for TLS authentications.

• available since Chrome 46
• https://developer.chrome.com/apps/certificateProvider

api-table clj

gen-call clj

gen-wrap clj/s macro

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

on-certificates-requested* cljs

(on-certificates-requested* config channel & args)

on-certificates-update-requested* cljs

(on-certificates-update-requested* config channel & args)

on-sign-digest-requested* cljs

(on-sign-digest-requested* config channel & args)

on-signature-requested* cljs

(on-signature-requested* config channel & args)

report-signature clj/s macro

(report-signature details)

Should be called as a response to 'onSignatureRequested'. The extension must eventually call this function for every 'onSignatureRequested' event; the API implementation will stop waiting for this call after some time and respond with a timeout error when this function is called.

|details| - https://developer.chrome.com/apps/certificateProvider#property-reportSignature-details.

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/certificateProvider#method-reportSignature.

report-signature* cljs

(report-signature* config details)

request-pin clj/s macro

(request-pin details)

Requests the PIN from the user. Only one ongoing request at a time is allowed. The requests issued while another flow is ongoing are rejected. It's the extension's responsibility to try again later if another flow is in progress.

|details| - Contains the details about the requested dialog.

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 [details] where:

|details| - https://developer.chrome.com/apps/certificateProvider#property-callback-details.

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/certificateProvider#method-requestPin.

request-pin* cljs

(request-pin* config details)

set-certificates clj/s macro

(set-certificates details)

Sets a list of certificates to use in the browser. The extension should call this function after initialization and on every change in the set of currently available certificates. The extension should also call this function in response to 'onCertificatesUpdateRequested' every time this event is received.

|details| - The certificates to set. Invalid certificates will be ignored.

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/certificateProvider#method-setCertificates.

set-certificates* cljs

(set-certificates* config details)

stop-pin-request clj/s macro

(stop-pin-request details)

Stops the pin request started by the 'requestPin' function.

|details| - Contains the details about the reason for stopping the request flow.

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/certificateProvider#method-stopPinRequest.

stop-pin-request* cljs

(stop-pin-request* config details)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.certificate-provider namespace.

tap-on-certificates-requested-events clj/s macro

(tap-on-certificates-requested-events channel & args)

This event fires every time the browser requests the current list of certificates provided by this extension. The extension must call reportCallback exactly once with the current list of certificates.

Events will be put on the |channel| with signature [::on-certificates-requested [report-callback]].

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/certificateProvider#event-onCertificatesRequested.

tap-on-certificates-update-requested-events clj/s macro

(tap-on-certificates-update-requested-events channel & args)

This event fires if the certificates set via 'setCertificates' are insufficient or the browser requests updated information. The extension must call 'setCertificates' with the updated list of certificates and the received certificatesRequestId.

Events will be put on the |channel| with signature [::on-certificates-update-requested [request]] where:

|request| - https://developer.chrome.com/apps/certificateProvider#property-onCertificatesUpdateRequested-request.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/certificateProvider#event-onCertificatesUpdateRequested.

tap-on-sign-digest-requested-events clj/s macro

(tap-on-sign-digest-requested-events channel & args)

This event fires every time the browser needs to sign a message using a certificate provided by this extension in reply to an 'onCertificatesRequested' event. The extension must sign the data in request using the appropriate algorithm and private key and return it by calling reportCallback. reportCallback must be called exactly once.

Events will be put on the |channel| with signature [::on-sign-digest-requested [request report-callback]] where:

|request| - Contains the details about the sign request.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/certificateProvider#event-onSignDigestRequested.

tap-on-signature-requested-events clj/s macro

(tap-on-signature-requested-events channel & args)

This event fires every time the browser needs to sign a message using a certificate provided by this extension via 'setCertificates'. The extension must sign the input data from request using the appropriate algorithm and private key and return it by calling 'reportSignature' with the received signRequestId.

Events will be put on the |channel| with signature [::on-signature-requested [request]] where:

|request| - https://developer.chrome.com/apps/certificateProvider#property-onSignatureRequested-request.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/certificateProvider#event-onSignatureRequested.