Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: Improve OIDC error descriptions

Browse Source
This commit is contained in:
Joachim Van Herwegen 2022-02-15 17:34:46 +01:00
parent c9ed90aeeb
commit e9e3c6df3c
2 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/identity/configuration/IdentityProviderFactory.ts
View File

@ -314,6 +314,12 @@ export class IdentityProviderFactory implements ProviderFactory {
config.renderError = async(ctx: KoaContextWithOIDC, out: ErrorOut, error: Error): Promise<void> => {
// This allows us to stream directly to the response object, see https://github.com/koajs/koa/issues/944
ctx.respond = false;
// OIDC library hides extra details in this field
if (out.error_description) {
error.message += ` - ${out.error_description}`;
}
const result = await this.errorHandler.handleSafe({ error, preferences: { type: { 'text/plain': 1 }}});
await this.responseWriter.handleSafe({ response: ctx.res, result });
};

20
test/unit/identity/configuration/IdentityProviderFactory.test.ts
View File

@ -129,7 +129,7 @@ describe('An IdentityProviderFactory', (): void => {
// Test the renderError function
const response = { } as HttpResponse;
await expect((config.renderError as any)({ res: response }, null, 'error!')).resolves.toBeUndefined();
await expect((config.renderError as any)({ res: response }, {}, 'error!')).resolves.toBeUndefined();
expect(errorHandler.handleSafe).toHaveBeenCalledTimes(1);
expect(errorHandler.handleSafe)
.toHaveBeenLastCalledWith({ error: 'error!', preferences: { type: { 'text/plain': 1 }}});
@ -191,4 +191,22 @@ describe('An IdentityProviderFactory', (): void => {
expect(storage.set).toHaveBeenCalledWith('jwks', result1.config.jwks);
expect(storage.set).toHaveBeenCalledWith('cookie-secret', result1.config.cookies?.keys);
});
it('updates errors if there is more information.', async(): Promise<void> => {
const provider = await factory.getProvider() as any;
const { config } = provider as { config: Configuration };
const response = { } as HttpResponse;
const error = new Error('bad data');
const out = { error_description: 'more info' };
await expect((config.renderError as any)({ res: response }, out, error)).resolves.toBeUndefined();
expect(errorHandler.handleSafe).toHaveBeenCalledTimes(1);
expect(errorHandler.handleSafe)
.toHaveBeenLastCalledWith({ error, preferences: { type: { 'text/plain': 1 }}});
expect(responseWriter.handleSafe).toHaveBeenCalledTimes(1);
expect(responseWriter.handleSafe).toHaveBeenLastCalledWith({ response, result: { statusCode: 500 }});
expect(error.message).toBe('bad data - more info');
expect(error.stack).toContain('Error: bad data - more info');
});
});