Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

discovery errors should be handled in express middleware #371

Merged
merged 1 commit into from
Jun 29, 2022
Merged

discovery errors should be handled in express middleware #371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 57 additions & 55 deletions lib/context.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,50 +179,52 @@ class ResponseContext {
async login(options = {}) {
let { config, req, res, next, transient } = weakRef(this);
next = cb(next).once();
const client = await getClient(config);

// Set default returnTo value, allow passed-in options to override or use originalUrl on GET
let returnTo = config.baseURL;
if (options.returnTo) {
returnTo = options.returnTo;
debug('req.oidc.login() called with returnTo: %s', returnTo);
} else if (req.method === 'GET' && req.originalUrl) {
// Collapse any leading slashes to a single slash to prevent Open Redirects
returnTo = req.originalUrl.replace(/^\/+/, '/');
debug('req.oidc.login() without returnTo, using: %s', returnTo);
}
try {
const client = await getClient(config);

// Set default returnTo value, allow passed-in options to override or use originalUrl on GET
let returnTo = config.baseURL;
if (options.returnTo) {
returnTo = options.returnTo;
debug('req.oidc.login() called with returnTo: %s', returnTo);
} else if (req.method === 'GET' && req.originalUrl) {
// Collapse any leading slashes to a single slash to prevent Open Redirects
returnTo = req.originalUrl.replace(/^\/+/, '/');
debug('req.oidc.login() without returnTo, using: %s', returnTo);
}

options = {
authorizationParams: {},
returnTo,
...options,
};
options = {
authorizationParams: {},
returnTo,
...options,
};

// Ensure a redirect_uri, merge in configuration options, then passed-in options.
options.authorizationParams = {
redirect_uri: this.getRedirectUri(),
...config.authorizationParams,
...options.authorizationParams,
};
// Ensure a redirect_uri, merge in configuration options, then passed-in options.
options.authorizationParams = {
redirect_uri: this.getRedirectUri(),
...config.authorizationParams,
...options.authorizationParams,
};

const stateValue = await config.getLoginState(req, options);
if (typeof stateValue !== 'object') {
next(new Error('Custom state value must be an object.'));
}
stateValue.nonce = transient.generateNonce();
if (options.silent) {
stateValue.attemptingSilentLogin = true;
}
const stateValue = await config.getLoginState(req, options);
if (typeof stateValue !== 'object') {
next(new Error('Custom state value must be an object.'));
}
stateValue.nonce = transient.generateNonce();
if (options.silent) {
stateValue.attemptingSilentLogin = true;
}

const usePKCE = options.authorizationParams.response_type.includes('code');
if (usePKCE) {
debug(
'response_type includes code, the authorization request will use PKCE'
const usePKCE = options.authorizationParams.response_type.includes(
'code'
);
stateValue.code_verifier = transient.generateCodeVerifier();
}
if (usePKCE) {
debug(
'response_type includes code, the authorization request will use PKCE'
);
stateValue.code_verifier = transient.generateCodeVerifier();
}

try {
const validResponseTypes = ['id_token', 'code id_token', 'code'];
assert(
validResponseTypes.includes(options.authorizationParams.response_type),
Expand Down Expand Up @@ -275,31 +277,31 @@ class ResponseContext {
async logout(params = {}) {
let { config, req, res, next } = weakRef(this);
next = cb(next).once();
const client = await getClient(config);

let returnURL = params.returnTo || config.routes.postLogoutRedirect;
debug('req.oidc.logout() with return url: %s', returnURL);

if (url.parse(returnURL).host === null) {
returnURL = urlJoin(config.baseURL, returnURL);
}
try {
const client = await getClient(config);

cancelSilentLogin(req, res);
if (url.parse(returnURL).host === null) {
returnURL = urlJoin(config.baseURL, returnURL);
}

if (!req.oidc.isAuthenticated()) {
debug('end-user already logged out, redirecting to %s', returnURL);
return res.redirect(returnURL);
}
cancelSilentLogin(req, res);

const { idToken: id_token_hint } = req.oidc;
req[config.session.name] = undefined;
if (!req.oidc.isAuthenticated()) {
debug('end-user already logged out, redirecting to %s', returnURL);
return res.redirect(returnURL);
}

if (!config.idpLogout) {
debug('performing a local only logout, redirecting to %s', returnURL);
return res.redirect(returnURL);
}
const { idToken: id_token_hint } = req.oidc;
req[config.session.name] = undefined;

if (!config.idpLogout) {
debug('performing a local only logout, redirecting to %s', returnURL);
return res.redirect(returnURL);
}

try {
returnURL = client.endSessionUrl({
...config.logoutParams,
...params.logoutParams,
Expand Down
29 changes: 29 additions & 0 deletions test/login.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
const assert = require('chai').assert;
const url = require('url');
const querystring = require('querystring');
const nock = require('nock');
const request = require('request-promise-native').defaults({
simple: false,
resolveWithFullResponse: true,
Expand Down Expand Up @@ -419,4 +420,32 @@ describe('auth', () => {

assert.include(fetchAuthCookie(res), 'SameSite=None');
});

it('should pass discovery errors to the express mw', async () => {
nock('https://example.com')
.get('/.well-known/openid-configuration')
.reply(500);
nock('https://example.com')
.get('/.well-known/oauth-authorization-server')
.reply(500);

server = await createServer(
auth({
...defaultConfig,
issuerBaseURL: 'https://example.com',
})
);
const res = await request.get('/login', {
baseUrl,
followRedirect: false,
json: true,
});
assert.equal(res.statusCode, 500);
console.log(res.body.err.message);
assert.match(
res.body.err.message,
/^Issuer.discover\(\) failed/,
'Should get error json from server error middleware'
);
});
});
30 changes: 30 additions & 0 deletions test/logout.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
const nock = require('nock');
const { assert } = require('chai');
const { URL } = require('url');
const { create: createServer } = require('./fixture/server');
Expand Down Expand Up @@ -320,4 +321,33 @@ describe('logout route', async () => {
assert.isFalse(url.searchParams.has('baz'));
assert.equal(url.searchParams.get('qux'), '');
});

it('should pass discovery errors to the express mw', async () => {
nock('https://example.com')
.get('/.well-known/openid-configuration')
.reply(500);
nock('https://example.com')
.get('/.well-known/oauth-authorization-server')
.reply(500);

server = await createServer(
auth({
...defaultConfig,
issuerBaseURL: 'https://example.com',
})
);
const res = await request.get({
uri: '/logout',
baseUrl: 'http://localhost:3000',
followRedirect: false,
json: true,
});
assert.equal(res.statusCode, 500);
console.log(res.body.err.message);
assert.match(
res.body.err.message,
/^Issuer.discover\(\) failed/,
'Should get error json from server error middleware'
);
});
});
8 changes: 4 additions & 4 deletions test/setup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,22 @@ let warn;

beforeEach(function () {
warn = sinon.stub(global.console, 'warn');
nock('https://op.example.com', { allowUnmocked: true })
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed we didn't need these (all requests should be mocked)

nock('https://op.example.com')
.persist()
.get('/.well-known/openid-configuration')
.reply(200, wellKnown);

nock('https://op.example.com', { allowUnmocked: true })
nock('https://op.example.com')
.persist()
.get('/.well-known/jwks.json')
.reply(200, certs.jwks);

nock('https://test.eu.auth0.com', { allowUnmocked: true })
nock('https://test.eu.auth0.com')
.persist()
.get('/.well-known/openid-configuration')
.reply(200, { ...wellKnown, end_session_endpoint: undefined });

nock('https://test.eu.auth0.com', { allowUnmocked: true })
nock('https://test.eu.auth0.com')
.persist()
.get('/.well-known/jwks.json')
.reply(200, certs.jwks);
Expand Down