Class WebauthnPlugin

Plugin per la gestione delle funzionalità WebAuthn in ShogunCore

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

_category? core description name signer version webauthn

Methods

abortAuthentication assertInitialized assertSigner assertWebauthn authenticateUser createAccount createAuthenticator createDerivedKeyPair createGunUserFromSigningCredential createSigningCredential destroy emit generateCredentials generatePairFromCredentials getGunUserPubFromSigningCredential getHashedCredentialId getSeedPhrase getSigningCredential importFromSeed initialize isSupported listSigningCredentials login off on once removeAllListeners removeDevice removeSigningCredential setupConsistentOneshotSigning signUp signWithDerivedKeys verifyConsistency

Constructors

constructor

Properties

Optional_category

_category?: PluginCategory

Categoria del plugin

Protectedcore

core: null | ShogunCore = null

Riferimento all'istanza di ShogunCore

description

description: string = "Provides WebAuthn authentication functionality for ShogunCore"

Descrizione opzionale del plugin

name

name: string = "webauthn"

Nome univoco del plugin - deve essere implementato dalle sottoclassi

Privatesigner

signer: null | WebAuthnSigner = null

version

version: string = "1.0.0"

Versione del plugin - deve essere implementata dalle sottoclassi

Privatewebauthn

webauthn: null | Webauthn = null

Methods

abortAuthentication

ProtectedassertInitialized

  • assertInitialized(): ShogunCore

    Verifica che il plugin sia stato inizializzato prima di usare il core

    Returns ShogunCore

    L'istanza di ShogunCore non null

    Throws

    Error se il plugin non è stato inizializzato

PrivateassertSigner

  • assertSigner(): WebAuthnSigner
    Private

    Assicura che il signer sia inizializzato

    Returns WebAuthnSigner

PrivateassertWebauthn

  • assertWebauthn(): Webauthn
    Private

    Assicura che il modulo Webauthn sia inizializzato

    Returns Webauthn

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

    • isNewDevice: boolean = false

      Flag che indica se è un nuovo dispositivo

    Returns Promise<CredentialResult>

    Promise con il risultato dell'operazione

createAuthenticator

  • createAuthenticator(
        credentialId: string,
    ): (data: any) => Promise<AuthenticatorAssertionResponse>

    Parameters

    • credentialId: string

    Returns (data: any) => Promise<AuthenticatorAssertionResponse>

    Inherit Doc

createDerivedKeyPair

  • createDerivedKeyPair(
        credentialId: string,
        username: string,
        extra?: string[],
    ): Promise<{ epriv: string; epub: string; priv: string; pub: string }>

    Parameters

    • credentialId: string
    • username: string
    • Optionalextra: string[]

    Returns Promise<{ epriv: string; epub: string; priv: string; pub: string }>

    Inherit Doc

createGunUserFromSigningCredential

  • createGunUserFromSigningCredential(
        credentialId: string,
        username: string,
    ): Promise<{ error?: string; success: boolean; userPub?: string }>

    Creates a Gun user from WebAuthn signing credential This ensures the SAME user is created as with normal approach

    Parameters

    • credentialId: string
    • username: string

    Returns Promise<{ error?: string; success: boolean; userPub?: string }>

createSigningCredential

  • createSigningCredential(username: string): Promise<WebAuthnSigningCredential>

    Parameters

    • username: string

    Returns Promise<WebAuthnSigningCredential>

    Inherit Doc

destroy

  • destroy(): void

    Distrugge il plugin e libera le risorse

    Returns void

emit

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

    Emits an event with arguments

    Parameters

    • event: EventType
    • Optionaldata: unknown

    Returns boolean

generateCredentials

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

    Genera credenziali WebAuthn

    Parameters

    • username: string

      Nome utente

    • OptionalexistingCredential: null | WebAuthnCredentials

      Credenziali esistenti (opzionale)

    • isLogin: boolean = false

      Flag che indica se è per login

    Returns Promise<WebAuthnUniformCredentials>

    Promise con il risultato dell'operazione

PrivategeneratePairFromCredentials

  • generatePairFromCredentials(
        credentials: WebAuthnUniformCredentials,
    ): Promise<null | ISEAPair>
    Private

    Genera un pair SEA dalle credenziali WebAuthn

    Parameters

    • credentials: WebAuthnUniformCredentials

    Returns Promise<null | ISEAPair>

getGunUserPubFromSigningCredential

  • getGunUserPubFromSigningCredential(credentialId: string): undefined | string

    Get the Gun user public key for a signing credential

    Parameters

    • credentialId: string

    Returns undefined | string

getHashedCredentialId

  • getHashedCredentialId(credentialId: string): undefined | string

    Get the hashed credential ID (for consistency checking)

    Parameters

    • credentialId: string

    Returns undefined | string

getSeedPhrase

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

    Get seed phrase for current user (if stored) Note: Seed phrases are NOT stored by default for security Users should save their seed phrase during registration

    Parameters

    • username: string

      Username

    Returns Promise<null | string>

    Seed phrase or null

getSigningCredential

  • getSigningCredential(
        credentialId: string,
    ): undefined | WebAuthnSigningCredential

    Parameters

    • credentialId: string

    Returns undefined | WebAuthnSigningCredential

    Inherit Doc

importFromSeed

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

    Import existing account from seed phrase Allows accessing the same account across multiple devices

    Parameters

    • username: string

      Username

    • seedPhrase: string

      12-word BIP39 mnemonic seed phrase

    Returns Promise<SignUpResult>

    Registration result

initialize

isSupported

  • isSupported(): boolean

    Verifica se WebAuthn è supportato nel browser corrente

    Returns boolean

    true se WebAuthn è supportato, false altrimenti

listSigningCredentials

  • listSigningCredentials(): WebAuthnSigningCredential[]

    Returns WebAuthnSigningCredential[]

    Inherit Doc

login

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

    Login with WebAuthn This is the recommended method for WebAuthn authentication

    Parameters

    • username: string

      Username

    Returns Promise<AuthResult>

    Authentication result

    Description

    Authenticates user using WebAuthn credentials. Requires browser support for WebAuthn and existing credentials.

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 }>

    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

removeSigningCredential

  • removeSigningCredential(credentialId: string): boolean

    Parameters

    • credentialId: string

    Returns boolean

    Inherit Doc

setupConsistentOneshotSigning

  • setupConsistentOneshotSigning(
        username: string,
    ): Promise<
        {
            authenticator: (data: any) => Promise<AuthenticatorAssertionResponse>;
            credential: WebAuthnSigningCredential;
            gunUser: { error?: string; success: boolean; userPub?: string };
            hashedCredentialId: string;
            pub: string;
        },
    >

    Complete oneshot workflow that creates the SAME Gun user as normal approach This is the recommended method for oneshot signing with full consistency

    Parameters

    • username: string

    Returns Promise<
        {
            authenticator: (data: any) => Promise<AuthenticatorAssertionResponse>;
            credential: WebAuthnSigningCredential;
            gunUser: { error?: string; success: boolean; userPub?: string };
            hashedCredentialId: string;
            pub: string;
        },
    >

signUp

  • signUp(
        username: string,
        options?: { generateSeedPhrase?: boolean; seedPhrase?: string },
    ): Promise<SignUpResult>

    Register new user with WebAuthn This is the recommended method for WebAuthn registration

    Parameters

    • username: string

      Username

    • Optionaloptions: { generateSeedPhrase?: boolean; seedPhrase?: string }

      Optional signup options (seed phrase support)

    Returns Promise<SignUpResult>

    Registration result with optional seed phrase

    Description

    Creates a new user account using WebAuthn credentials. Requires browser support for WebAuthn. If generateSeedPhrase is true, returns a BIP39 mnemonic for multi-device support.

signWithDerivedKeys

  • signWithDerivedKeys(
        data: any,
        credentialId: string,
        username: string,
        extra?: string[],
    ): Promise<string>

    Parameters

    • data: any
    • credentialId: string
    • username: string
    • Optionalextra: string[]

    Returns Promise<string>

    Inherit Doc

verifyConsistency

  • verifyConsistency(
        credentialId: string,
        username: string,
        expectedUserPub?: string,
    ): Promise<
        {
            actualUserPub?: string;
            consistent: boolean;
            expectedUserPub?: string;
        },
    >

    Verify consistency between oneshot and normal approaches This ensures both approaches create the same Gun user

    Parameters

    • credentialId: string
    • username: string
    • OptionalexpectedUserPub: string

    Returns Promise<
        {
            actualUserPub?: string;
            consistent: boolean;
            expectedUserPub?: string;
        },
    >

Settings

Member Visibility

On This Page

Constructors
Properties
Methods