Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

fix(api-gateway): make securityContext available to extendContext #10050

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.

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

Open
morford-brex wants to merge 4 commits into cube-js:master
base: master
Choose a base branch
Loading
from morford-brex:merge-security-context
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions packages/cubejs-api-gateway/src/gateway.ts
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2158,6 +2158,11 @@ class ApiGateway {
}

public async contextByReq(req: Request, securityContext, requestId: string): Promise<ExtendedRequestContext> {
req.securityContext = {
...req.securityContext,
...securityContext,
};

const extensions = typeof this.extendContext === 'function' ? await this.extendContext(req) : {};

return {
Expand Down
107 changes: 107 additions & 0 deletions packages/cubejs-api-gateway/test/auth.test.ts
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,4 +673,111 @@ describe('test authorization', () => {
// no warnings, done on checkAuth/checkAuthMiddleware level
expect(loggerMock.mock.calls.length).toEqual(0);
});

test('extendContext receives securityContext from checkAuth', async () => {
const loggerMock = jest.fn(() => {
//
});

const extendContextMock = jest.fn((req) => ({
securityContext: {
...req.securityContext,
extendedField: 'added_by_extend_context',
}
}));

const expectSecurityContext = (securityContext) => {
expect(securityContext.uid).toEqual(5);
expect(securityContext.extendedField).toEqual('added_by_extend_context');
expect(securityContext.iat).toBeDefined();
expect(securityContext.exp).toBeDefined();
};

const handlerMock = jest.fn((req, res) => {
expectSecurityContext(req.context.securityContext);
res.status(200).end();
});

const { app } = createApiGateway(handlerMock, loggerMock, {
extendContext: extendContextMock,
});

const token = generateAuthToken({ uid: 5 });

await request(app)
.get('/test-auth-fake')
.set('Authorization', `Authorization: ${token}`)
.expect(200);

expect(handlerMock.mock.calls.length).toEqual(1);
expect(extendContextMock.mock.calls.length).toEqual(1);

// should receive securityContext from checkAuth
expect(extendContextMock.mock.calls[0][0].securityContext).toMatchObject({
uid: 5,
iat: expect.any(Number),
exp: expect.any(Number),
});
expectSecurityContext(handlerMock.mock.calls[0][0].context.securityContext);
});

test('extendContext with custom checkAuth returning securityContext', async () => {
const loggerMock = jest.fn(() => {
//
});

const checkAuthMock = jest.fn(async (req: Request, auth?: string) => {
if (auth) {
const decoded = jwt.verify(auth, 'secret') as any;
return {
security_context: {
...decoded,
tenantId: 'tenant_123',
customField: 'from_check_auth',
}
};
}
return {};
});

const extendContextMock = jest.fn((req) => {
// should receive securityContext from checkAuth
expect(req.securityContext).toBeDefined();
expect(req.securityContext.customField).toEqual('from_check_auth');

return {
securityContext: {
...req.securityContext,
extendedField: 'from_extend_context',
}
};
});

const handlerMock = jest.fn((req, res) => {
expect(req.context.securityContext.customField).toEqual('from_check_auth');
expect(req.context.securityContext.extendedField).toEqual('from_extend_context');
res.status(200).end();
});

const { app } = createApiGateway(handlerMock, loggerMock, {
checkAuth: checkAuthMock,
extendContext: extendContextMock,
});

const token = generateAuthToken({ uid: 5 });

await request(app)
.get('/test-auth-fake')
.set('Authorization', `Authorization: ${token}`)
.expect(200);

expect(checkAuthMock.mock.calls.length).toEqual(1);
expect(extendContextMock.mock.calls.length).toEqual(1);
expect(handlerMock.mock.calls.length).toEqual(1);
expect(extendContextMock.mock.calls[0][0].securityContext).toMatchObject({
uid: 5,
tenantId: 'tenant_123',
customField: 'from_check_auth',
});
});
});
Loading

AltStyle によって変換されたページ (->オリジナル) /