Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SAMAPI

SAM API.

Hierarchy

  • SAMAPI

Index

Methods

Methods

disableCredentials

  • disableCredentials(): Promise<void>

  • Removes the logon password.

    Returns Promise<void>

readSAM

  • readSAM(): Promise<SAMDB>

  • Reads the SAM config.

    Returns Promise<SAMDB>

    The SAM database, or null.

requiresCredentials

  • requiresCredentials(): Promise<boolean>

  • Returns true if a password is set, false if not.

    Returns Promise<boolean>

setCredentials

  • setCredentials(user: string, passwd: string): Promise<void>

  • Sets the logon username and password.

    Parameters

    • user: string

      The username to set.

    • passwd: string

      The password to set.

    Returns Promise<void>

verifyCredentials

  • verifyCredentials(user: string, passwd: string): Promise<boolean>

  • Verifies the given credentials with the stored password hash.

    Parameters

    • user: string

      The user to verify.

    • passwd: string

      The password to verify.

    Returns Promise<boolean>

Generated using TypeDoc