index.d.ts

/* auto-generated by NAPI-RS */
/* eslint-disable */

export type Base64UrlString = string

export type UserVerificationPolicy = 'required' | 'preferred' | 'discouraged'

export type ResidentKeyRequirement = 'discouraged' | 'preferred' | 'required'

export type AuthenticatorAttachment = 'platform' | 'cross-platform'

export type AuthenticatorTransport =
  | 'usb'
  | 'nfc'
  | 'ble'
  | 'internal'
  | 'hybrid'
  | 'test'
  | 'unknown'

export type PublicKeyCredentialHint = 'security-key' | 'client-device' | 'hybrid'

export type AttestationConveyancePreference = 'none' | 'indirect' | 'direct'

export type AttestationFormat =
  | 'packed'
  | 'tpm'
  | 'android-key'
  | 'android-safetynet'
  | 'fido-u2f'
  | 'apple'
  | 'none'

export type CredentialProtectionPolicy =
  | 'userVerificationOptional'
  | 'userVerificationOptionalWithCredentialIDList'
  | 'userVerificationRequired'

export interface CreationChallengeResponse {
  publicKey: PublicKeyCredentialCreationOptions
}

export interface PublicKeyCredentialCreationOptions {
  rp: RelyingParty
  user: User
  challenge: Base64UrlString
  pubKeyCredParams: PubKeyCredParams[]
  timeout?: number | null
  excludeCredentials?: PublicKeyCredentialDescriptor[] | null
  authenticatorSelection?: AuthenticatorSelectionCriteria | null
  hints?: PublicKeyCredentialHint[] | null
  attestation?: AttestationConveyancePreference | null
  attestationFormats?: AttestationFormat[] | null
  extensions?: RequestRegistrationExtensions | null
}

export interface RelyingParty {
  name: string
  id: string
}

export interface User {
  id: Base64UrlString
  name: string
  displayName: string
}

export interface PubKeyCredParams {
  type: string
  alg: number
}

export interface PublicKeyCredentialDescriptor {
  type: string
  id: Base64UrlString
  transports?: AuthenticatorTransport[] | null
}

export interface AuthenticatorSelectionCriteria {
  authenticatorAttachment?: AuthenticatorAttachment | null
  residentKey?: ResidentKeyRequirement | null
  requireResidentKey: boolean
  userVerification: UserVerificationPolicy
}

export interface RequestRegistrationExtensions {
  credentialProtectionPolicy?: CredentialProtectionPolicy | null
  enforceCredentialProtectionPolicy?: boolean | null
  uvm?: boolean | null
  credProps?: boolean | null
  minPinLength?: boolean | null
  hmacCreateSecret?: boolean | null
}

export interface RequestChallengeResponse {
  publicKey: PublicKeyCredentialRequestOptionsJSON
  mediation?: 'conditional' | null
}

export interface PublicKeyCredentialRequestOptionsJSON {
  allowCredentials?: PublicKeyCredentialDescriptorJSON[]
  challenge: Base64UrlString
  extensions?: AuthenticationExtensionsClientInputsJSON
  hints?: string[]
  rpId?: string
  timeout?: number
  userVerification?: string
}

export interface PublicKeyCredentialDescriptorJSON {
  type: string
  id: Base64UrlString
  transports?: string[]
}

export interface AuthenticationExtensionsClientInputsJSON {
  appid?: string
  credProps?: boolean
  largeBlob?: AuthenticationExtensionsLargeBlobInputsJSON
  prf?: AuthenticationExtensionsPRFInputsJSON
}

export interface AuthenticationExtensionsLargeBlobInputsJSON {
  read?: boolean
  support?: string
  write?: Base64UrlString
}

export interface AuthenticationExtensionsPRFInputsJSON {
  eval?: AuthenticationExtensionsPRFValuesJSON
  evalByCredential?: Record<string, AuthenticationExtensionsPRFValuesJSON>
}

export interface AuthenticationExtensionsPRFValuesJSON {
  first: Base64UrlString
  second?: Base64UrlString
}

export type PublicKeyCredentialRequestOptions = PublicKeyCredentialRequestOptionsJSON

export type AllowCredentials = PublicKeyCredentialDescriptorJSON

export type RequestAuthenticationExtensions = AuthenticationExtensionsClientInputsJSON

export interface RegisterPublicKeyCredential {
  id: string
  rawId: Base64UrlString
  response: AuthenticatorAttestationResponseRaw
  type: string
  extensions: RegistrationExtensionsClientOutputs
}

export interface AuthenticatorAttestationResponseRaw {
  attestationObject: Base64UrlString
  clientDataJSON: Base64UrlString
  transports: AuthenticatorTransport[] | null
}

export interface RegistrationExtensionsClientOutputs {
  appid?: boolean
  credProps?: CredProps
  hmacSecret?: boolean
  credProtect?: CredentialProtectionPolicy
  minPinLength?: number
}

export interface CredProps {
  rk?: boolean | null
}

export interface PublicKeyCredential {
  id: string
  rawId: Base64UrlString
  response: AuthenticatorAssertionResponseRaw
  extensions: AuthenticationExtensionsClientOutputs
  type: string
}

export interface AuthenticatorAssertionResponseRaw {
  authenticatorData: Base64UrlString
  clientDataJSON: Base64UrlString
  signature: Base64UrlString
  userHandle: Base64UrlString | null
}

export interface AuthenticationExtensionsClientOutputs {
  appid: boolean | null
  hmac_get_secret: HmacGetSecretOutput | null
}

export interface HmacGetSecretOutput {
  output1: Base64UrlString
  output2: Base64UrlString | null
}

export type CableRequestType =
  | 'getAssertion'
  | 'makeCredential'
  | 'discoverableMakeCredential'

export type CableState =
  | 'connectingToTunnelServer'
  | 'waitingForInitiatorConnection'
  | 'handshaking'
  | 'waitingForInitiatorResponse'
  | 'waitingForInitiatorCommand'
  | 'processing'
  | 'waitingForAuthenticatorResponse'

export type CableFingerprintFeedback =
  | 'good'
  | 'tooHigh'
  | 'tooLow'
  | 'tooLeft'
  | 'tooRight'
  | 'tooFast'
  | 'tooSlow'
  | 'poorQuality'
  | 'tooSkewed'
  | 'tooShort'
  | 'mergeFailure'
  | 'alreadyExists'
  | 'noUserActivity'
  | 'noUserPresenceTransition'

export type CableRequestPinEvent = {
  event: 'requestPin'
}

export type CableRequestTouchEvent = {
  event: 'requestTouch'
}

export type CableProcessingEvent = {
  event: 'processing'
}

export type CableFingerprintEnrollmentFeedbackEvent = {
  event: 'fingerprintEnrollmentFeedback'
  remainingSamples: number
  fingerprintFeedback?: CableFingerprintFeedback
}

export type CableQrCodeEvent = {
  event: 'cableQrCode'
  requestType: CableRequestType
  url: string
}

export type CableDismissQrCodeEvent = {
  event: 'dismissQrCode'
}

export type CableStatusUpdateEvent = {
  event: 'cableStatusUpdate'
  state: CableState
}

export type CableUiEvent =
  | CableRequestPinEvent
  | CableRequestTouchEvent
  | CableProcessingEvent
  | CableFingerprintEnrollmentFeedbackEvent
  | CableQrCodeEvent
  | CableDismissQrCodeEvent
  | CableStatusUpdateEvent;
export declare function cableAuthenticate(origin: string, options: RequestChallengeResponse, onEvent: (event: CableUiEvent) => void): Promise<PublicKeyCredential>

export declare function cableGetTunnelDomain(domainId: number): string | null

export declare function cableRegister(origin: string, options: CreationChallengeResponse, onEvent: (event: CableUiEvent) => void): Promise<RegisterPublicKeyCredential>

export declare function supportedBackends(): Array<string>

export declare function win10ApiVersion(): number | null

export declare function win10Authenticate(origin: string, options: RequestChallengeResponse): Promise<PublicKeyCredential>

export declare function win10Register(origin: string, options: CreationChallengeResponse): Promise<RegisterPublicKeyCredential>

export declare function win10SupportsCable(): boolean