From b4e5b958bdd815ff6b6cbe2cce43ea53b8c8f6a3 Mon Sep 17 00:00:00 2001 From: chenasraf Date: Mon, 28 Nov 2022 22:32:45 +0000 Subject: [PATCH] deploy: 45490860a3cdf02fda8f7def885571d41e828e60 --- assets/search.js | 2 +- functions/default.html | 2 +- index.html | 7 +++--- interfaces/TotpApiOptions.html | 40 ++++++++++++++++++++++++++++----- interfaces/TotpMiddlewares.html | 18 +++++++-------- interfaces/TotpOptions.html | 12 +++++----- interfaces/UserData.html | 8 +++---- 7 files changed, 60 insertions(+), 29 deletions(-) diff --git a/assets/search.js b/assets/search.js index 39b922a..502e0e0 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\"},\"rows\":[{\"kind\":256,\"name\":\"TotpOptions\",\"url\":\"interfaces/TotpOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"issuer\",\"url\":\"interfaces/TotpOptions.html#issuer\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":1024,\"name\":\"period\",\"url\":\"interfaces/TotpOptions.html#period\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":1024,\"name\":\"algorithm\",\"url\":\"interfaces/TotpOptions.html#algorithm\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":1024,\"name\":\"digits\",\"url\":\"interfaces/TotpOptions.html#digits\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":1024,\"name\":\"timestamp\",\"url\":\"interfaces/TotpOptions.html#timestamp\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":256,\"name\":\"UserData\",\"url\":\"interfaces/UserData.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"interfaces/UserData.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UserData\"},{\"kind\":1024,\"name\":\"secret\",\"url\":\"interfaces/UserData.html#secret\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UserData\"},{\"kind\":1024,\"name\":\"username\",\"url\":\"interfaces/UserData.html#username\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UserData\"},{\"kind\":256,\"name\":\"TotpApiOptions\",\"url\":\"interfaces/TotpApiOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":2048,\"name\":\"getUser\",\"url\":\"interfaces/TotpApiOptions.html#getUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpApiOptions\"},{\"kind\":2048,\"name\":\"getToken\",\"url\":\"interfaces/TotpApiOptions.html#getToken\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpApiOptions\"},{\"kind\":256,\"name\":\"TotpMiddlewares\",\"url\":\"interfaces/TotpMiddlewares.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":2048,\"name\":\"authenticate\",\"url\":\"interfaces/TotpMiddlewares.html#authenticate\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/TotpMiddlewares.html#authenticate.authenticate-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"TotpMiddlewares.authenticate.authenticate\"},{\"kind\":2048,\"name\":\"generateSecretURL\",\"url\":\"interfaces/TotpMiddlewares.html#generateSecretURL\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":2048,\"name\":\"generateSecretQR\",\"url\":\"interfaces/TotpMiddlewares.html#generateSecretQR\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":2048,\"name\":\"generateNewSecret\",\"url\":\"interfaces/TotpMiddlewares.html#generateNewSecret\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":2048,\"name\":\"verifyToken\",\"url\":\"interfaces/TotpMiddlewares.html#verifyToken\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":2048,\"name\":\"verifyUser\",\"url\":\"interfaces/TotpMiddlewares.html#verifyUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":64,\"name\":\"default\",\"url\":\"functions/default.html\",\"classes\":\"tsd-kind-function\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,27.3]],[\"comment/0\",[]],[\"name/1\",[1,27.3]],[\"comment/1\",[]],[\"name/2\",[2,27.3]],[\"comment/2\",[]],[\"name/3\",[3,27.3]],[\"comment/3\",[]],[\"name/4\",[4,27.3]],[\"comment/4\",[]],[\"name/5\",[5,27.3]],[\"comment/5\",[]],[\"name/6\",[6,27.3]],[\"comment/6\",[]],[\"name/7\",[7,27.3]],[\"comment/7\",[]],[\"name/8\",[8,27.3]],[\"comment/8\",[]],[\"name/9\",[9,27.3]],[\"comment/9\",[]],[\"name/10\",[10,27.3]],[\"comment/10\",[]],[\"name/11\",[11,27.3]],[\"comment/11\",[]],[\"name/12\",[12,27.3]],[\"comment/12\",[]],[\"name/13\",[13,27.3]],[\"comment/13\",[]],[\"name/14\",[14,27.3]],[\"comment/14\",[]],[\"name/15\",[15,27.3]],[\"comment/15\",[]],[\"name/16\",[16,27.3]],[\"comment/16\",[]],[\"name/17\",[17,27.3]],[\"comment/17\",[]],[\"name/18\",[18,27.3]],[\"comment/18\",[]],[\"name/19\",[19,27.3]],[\"comment/19\",[]],[\"name/20\",[20,27.3]],[\"comment/20\",[]],[\"name/21\",[21,27.3]],[\"comment/21\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"algorithm\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"authenticate\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"default\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"digits\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"generatenewsecret\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"generatesecretqr\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"generatesecreturl\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"gettoken\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"getuser\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"issuer\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"period\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"secret\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"timestamp\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"totpapioptions\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"totpmiddlewares\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"totpoptions\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"user\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"userdata\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"username\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"verifytoken\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"verifyuser\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\"},\"rows\":[{\"kind\":64,\"name\":\"default\",\"url\":\"functions/default.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"TotpOptions\",\"url\":\"interfaces/TotpOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"issuer\",\"url\":\"interfaces/TotpOptions.html#issuer\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":1024,\"name\":\"period\",\"url\":\"interfaces/TotpOptions.html#period\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":1024,\"name\":\"algorithm\",\"url\":\"interfaces/TotpOptions.html#algorithm\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":1024,\"name\":\"digits\",\"url\":\"interfaces/TotpOptions.html#digits\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":1024,\"name\":\"timestamp\",\"url\":\"interfaces/TotpOptions.html#timestamp\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"TotpOptions\"},{\"kind\":256,\"name\":\"UserData\",\"url\":\"interfaces/UserData.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"interfaces/UserData.html#user\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UserData\"},{\"kind\":1024,\"name\":\"secret\",\"url\":\"interfaces/UserData.html#secret\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UserData\"},{\"kind\":1024,\"name\":\"username\",\"url\":\"interfaces/UserData.html#username\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"UserData\"},{\"kind\":256,\"name\":\"TotpApiOptions\",\"url\":\"interfaces/TotpApiOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":2048,\"name\":\"getUser\",\"url\":\"interfaces/TotpApiOptions.html#getUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpApiOptions\"},{\"kind\":2048,\"name\":\"getToken\",\"url\":\"interfaces/TotpApiOptions.html#getToken\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpApiOptions\"},{\"kind\":2048,\"name\":\"errorResponse\",\"url\":\"interfaces/TotpApiOptions.html#errorResponse\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpApiOptions\"},{\"kind\":256,\"name\":\"TotpMiddlewares\",\"url\":\"interfaces/TotpMiddlewares.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":2048,\"name\":\"authenticate\",\"url\":\"interfaces/TotpMiddlewares.html#authenticate\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/TotpMiddlewares.html#authenticate.authenticate-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"TotpMiddlewares.authenticate.authenticate\"},{\"kind\":2048,\"name\":\"generateSecretURL\",\"url\":\"interfaces/TotpMiddlewares.html#generateSecretURL\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":2048,\"name\":\"generateSecretQR\",\"url\":\"interfaces/TotpMiddlewares.html#generateSecretQR\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":2048,\"name\":\"generateNewSecret\",\"url\":\"interfaces/TotpMiddlewares.html#generateNewSecret\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":2048,\"name\":\"verifyToken\",\"url\":\"interfaces/TotpMiddlewares.html#verifyToken\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"},{\"kind\":2048,\"name\":\"verifyUser\",\"url\":\"interfaces/TotpMiddlewares.html#verifyUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"TotpMiddlewares\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,27.726]],[\"comment/0\",[]],[\"name/1\",[1,27.726]],[\"comment/1\",[]],[\"name/2\",[2,27.726]],[\"comment/2\",[]],[\"name/3\",[3,27.726]],[\"comment/3\",[]],[\"name/4\",[4,27.726]],[\"comment/4\",[]],[\"name/5\",[5,27.726]],[\"comment/5\",[]],[\"name/6\",[6,27.726]],[\"comment/6\",[]],[\"name/7\",[7,27.726]],[\"comment/7\",[]],[\"name/8\",[8,27.726]],[\"comment/8\",[]],[\"name/9\",[9,27.726]],[\"comment/9\",[]],[\"name/10\",[10,27.726]],[\"comment/10\",[]],[\"name/11\",[11,27.726]],[\"comment/11\",[]],[\"name/12\",[12,27.726]],[\"comment/12\",[]],[\"name/13\",[13,27.726]],[\"comment/13\",[]],[\"name/14\",[14,27.726]],[\"comment/14\",[]],[\"name/15\",[15,27.726]],[\"comment/15\",[]],[\"name/16\",[16,27.726]],[\"comment/16\",[]],[\"name/17\",[17,27.726]],[\"comment/17\",[]],[\"name/18\",[18,27.726]],[\"comment/18\",[]],[\"name/19\",[19,27.726]],[\"comment/19\",[]],[\"name/20\",[20,27.726]],[\"comment/20\",[]],[\"name/21\",[21,27.726]],[\"comment/21\",[]],[\"name/22\",[22,27.726]],[\"comment/22\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"algorithm\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"authenticate\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"default\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"digits\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"errorresponse\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"generatenewsecret\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"generatesecretqr\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"generatesecreturl\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"gettoken\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"getuser\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"issuer\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"period\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"secret\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"timestamp\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"totpapioptions\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"totpmiddlewares\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"totpoptions\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"user\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"userdata\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"username\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"verifytoken\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"verifyuser\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/functions/default.html b/functions/default.html index 45ee378..5681536 100644 --- a/functions/default.html +++ b/functions/default.html @@ -31,7 +31,7 @@
_options: TotpOptions & TotpApiOptions<U>

Returns TotpMiddlewares<U>

+
  • Defined in index.ts:41
    • diff --git a/index.html b/index.html index 00b89d7..f14f372 100644 --- a/index.html +++ b/index.html @@ -36,7 +36,7 @@ auth mechanism for your app.

    Initialize

    First, use the otp function to generate middleware and functions for your use:

    -
    import otp from 'express-otp'

    const totp = otp({
      // Any identifier that is for your app
      issuer: 'my-issuer',
      // This should return user information if a request contains a valid user
      // attempt (such as username or email)
      getUser: async (req) => {
        const user = await db.users.findOne({ username: req.query.username })
        if (!user) {
          return undefined
        }
        return { user: user.details, secret: user.secret, username: user.username }
      },
      // By default, the token is fetched using `req.query.token`. You can change
      // that by providing a `getToken` option:
      getToken: (req) => req.headers['X-OTP-Token'] as string,
    })
+
    import otp from 'express-otp'

    const totp = otp({
      // Any identifier that is for your app
      issuer: 'my-issuer',

      // This should return user information if a request contains a valid user
      // attempt (such as username or email)
      getUser: async (req) => {
        const user = await db.users.findOne({ username: req.query.username })
        if (!user) {
          return undefined
        }
        return { user: user.details, secret: user.secret, username: user.username }
      },

      // By default, the token is fetched using `req.query.token`. You can change
      // that by providing a `getToken` option:
      getToken: (req) => req.headers['X-OTP-Token'] as string,

      // Use this option to immediately respond with an error when a token is
      // missing/invalid. If this is omitted, the next route/middleware will fire
      // normally, but without `req.user` injected. Providing this function ends
      // the response if it's fired.
      errorResponse(req, res, next, error) {
        res.send(error.message)
        res.status(401)
      },
    })
 
    
 
 
@@ -59,8 +59,9 @@ use in their authenticator apps.
    
   
    Authenticate a user
    
     
 
    To lock any endpoint behind authentication, use the provided authenticate() middleware. If the
-user provided the token by your specified method, the user is injected into the request. If the
-req object contains a user, that means your user is authenticated!
    
+user provided the token by your specified method, the user is injected into the request. Otherwise,
+an error will be chained to the next middleware. You can make it respond immediately with an error
+by using errorResponse option.
    
 
    Further requests will still need to be validated with a correct token. The authentication state will
 not be saved in memory between sessions - that is up to you to implement (if necessary).
    
 
    app.get('/user/me', totp.authenticate(), (req, res) => {
      if (!req.user) {
        res.status(401).json('Unauthorized')
        return
      }

      res.status(200).json(req.user)
    })
diff --git a/interfaces/TotpApiOptions.html b/interfaces/TotpApiOptions.html
index 34f2c17..578d2ce 100644
--- a/interfaces/TotpApiOptions.html
+++ b/interfaces/TotpApiOptions.html
@@ -25,7 +25,7 @@
 
      
 
    • TotpApiOptions
    
+
  • Defined in types.ts:52
    • 
 
    
 
    
 
    
@@ -33,13 +33,42 @@
 
    
 
    
 
    Methods
    
-
    getToken?
+
    errorResponse?
+getToken?
 getUser
 
    
 
    
 
    Methods
    
+
    
+
    Optional errorResponse
    
+
      
+
+
    • 
+
      If this function is provided, it will be used to respond to the user with an error when OTP verification fails.
+The response ends after this function is called.
      
+
      
+
      
+
      Parameters
      
+
        
+
      • 
+
        req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
        
+
        The request object.
        
+
        • 
+
      • 
+
        res: Response<any, Record<string, any>>
        
+
        The response object.
        
+
        • 
+
      • 
+
        next: NextFunction
        
+
        The next function.
        
+
        • 
+
      • 
+
        reason: OTPError
      
+
      Returns void
    
 
    
-
    Optional getToken
    
+
    Optional getToken
    
 
      
 
 
    • 
@@ -56,7 +85,7 @@

    Returns PromiseOrValue<undefined | string>

    +
  • Defined in types.ts:78

    • getUser

      @@ -83,7 +112,7 @@ checking headers, etc.

    Returns PromiseOrValue<undefined | UserData<U>>

    +
  • Defined in types.ts:70
    • @@ -109,6 +138,7 @@ checking headers, etc.

    diff --git a/interfaces/TotpMiddlewares.html b/interfaces/TotpMiddlewares.html index c68125c..4f3985e 100644 --- a/interfaces/TotpMiddlewares.html +++ b/interfaces/TotpMiddlewares.html @@ -25,7 +25,7 @@
    • TotpMiddlewares
    +
  • Defined in types.ts:91
    • @@ -80,7 +80,7 @@ further requests.

    Returns void

    Returns Promise<void>

    +
  • Defined in types.ts:100

    • generateNewSecret

      @@ -90,7 +90,7 @@ further requests.

      Returns string

    +
  • Defined in types.ts:151

    • generateSecretQR

      @@ -114,7 +114,7 @@ further requests.

    Returns Promise<string>

    +
  • Defined in types.ts:122

  • Function for generating a QR code for a user from a given secret and username.

    @@ -137,7 +137,7 @@ further requests.

    • Returns Promise<void>

    +
  • Defined in types.ts:133

  • Function for generating a QR code for a user from a given secret and username.

    @@ -164,7 +164,7 @@ user.

    • Returns Promise<string | void>

    +
  • Defined in types.ts:146

    • generateSecretURL

      @@ -187,7 +187,7 @@ user.

    Returns string

    +
  • Defined in types.ts:110

    • verifyToken

      @@ -211,7 +211,7 @@ secret, it returns true. Otherwise, it returns false.<

    Returns boolean

    +
  • Defined in types.ts:162

    • verifyUser

      @@ -230,7 +230,7 @@ secret, it returns true. Otherwise, it returns false.<

    Returns Promise<undefined | U>

    +
  • Defined in types.ts:170
    • diff --git a/interfaces/TotpOptions.html b/interfaces/TotpOptions.html index 7ffd1bb..9302d75 100644 --- a/interfaces/TotpOptions.html +++ b/interfaces/TotpOptions.html @@ -20,7 +20,7 @@
    • TotpOptions
    +
  • Defined in types.ts:14
    • @@ -43,35 +43,35 @@ SHA3-224, SHA3-256, SHA3-384, SHA3-512, SHAKE128, or SHAKE256).

    +
  • Defined in types.ts:23

    • Optional digits

    digits?: number

    Amount of token digits to use. Defaults to 6

    +
  • Defined in types.ts:36

    • issuer

    issuer: string

    The issuer for your app (required)

    +
  • Defined in types.ts:16

    • Optional period

    period?: number

    The time it takes for a new token to generate, in seconds. Defaults to 30

    +
  • Defined in types.ts:18

    • Optional timestamp

    timestamp?: number

    The epoch time. Defaults to 0 (unix epoch)

    +
  • Defined in types.ts:38
    • diff --git a/interfaces/UserData.html b/interfaces/UserData.html index 3efeee0..cc1785d 100644 --- a/interfaces/UserData.html +++ b/interfaces/UserData.html @@ -25,7 +25,7 @@
    • UserData
    +
  • Defined in types.ts:41
    • @@ -45,21 +45,21 @@

    The secret key of the user, used for generating a comparison key.

    +
  • Defined in types.ts:45

    • user

    user: U

    The user object that will get injected into further requests.

    +
  • Defined in types.ts:43

    • username

    username: string

    The username used for generating the token URL/QR.

    +
  • Defined in types.ts:47