Class Webauthn

Main WebAuthn class for authentication management

Hierarchy

  • EventEmitter
    • Webauthn

Constructors

constructor

Properties

abortController config credential gunInstance?

Methods

abortAuthentication authenticateUser bufferToBase64 createAccount createCredential emit generateChallenge generateCredentials generateCredentialsFromSalt getDeviceInfo getPlatformInfo getRandomBytes isSupported off on once removeAllListeners removeDevice sign uint8ArrayToHex validateUsername verifyCredential

Constructors

constructor

  • new Webauthn(
        gunInstance?: IGunInstance<any>,
        config?: Partial<WebAuthnConfig>,
    ): Webauthn

    Creates a new WebAuthn instance

    Parameters

    • OptionalgunInstance: IGunInstance<any>
    • Optionalconfig: Partial<WebAuthnConfig>

    Returns Webauthn

Properties

PrivateabortController

abortController: null | AbortController = null

Private Readonlyconfig

config: WebAuthnConfig

Privatecredential

credential: null | WebAuthnCredentialData

Private Optional ReadonlygunInstance

gunInstance?: IGunInstance<any>

Methods

abortAuthentication

  • abortAuthentication(): void

    Aborts current authentication attempt

    Returns void

authenticateUser

  • authenticateUser(
        username: string,
        salt: null | string,
        options?: WebAuthnOperationOptions,
    ): Promise<CredentialResult>

    Authenticates a user with timeout and abort handling

    Parameters

    • username: string
    • salt: null | string
    • options: WebAuthnOperationOptions = {}

    Returns Promise<CredentialResult>

PrivatebufferToBase64

  • bufferToBase64(buffer: ArrayBuffer): string

    Converts ArrayBuffer to URL-safe base64 string

    Parameters

    • buffer: ArrayBuffer

    Returns string

createAccount

  • createAccount(
        username: string,
        credentials: null | WebAuthnCredentials,
        isNewDevice?: boolean,
    ): Promise<CredentialResult>

    Creates a new WebAuthn account with retry logic

    Parameters

    • username: string
    • credentials: null | WebAuthnCredentials
    • isNewDevice: boolean = false

    Returns Promise<CredentialResult>

PrivatecreateCredential

  • createCredential(username: string): Promise<WebAuthnCredentialData>

    Creates a WebAuthn credential for registration

    Parameters

    • username: string

    Returns Promise<WebAuthnCredentialData>

emit

  • emit(event: EventType, data?: unknown): boolean

    Emits an event with arguments

    Parameters

    • event: EventType
    • Optionaldata: unknown

    Returns boolean

PrivategenerateChallenge

  • generateChallenge(username: string): Uint8Array

    Generates a challenge for WebAuthn operations

    Parameters

    • username: string

    Returns Uint8Array

generateCredentials

  • generateCredentials(
        username: string,
        existingCredential?: null | WebAuthnCredentials,
        isLogin?: boolean,
    ): Promise<
        {
            credentialId: string;
            error?: string;
            key: any;
            publicKey?: null
            | ArrayBuffer;
            success: boolean;
            username: string;
        },
    >

    Generates WebAuthn credentials (uniforme con altri plugin)

    Parameters

    • username: string
    • OptionalexistingCredential: null | WebAuthnCredentials
    • isLogin: boolean = false

    Returns Promise<
        {
            credentialId: string;
            error?: string;
            key: any;
            publicKey?: null
            | ArrayBuffer;
            success: boolean;
            username: string;
        },
    >

PrivategenerateCredentialsFromSalt

  • generateCredentialsFromSalt(
        username: string,
        salt: string,
    ): { password: string }

    Generates credentials from username and salt

    Parameters

    • username: string
    • salt: string

    Returns { password: string }

PrivategetDeviceInfo

  • getDeviceInfo(credentialId: string): DeviceInfo

    Gets device information

    Parameters

    • credentialId: string

    Returns DeviceInfo

PrivategetPlatformInfo

  • getPlatformInfo(): { name: string; platform: string }

    Gets platform information

    Returns { name: string; platform: string }

PrivategetRandomBytes

  • getRandomBytes(length: number): Uint8Array

    Gets cryptographically secure random bytes

    Parameters

    • length: number

    Returns Uint8Array

isSupported

  • isSupported(): boolean

    Checks if WebAuthn is supported

    Returns boolean

off

  • off(event: EventType, listener: (data: unknown) => void): void

    Removes an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

on

  • on(event: EventType, listener: (data: unknown) => void): void

    Registers an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

once

  • once(event: EventType, listener: (data: unknown) => void): void

    Registers a one-time event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

removeAllListeners

  • removeAllListeners(event?: EventType): void

    Removes all listeners for an event or all events

    Parameters

    • Optionalevent: EventType

    Returns void

removeDevice

  • removeDevice(
        username: string,
        credentialId: string,
        credentials: WebAuthnCredentials,
    ): Promise<{ success: boolean; updatedCredentials?: WebAuthnCredentials }>

    Removes device credentials

    Parameters

    • username: string
    • credentialId: string
    • credentials: WebAuthnCredentials

    Returns Promise<{ success: boolean; updatedCredentials?: WebAuthnCredentials }>

sign

  • sign(data: Record<string, unknown>): Promise<unknown>

    Signs data with the credential

    Parameters

    • data: Record<string, unknown>

    Returns Promise<unknown>

Privateuint8ArrayToHex

  • uint8ArrayToHex(arr: Uint8Array): string

    Converts Uint8Array to hexadecimal string

    Parameters

    • arr: Uint8Array

    Returns string

validateUsername

  • validateUsername(username: string): void

    Validates a username

    Parameters

    • username: string

    Returns void

PrivateverifyCredential

  • verifyCredential(username: string): Promise<WebAuthnVerificationResult>

    Verifies a credential

    Parameters

    • username: string

    Returns Promise<WebAuthnVerificationResult>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods