hapi-auth-jwt2 | Secure Hapi.js authentication plugin using JSON Web Tokens | Authentication library

key - (required - unless you have a customVerify function) the secret key (or array of potential keys) used to check the signature of the token or a key lookup function with signature async function(decoded) where: decoded - the decoded but unverified JWT received from client Returns an object { key, extraInfo } where: key - the secret key (or array of keys to try) extraInfo - (optional) any additional information that you would like to use in validate which can be accessed via request.plugins['hapi-auth-jwt2'].extraInfo Throws a Boom error when key lookup fails. Refer to this example implementation and its associated test for a working example.validate - (required) the function which is run once the Token has been decoded with signature async function(decoded, request, h) where: decoded - (required) is the decoded and verified JWT received in the request request - (required) is the original request received from the client h - (required) the response toolkit. Returns an object { isValid, credentials, response } where: isValid - true if the JWT was valid, otherwise false. credentials - (optional) alternative credentials to be set instead of decoded. response - (optional) If provided will be used immediately as a takeover response. errorMessage - (optional defaults to 'Invalid credentials') - the error message raised to Boom if the token is invalid (passed to errorFunc as errorContext.message)verifyOptions - (optional defaults to none) settings to define how tokens are verified by the jsonwebtoken library ignoreExpiration - ignore expired tokens audience - do not enforce token audience issuer - do not require the issuer to be valid algorithms - list of allowed algorithmsresponseFunc - (optional) function called to decorate the response with authentication headers before the response headers or payload is written where: request - the request object. h- the response toolkit.errorFunc - (optional defaults to raising the error requested) function called when an error has been raised. It provides an extension point to allow the host the ability to customise the error messages returned. Passed in object follows the following schema: errorContext - the error object. errorContext.errorType - required the Boom method to call (eg. unauthorized) errorContext.message - required the message passed into the Boom method call errorContext.schema - the schema passed into the Boom method call errorContext.attributes - the attributes passed into the Boom method call The function is expected to return the modified errorContext with all above fields defined. request - the request object. h- the response toolkit.urlKey - (optional defaults to 'token') - if you prefer to pass your token via url, simply add a token url parameter to your request or use a custom parameter by setting urlKey. To disable the url parameter set urlKey to false or ''.cookieKey - (optional defaults to 'token') - if you prefer to set your own cookie key or your project has a cookie called 'token' for another purpose, you can set a custom key for your cookie by setting options.cookieKey='yourkeyhere'. To disable cookies set cookieKey to false or ''.headerKey - (optional defaults to 'authorization') - The lowercase name of an HTTP header to read the token from. To disable reading the token from a header, set this to false or ''.payloadKey - (optional defaults to 'token') - The lowercase name of an HTTP POST body to read the token from. To disable reading the token from a payload, set this to false or ''. Please note, this will not prevent authentication falling through to the payload method unless attemptToExtractTokenInPayload is falsetokenType - (optional defaults to none) - allow custom token type, e.g. Authorization: <tokenType> 12345678.complete - (optional defaults to false) - set to true to receive the complete token (decoded.header, decoded.payload and decoded.signature) as decoded argument to key lookup and verify callbacks (not validate)headless - (optional defaults to none) - set to an object containing the header part of the JWT token that should be added to a headless JWT token received. Token's with headers can still be used with this option activated. e.g { alg: 'HS256', typ: 'JWT' }attemptToExtractTokenInPayload - (optional defaults to false) - set to true to let the authenticate method fall through to the payload method for token extractioncustomExtractionFunc - (optional) function called to perform a custom extraction of the JWT where: request - the request object.