Interface TotpMiddlewares<U>

This object contains the authenticate() function which is the main middleware, as well as additional functions for generating tokens and URLs.

Type Parameters

Hierarchy

TotpMiddlewares

Index

Methods

authenticate generateNewSecret generateSecretQR generateSecretURL verifyToken verifyUser

Methods

authenticate

authenticate(options?: Partial<TotpApiOptions<U>>): ((req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: (() => void)) => Promise<void>)
Middleware for authenticating a user, using their secret and the token provided in the request.

See
- TotpApiOptions.getUser to control which user gets used for comparing the token to and later injected into further requests.
- TotpApiOptions.getToken to control how the token is fetched in the request (query, headers, etc).
Parameters
- Optional options: Partial<TotpApiOptions<U>>
  
  Options for the middleware.
Returns ((req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: (() => void)) => Promise<void>)
- - (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: (() => void)): Promise<void>
  - Middleware for authenticating a user, using their secret and the token provided in the request.
    
    See
    - TotpApiOptions.getUser to control which user gets used for comparing the token to and later injected into further requests.
    - TotpApiOptions.getToken to control how the token is fetched in the request (query, headers, etc).
    Parameters
    - req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    - res: Response<any, Record<string, any>>
    - next: (() => void)
      
      (): void
      
      Returns void
    Returns Promise<void>
- Defined in types.ts:154

generateNewSecret

generateNewSecret(): string
Generates a random, 32-byte secret key. You can attach this to your user object or DB however you want.

Returns string
- Defined in types.ts:205

generateSecretQR

generateSecretQR(username: string, secret: string): Promise<string>
Function for generating a QR code for a user from a given secret and username.

This returns a PNG image as a data URL.

Returns
The QR code as a data URL.
Parameters
- username: string
  
  The username to use for generating the URL.
- secret: string
  
  The secret to use for generating the URL.
Returns Promise<string>
- Defined in types.ts:176
generateSecretQR(username: string, secret: string, filename: string): Promise<void>
Function for generating a QR code for a user from a given secret and username.

This writes the QR code directly to a file, which you can later use to serve to the user.
Parameters
- username: string
  
  The username to use for generating the URL.
- secret: string
  
  The secret to use for generating the URL.
- filename: string
  
  The path of the file to write the QR image to.
Returns Promise<void>
- Defined in types.ts:187
generateSecretQR(username: string, secret: string, filename?: string): Promise<string | void>
Function for generating a QR code for a user from a given secret and username.
- If filename is provided, this writes the QR code directly to that path, which you can later use to serve to the user.
- If filename is omitted (or blank), this returns a PNG image as a data URL.
Parameters
- username: string
  
  The username to use for generating the URL.
- secret: string
  
  The secret to use for generating the URL.
- Optional filename: string
  
  If provided, will use as path of the file to write the QR image to.
Returns Promise<string | void>
- Defined in types.ts:200

generateSecretURL

generateSecretURL(username: string, secret: string): string
Function for generating a secret URL for a user from a given secret and username.

Returns
The URL for the user.
Parameters
- username: string
  
  The username to use for generating the URL.
- secret: string
  
  The secret to use for generating the URL.
Returns string
- Defined in types.ts:164

verifyToken

verifyToken(secret: string, token: string): boolean
Verifies a given token against a given secret. If the provided token is equal to the generated token for given secret, it returns true. Otherwise, it returns false.

Returns
true if the token is valid, false otherwise.
Parameters
- secret: string
  
  The secret key of the user.
- token: string
  
  The request token to verify against.
Returns boolean
- Defined in types.ts:216

verifyUser

verifyUser(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<undefined | U>
Returns the user, only if the token is valid. Otherwise, it returns undefined.

Returns
The user, or undefined if the token is invalid.
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
  
  The request object.
Returns Promise<undefined | U>
- Defined in types.ts:224

Interface TotpMiddlewares<U>

Type Parameters

U

Hierarchy

Index

Methods

Methods

authenticate

See

Parameters

Optional options: Partial<TotpApiOptions<U>>

Returns ((req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: (() => void)) => Promise<void>)

See

Parameters

req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

res: Response<any, Record<string, any>>

next: (() => void)

Returns void

Returns Promise<void>

generateNewSecret

Returns string

generateSecretQR

Returns

Parameters

username: string

secret: string

Returns Promise<string>

Parameters

username: string

secret: string

filename: string

Returns Promise<void>

Parameters

username: string

secret: string

Optional filename: string

Returns Promise<string | void>

generateSecretURL

Returns

Parameters

username: string

secret: string

Returns string

verifyToken

Returns

Parameters

secret: string

token: string

Returns boolean

verifyUser

Returns

Parameters

req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Returns Promise<undefined | U>

Settings

Member Visibility

Theme

`Optional` options: Partial<TotpApiOptions<U>>

`Optional` filename: string