Methods
(package) coseAlgToHashStr(alg)
- Source:
Utility function to convert a cose hashing algorithm to string
Parameters:
Name | Type | Description |
---|---|---|
alg |
string | number | Cose algorithm |
(package) coseAlgToStr(alg)
- Source:
Utility function to convert a cose algorithm to string
Parameters:
Name | Type | Description |
---|---|---|
alg |
string | number | Cose algorithm |
(async) parseAttestationObject(attestationObject) → {Object}
- Source:
- Deprecated:
- Parses the CBOR attestation statement
- See:
Parameters:
Name | Type | Description |
---|---|---|
attestationObject |
ArrayBuffer | The CBOR byte array representing the attestation statement |
Returns:
The Object containing all the attestation information
- Type
- Object
parseClientResponse(clientDataJSON) → {Object}
Parses the clientData JSON byte stream into an Object
Parameters:
Name | Type | Description |
---|---|---|
clientDataJSON |
ArrayBuffer | The ArrayBuffer containing the properly formatted JSON of the clientData object |
Returns:
The parsed clientData object
- Type
- Object
Type Definitions
PublicKeyCredentialCreationOptions
Properties:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rp |
Object | Relying party information (a.k.a. - server / service information) Properties
|
|||||||||||||||||
user |
Object | User information. This will be an empty object |
|||||||||||||||||
challenge |
ArrayBuffer | An ArrayBuffer filled with random bytes. This will be verified in attestationResult |
|||||||||||||||||
pubKeyCredParams |
Array |
<optional> |
A list of PublicKeyCredentialParameters objects, based on the |
||||||||||||||||
timeout |
Number |
<optional> |
The amount of time that the call should take before returning an error |
||||||||||||||||
attestation |
String |
<optional> |
Whether the client should request attestation from the authenticator or not |
||||||||||||||||
authenticatorSelection |
Object |
<optional> |
A object describing which authenticators are preferred for registration Properties
|
||||||||||||||||
rawChallenge |
ArrayBuffer |
<optional> |
If |
||||||||||||||||
extensions |
Object |
<optional> |
The values of any enabled extensions. |
This object is returned by attestationOptions and is basially the same as
the PublicKeyCredentialCreationOptions
object that is required to be passed to navigator.credentials.create()
. With the exception of the challenge
property,
all other properties are optional and only set if they were specified in the configuration paramater
that was passed to the constructor.
Type:
- Object
PublicKeyCredentialRequestOptions
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
challenge |
ArrayBuffer | An ArrayBuffer filled with random bytes. This will be verified in attestationResult |
|
timeout |
Number |
<optional> |
The amount of time that the call should take before returning an error |
rpId |
String |
<optional> |
Relying party ID, a domain name (e.g. - "example.com"). This is only set if |
attestation |
String |
<optional> |
Whether the client should request attestation from the authenticator or not |
userVerification |
String |
<optional> |
Indicates whether user verification is required for authenticators. User verification
means that an authenticator will validate a use through their biometrics (e.g. fingerprint) or knowledge (e.g. PIN). Allowed
values for |
rawChallenge |
ArrayBuffer |
<optional> |
If |
extensions |
Object |
<optional> |
The values of any enabled extensions. |
This object is returned by assertionOptions and is basially the same as
the PublicKeyCredentialRequestOptions
object that is required to be passed to navigator.credentials.get()
. With the exception of the challenge
property,
all other properties are optional and only set if they were specified in the configuration paramater
that was passed to the constructor.
Type:
- Object
UserVerificationDesc
Properties:
Name | Type | Description |
---|---|---|
type |
String | The type of user verification that the authenticator performs. Valid options are "code" (i.e. PIN), "biometric", or "pattern". |
userVerification |
String | The specific type of user verification performed, such as "fingerprint", "presence", "passcode", etc. |
userVerificationMethod |
String | The method of user verification performed, such as "passcode_internal", "presence_internal", etc. |
A description of a user verification method that an authenticator will peform.
The properties are as described below, plus the contents of caDesc
, baDesc
or paDesc
(depending on whether "code", "biometrics", or "pattern" are being described)
as described in the FIDO Metadata specification
Type:
- Object