public_key

Types

Algorithm

pub type Algorithm {
  Ed25519
  ES256
  RS256
}

Constructors

```
Ed25519
```
```
ES256
```
```
RS256
```

Assertion

</>

pub type Assertion

Attest

</>

pub type Attest

Attestation

</>

pub type Attestation {
  NoAttestation
  Direct
  Enterprise
  Indirect
}

Constructors

```
NoAttestation
```
```
Direct
```
```
Enterprise
```
```
Indirect
```

AuthenticatorAttachement

</>

pub type AuthenticatorAttachement {
  Platform
  CrossPlatform
}

Constructors

```
Platform
```
```
CrossPlatform
```

CreationOptions

</>

pub type CreationOptions {
  CreationOptions(
    attestation: Attestation,
    attestation_formats: List(String),
    authenticator_attachement: Option(AuthenticatorAttachement),
    resident_key: Requirement,
    user_verification: Requirement,
    challenge: BitArray,
    exclude_credentials: List(#(BitArray, List(Transport))),
    public_key_credential_parameters: List(Algorithm),
    relaying_party_id: Option(String),
    relaying_party_name: String,
    timeout: Option(Int),
    user_id: BitArray,
    user_name: String,
    user_display_name: String,
    hints: List(Hint),
  )
}

Constructors

CreationOptions(
  attestation: Attestation,
  attestation_formats: List(String),
  authenticator_attachement: Option(AuthenticatorAttachement),
  resident_key: Requirement,
  user_verification: Requirement,
  challenge: BitArray,
  exclude_credentials: List(#(BitArray, List(Transport))),
  public_key_credential_parameters: List(Algorithm),
  relaying_party_id: Option(String),
  relaying_party_name: String,
  timeout: Option(Int),
  user_id: BitArray,
  user_name: String,
  user_display_name: String,
  hints: List(Hint),
)

Credential

</>

pub type Credential(t)

Hint

</>

pub type Hint {
  SecurityKey
  ClientDevice
  HybridHint
}

Constructors

```
SecurityKey
```
```
ClientDevice
```
```
HybridHint
```

NativeCreationOptions

</>

pub type NativeCreationOptions

NativeRequestOptions

</>

pub type NativeRequestOptions

RequestOptions

</>

pub type RequestOptions {
  RequestOptions(
    allow_credentials: List(#(BitArray, List(Transport))),
    challenge: BitArray,
    hints: List(Hint),
    relaying_party_id: Option(String),
    timeout: Option(Int),
    user_verification: Requirement,
  )
}

Constructors

RequestOptions(
  allow_credentials: List(#(BitArray, List(Transport))),
  challenge: BitArray,
  hints: List(Hint),
  relaying_party_id: Option(String),
  timeout: Option(Int),
  user_verification: Requirement,
)

Requirement

</>

pub type Requirement {
  Required
  Preferred
  Discouraged
}

Constructors

```
Required
```
```
Preferred
```
```
Discouraged
```

Transport

</>

pub type Transport {
  Ble
  HybridTransport
  Internal
  Nfc
  Usb
}

Constructors

```
Ble
```
```
HybridTransport
```
```
Internal
```
```
Nfc
```
```
Usb
```

Functions

algorithm_to_number

</>

pub fn algorithm_to_number(algorithm: Algorithm) -> Int

attestation_object

</>

pub fn attestation_object(
  credential: Credential(Attest),
) -> BitArray

authenticator_attachment

</>

pub fn authenticator_attachment(
  credential: Credential(a),
) -> AuthenticatorAttachement

authenticator_data

</>

pub fn authenticator_data(
  credential: Credential(Assertion),
) -> BitArray

client_data_json

</>

pub fn client_data_json(credential: Credential(a)) -> BitArray

create

</>

pub fn create(
  container: CredentialsContainer,
  options: CreationOptions,
) -> Promise(Result(Credential(Attest), String))

creation

</>

pub fn creation(
  challenge: BitArray,
  algorithm: Algorithm,
  relaying_party_name: String,
  user_id: BitArray,
  user_name: String,
  user_display_name: String,
) -> CreationOptions

do_create

</>

pub fn do_create(
  container: CredentialsContainer,
  options: NativeCreationOptions,
) -> Promise(Result(Credential(Attest), String))

do_get

</>

pub fn do_get(
  container: CredentialsContainer,
  options: NativeRequestOptions,
) -> Promise(Result(Credential(Assertion), String))

get

</>

pub fn get(
  container: CredentialsContainer,
  options: RequestOptions,
) -> Promise(Result(Credential(Assertion), String))

get_authenticator_data

</>

pub fn get_authenticator_data(
  credential: Credential(Attest),
) -> BitArray

get_public_key

</>

pub fn get_public_key(credential: Credential(Attest)) -> BitArray

get_public_key_algorithm

</>

pub fn get_public_key_algorithm(
  credential: Credential(Attest),
) -> BitArray

get_transports

</>

pub fn get_transports(credential: Credential(Attest)) -> BitArray

id

</>

pub fn id(credential: Credential(a)) -> String

This property is a base64url encoded version of PublicKeyCredential.rawId.

is_conditional_mediation_available

</>

pub fn is_conditional_mediation_available() -> Promise(Bool)

is_user_verifying_platform_authenticator_available

</>

pub fn is_user_verifying_platform_authenticator_available() -> Promise(
  Bool,
)

parse_creation_options_from_json

</>

pub fn parse_creation_options_from_json(
  options: Dynamic,
) -> Result(NativeCreationOptions, String)

parse_request_options_from_json

</>

pub fn parse_request_options_from_json(
  options: Dynamic,
) -> Result(NativeRequestOptions, String)

raw_id

</>

pub fn raw_id(credential: Credential(a)) -> BitArray

request

</>

pub fn request(challenge: BitArray) -> RequestOptions

signature

</>

pub fn signature(credential: Credential(Assertion)) -> BitArray

to_json

</>

pub fn to_json(credential: Credential(a)) -> Json

user_handle

</>

pub fn user_handle(credential: Credential(Assertion)) -> BitArray