qz | API Namespace: security

Calls related to signing connection requests.

Source:

qz-tray.js, line 2595

Methods

(static) getSignatureAlgorithm() → {string}

Get the signing algorithm QZ will be checking signatures against.

Since:

2.1.0

Source:

qz-tray.js, line 2664

Returns:

The algorithm used in signing.

Type: string

(static) setCertificatePromise(promiseHandler, optionsopt)

Set promise resolver for calls to acquire the site's certificate.

Parameters:

Name Type Attributes Description

promiseHandler function | AsyncFunction | Promise.<string> Either a function that will be used as a promise resolver (of format Function({function} resolve, {function}reject)), an async function, or a promise. Any of which should return the public certificate via their respective resolve call.

options

Object

Configuration options for the certificate resolver

Properties

Name	Type	Attributes	Default	Description
`rejectOnFailure`	boolean	<optional>	[false]	Overrides default behavior to call resolve with a blank certificate on failure.

Source:

qz-tray.js, line 2609

(static) setSignatureAlgorithm(algorithm)

Set which signing algorithm QZ will check signatures against.

Parameters:

Name	Type	Description
`algorithm`	string	The algorithm used in signing. Valid values: `[SHA1 \| SHA256 \| SHA512]`

Since:

2.1.0

Source:

qz-tray.js, line 2643

(static) setSignaturePromise(promiseFactory)

Set promise factory for calls to sign API calls.

Parameters:

Name	Type	Description
`promiseFactory`	function \| AsyncFunction	Either a function that accepts a string parameter of the data to be signed and returns a function to be used as a promise resolver (of format `Function({function} resolve, {function}reject)`), or an async function that can take a string parameter of the data to be signed. Either of which should return the signed contents of the passed string parameter via their respective `resolve` call.

Source:

qz-tray.js, line 2631

Example

qz.security.setSignaturePromise(function(dataToSign) {
   return function(resolve, reject) {
     $.ajax("/signing-url?data=" + dataToSign).then(resolve, reject);
   }
 })