+
+
+
+
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 00000000..2dcf244f
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,3215 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attempt
+
+
+
+
+
+
+ claim
+
+
+
+ claim
+
+
+
+ claim
+
+
+
+ requires
+
+
+
+
+
+
+
+ Express OpenID Connect
+ +Express JS middleware implementing sign on for Express web apps using OpenID Connect.
+
Table of Contents
+ +-
+
- Documentation +
- Install +
- Getting Started +
- Architecture +
- Contributing +
- Troubleshooting +
- Support + Feedback +
- Vulnerability Reporting +
- What is Auth0 +
- License +
Documentation
+ +-
+
- Our Express Quickstart is the quickest way to get up and running from scratch. +
- Use the Examples for common configurations for use cases beyond the basics. +
- The API documentation details all configuration options, methods, and data that this library provides. +
- You can run the sample application to see how this SDK functions without writing your own integration. +
Install
+ +Node.js version >=12.0.0 is recommended, but ^10.13.0 lts/dubnium is also supported.
+npm install express-openid-connectGetting Started
+ +Follow our Secure Local Development guide to ensure that applications using this library are running over secure channels (HTTPS URLs). Applications using this library without HTTPS may experience "invalid state" errors.
+The library needs issuerBaseURL, baseURL, clientID and secret to request and accept authentication. These can be configured with environmental variables:
+ISSUER_BASE_URL=https://YOUR_DOMAIN
+CLIENT_ID=YOUR_CLIENT_ID
+BASE_URL=https://YOUR_APPLICATION_ROOT_URL
+SECRET=LONG_RANDOM_VALUE... or in the library initialization:
+// index.js
+
+const { auth } = require('express-openid-connect');
+app.use(
+ auth({
+ issuerBaseURL: 'https://YOUR_DOMAIN',
+ baseURL: 'https://YOUR_APPLICATION_ROOT_URL',
+ clientID: 'YOUR_CLIENT_ID',
+ secret: 'LONG_RANDOM_STRING',
+ })
+);With this basic configuration, your application will require authentication for all routes and store the user identity in an encrypted and signed cookie.
+See the examples for route-specific authentication, custom application session handling, requesting and using access tokens for external APIs, and more.
+See the API documentation for additional configuration possibilities and provided methods.
+ +A note on error handling
+ +Errors raised by this library are handled by the default Express error handler which, in the interests of security, does not include the stack trace in the production environment.
+But you may want to go one step further and hide additional error details from client, like the error message. To do this see the Express documentation on writing Custom error handlers
+ +Contributing
+ +We appreciate feedback and contribution to this repo! Before you get started, please see the following:
+ +Contributions can be made to this library through PRs to fix issues, improve documentation or add features. Please fork this repo, create a well-named branch, and submit a PR with a complete template filled out.
+Code changes in PRs should be accompanied by tests covering the changed or added functionality. Tests can be run for this library with:
+npm install
+npm testWhen you're ready to push your changes, please run the lint command first:
+npm run lintSupport + Feedback
+ +Please use the Issues queue in this repo for questions and feedback.
+ +Vulnerability Reporting
+ +Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
+ +What is Auth0?
+ +Auth0 helps you to easily:
+-
+
- implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.) +
- log in users with username/password databases, passwordless, or multi-factor authentication +
- link multiple user accounts together +
- generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely +
- access demographics and analytics detailing how, when, and where users are logging in +
- enrich user profiles from other data sources using customizable JavaScript rules +
License
+ +This project is licensed under the MIT license. See the LICENSE file for more info.
+Index
+
+
+
+
+
+
+ Interfaces
+ +Functions
+-
+
- attempt
Silent Login
+ - auth +
- claim
Check
+ - claim
Equals
+ - claim
Includes
+ - requires
Auth
+
Functions
+attemptSilentLogin
+ -
+
+
-
+
-
+
+
Returns RequestHandler
+
+
auth
+-
+
+
-
+
-
+
+ ++++
Express JS middleware implementing sign on for Express web apps using OpenID Connect.
+The
+auth()middleware requires secret, baseURL, clientID + and issuerBaseURL.If you are using a response type that includes
+code, you will also need: clientSecretconst express = require('express'); +const { auth } = require('express-openid-connect'); + +const app = express(); + +app.use( + auth({ + issuerBaseURL: 'https://YOUR_DOMAIN', + baseURL: 'https://YOUR_APPLICATION_ROOT_URL', + clientID: 'YOUR_CLIENT_ID', + secret: 'LONG_RANDOM_STRING', + }) +); + +app.get('/', (req, res) => { + res.send(`hello ${req.oidc.user.name}`); +}); + + app.listen(3000, () => console.log('listening at http://localhost:3000'))Parameters
+-
+
-
+
Optional params: ConfigParams
+
+
Returns RequestHandler
+
+ -
+
claimCheck
+ -
+
+
-
+
-
+
+ ++++
Use this MW to protect a route, providing a custom function to check.
+const { claimCheck } = require('express-openid-connect'); + +app.get('/admin/community', claimCheck((req, claims) => { + return claims.isAdmin && claims.roles.includes('community'); +}), (req, res) => { + res.send(...); +}); +Parameters
+-
+
-
+
checkFn: (req: OpenidRequest, claims: IdTokenClaims) => boolean
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
req: OpenidRequest
+
+ -
+
claims: IdTokenClaims
+
+
Returns boolean
+
+ -
+
+ -
+
+ -
+
Returns RequestHandler
+
+ -
+
claimEquals
+ -
+
+
-
+
-
+
+ ++++
Use this MW to protect a route based on the value of a specific claim.
+const { claimEquals } = require('express-openid-connect'); + +app.get('/admin', claimEquals('isAdmin', true), (req, res) => { + res.send(...); +}); +Parameters
+-
+
-
+
claim: string
+++The name of the claim
+
+ -
+
value: boolean | number | string | null
+++The value of the claim, should be a primitive
+
+
Returns RequestHandler
+
+ -
+
claimIncludes
+ -
+
+
-
+
-
+
+ ++++
Use this MW to protect a route, checking that all values are in a claim.
+const { claimIncludes } = require('express-openid-connect'); + +app.get('/admin/delete', claimIncludes('roles', 'admin', 'superadmin'), (req, res) => { + res.send(...); +}); +Parameters
+-
+
-
+
claim: string
+++The name of the claim
+
+ -
+
Rest ...args: (string | number | false | true)[]
+++Claim values that must all be included
+
+
Returns RequestHandler
+
+ -
+
requiresAuth
+ -
+
+
-
+
-
+
+ ++++
Set authRequired to
+falsethen require authentication + on specific routes.const { auth, requiresAuth } = require('express-openid-connect'); + +app.use( + auth({ + ... + authRequired: false + }) +); + +app.get('/profile', requiresAuth(), (req, res) => { + res.send(`hello ${req.oidc.user.name}`); +}); +Parameters
+-
+
-
+
Optional requiresLoginCheck: (req: OpenidRequest) => boolean
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
req: OpenidRequest
+
+
Returns boolean
+
+ -
+
+ -
+
+ -
+
Returns RequestHandler
+
+ -
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/accesstoken.html b/docs/interfaces/accesstoken.html
new file mode 100644
index 00000000..25d16941
--- /dev/null
+++ b/docs/interfaces/accesstoken.html
@@ -0,0 +1,2943 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attempt
+
+
+
+
+
+
+ claim
+
+
+
+ claim
+
+
+
+ claim
+
+
+
+ requires
+
+
+
+
+
+
+
+
+ Express OpenID Connect
+ +Express JS middleware implementing sign on for Express web apps using OpenID Connect.
+
Table of Contents
+ +-
+
- Documentation +
- Install +
- Getting Started +
- Architecture +
- Contributing +
- Troubleshooting +
- Support + Feedback +
- Vulnerability Reporting +
- What is Auth0 +
- License +
Documentation
+ +-
+
- Our Express Quickstart is the quickest way to get up and running from scratch. +
- Use the Examples for common configurations for use cases beyond the basics. +
- The API documentation details all configuration options, methods, and data that this library provides. +
- You can run the sample application to see how this SDK functions without writing your own integration. +
Install
+ +Node.js version >=12.0.0 is recommended, but ^10.13.0 lts/dubnium is also supported.
+npm install express-openid-connectGetting Started
+ +Follow our Secure Local Development guide to ensure that applications using this library are running over secure channels (HTTPS URLs). Applications using this library without HTTPS may experience "invalid state" errors.
+The library needs issuerBaseURL, baseURL, clientID and secret to request and accept authentication. These can be configured with environmental variables:
+ISSUER_BASE_URL=https://YOUR_DOMAIN
+CLIENT_ID=YOUR_CLIENT_ID
+BASE_URL=https://YOUR_APPLICATION_ROOT_URL
+SECRET=LONG_RANDOM_VALUE... or in the library initialization:
+// index.js
+
+const { auth } = require('express-openid-connect');
+app.use(
+ auth({
+ issuerBaseURL: 'https://YOUR_DOMAIN',
+ baseURL: 'https://YOUR_APPLICATION_ROOT_URL',
+ clientID: 'YOUR_CLIENT_ID',
+ secret: 'LONG_RANDOM_STRING',
+ })
+);With this basic configuration, your application will require authentication for all routes and store the user identity in an encrypted and signed cookie.
+See the examples for route-specific authentication, custom application session handling, requesting and using access tokens for external APIs, and more.
+See the API documentation for additional configuration possibilities and provided methods.
+ +A note on error handling
+ +Errors raised by this library are handled by the default Express error handler which, in the interests of security, does not include the stack trace in the production environment.
+But you may want to go one step further and hide additional error details from client, like the error message. To do this see the Express documentation on writing Custom error handlers
+ +Contributing
+ +We appreciate feedback and contribution to this repo! Before you get started, please see the following:
+ +Contributions can be made to this library through PRs to fix issues, improve documentation or add features. Please fork this repo, create a well-named branch, and submit a PR with a complete template filled out.
+Code changes in PRs should be accompanied by tests covering the changed or added functionality. Tests can be run for this library with:
+npm install
+npm testWhen you're ready to push your changes, please run the lint command first:
+npm run lintSupport + Feedback
+ +Please use the Issues queue in this repo for questions and feedback.
+ +Vulnerability Reporting
+ +Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
+ +What is Auth0?
+ +Auth0 helps you to easily:
+-
+
- implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.) +
- log in users with username/password databases, passwordless, or multi-factor authentication +
- link multiple user accounts together +
- generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely +
- access demographics and analytics detailing how, when, and where users are logging in +
- enrich user profiles from other data sources using customizable JavaScript rules +
License
+ +This project is licensed under the MIT license. See the LICENSE file for more info.
+Index
+
+
+
+
+
+
+ Interfaces
+ +Functions
+-
+
- attempt
Silent Login
+ - auth +
- claim
Check
+ - claim
Equals
+ - claim
Includes
+ - requires
Auth
+
Functions
+attemptSilentLogin
+ -
+
+
-
+
-
+
+ ++++ +
Use this MW to attempt silent login (
+prompt=none) but not require authentication.const { attemptSilentLogin } = require('express-openid-connect'); + +app.get('/', attemptSilentLogin(), (req, res) => { + res.render('homepage', { + isAuthenticated: req.isAuthenticated() // show a login or logout button + }); +}); +Returns RequestHandler
+
+
auth
+-
+
+
-
+
-
+
+ ++++
Express JS middleware implementing sign on for Express web apps using OpenID Connect.
+The
+auth()middleware requires secret, baseURL, clientID + and issuerBaseURL.If you are using a response type that includes
+code, you will also need: clientSecretconst express = require('express'); +const { auth } = require('express-openid-connect'); + +const app = express(); + +app.use( + auth({ + issuerBaseURL: 'https://YOUR_DOMAIN', + baseURL: 'https://YOUR_APPLICATION_ROOT_URL', + clientID: 'YOUR_CLIENT_ID', + secret: 'LONG_RANDOM_STRING', + }) +); + +app.get('/', (req, res) => { + res.send(`hello ${req.oidc.user.name}`); +}); + + app.listen(3000, () => console.log('listening at http://localhost:3000'))Parameters
+-
+
-
+
Optional params: ConfigParams
+
+
Returns RequestHandler
+
+ -
+
claimCheck
+ -
+
+
-
+
-
+
+ ++++
Use this MW to protect a route, providing a custom function to check.
+const { claimCheck } = require('express-openid-connect'); + +app.get('/admin/community', claimCheck((req, claims) => { + return claims.isAdmin && claims.roles.includes('community'); +}), (req, res) => { + res.send(...); +}); +Parameters
+-
+
-
+
checkFn: (req: OpenidRequest, claims: IdTokenClaims) => boolean
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
req: OpenidRequest
+
+ -
+
claims: IdTokenClaims
+
+
Returns boolean
+
+ -
+
+ -
+
+ -
+
Returns RequestHandler
+
+ -
+
claimEquals
+ -
+
+
-
+
-
+
+ ++++
Use this MW to protect a route based on the value of a specific claim.
+const { claimEquals } = require('express-openid-connect'); + +app.get('/admin', claimEquals('isAdmin', true), (req, res) => { + res.send(...); +}); +Parameters
+-
+
-
+
claim: string
+++The name of the claim
+
+ -
+
value: boolean | number | string | null
+++The value of the claim, should be a primitive
+
+
Returns RequestHandler
+
+ -
+
claimIncludes
+ -
+
+
-
+
-
+
+ ++++
Use this MW to protect a route, checking that all values are in a claim.
+const { claimIncludes } = require('express-openid-connect'); + +app.get('/admin/delete', claimIncludes('roles', 'admin', 'superadmin'), (req, res) => { + res.send(...); +}); +Parameters
+-
+
-
+
claim: string
+++The name of the claim
+
+ -
+
Rest ...args: (string | number | false | true)[]
+++Claim values that must all be included
+
+
Returns RequestHandler
+
+ -
+
requiresAuth
+ -
+
+
-
+
-
+
+ ++++
Set authRequired to
+falsethen require authentication + on specific routes.const { auth, requiresAuth } = require('express-openid-connect'); + +app.use( + auth({ + ... + authRequired: false + }) +); + +app.get('/profile', requiresAuth(), (req, res) => { + res.send(`hello ${req.oidc.user.name}`); +}); +Parameters
+-
+
-
+
Optional requiresLoginCheck: (req: OpenidRequest) => boolean
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
req: OpenidRequest
+
+
Returns boolean
+
+ -
+
+ -
+
+ -
+
Returns RequestHandler
+
+ -
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/configparams.html b/docs/interfaces/configparams.html
new file mode 100644
index 00000000..1c086e75
--- /dev/null
+++ b/docs/interfaces/configparams.html
@@ -0,0 +1,3309 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ access_
+
+
+
+
+
+ expires_
+
+
+
+
+
+ is
+
+
+
+
+
+ token_
+
+
+
+
+
+
+
+
+
+
+
+Hierarchy
+-
+
- + AccessToken + +
Index
+
+
+
+
+
+
+ Properties
+-
+
- access_
token
+ - expires_
in
+ - is
Expired
+ - token_
type
+
Methods
+-
+
- refresh +
Properties
+access_token
+
+
+
+
+
+
+ The access token itself, can be an opaque string, JWT, or non-JWT token.
+expires_in
+
+
+
+
+
+
+ Number of seconds until the access token expires.
+isExpired
+
+
+
+
+
+
+ Returns true if the access_token has expired.
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Returns boolean
+
+
+ -
+
token_type
+
+
+
+
+
+
+ The type of access token, Usually "Bearer".
+Methods
+refresh
+-
+
+
-
+
-
+
+ ++++
Performs refresh_token grant type exchange and updates the session's access token.
+let accessToken = req.oidc.accessToken; +if (accessToken.isExpired()) { + accessToken = await accessToken.refresh(); +}Returns Promise<AccessToken>
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/loginoptions.html b/docs/interfaces/loginoptions.html
new file mode 100644
index 00000000..a46a6578
--- /dev/null
+++ b/docs/interfaces/loginoptions.html
@@ -0,0 +1,2859 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional attempt
+
+
+
+
+
+ Optional auth0
+
+
+
+
+
+ Optional auth
+
+
+
+
+
+ Optional authorization
+
+
+
+
+
+
+
+
+
+
+
+ Optional client
+
+
+
+
+
+ Optional clock
+
+
+
+
+
+ Optional enable
+
+
+
+
+
+ Optional error
+
+
+
+
+
+ Optional get
+
+
+
+
+
+ Optional id
+
+
+
+
+
+ Optional identity
+
+
+
+
+
+ Optional idp
+
+
+
+
+
+ Optional issuer
+
+
+
+
+
+ Optional legacy
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Configuration parameters passed to the auth() middleware.
issuerBaseURL, baseURL, clientID + and secret are required but can be configured with environmental variables:
+ISSUER_BASE_URL=https://YOUR_DOMAIN
+CLIENT_ID=YOUR_CLIENT_ID
+BASE_URL=https://YOUR_APPLICATION_ROOT_URL
+SECRET=LONG_RANDOM_VALUEHierarchy
+-
+
- + ConfigParams + +
Index
+
+
+
+
+ Properties
+-
+
- attempt
Silent Login
+ - auth0
Logout
+ - auth
Required
+ - authorization
Params
+ - baseURL +
- clientID +
- client
Secret
+ - clock
Tolerance
+ - enable
Telemetry
+ - error
OnRequired Auth
+ - get
Login State
+ - id
Token Signing Alg
+ - identity
Claim Filter
+ - idp
Logout
+ - issuer
BaseURL
+ - legacy
Same Site Cookie
+ - routes +
- secret +
- session +
Properties
+Optional attemptSilentLogin
+
+
+
+
+
+
+ Attempt silent login (prompt: 'none') on the first unauthenticated route the user visits.
+ For protected routes this can be useful if your Identity Provider does not default to
+ prompt: 'none' and you'd like to attempt this before requiring the user to interact with a login prompt.
+ For unprotected routes this can be useful if you want to check the user's logged in state on their IDP, to
+ show them a login/logout button for example.
+ Default is false
Optional auth0Logout
+
+
+
+
+
+
+ Boolean value to enable Auth0's logout feature.
+Optional authRequired
+
+
+
+
+
+
+ Require authentication for all routes.
+Optional authorizationParams
+
+
+
+
+
+
+ URL parameters used when redirecting users to the authorization server to log in.
+If this property is not provided by your application, its default values will be:
+{
+ response_type: 'id_token',
+ response_mode: 'form_post,
+ scope: openid profile email'
+}New values can be passed in to change what is returned from the authorization server depending on your specific scenario.
+For example, to receive an access token for an API, you could initialize like the sample below. Note that response_mode can be omitted because the OAuth2 default mode of query is fine:
app.use(
+ auth({
+ authorizationParams: {
+ response_type: 'code',
+ scope: 'openid profile email read:reports',
+ audience: 'https://your-api-identifier',
+ },
+ })
+);Additional custom parameters can be added as well:
+app.use(auth({
+ authorizationParams: {
+ // Note: you need to provide required parameters if this object is set.
+ response_type: "id_token",
+ response_mode: "form_post",
+ scope: "openid profile email"
+ // Additional parameters
+ acr_value: "tenant:test-tenant",
+ custom_param: "custom-value"
+ }
+}));Optional baseURL
+ + +
+
+
+
+ REQUIRED. The root URL for the application router, eg https://localhost + Can use env key BASE_URL instead.
+Optional clientID
+ + +
+
+
+
+ REQUIRED. The Client ID for your application. + Can use env key CLIENT_ID instead.
+Optional clientSecret
+
+
+
+
+
+
+ The Client Secret for your application. + Required when requesting access tokens. + Can use env key CLIENT_SECRET instead.
+Optional clockTolerance
+
+
+
+
+
+
+ Integer value for the system clock's tolerance (leeway) in seconds for ID token verification.` + Default is 60
+Optional enableTelemetry
+
+
+
+
+
+
+ To opt-out of sending the library and node version to your authorization server
+ via the Auth0-Client header. Default is `true
Optional errorOnRequiredAuth
+
+
+
+
+
+
+ Throw a 401 error instead of triggering the login process for routes that require authentication.
+ Default is false
Optional getLoginState
+
+
+
+
+
+
+ Function that returns an object with URL-safe state values for res.oidc.login().
+ Used for passing custom state parameters to your authorization server.
app.use(auth({
+ ...
+ getLoginState(req, options) {
+ return {
+ returnTo: options.returnTo || req.originalUrl,
+ customState: 'foo'
+ };
+ }
+}))
+``
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
req: OpenidRequest
+
+ -
+
options: LoginOptions
+
+
Returns object
+
+ -
+
+ -
+
Optional idTokenSigningAlg
+
+
+
+
+
+
+ String value for the expected ID token algorithm. Default is 'RS256'
+Optional identityClaimFilter
+
+
+
+
+
+
+ Array value of claims to remove from the ID token before storing the cookie session.
+ Default is ['aud', 'iss', 'iat', 'exp', 'nbf', 'nonce', 'azp', 'auth_time', 's_hash', 'at_hash', 'c_hash' ]
Optional idpLogout
+
+
+
+
+
+
+ Boolean value to log the user out from the identity provider on application logout. Default is false
Optional issuerBaseURL
+
+
+
+
+
+
+ REQUIRED. The root URL for the token issuer with no trailing slash. + Can use env key ISSUER_BASE_URL instead.
+Optional legacySameSiteCookie
+
+
+
+
+
+
+ Set a fallback cookie with no SameSite attribute when response_mode is form_post. + Default is true
+Optional routes
+ + +
+
+
+
+ Boolean value to automatically install the login and logout routes.
+
+
+ Type declaration
+-
+
-
+
Optional callback?: string
+++++Relative path to the application callback to process the response from the authorization server.
+
+ -
+
Optional login?: string | false
+++++Relative path to application login.
+
+ -
+
Optional logout
+Path?: string | false ++++Relative path to application logout.
+
+ -
+
Optional post
+Logout Redirect?: string ++++Either a relative path to the application or a valid URI to an external domain. + This value must be registered on the authorization server. + The user will be redirected to this after a logout has been performed.
+
+
Optional secret
+ + +
+
+
+
+ REQUIRED. The secret(s) used to derive an encryption key for the user identity in a session cookie and + to sign the transient cookies used by the login callback. + Use a single string key or array of keys for an encrypted session cookie. + Can use env key SECRET instead.
+Optional session
+ + +
+
+
+
+ Object defining application session cookie attributes.
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/logoutoptions.html b/docs/interfaces/logoutoptions.html
new file mode 100644
index 00000000..1b58cd2e
--- /dev/null
+++ b/docs/interfaces/logoutoptions.html
@@ -0,0 +1,2840 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional authorization
+
+
+
+
+
+ Optional return
+
+
+
+
+
+
+
+
+
+
+ Custom options to pass to login.
+Hierarchy
+-
+
- + LoginOptions + +
Index
+
+
+
+
+ Properties
+-
+
- authorization
Params
+ - return
To
+
Properties
+Optional authorizationParams
+
+
+
+
+
+
+ Override the default authorizationParams
+Optional returnTo
+
+
+
+
+
+
+ URL to return to after login, overrides the Default is {@link Request.originalUrl}
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/openidrequest.html b/docs/interfaces/openidrequest.html
new file mode 100644
index 00000000..7c0b007c
--- /dev/null
+++ b/docs/interfaces/openidrequest.html
@@ -0,0 +1,6493 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional return
+
+
+
+
+
+
+
+
+
+
+ Custom options to pass to logout.
+Hierarchy
+-
+
- + LogoutOptions + +
Index
+
+
+
+
+ Properties
+-
+
- return
To
+
Properties
+Optional returnTo
+
+
+
+
+
+
+ URL to returnTo after logout, overrides the Default in {@link ConfigParams.routes.postLogoutRedirect routes.postLogoutRedirect}
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/openidresponse.html b/docs/interfaces/openidresponse.html
new file mode 100644
index 00000000..b835c9e8
--- /dev/null
+++ b/docs/interfaces/openidresponse.html
@@ -0,0 +1,7479 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ base
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http
+
+
+
+
+
+ http
+
+
+
+
+
+ http
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ original
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ raw
+
+
+
+
+
+ raw
+
+
+
+
+
+
+
+
+ Readonly readable
+
+
+
+
+
+ Readonly readable
+
+
+
+
+
+ Readonly readable
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ signed
+
+
+
+
+
+
+
+
+
+
+
+ Optional status
+
+
+
+
+
+ Optional status
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Static default
+
+
+
+
+
+
+
+ [
+
+
+
+
+
+
+
+
+
+
+
+
+ accepts
+
+
+
+ accepts
+
+
+
+ accepts
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+
+
+
+ get
+
+
+
+
+
+
+
+
+
+ is
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+
+
+
+
+
+
+ raw
+
+
+
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Static listener
+
+
+
+
+
+
+
+
+ The Express.js Request with oidc context added by the auth middleware.
app.use(auth());
+
+app.get('/profile', (req, res) => {
+ const user = req.oidc.user;
+ ...
+})Type parameters
+-
+
-
+
P: core.Params
+
+ -
+
ResBody
+
+ -
+
ReqBody
+
+ -
+
ReqQuery
+
+
Hierarchy
+-
+
-
+ Request
+
-
+
- + OpenidRequest + +
+
Implements
+-
+
- ReadableStream +
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- accepted +
- app +
- base
Url
+ - body +
- complete +
- connection +
- cookies +
- destroyed +
- fresh +
- headers +
- host +
- hostname +
- http
Version
+ - http
Version Major
+ - http
Version Minor
+ - ip +
- ips +
- method +
- next +
- oidc +
- original
Url
+ - params +
- path +
- protocol +
- query +
- raw
Headers
+ - raw
Trailers
+ - readable +
- readable
High Water Mark
+ - readable
Length
+ - readable
Object Mode
+ - res +
- route +
- secure +
- signed
Cookies
+ - socket +
- stale +
- status
Code
+ - status
Message
+ - subdomains +
- trailers +
- url +
- xhr +
- default
Max Listeners
+
Methods
+-
+
- [
Symbol.async Iterator]
+ - _destroy +
- _read +
- accepts +
- accepts
Charsets
+ - accepts
Encodings
+ - accepts
Languages
+ - add
Listener
+ - destroy +
- emit +
- event
Names
+ - get +
- get
Max Listeners
+ - header +
- is +
- is
Paused
+ - listener
Count
+ - listeners +
- off +
- on +
- once +
- param +
- pause +
- pipe +
- prepend
Listener
+ - prepend
Once Listener
+ - push +
- range +
- raw
Listeners
+ - read +
- remove
All Listeners
+ - remove
Listener
+ - resume +
- set
Encoding
+ - set
Max Listeners
+ - set
Timeout
+ - unpipe +
- unshift +
- wrap +
- from +
- listener
Count
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
socket: Socket
+
+
Returns OpenidRequest
+
+ -
+
Properties
+accepted
+ + +
+
+
+
+ Return an array of Accepted media types + ordered from highest quality to lowest.
+app
+ + +baseUrl
+
+
+ body
+ + +complete
+ + +connection
+ + +
+
+
+ cookies
+ + +destroyed
+ + +fresh
+ + +
+
+
+
+ Check if the request is fresh, aka + Last-Modified and/or the ETag + still match.
+headers
+ + +host
+ + +
+
+
+ hostname
+ + +
+
+
+
+ Parse the "Host" header field hostname.
+httpVersion
+
+
+ httpVersionMajor
+
+
+ httpVersionMinor
+
+
+ ip
+ + +
+
+
+
+ Return the remote address, or when
+ "trust proxy" is true return
+ the upstream addr.
ips
+ + +
+
+
+
+ When "trust proxy" is true, parse
+ the "X-Forwarded-For" ip address list.
For example if the value were "client, proxy1, proxy2"
+ you would receive the array ["client", "proxy1", "proxy2"]
+ where "proxy2" is the furthest down-stream.
method
+ + +Optional next
+ + +oidc
+ + +
+
+
+
+ Library namespace for authentication methods and data.
+originalUrl
+
+
+ params
+ + +path
+ + +
+
+
+
+ Short-hand for url.parse(req.url).pathname.
protocol
+ + +
+
+
+
+ Return the protocol string "http" or "https" + when requested with TLS. When the "trust proxy" + setting is enabled the "X-Forwarded-Proto" header + field will be trusted. If you're running behind + a reverse proxy that supplies https for you this + may be enabled.
+query
+ + +rawHeaders
+
+
+ rawTrailers
+
+
+ readable
+ + +Readonly readableHighWaterMark
+
+
+ Readonly readableLength
+
+
+ Readonly readableObjectMode
+
+
+ Optional res
+ + +
+
+
+
+ After middleware.init executed, Request will contain res and next properties + See: express/lib/middleware/init.js
+route
+ + +secure
+ + +
+
+
+
+ Short-hand for:
+req.protocol == 'https'
+signedCookies
+
+
+ socket
+ + +stale
+ + +
+
+
+
+ Check if the request is stale, aka + "Last-Modified" and / or the "ETag" for the + resource has changed.
+Optional statusCode
+
+
+
+
+
+
+ Only valid for response obtained from http.ClientRequest.
+Optional statusMessage
+
+
+
+
+
+
+ Only valid for response obtained from http.ClientRequest.
+subdomains
+ + +
+
+
+
+ Return subdomains as an array.
+Subdomains are the dot-separated parts of the host before the main domain of + the app. By default, the domain of the app is assumed to be the last two + parts of the host. This can be changed by setting "subdomain offset".
+For example, if the domain is "tobi.ferrets.example.com":
+ If "subdomain offset" is not set, req.subdomains is ["ferrets", "tobi"].
+ If "subdomain offset" is 3, req.subdomains is ["tobi"].
trailers
+ + +
+
+ Type declaration
+-
+
-
+
[key: string]: string | undefined
+
+
url
+ + +xhr
+ + +
+
+
+
+ Check if the request was an XMLHttpRequest.
+Static defaultMaxListeners
+
+
+ Methods
+[Symbol.asyncIterator]
+ -
+
+
-
+
-
+
+
Returns AsyncIterableIterator<any>
+
+
_destroy
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
error: Error | null
+
+ -
+
callback: (error?: Error | null) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional error: Error | null
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns void
+
+ -
+
_read
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
size: number
+
+
Returns void
+
+ -
+
accepts
+-
+
+
+
+
+
-
+
-
+
+ ++++
Check if the given
+type(s)is acceptable, returning + the best match when true, otherwiseundefined, in which + case you should respond with 406 "Not Acceptable".The
+typevalue may be a single mime type string + such as "application/json", the extension name + such as "json", a comma-delimted list such as "json, html, text/plain", + or an array["json", "html", "text/plain"]. When a list + or array is given the best match, if any is returned.Examples:
+// Accept: text/html +req.accepts('html'); +// => "html" + +// Accept: text/*, application/json +req.accepts('html'); +// => "html" +req.accepts('text/html'); +// => "text/html" +req.accepts('json, text'); +// => "json" +req.accepts('application/json'); +// => "application/json" + +// Accept: text/*, application/json +req.accepts('image/png'); +req.accepts('png'); +// => undefined + +// Accept: text/*;q=.5, application/json +req.accepts(['html', 'json']); +req.accepts('html, json'); +// => "json"Returns string[]
+
+ -
+
+
Parameters
+-
+
-
+
type: string
+
+
Returns string | false
+
+ -
+
-
+
+
Parameters
+-
+
-
+
type: string[]
+
+
Returns string | false
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...type: string[]
+
+
Returns string | false
+
+ -
+
acceptsCharsets
+ -
+
+
+
+
+
-
+
-
+
+ ++++
Returns the first accepted charset of the specified character sets, + based on the request's Accept-Charset HTTP header field. + If none of the specified charsets is accepted, returns false.
+For more information, or if you have issues or concerns, see accepts.
+Returns string[]
+
+ -
+
+
Parameters
+-
+
-
+
charset: string
+
+
Returns string | false
+
+ -
+
-
+
+
Parameters
+-
+
-
+
charset: string[]
+
+
Returns string | false
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...charset: string[]
+
+
Returns string | false
+
+ -
+
acceptsEncodings
+ -
+
+
+
+
+
-
+
-
+
+ ++++
Returns the first accepted encoding of the specified encodings, + based on the request's Accept-Encoding HTTP header field. + If none of the specified encodings is accepted, returns false.
+For more information, or if you have issues or concerns, see accepts.
+Returns string[]
+
+ -
+
+
Parameters
+-
+
-
+
encoding: string
+
+
Returns string | false
+
+ -
+
-
+
+
Parameters
+-
+
-
+
encoding: string[]
+
+
Returns string | false
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...encoding: string[]
+
+
Returns string | false
+
+ -
+
acceptsLanguages
+ -
+
+
+
+
+
-
+
-
+
+ ++++
Returns the first accepted language of the specified languages, + based on the request's Accept-Language HTTP header field. + If none of the specified languages is accepted, returns false.
+For more information, or if you have issues or concerns, see accepts.
+Returns string[]
+
+ -
+
+
Parameters
+-
+
-
+
lang: string
+
+
Returns string | false
+
+ -
+
-
+
+
Parameters
+-
+
-
+
lang: string[]
+
+
Returns string | false
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...lang: string[]
+
+
Returns string | false
+
+ -
+
addListener
+ -
+
+
+
+
+
+
+
-
+
-
+
+ ++++
Event emitter + The defined events on documents including:
+-
+
- close +
- data +
- end +
- readable +
- error +
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
+
Parameters
+-
+
-
+
event: "data"
+
+ -
+
listener: (chunk: any) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
chunk: any
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "end"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "readable"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
destroy
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional error: Error
+
+
Returns void
+
+ -
+
emit
+-
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "data"
+
+ -
+
chunk: any
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "end"
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "readable"
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
err: Error
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
get
+-
+
+
+
-
+
-
+
+ ++++
Return request header.
+The
+Referrerheader field is special-cased, + bothReferrerandRefererare interchangeable.Examples:
+req.get('Content-Type'); +// => "text/plain" + +req.get('content-type'); +// => "text/plain" + +req.get('Something'); +// => undefinedAliased as
+req.header().Parameters
+-
+
-
+
name: "set-cookie"
+
+
Returns string[] | undefined
+
+ -
+
-
+
+
Parameters
+-
+
-
+
name: string
+
+
Returns string | undefined
+
+ -
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
header
+-
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
name: "set-cookie"
+
+
Returns string[] | undefined
+
+ -
+
-
+
+
Parameters
+-
+
-
+
name: string
+
+
Returns string | undefined
+
+ -
+
is
+-
+
+
-
+
-
+
+ ++++
Check if the incoming request contains the "Content-Type" + header field, and it contains the give mime
+type.Examples:
+// With Content-Type: text/html; charset=utf-8 + req.is('html'); + req.is('text/html'); + req.is('text/*'); + // => true + + // When Content-Type is application/json + req.is('json'); + req.is('application/json'); + req.is('application/*'); + // => true + + req.is('html'); + // => falseParameters
+-
+
-
+
type: string | string[]
+
+
Returns string | false | null
+
+ -
+
isPaused
+ -
+
+
-
+
-
+
+
Returns boolean
+
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
type: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "data"
+
+ -
+
listener: (chunk: any) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
chunk: any
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "end"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "readable"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "data"
+
+ -
+
listener: (chunk: any) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
chunk: any
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "end"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "readable"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
param
+-
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
name: string
+
+ -
+
Optional defaultValue: any
+
+
Returns string
+
+ -
+
pause
+-
+
+
-
+
-
+
+
Returns this
+
+
pipe
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
T: WritableStream
+
+
Parameters
+-
+
-
+
destination: T
+
+ -
+
Optional options: { end?: boolean }
+-
+
-
+
Optional end?: boolean
+
+
+ -
+
Returns T
+
+ -
+
prependListener
+ -
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "data"
+
+ -
+
listener: (chunk: any) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
chunk: any
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "end"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "readable"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "data"
+
+ -
+
listener: (chunk: any) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
chunk: any
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "end"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "readable"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
push
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
chunk: any
+
+ -
+
Optional encoding: string
+
+
Returns boolean
+
+ -
+
range
+-
+
+
-
+
-
+
+ ++++
Parse Range header field, capping to the given
+size.Unspecified ranges such as "0-" require knowledge of your resource length. In + the case of a byte range this is of course the total number of bytes. + If the Range header field is not given
+undefinedis returned. + If the Range header field is given, return value is a result of range-parser. + See more ./types/range-parser/index.d.tsNOTE: remember that ranges are inclusive, so for example "Range: users=0-3" + should respond with 4 users when available, not 3.
+Parameters
+-
+
-
+
size: number
+
+ -
+
Optional options: RangeParserOptions
+
+
Returns RangeParserRanges | RangeParserResult | undefined
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
read
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional size: number
+
+
Returns any
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "data"
+
+ -
+
listener: (chunk: any) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
chunk: any
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "end"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "readable"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
resume
+-
+
+
-
+
-
+
+
Returns this
+
+
setEncoding
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
encoding: string
+
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
setTimeout
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
msecs: number
+
+ -
+
Optional callback: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
unpipe
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional destination: WritableStream
+
+
Returns this
+
+ -
+
unshift
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
chunk: any
+
+ -
+
Optional encoding: BufferEncoding
+
+
Returns void
+
+ -
+
wrap
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
oldStream: ReadableStream
+
+
Returns this
+
+ -
+
Static from
+-
+
+
-
+
-
+
+ ++++
A utility method for creating Readable Streams out of iterators.
+Parameters
+-
+
-
+
iterable: Iterable<any> | AsyncIterable<any>
+
+ -
+
Optional options: ReadableOptions
+
+
Returns Readable
+
+ -
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/requestcontext.html b/docs/interfaces/requestcontext.html
new file mode 100644
index 00000000..fb204c9b
--- /dev/null
+++ b/docs/interfaces/requestcontext.html
@@ -0,0 +1,3001 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ chunked
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ headers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ send
+
+
+
+
+
+ should
+
+
+
+
+
+
+
+
+ status
+
+
+
+
+
+ status
+
+
+
+
+
+
+
+
+ use
+
+
+
+
+
+
+
+
+ Readonly writable
+
+
+
+
+
+ Readonly writable
+
+
+
+
+
+ writable
+
+
+
+
+
+ Readonly writable
+
+
+
+
+
+ Readonly writable
+
+
+
+
+
+ Readonly writable
+
+
+
+
+
+ Static default
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+ assign
+
+
+
+
+
+
+ clear
+
+
+
+ content
+
+
+
+
+
+
+
+
+
+
+
+
+ detach
+
+
+
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+ flush
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ has
+
+
+
+
+
+
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+ raw
+
+
+
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+
+
+
+ send
+
+
+
+ send
+
+
+
+
+
+
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ write
+
+
+
+ write
+
+
+
+ write
+
+
+
+ Static listener
+
+
+
+
+
+
+
+
+ The Express.js Response with oidc context added by the auth middleware.
app.use(auth());
+
+app.get('/login', (req, res) => {
+ res.oidc.login();
+})Type parameters
+-
+
-
+
ResBody
+
+
Hierarchy
+-
+
-
+ Response
+
-
+
- + OpenidResponse + +
+
Implements
+-
+
- WritableStream +
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- app +
- charset +
- chunked
Encoding
+ - connection +
- destroyed +
- finished +
- headers
Sent
+ - json +
- jsonp +
- locals +
- oidc +
- req +
- send +
- send
Date
+ - should
Keep Alive
+ - socket +
- status
Code
+ - status
Message
+ - upgrading +
- use
Chunked Encoding ByDefault
+ - writable +
- writable
Corked
+ - writable
Ended
+ - writable
Finished
+ - writable
High Water Mark
+ - writable
Length
+ - writable
Object Mode
+ - default
Max Listeners
+
Methods
+-
+
- _destroy +
- _final +
- _write +
- _writev +
- add
Listener
+ - add
Trailers
+ - append +
- assign
Socket
+ - attachment +
- clear
Cookie
+ - content
Type
+ - cookie +
- cork +
- destroy +
- detach
Socket
+ - download +
- emit +
- end +
- event
Names
+ - flush
Headers
+ - format +
- get +
- get
Header
+ - get
Header Names
+ - get
Headers
+ - get
Max Listeners
+ - has
Header
+ - header +
- links +
- listener
Count
+ - listeners +
- location +
- off +
- on +
- once +
- pipe +
- prepend
Listener
+ - prepend
Once Listener
+ - raw
Listeners
+ - redirect +
- remove
All Listeners
+ - remove
Header
+ - remove
Listener
+ - render +
- send
File
+ - send
Status
+ - sendfile +
- set +
- set
Default Encoding
+ - set
Header
+ - set
Max Listeners
+ - set
Timeout
+ - status +
- type +
- uncork +
- vary +
- write +
- write
Continue
+ - write
Head
+ - write
Processing
+ - listener
Count
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
req: IncomingMessage
+
+
Returns OpenidResponse
+
+ -
+
Properties
+app
+ + +charset
+ + +chunkedEncoding
+
+
+ connection
+ + +
+
+
+ destroyed
+ + +finished
+ + +headersSent
+
+
+ json
+ + +
+
+
+
+ Send JSON response.
+Examples:
+res.json(null);
+res.json({ user: 'tj' });
+res.status(500).json('oh noes!');
+res.status(404).json('I dont have that');jsonp
+ + +
+
+
+
+ Send JSON response with JSONP callback support.
+Examples:
+res.jsonp(null);
+res.jsonp({ user: 'tj' });
+res.status(500).jsonp('oh noes!');
+res.status(404).jsonp('I dont have that');locals
+ + +oidc
+ + +
+
+
+
+ Library namespace for authentication methods and data.
+Optional req
+ + +
+
+
+
+ After middleware.init executed, Response will contain req property + See: express/lib/middleware/init.js
+send
+ + +
+
+
+
+ Send a response.
+Examples:
+res.send(new Buffer('wahoo'));
+res.send({ some: 'json' });
+res.send('<p>some html</p>');
+res.status(404).send('Sorry, cant find that');sendDate
+
+
+ shouldKeepAlive
+
+
+ socket
+ + +statusCode
+
+
+ statusMessage
+
+
+ upgrading
+ + +useChunkedEncodingByDefault
+
+
+ Readonly writable
+ + +Readonly writableCorked
+
+
+ Readonly writableEnded
+
+
+ writableFinished
+
+
+ Readonly writableHighWaterMark
+
+
+ Readonly writableLength
+
+
+ Readonly writableObjectMode
+
+
+ Static defaultMaxListeners
+
+
+ Methods
+_destroy
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
error: Error | null
+
+ -
+
callback: (error?: Error | null) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional error: Error | null
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns void
+
+ -
+
_final
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
callback: (error?: Error | null) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional error: Error | null
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns void
+
+ -
+
_write
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
chunk: any
+
+ -
+
encoding: string
+
+ -
+
callback: (error?: Error | null) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional error: Error | null
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns void
+
+ -
+
Optional _writev
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
chunks: Array<{ chunk: any; encoding: string }>
+
+ -
+
callback: (error?: Error | null) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional error: Error | null
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns void
+
+ -
+
addListener
+ -
+
+
+
+
+
+
+
+
-
+
-
+
+ ++++
Event emitter + The defined events on documents including:
+-
+
- close +
- drain +
- error +
- finish +
- pipe +
- unpipe +
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
+
Parameters
+-
+
-
+
event: "drain"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "finish"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "pipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "unpipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
addTrailers
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
headers: OutgoingHttpHeaders | Array<[string, string]>
+
+
Returns void
+
+ -
+
append
+-
+
+
-
+
-
+
+ ++++
Appends the specified value to the HTTP response header field. + If the header is not already set, it creates the header with the specified value. + The value parameter can be a string or an array.
+Note: calling res.set() after res.append() will reset the previously-set header value.
+ +Parameters
+-
+
-
+
field: string
+
+ -
+
Optional value: string[] | string
+
+
Returns this
+
+ -
+
assignSocket
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
socket: Socket
+
+
Returns void
+
+ -
+
attachment
+-
+
+
-
+
-
+
+ ++++
Set Content-Disposition header to attachment with optional
+filename.Parameters
+-
+
-
+
Optional filename: string
+
+
Returns this
+
+ -
+
clearCookie
+ -
+
+
-
+
-
+
+ ++++
Clear cookie
+name.Parameters
+-
+
-
+
name: string
+
+ -
+
Optional options: any
+
+
Returns this
+
+ -
+
contentType
+ -
+
+
-
+
-
+
+ ++++
Set Content-Type response header with
+typethroughmime.lookup()+ when it does not contain "/", or set the Content-Type totypeotherwise.Examples:
+res.type('.html'); +res.type('html'); +res.type('json'); +res.type('application/json'); +res.type('png');Parameters
+-
+
-
+
type: string
+
+
Returns this
+
+ -
+
cookie
+-
+
+
+
+
-
+
-
+
+ ++++
Set cookie
+nametoval, with the givenoptions.Options:
+-
+
maxAgemax-age in milliseconds, converted toexpires
+ signedsign the cookie
+ pathdefaults to "/"
+
Examples:
+// "Remember Me" for 15 minutes + res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true });
+// save as above + res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true })
+Parameters
+-
+
-
+
name: string
+
+ -
+
val: string
+
+ -
+
options: CookieOptions
+
+
Returns this
+
+ -
+
+
Parameters
+-
+
-
+
name: string
+
+ -
+
val: any
+
+ -
+
options: CookieOptions
+
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
name: string
+
+ -
+
val: any
+
+
Returns this
+
+ -
+
cork
+-
+
+
-
+
-
+
+
Returns void
+
+
destroy
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional error: Error
+
+
Returns void
+
+ -
+
detachSocket
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
socket: Socket
+
+
Returns void
+
+ -
+
download
+-
+
+
+
+
-
+
-
+
+ ++++
Transfer the file at the given
+pathas an attachment.Optionally providing an alternate attachment
+filename, + and optional callbackfn(err). The callback is invoked + when the data transfer is complete, or when an error has + ocurred. Be sure to checkres.headerSentif you plan to respond.The optional options argument passes through to the underlying + res.sendFile() call, and takes the exact same parameters.
+This method uses
+res.sendfile().Parameters
+-
+
-
+
path: string
+
+ -
+
Optional fn: Errback
+
+
Returns void
+
+ -
+
-
+
+
Parameters
+-
+
-
+
path: string
+
+ -
+
filename: string
+
+ -
+
Optional fn: Errback
+
+
Returns void
+
+ -
+
-
+
+
Parameters
+-
+
-
+
path: string
+
+ -
+
filename: string
+
+ -
+
options: any
+
+ -
+
Optional fn: Errback
+
+
Returns void
+
+ -
+
emit
+-
+
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "drain"
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
err: Error
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "finish"
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "pipe"
+
+ -
+
src: Readable
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "unpipe"
+
+ -
+
src: Readable
+
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
end
+-
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional cb: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns void
+
+ -
+
-
+
+
Parameters
+-
+
-
+
chunk: any
+
+ -
+
Optional cb: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns void
+
+ -
+
-
+
+
Parameters
+-
+
-
+
chunk: any
+
+ -
+
encoding: string
+
+ -
+
Optional cb: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns void
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
flushHeaders
+ -
+
+
-
+
-
+
+
Returns void
+
+
format
+-
+
+
-
+
-
+
+ ++++
Respond to the Acceptable formats using an
+obj+ of mime-type callbacks.This method uses
+req.accepted, an array of + acceptable types ordered by their quality values. + When "Accept" is not present the first callback + is invoked, otherwise the first match is used. When + no match is performed the server responds with + 406 "Not Acceptable".Content-Type is set for you, however if you choose + you may alter this within the callback using
+res.type()+ orres.set('Content-Type', ...).res.format({ + 'text/plain': function(){ + res.send('hey'); + },
+'text/html': function(){ + res.send('<p>hey</p>'); + }, + + 'appliation/json': function(){ + res.send({ message: 'hey' }); + }});
+In addition to canonicalized MIME types you may + also use extnames mapped to these types:
+res.format({ + text: function(){ + res.send('hey'); + },
+html: function(){ + res.send('<p>hey</p>'); + }, + + json: function(){ + res.send({ message: 'hey' }); + }});
+By default Express passes an
+Error+ with a.statusof 406 tonext(err)+ if a match is not made. If you provide + a.defaultcallback it will be invoked + instead.Parameters
+-
+
-
+
obj: any
+
+
Returns this
+
+ -
+
get
+-
+
+
-
+
-
+
+ ++++
Get value for header
+field.Parameters
+-
+
-
+
field: string
+
+
Returns string
+
+ -
+
getHeader
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
name: string
+
+
Returns number | string | string[] | undefined
+
+ -
+
getHeaderNames
+ -
+
+
-
+
-
+
+
Returns string[]
+
+
getHeaders
+ -
+
+
-
+
-
+
+
Returns OutgoingHttpHeaders
+
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
hasHeader
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
name: string
+
+
Returns boolean
+
+ -
+
header
+-
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
field: any
+
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
field: string
+
+ -
+
Optional value: string | string[]
+
+
Returns this
+
+ -
+
links
+-
+
+
-
+
-
+
+ ++++
Set Link header field with the given
+links.Examples:
+res.links({ + next: 'http://api.example.com/users?page=2', + last: 'http://api.example.com/users?page=5' + });
+Parameters
+-
+
-
+
links: any
+
+
Returns this
+
+ -
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
type: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
location
+-
+
+
-
+
-
+
+ ++++
Set the location header to
+url.The given
+urlcan also be the name of a mapped url, for + example by default express supports "back" which redirects + to the Referrer or Referer headers or "/".Examples:
+res.location('/foo/bar').; + res.location('http://example.com'); + res.location('../login'); // /blog/post/1 -> /blog/login
+Mounting:
+When an application is mounted and
+res.location()+ is given a path that does not lead with "/" it becomes + relative to the mount-point. For example if the application + is mounted at "/blog", the following would become "/blog/login".res.location('login');While the leading slash would result in a location of "/login":
+res.location('/login');Parameters
+-
+
-
+
url: string
+
+
Returns this
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "drain"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "finish"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "pipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "unpipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "drain"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "finish"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "pipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "unpipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
pipe
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
T: WritableStream
+
+
Parameters
+-
+
-
+
destination: T
+
+ -
+
Optional options: { end?: boolean }
+-
+
-
+
Optional end?: boolean
+
+
+ -
+
Returns T
+
+ -
+
prependListener
+ -
+
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "drain"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "finish"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "pipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "unpipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "drain"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "finish"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "pipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "unpipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
redirect
+-
+
+
+
+
-
+
-
+
+ ++++
Redirect to the given
+urlwith optional responsestatus+ defaulting to 302.The resulting
+urlis determined byres.location(), so + it will play nicely with mounted apps, relative paths, +"back"etc.Examples:
+res.redirect('/foo/bar'); + res.redirect('http://example.com'); + res.redirect(301, 'http://example.com'); + res.redirect('http://example.com', 301); + res.redirect('../login'); // /blog/post/1 -> /blog/login
+Parameters
+-
+
-
+
url: string
+
+
Returns void
+
+ -
+
-
+
+
Parameters
+-
+
-
+
status: number
+
+ -
+
url: string
+
+
Returns void
+
+ -
+
-
+
+
Parameters
+-
+
-
+
url: string
+
+ -
+
status: number
+
+
Returns void
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeHeader
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
name: string
+
+
Returns void
+
+ -
+
removeListener
+ -
+
+
+
+
+
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: "close"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "drain"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "error"
+
+ -
+
listener: (err: Error) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "finish"
+
+ -
+
listener: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "pipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: "unpipe"
+
+ -
+
listener: (src: Readable) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
src: Readable
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
render
+-
+
+
+
-
+
-
+
+ ++++
Render
+viewwith the givenoptionsand optional callbackfn. + When a callback function is given a response will not be made + automatically, otherwise a response of 200 and text/html is given.Options:
+-
+
cacheboolean hinting to the engine it should cache
+ filenamefilename of the view being rendered
+
Parameters
+-
+
-
+
view: string
+
+ -
+
Optional options: object
+
+ -
+
Optional callback: (err: Error, html: string) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+ -
+
html: string
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns void
+
+ -
+
+
Parameters
+-
+
-
+
view: string
+
+ -
+
Optional callback: (err: Error, html: string) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
err: Error
+
+ -
+
html: string
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns void
+
+ -
+
sendFile
+ -
+
+
+
-
+
-
+
+ ++++
Transfer the file at the given
+path.Automatically sets the Content-Type response header field. + The callback
+fn(err)is invoked when the transfer is complete + or when an error occurs. Be sure to checkres.sentHeader+ if you wish to attempt responding, as the header and some data + may have already been transferred.Options:
+-
+
maxAgedefaulting to 0 (can be string converted byms)
+ rootroot directory for relative filenames
+ headersobject of headers to serve with file
+ dotfilesserve dotfiles, defaulting to false; can be"allow"to send them
+
Other options are passed along to
+send.Examples:
+The following example illustrates how
+res.sendFile()may + be used as an alternative for thestatic()middleware for + dynamic situations. The code backingres.sendFile()is actually + the same code, so HTTP cache support etc is identical.app.get('/user/:uid/photos/:file', function(req, res){ + var uid = req.params.uid + , file = req.params.file; + + req.user.mayViewFilesFrom(uid, function(yes){ + if (yes) { + res.sendFile('/uploads/' + uid + '/' + file); + } else { + res.send(403, 'Sorry! you cant see that.'); + } + }); +});Parameters
+-
+
-
+
path: string
+
+ -
+
Optional fn: Errback
+
+
Returns void
+
+ -
+
+
Parameters
+-
+
-
+
path: string
+
+ -
+
options: any
+
+ -
+
Optional fn: Errback
+
+
Returns void
+
+ -
+
sendStatus
+ -
+
+
-
+
-
+
+ ++++ +
Set the response HTTP status code to
+statusCodeand send its string representation as the response body.Parameters
+-
+
-
+
code: number
+
+
Returns this
+
+ -
+
sendfile
+-
+
+
+
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
path: string
+
+
Returns void
+
+ -
+
-
+
+ + ++
Parameters
+-
+
-
+
path: string
+
+ -
+
options: any
+
+
Returns void
+
+ -
+
-
+
+ + ++
Parameters
+-
+
-
+
path: string
+
+ -
+
fn: Errback
+
+
Returns void
+
+ -
+
-
+
+ + ++
Parameters
+-
+
-
+
path: string
+
+ -
+
options: any
+
+ -
+
fn: Errback
+
+
Returns void
+
+ -
+
set
+-
+
+
+
-
+
-
+
+ ++++
Set header
+fieldtoval, or pass + an object of header fields.Examples:
+res.set('Foo', ['bar', 'baz']); + res.set('Accept', 'application/json'); + res.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
+Aliased as
+res.header().Parameters
+-
+
-
+
field: any
+
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
field: string
+
+ -
+
Optional value: string | string[]
+
+
Returns this
+
+ -
+
setDefaultEncoding
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
encoding: string
+
+
Returns this
+
+ -
+
setHeader
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
name: string
+
+ -
+
value: number | string | string[]
+
+
Returns void
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
setTimeout
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
msecs: number
+
+ -
+
Optional callback: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns this
+
+ -
+
status
+-
+
+
-
+
-
+
+ ++++
Set status
+code.Parameters
+-
+
-
+
code: number
+
+
Returns this
+
+ -
+
type
+-
+
+
-
+
-
+
+ ++++
Set Content-Type response header with
+typethroughmime.lookup()+ when it does not contain "/", or set the Content-Type totypeotherwise.Examples:
+res.type('.html'); +res.type('html'); +res.type('json'); +res.type('application/json'); +res.type('png');Parameters
+-
+
-
+
type: string
+
+
Returns this
+
+ -
+
uncork
+-
+
+
-
+
-
+
+
Returns void
+
+
vary
+-
+
+
-
+
-
+
+ ++++
Adds the field to the Vary response header, if it is not there already. + Examples:
+res.vary('User-Agent').render('docs');Parameters
+-
+
-
+
field: string
+
+
Returns this
+
+ -
+
write
+-
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
chunk: any
+
+ -
+
Optional cb: (error: Error | null | undefined) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
error: Error | null | undefined
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns boolean
+
+ -
+
-
+
+
Parameters
+-
+
-
+
chunk: any
+
+ -
+
encoding: string
+
+ -
+
Optional cb: (error: Error | null | undefined) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
error: Error | null | undefined
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns boolean
+
+ -
+
writeContinue
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional callback: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
Returns void
+
+ -
+
writeHead
+ -
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
statusCode: number
+
+ -
+
Optional reasonPhrase: string
+
+ -
+
Optional headers: OutgoingHttpHeaders
+
+
Returns this
+
+ -
+
-
+
+
Parameters
+-
+
-
+
statusCode: number
+
+ -
+
Optional headers: OutgoingHttpHeaders
+
+
Returns this
+
+ -
+
writeProcessing
+ -
+
+
-
+
-
+
+
Returns void
+
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/responsecontext.html b/docs/interfaces/responsecontext.html
new file mode 100644
index 00000000..7b827d0d
--- /dev/null
+++ b/docs/interfaces/responsecontext.html
@@ -0,0 +1,2920 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional access
+
+
+
+
+
+ Optional id
+
+
+
+
+
+ Optional id
+
+
+
+
+
+ is
+
+
+
+
+
+ Optional refresh
+
+
+
+
+
+
+
+
+
+
+ fetch
+
+
+
+
+
+
+
+
+ The request authentication context found on the Express request when + OpenID Connect auth middleware is added to your application.
+app.use(auth());
+
+app.get('/profile', (req, res) => {
+ const user = req.oidc.user;
+ ...
+})Hierarchy
+-
+
- + RequestContext + +
Index
+
+
+
+
+
+
+ Properties
+-
+
- access
Token
+ - id
Token
+ - id
Token Claims
+ - is
Authenticated
+ - refresh
Token
+ - user +
Methods
+-
+
- fetch
User Info
+
Properties
+Optional accessToken
+
+
+
+
+
+
+
+ Credentials that can be used by an application to access an API.
+Optional idToken
+
+
+
+
+
+
+
+ The OpenID Connect ID Token.
+Optional idTokenClaims
+
+
+
+
+
+
+ An object containing all the claims of the ID Token.
+isAuthenticated
+
+
+
+
+
+
+ Method to check the user's authenticated state, returns true if logged in.
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Returns boolean
+
+
+ -
+
Optional refreshToken
+
+
+
+
+
+
+
+ Credentials that can be used to refresh an access token.
+Optional user
+ + +
+
+
+
+ An object containing all the claims of the ID Token with the claims + specified in identityClaimFilter removed.
+Methods
+fetchUserInfo
+ -
+
+
-
+
-
+
+ ++++
Fetches the OIDC userinfo response.
+app.use(auth()); + +app.get('/user-info', async (req, res) => { + const userInfo = await req.oidc.fetchUserInfo(); + res.json(userInfo); +})Returns Promise<UserinfoResponse>
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/sessionconfigparams.html b/docs/interfaces/sessionconfigparams.html
new file mode 100644
index 00000000..6c8f756c
--- /dev/null
+++ b/docs/interfaces/sessionconfigparams.html
@@ -0,0 +1,3031 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The response authentication context found on the Express response when + OpenID Connect auth middleware is added to your application.
+app.use(auth());
+
+app.get('/admin-login', (req, res) => {
+ res.openid.login({ returnTo: '/admin' })
+})Hierarchy
+-
+
- + ResponseContext + +
Index
+Properties
+login
+ + +
+
+
+
+ Provided by default via the /login route. Call this to override or have other
+ login routes with custom authorizationParams or returnTo
app.get('/admin-login', (req, res) => {
+ res.oidc.login({
+ returnTo: '/admin',
+ authorizationParams: {
+ scope: 'openid profile email admin:user',
+ }
+ });
+});
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional opts: LoginOptions
+
+
Returns Promise<void>
+
+ -
+
+ -
+
logout
+ + +
+
+
+
+ Provided by default via the /logout route. Call this to override or have other
+ logout routes with custom returnTo
app.get('/admin-logout', (req, res) => {
+ res.oidc.logout({ returnTo: '/admin-welcome' })
+});
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional opts: LogoutOptions
+
+
Returns Promise<void>
+
+ -
+
+ -
+
+
+
+
+
\ No newline at end of file
diff --git a/end-to-end/access-an-api.js b/end-to-end/access-an-api.js
new file mode 100644
index 00000000..0f87e901
--- /dev/null
+++ b/end-to-end/access-an-api.js
@@ -0,0 +1,87 @@
+const { assert } = require('chai');
+const sinon = require('sinon');
+const puppeteer = require('puppeteer');
+const provider = require('./fixture/oidc-provider');
+const {
+ baseUrl,
+ start,
+ runExample,
+ runApi,
+ stubEnv,
+ checkContext,
+ goto,
+ login,
+} = require('./fixture/helpers');
+
+describe('access an api', async () => {
+ let authServer;
+ let appServer;
+ let apiServer;
+
+ beforeEach(async () => {
+ stubEnv();
+ authServer = await start(provider, 3001);
+ appServer = await runExample('access-an-api');
+ apiServer = await runApi();
+ });
+
+ afterEach(async () => {
+ authServer.close();
+ appServer.close();
+ apiServer.close();
+ });
+
+ it('should get an access token and access an api', async () => {
+ const browser = await puppeteer.launch({
+ args: ['no-sandbox', 'disable-setuid-sandbox'],
+ });
+ const page = await browser.newPage();
+
+ const clock = sinon.useFakeTimers({
+ now: Date.now(),
+ toFake: ['Date'],
+ });
+
+ await goto(baseUrl, page);
+
+ await login('username', 'password', page);
+
+ assert.equal(
+ page.url(),
+ `${baseUrl}/`,
+ 'User is returned to the original page'
+ );
+ const {
+ accessToken: { access_token, expires_in },
+ } = await checkContext(await page.cookies());
+ assert.isOk(access_token);
+ const content = await page.content();
+ assert.include(
+ content,
+ 'Products: Football boots, Running shoes, Flip flops',
+ 'Page should access products api and show a list of items'
+ );
+ clock.tick(expires_in * 10000);
+ const {
+ accessToken: { isExpired },
+ } = await checkContext(await page.cookies());
+ assert.ok(isExpired);
+
+ await page.reload();
+
+ const reloadedContent = await page.content();
+ assert.include(
+ reloadedContent,
+ 'Products: Football boots, Running shoes, Flip flops',
+ 'Page should access products api with refreshed token and show a list of items'
+ );
+ const {
+ accessToken: { access_token: new_access_token, isExpired: newIsExpired },
+ } = await checkContext(await page.cookies());
+
+ assert.isOk(new_access_token);
+ assert.notOk(newIsExpired);
+ assert.notEqual(new_access_token, access_token);
+ clock.restore();
+ });
+});
diff --git a/end-to-end/basic.test.js b/end-to-end/basic.test.js
new file mode 100644
index 00000000..38b36df5
--- /dev/null
+++ b/end-to-end/basic.test.js
@@ -0,0 +1,62 @@
+const { assert } = require('chai');
+const puppeteer = require('puppeteer');
+const provider = require('./fixture/oidc-provider');
+const {
+ baseUrl,
+ start,
+ runExample,
+ stubEnv,
+ checkContext,
+ goto,
+ login,
+ logout,
+} = require('./fixture/helpers');
+
+describe('basic login and logout', async () => {
+ let authServer;
+ let appServer;
+
+ beforeEach(async () => {
+ stubEnv();
+ authServer = await start(provider, 3001);
+ appServer = await runExample('basic');
+ });
+
+ afterEach(async () => {
+ authServer.close();
+ appServer.close();
+ });
+
+ it('should login and logout with default configuration', async () => {
+ const browser = await puppeteer.launch({
+ args: ['no-sandbox', 'disable-setuid-sandbox'],
+ });
+ const page = await browser.newPage();
+ await goto(baseUrl, page);
+ assert.match(
+ page.url(),
+ /http:\/\/localhost:3001\/interaction/,
+ 'User should have been redirected to the auth server to login'
+ );
+ await login('username', 'password', page);
+ assert.equal(
+ page.url(),
+ `${baseUrl}/`,
+ 'User is returned to the original page'
+ );
+ const loggedInCookies = await page.cookies('http://localhost:3000');
+ assert.ok(loggedInCookies.find(({ name }) => name === 'appSession'));
+
+ const response = await checkContext(await page.cookies());
+ assert.isOk(response.isAuthenticated);
+ assert.equal(response.user.sub, 'username');
+ assert.empty(
+ response.accessToken,
+ "default response_type doesn't include code"
+ );
+ await logout(page);
+
+ const loggedOutCookies = await page.cookies('http://localhost:3000');
+ assert.notOk(loggedOutCookies.find(({ name }) => name === 'appSession'));
+ });
+});
diff --git a/end-to-end/fixture/helpers.js b/end-to-end/fixture/helpers.js
new file mode 100644
index 00000000..9a9e4ff8
--- /dev/null
+++ b/end-to-end/fixture/helpers.js
@@ -0,0 +1,103 @@
+const path = require('path');
+const sinon = require('sinon');
+const express = require('express');
+const request = require('request-promise-native').defaults({ json: true });
+
+const baseUrl = 'http://localhost:3000';
+
+const start = (app, port) =>
+ new Promise((resolve, reject) => {
+ const server = app.listen(port, (err) => {
+ if (err) {
+ reject(err);
+ } else {
+ resolve(server);
+ }
+ });
+ });
+
+const runExample = (name) => {
+ const app = require(path.join('..', '..', 'examples', name));
+ app.use(testMw());
+ return start(app, 3000);
+};
+
+const runApi = () => {
+ const app = require(path.join('..', '..', 'examples', 'api'));
+ return start(app, 3002);
+};
+
+const stubEnv = (
+ env = {
+ ISSUER_BASE_URL: 'http://localhost:3001',
+ CLIENT_ID: 'test-express-openid-connect-client-id',
+ BASE_URL: 'http://localhost:3000',
+ SECRET: 'LONG_RANDOM_VALUE',
+ CLIENT_SECRET: 'test-express-openid-connect-client-secret',
+ }
+) =>
+ sinon.stub(process, 'env').value({
+ ...process.env,
+ ...env,
+ });
+
+const testMw = () => {
+ const router = new express.Router();
+ router.get('/context', (req, res) => {
+ res.json({
+ idToken: req.oidc.idToken,
+ accessToken: req.oidc.accessToken
+ ? {
+ access_token: req.oidc.accessToken.access_token,
+ token_type: req.oidc.accessToken.token_type,
+ expires_in: req.oidc.accessToken.expires_in,
+ isExpired: req.oidc.accessToken.isExpired(),
+ }
+ : {},
+ refreshToken: req.oidc.refreshToken,
+ idTokenClaims: req.oidc.idTokenClaims,
+ user: req.oidc.user,
+ isAuthenticated: req.oidc.isAuthenticated(),
+ });
+ });
+ return router;
+};
+
+const checkContext = async (cookies) => {
+ const jar = request.jar();
+ cookies.forEach(({ name, value }) =>
+ jar.setCookie(`${name}=${value}`, baseUrl)
+ );
+ return request('/context', { jar, baseUrl });
+};
+
+const goto = async (url, page) =>
+ Promise.all([page.goto(url), page.waitForNavigation()]);
+
+const login = async (username, password, page) => {
+ await page.type('[name=login]', username);
+ await page.type('[name=password]', password);
+ await Promise.all([page.click('.login-submit'), page.waitForNavigation()]);
+ await Promise.all([page.click('.login-submit'), page.waitForNavigation()]); // consent
+ if (!page.url().startsWith('http://localhost:3000')) {
+ await page.waitForNavigation();
+ }
+};
+
+const logout = async (page) => {
+ await goto(`${baseUrl}/logout`, page);
+ await Promise.all([page.click('[name=logout]'), page.waitForNavigation()]);
+};
+
+module.exports = {
+ baseUrl,
+ start,
+ runExample,
+ runApi,
+ stubEnv,
+ testMw,
+ checkContext,
+ goto,
+ login,
+ logout,
+};
diff --git a/end-to-end/fixture/oidc-provider.js b/end-to-end/fixture/oidc-provider.js
new file mode 100644
index 00000000..19eb6570
--- /dev/null
+++ b/end-to-end/fixture/oidc-provider.js
@@ -0,0 +1,49 @@
+const Provider = require('oidc-provider');
+
+const config = {
+ clients: [
+ {
+ client_id: 'test-express-openid-connect-client-id',
+ client_secret: 'test-express-openid-connect-client-secret',
+ token_endpoint_auth_method: 'client_secret_basic',
+ response_types: ['id_token', 'code', 'code id_token'],
+ grant_types: ['implicit', 'authorization_code', 'refresh_token'],
+ redirect_uris: [`http://localhost:3000/callback`],
+ post_logout_redirect_uris: [
+ 'http://localhost:3000',
+ 'http://localhost:3000/custom-logout',
+ ],
+ },
+ ],
+ formats: {
+ AccessToken: 'jwt',
+ },
+ audiences() {
+ return 'https://api.example.com/products';
+ },
+ scopes: ['openid', 'offline_access', 'read:products'],
+ findAccount(ctx, id) {
+ return {
+ accountId: id,
+ claims: () => ({ sub: id }),
+ };
+ },
+};
+
+const PORT = process.env.PROVIDER_PORT || 3001;
+
+const provider = new Provider(`http://localhost:${PORT}`, config);
+
+// Monkey patch the provider to allow localhost and http redirect uris
+const { invalidate: orig } = provider.Client.Schema.prototype;
+provider.Client.Schema.prototype.invalidate = function invalidate(
+ message,
+ code
+) {
+ if (code === 'implicit-force-https' || code === 'implicit-forbid-localhost') {
+ return;
+ }
+ orig.call(this, message);
+};
+
+module.exports = provider;
diff --git a/end-to-end/userinfo.test.js b/end-to-end/userinfo.test.js
new file mode 100644
index 00000000..7e969afc
--- /dev/null
+++ b/end-to-end/userinfo.test.js
@@ -0,0 +1,48 @@
+const { assert } = require('chai');
+const puppeteer = require('puppeteer');
+const provider = require('./fixture/oidc-provider');
+const {
+ baseUrl,
+ start,
+ runExample,
+ stubEnv,
+ goto,
+ login,
+} = require('./fixture/helpers');
+
+describe('fetch userinfo', async () => {
+ let authServer;
+ let appServer;
+
+ beforeEach(async () => {
+ stubEnv();
+ authServer = await start(provider, 3001);
+ appServer = await runExample('userinfo');
+ });
+
+ afterEach(async () => {
+ authServer.close();
+ appServer.close();
+ });
+
+ it('should login with hybrid flow and fetch userinfo', async () => {
+ const browser = await puppeteer.launch({
+ args: ['no-sandbox', 'disable-setuid-sandbox'],
+ });
+ const page = await browser.newPage();
+ await goto(baseUrl, page);
+ assert.match(
+ page.url(),
+ /http:\/\/localhost:3001\/interaction/,
+ 'User should have been redirected to the auth server to login'
+ );
+ await login('username', 'password', page);
+ assert.equal(
+ page.url(),
+ `${baseUrl}/`,
+ 'User is returned to the original page'
+ );
+
+ assert.include(await page.content(), 'hello username');
+ });
+});
diff --git a/examples/.env.sample b/examples/.env.sample
new file mode 100644
index 00000000..cbf8ce9d
--- /dev/null
+++ b/examples/.env.sample
@@ -0,0 +1,9 @@
+# For the example app
+PORT=3000
+# For the auth config
+ISSUER_BASE_URL=https://YOUR_DOMAIN
+CLIENT_ID=YOUR_CLIENT_ID
+BASE_URL=https://YOUR_APPLICATION_ROOT_URL
+SECRET=LONG_RANDOM_VALUE
+# For response_type values that include 'code'
+CLIENT_SECRET=YOUR_CLIENT_SECRET
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 00000000..c4f6b900
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,23 @@
+# Examples
+
+To run an example `npm run start:example -- "name of example"`. Eg to run the basic example at `./basic.js`:
+
+```shell script
+$ npm run start:example -- basic
+```
+
+To run the example against your authorization server add the following items to your `./examples/.env`
+
+```shell script
+# For the example app
+PORT=3000
+# For the auth config
+ISSUER_BASE_URL=https://YOUR_DOMAIN
+CLIENT_ID=YOUR_CLIENT_ID
+BASE_URL=https://YOUR_APPLICATION_ROOT_URL
+SECRET=LONG_RANDOM_VALUE
+# For response_type values that include 'code'
+CLIENT_SECRET=YOUR_CLIENT_SECRET
+```
+
+If you do not specify an env file, we will configure one for you and start a mock authorisation server. To login to this authorisation server, use any credentials, and the username will be reflected in the `sub` claim of the ID Token.
diff --git a/examples/access-an-api.js b/examples/access-an-api.js
new file mode 100644
index 00000000..d077b916
--- /dev/null
+++ b/examples/access-an-api.js
@@ -0,0 +1,34 @@
+const express = require('express');
+const request = require('request-promise-native');
+const { auth } = require('../');
+
+const app = express();
+
+const { API_PORT = 3002 } = process.env;
+
+app.use(
+ auth({
+ authorizationParams: {
+ response_type: 'code',
+ audience: 'https://api.example.com/products',
+ scope: 'openid profile email offline_access read:products',
+ prompt: 'consent',
+ },
+ })
+);
+
+app.get('/', async (req, res) => {
+ let { token_type, access_token, isExpired, refresh } = req.oidc.accessToken;
+ if (isExpired()) {
+ ({ access_token } = await refresh());
+ }
+ const products = await request.get(`http://localhost:${API_PORT}/products`, {
+ headers: {
+ Authorization: `${token_type} ${access_token}`,
+ },
+ json: true,
+ });
+ res.send(`Products: ${products.map(({ name }) => name).join(', ')}`);
+});
+
+module.exports = app;
diff --git a/examples/api.js b/examples/api.js
new file mode 100644
index 00000000..65c89747
--- /dev/null
+++ b/examples/api.js
@@ -0,0 +1,17 @@
+process.env.ALLOWED_AUDIENCES = 'https://api.example.com/products';
+
+const express = require('express');
+const { auth, requiredScopes } = require('express-oauth2-bearer');
+
+const app = express();
+app.use(auth());
+
+app.get('/products', requiredScopes('read:products'), (req, res) => {
+ res.json([
+ { id: 1, name: 'Football boots' },
+ { id: 2, name: 'Running shoes' },
+ { id: 3, name: 'Flip flops' },
+ ]);
+});
+
+module.exports = app;
diff --git a/examples/basic.js b/examples/basic.js
new file mode 100644
index 00000000..9a2d56c8
--- /dev/null
+++ b/examples/basic.js
@@ -0,0 +1,16 @@
+const express = require('express');
+const { auth } = require('../');
+
+const app = express();
+
+app.use(
+ auth({
+ idpLogout: true,
+ })
+);
+
+app.get('/', (req, res) => {
+ res.send(`hello ${req.oidc.user.sub}`);
+});
+
+module.exports = app;
diff --git a/examples/custom-routes.js b/examples/custom-routes.js
new file mode 100644
index 00000000..e59974cb
--- /dev/null
+++ b/examples/custom-routes.js
@@ -0,0 +1,30 @@
+const express = require('express');
+const { auth, requiresAuth } = require('../');
+
+const app = express();
+
+app.use(
+ auth({
+ idpLogout: true,
+ authRequired: false,
+ routes: {
+ // Pass custom options to the login method by overriding the default login route
+ login: false,
+ // Pass a custom path to the postLogoutRedirect to redirect users to a different
+ // path after login, this should be registered on your authorization server.
+ postLogoutRedirect: '/custom-logout',
+ },
+ })
+);
+
+app.get('/', (req, res) => res.send('Welcome!'));
+
+app.get('/profile', requiresAuth(), (req, res) =>
+ res.send(`hello ${req.oidc.user.sub}`)
+);
+
+app.get('/login', (req, res) => res.oidc.login({ returnTo: '/profile' }));
+
+app.get('/custom-logout', (req, res) => res.send('Bye!'));
+
+module.exports = app;
diff --git a/examples/routes.js b/examples/routes.js
new file mode 100644
index 00000000..8ae1caf8
--- /dev/null
+++ b/examples/routes.js
@@ -0,0 +1,22 @@
+const express = require('express');
+const { auth, requiresAuth } = require('../');
+
+const app = express();
+
+app.use(
+ auth({
+ authRequired: false
+ })
+);
+
+// Anyone can access the homepage
+app.get('/', (req, res) => {
+ res.send('Admin Section');
+});
+
+// requiresAuth checks authentication.
+app.get('/admin', requiresAuth(), (req, res) =>
+ res.send(`Hello ${req.oidc.user.sub}, this is the admin section.`)
+);
+
+module.exports = app;
diff --git a/examples/run_example.js b/examples/run_example.js
new file mode 100644
index 00000000..bc51ffa3
--- /dev/null
+++ b/examples/run_example.js
@@ -0,0 +1,39 @@
+const path = require('path');
+
+require('dotenv').config();
+
+const { PORT = 3000, PROVIDER_PORT = 3001, API_PORT = 3002 } = process.env;
+
+const example = process.argv.pop();
+
+// Configure and start a mock authorization server if no .env config is found
+if (!process.env.CLIENT_ID) {
+ const provider = require('../end-to-end/fixture/oidc-provider');
+ console.log(
+ 'Starting a mock authorization server. You can login with any credentials.'
+ );
+ process.env = {
+ ...process.env,
+ ISSUER_BASE_URL: `http://localhost:${PROVIDER_PORT}`,
+ CLIENT_ID: 'test-express-openid-connect-client-id',
+ BASE_URL: `http://localhost:${PORT}`,
+ SECRET: 'LONG_RANDOM_VALUE',
+ CLIENT_SECRET: 'test-express-openid-connect-client-secret',
+ };
+ provider.listen(PROVIDER_PORT, () =>
+ console.log(
+ `Authorization server started at http://localhost:${PROVIDER_PORT}`
+ )
+ );
+}
+
+const api = require(path.join(__dirname, 'api'));
+api.listen(API_PORT, () =>
+ console.log(`API started at http://localhost:${API_PORT}`)
+);
+
+const app = require(path.join(__dirname, example));
+
+app.listen(PORT, () =>
+ console.log(`Example app started at http://localhost:${PORT}`)
+);
diff --git a/examples/userinfo.js b/examples/userinfo.js
new file mode 100644
index 00000000..e4dbb4df
--- /dev/null
+++ b/examples/userinfo.js
@@ -0,0 +1,20 @@
+const express = require('express');
+const { auth } = require('../');
+
+const app = express();
+
+app.use(
+ auth({
+ idpLogout: true,
+ authorizationParams: {
+ response_type: 'code id_token',
+ },
+ })
+);
+
+app.get('/', async (req, res) => {
+ const userInfo = await req.oidc.fetchUserInfo();
+ res.send(`hello ${userInfo.sub}`);
+});
+
+module.exports = app;
diff --git a/index.d.ts b/index.d.ts
index 2329d09c..a50bab03 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -1,217 +1,625 @@
// Type definitions for express-openid-connect
-import { AuthorizationParameters, TokenSet, UserinfoResponse } from 'openid-client';
-import { Request, Response, NextFunction, RequestHandler, ErrorRequestHandler } from 'express';
+import {
+ AuthorizationParameters,
+ IdTokenClaims,
+ UserinfoResponse,
+} from 'openid-client';
+import { Request, Response, RequestHandler } from 'express';
+/**
+ * The Express.js Request with `oidc` context added by the `auth` middleware.
+ *
+ * ```js
+ * app.use(auth());
+ *
+ * app.get('/profile', (req, res) => {
+ * const user = req.oidc.user;
+ * ...
+ * })
+ * ```
+ */
interface OpenidRequest extends Request {
- /**
- * Library namespace for methods and data.
- * See RequestContext and ResponseContext for how this is used.
- */
- openid: object;
-
- /**
- * Decoded state for use in config.handleCallback().
- */
- openidState: object;
-
- /**
- * Tokens for use in config.handleCallback().
- */
- openidTokens: TokenSet;
+ /**
+ * Library namespace for authentication methods and data.
+ */
+ oidc: RequestContext;
}
/**
- * Configuration parameters passed to the auth() middleware.
+ * The Express.js Response with `oidc` context added by the `auth` middleware.
+ *
+ * ```js
+ * app.use(auth());
+ *
+ * app.get('/login', (req, res) => {
+ * res.oidc.login();
+ * })
+ * ```
*/
-interface ConfigParams {
- /**
- * Object defining application session cookie attributes.
- */
- appSession: boolean | AppSessionConfigParams;
-
- /**
- * Boolean value to enable Auth0's logout feature.
- */
- auth0Logout?: boolean;
-
- /**
- * URL parameters used when redirecting users to the authorization server to log in.
- */
- authorizationParams?: AuthorizationParameters
-
- /**
- * REQUIRED. The root URL for the application router.
- * Can use env key BASE_URL instead.
- */
- baseURL?: string;
-
- /**
- * REQUIRED. The Client ID for your application.
- * Can use env key CLIENT_ID instead.
- */
- clientID?: string;
-
- /**
- * The Client Secret for your application.
- * Required when requesting access tokens.
- * Can use env key CLIENT_SECRET instead.
- */
- clientSecret?: string;
-
- /**
- * Integer value for the system clock's tolerance (leeway) in seconds for ID token verification.
- */
- clockTolerance?: number;
-
- /**
- * Opt-in to sending the library and node version to your authorization server
- * via the `Auth0-Client` header.
- */
- enableTelemetry?: boolean;
-
- /**
- * Throw a 401 error instead of triggering the login process for routes that require authentication.
- */
- errorOnRequiredAuth?: boolean;
-
- /**
- * Function that returns a URL-safe state value for `res.openid.login()`.
- */
- getLoginState?: (req: OpenidRequest, config: object) => object;
-
- /**
- * Function that returns the profile for `req.openid.user`.
- */
- getUser?: (req: OpenidRequest, config: ConfigParams) => undefined | UserinfoResponse;
-
- /**
- * Function that runs on the callback route, after callback processing but before redirection.
- */
- handleCallback?: (req: OpenidRequest, res: Response, next: NextFunction) => void;
-
- /**
- * Default options object used for all HTTP calls made by the library.
- */
- httpOptions?: object;
-
- /**
- * Array value of claims to remove from the ID token before storing the cookie session.
- */
- identityClaimFilter?: string[];
+interface OpenidResponse extends Response {
+ /**
+ * Library namespace for authentication methods and data.
+ */
+ oidc: ResponseContext;
+}
- /**
- * Boolean value to log the user out from the identity provider on application logout.
- */
- idpLogout?: boolean;
+/**
+ * The request authentication context found on the Express request when
+ * OpenID Connect auth middleware is added to your application.
+ *
+ * ```js
+ * app.use(auth());
+ *
+ * app.get('/profile', (req, res) => {
+ * const user = req.oidc.user;
+ * ...
+ * })
+ * ```
+ */
+interface RequestContext {
+ /**
+ * Method to check the user's authenticated state, returns `true` if logged in.
+ */
+ isAuthenticated: () => boolean;
+
+ /**
+ * The OpenID Connect ID Token.
+ *
+ * See: https://auth0.com/docs/protocols/oidc#id-tokens
+ */
+ idToken?: string;
+
+ /**
+ * Credentials that can be used by an application to access an API.
+ *
+ * See: https://auth0.com/docs/protocols/oidc#access-tokens
+ */
+ accessToken?: AccessToken;
+
+ /**
+ * Credentials that can be used to refresh an access token.
+ *
+ * See: https://auth0.com/docs/tokens/concepts/refresh-tokens
+ */
+ refreshToken?: string;
+
+ /**
+ * An object containing all the claims of the ID Token.
+ */
+ idTokenClaims?: IdTokenClaims;
+
+ /**
+ * An object containing all the claims of the ID Token with the claims
+ * specified in {@link ConfigParams.identityClaimFilter identityClaimFilter} removed.
+ */
+ user?: object;
+
+ /**
+ * Fetches the OIDC userinfo response.
+ *
+ * ```js
+ * app.use(auth());
+ *
+ * app.get('/user-info', async (req, res) => {
+ * const userInfo = await req.oidc.fetchUserInfo();
+ * res.json(userInfo);
+ * })
+ * ```
+ *
+ */
+ fetchUserInfo(): Promise
+
+
+
+
+
+
+
+
+
+
+
+ Optional absolute
+
+
+
+
+
+
+
+
+ Optional http
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional rolling
+
+
+
+
+
+ Optional same
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Configuration parameters used for the application session.
+Hierarchy
+-
+
- + SessionConfigParams + +
Index
+
+
+
+
+ Properties
+-
+
- absolute
Duration
+ - domain +
- http
Only
+ - name +
- path +
- rolling +
- rolling
Duration
+ - same
Site
+ - secure +
- transient +
Properties
+Optional absoluteDuration
+
+
+
+
+
+
+ Integer value, in seconds, for application absolute rolling duration.
+ The amount of time after the user has logged in that they will be logged out.
+ Set this to false if you don't want an absolute duration on your session.
+ Default is 604800 seconds (7 days).
Optional domain
+ + +
+
+
+
+ Domain name for the cookie.
+ Passed to the Response cookie as domain
Optional httpOnly
+
+
+
+
+
+
+ Flags the cookie to be accessible only by the web server.
+ Passed to the Response cookie as httponly.
+ Defaults to true.
Optional name
+ + +
+
+
+
+ String value for the cookie name used for the internal session.
+ This value must only include letters, numbers, and underscores.
+ Default is appSession.
Optional path
+ + +
+
+
+
+ Path for the cookie.
+ Passed to the Response cookie as path
Optional rolling
+ + +
+
+
+
+ If you want your session duration to be rolling, eg reset everytime the
+ user is active on your site, set this to a true. If you want the session
+ duration to be absolute, where the user is logged out a fixed time after login,
+ regardless of activity, set this to false
+ Default is true.
Optional rollingDuration
+
+
+
+
+
+
+ Integer value, in seconds, for application session rolling duration. + The amount of time for which the user must be idle for then to be logged out. + Default is 86400 seconds (1 day).
+Optional sameSite
+
+
+
+
+
+
+ Value of the SameSite Set-Cookie attribute.
+ Passed to the Response cookie as samesite.
+ Defaults to "Lax" but will be adjusted based on {@link AuthorizationParameters.response_type}.
Optional secure
+ + +
+
+
+
+ Marks the cookie to be used over secure channels only.
+ Passed to the Response cookie as secure.
+ Defaults to {@link Request.secure}.
Optional transient
+ + +
+
+
+
+ Set to true to use a transient cookie (cookie without an explicit expiration).
+ Default is false
Use this MW to attempt silent login (
+prompt=none) but not require authentication.See attemptSilentLogin
+const { attemptSilentLogin } = require('express-openid-connect'); + +app.get('/', attemptSilentLogin(), (req, res) => { + res.render('homepage', { + isAuthenticated: req.isAuthenticated() // show a login or logout button + }); +}); +