Interface WebauthnPluginInterface

Interfaccia per il plugin WebAuthn

interface WebauthnPluginInterface {
    abortAuthentication(): void;
    authenticateUser(
        username: string,
        salt: null | string,
        options?: any,
    ): Promise<CredentialResult>;
    createAccount(
        username: string,
        credentials: null | WebAuthnCredentials,
        isNewDevice?: boolean,
    ): Promise<CredentialResult>;
    generateCredentials(
        username: string,
        existingCredential?: null | WebAuthnCredentials,
        isLogin?: boolean,
    ): Promise<CredentialResult>;
    getSeedPhrase(username: string): Promise<null | string>;
    importFromSeed(username: string, seedPhrase: string): Promise<SignUpResult>;
    isSupported(): boolean;
    login(username: string): Promise<AuthResult>;
    removeDevice(
        username: string,
        credentialId: string,
        credentials: WebAuthnCredentials,
    ): Promise<{ success: boolean; updatedCredentials?: WebAuthnCredentials }>;
    signUp(
        username: string,
        options?: WebAuthnSignUpOptions,
    ): Promise<SignUpResult>;
}

Implemented by

Methods

abortAuthentication authenticateUser createAccount generateCredentials getSeedPhrase importFromSeed isSupported login removeDevice signUp

Methods

abortAuthentication

  • abortAuthentication(): void

    Interrompe un tentativo di autenticazione in corso

    Returns void

authenticateUser

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

    Autentica un utente con WebAuthn

    Parameters

    • username: string

      Nome utente

    • salt: null | string

      Salt per l'autenticazione

    • Optionaloptions: any

      Opzioni per l'operazione

    Returns Promise<CredentialResult>

    Promise con il risultato dell'autenticazione

createAccount

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

    Crea un nuovo account WebAuthn

    Parameters

    • username: string

      Nome utente

    • credentials: null | WebAuthnCredentials

      Credenziali WebAuthn

    • OptionalisNewDevice: boolean

      Flag che indica se è un nuovo dispositivo

    Returns Promise<CredentialResult>

    Promise con il risultato dell'operazione

generateCredentials

  • generateCredentials(
        username: string,
        existingCredential?: null | WebAuthnCredentials,
        isLogin?: boolean,
    ): Promise<CredentialResult>

    Genera credenziali WebAuthn

    Parameters

    • username: string

      Nome utente

    • OptionalexistingCredential: null | WebAuthnCredentials

      Credenziali esistenti (opzionale)

    • OptionalisLogin: boolean

      Flag che indica se è per login

    Returns Promise<CredentialResult>

    Promise con il risultato dell'operazione

getSeedPhrase

  • getSeedPhrase(username: string): Promise<null | string>

    Get seed phrase for current user (if available)

    Parameters

    • username: string

      Nome utente

    Returns Promise<null | string>

    Seed phrase or null

importFromSeed

  • importFromSeed(username: string, seedPhrase: string): Promise<SignUpResult>

    Import account from seed phrase

    Parameters

    • username: string

      Nome utente

    • seedPhrase: string

      BIP39 mnemonic seed phrase (12 words)

    Returns Promise<SignUpResult>

    Promise con il risultato dell'operazione

isSupported

  • isSupported(): boolean

    Verifica se WebAuthn è supportato nel browser corrente

    Returns boolean

    true se WebAuthn è supportato, false altrimenti

login

  • login(username: string): Promise<AuthResult>

    Login con WebAuthn

    Parameters

    • username: string

      Nome utente

    Returns Promise<AuthResult>

    Promise con il risultato dell'operazione

removeDevice

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

    Rimuove un dispositivo WebAuthn

    Parameters

    • username: string

      Nome utente

    • credentialId: string

      ID della credenziale

    • credentials: WebAuthnCredentials

      Credenziali WebAuthn

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

    Promise con il risultato dell'operazione

signUp

  • signUp(username: string, options?: WebAuthnSignUpOptions): Promise<SignUpResult>

    Signup con WebAuthn

    Parameters

    • username: string

      Nome utente

    • Optionaloptions: WebAuthnSignUpOptions

      Optional signup options

    Returns Promise<SignUpResult>

    Promise con il risultato dell'operazione

Settings

Member Visibility

On This Page

Methods