Skip to content
Merged
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
2 changes: 1 addition & 1 deletion express-api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"license": "ISC",
"dependencies": {
"@bcgov/citz-imb-kc-css-api": "https://github.com/bcgov/citz-imb-kc-css-api/releases/download/v1.4.0/bcgov-citz-imb-kc-css-api-1.4.0.tgz",
"@bcgov/citz-imb-sso-express": "1.0.3-beta3",
"@bcgov/citz-imb-sso-js-core": "1.0.3",
"compression": "1.8.0",
"cookie-parser": "1.4.7",
"cors": "2.8.5",
Expand Down
2 changes: 1 addition & 1 deletion express-api/src/controllers/users/usersController.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import userServices from '@/services/users/usersServices';
import { Request, Response } from 'express';
import { SSOUser } from '@bcgov/citz-imb-sso-express';
import { SSOUser } from '@/middleware/keycloak/ssoUser';
import { UserFiltering, UserFilteringSchema } from '@/controllers/users/usersSchema';
import { z } from 'zod';
import notificationServices from '@/services/notifications/notificationServices';
Expand Down
8 changes: 4 additions & 4 deletions express-api/src/express.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ import cookieParser from 'cookie-parser';
import compression from 'compression';
import cors from 'cors';
import rateLimit from 'express-rate-limit';
import { protectedRoute, sso } from '@bcgov/citz-imb-sso-express';
import protectedRoute from '@/middleware/keycloak/protectedRoute';
import authRouter from '@/middleware/keycloak/authRouter';
import router from '@/routes';
import middleware from '@/middleware';
import constants from '@/constants';
import { SSO_OPTIONS } from '@/middleware/keycloak/keycloakOptions';
import swaggerUi from 'swagger-ui-express';
import swaggerJSDoc from 'swagger-jsdoc';
import errorHandler from '@/middleware/errorHandler';
Expand Down Expand Up @@ -60,8 +60,8 @@ const { headerHandler, morganMiddleware } = middleware;
// Logging Middleware
app.use(morganMiddleware);

// SSO initialization
sso(app, SSO_OPTIONS);
// SSO authentication routes (consumed by the @bcgov/citz-imb-sso-react package)
app.use('/auth', authRouter);

// Nunjucks configuration
const nj = nunjucks.configure('src/notificationTemplates', {
Expand Down
35 changes: 35 additions & 0 deletions express-api/src/middleware/keycloak/authConfig.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import { AUTH_URLS } from '@bcgov/citz-imb-sso-js-core';

const {
FRONTEND_URL = '',
BACKEND_URL = '',
SSO_CLIENT_ID = '',
SSO_CLIENT_SECRET = '',
SSO_ENVIRONMENT = 'dev',
} = process.env;

export type SSOEnvironment = 'dev' | 'test' | 'prod';

export const ssoClient = {
clientID: SSO_CLIENT_ID,
clientSecret: SSO_CLIENT_SECRET,
ssoEnvironment: SSO_ENVIRONMENT as SSOEnvironment,
ssoRealm: 'standard',
ssoProtocol: 'openid-connect' as const,
};

export const FRONTEND_URL_CONFIG = FRONTEND_URL;
export const BACKEND_URL_CONFIG = BACKEND_URL;

export const COOKIE_DOMAIN = FRONTEND_URL.includes('localhost') ? 'localhost' : '.gov.bc.ca';

export const refreshCookieOptions = {
httpOnly: true,
secure: true,
sameSite: 'none' as const,
domain: COOKIE_DOMAIN,
};

export const AUTH_SERVER_URL =
process.env.SSO_AUTH_SERVER_URL?.trim() ??
`${AUTH_URLS[ssoClient.ssoEnvironment]}/realms/${ssoClient.ssoRealm}/protocol/${ssoClient.ssoProtocol}`;
15 changes: 15 additions & 0 deletions express-api/src/middleware/keycloak/authRouter.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Router } from 'express';
import { login, loginCallback, logout, logoutCallback, token } from './controllers';

/**
* Routes required by the @bcgov/citz-imb-sso-react frontend package.
*/
const authRouter = Router();

authRouter.get('/login', login);
authRouter.get('/login/callback', loginCallback);
authRouter.get('/logout', logout);
authRouter.get('/logout/callback', logoutCallback);
authRouter.post('/token', token);

export default authRouter;
5 changes: 5 additions & 0 deletions express-api/src/middleware/keycloak/controllers/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export * from './login';
export * from './loginCallback';
export * from './logout';
export * from './logoutCallback';
export * from './token';
39 changes: 39 additions & 0 deletions express-api/src/middleware/keycloak/controllers/login.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { RequestHandler } from 'express';
import { getLoginURL } from '@bcgov/citz-imb-sso-js-core';
import type { SSOEnvironment, SSOIdentityProvider, SSOProtocol } from '@bcgov/citz-imb-sso-js-core';
import logger from '@/utilities/winstonLogger';
import { BACKEND_URL_CONFIG, COOKIE_DOMAIN, ssoClient } from '../authConfig';

const loginCallbackURI = () => `${BACKEND_URL_CONFIG}/auth/login/callback`;

/**
* GET /auth/login
* Initiates the Keycloak login flow. Stashes the desired post-login redirect
* in a cookie (read again by /auth/login/callback) and redirects the browser
* to the Keycloak authorization endpoint.
*/
export const login: RequestHandler = async (req, res) => {
try {
const { idp, post_login_redirect_url } = req.query;
const redirectURL = getLoginURL({
idpHint: idp ? (String(idp) as SSOIdentityProvider) : undefined,
clientID: ssoClient.clientID,
redirectURI: loginCallbackURI(),
ssoEnvironment: ssoClient.ssoEnvironment as SSOEnvironment,
ssoRealm: ssoClient.ssoRealm,
ssoProtocol: ssoClient.ssoProtocol as SSOProtocol,
});
if (post_login_redirect_url) {
res.cookie('post_login_redirect_url', String(post_login_redirect_url), {
domain: COOKIE_DOMAIN,
});
}
return res.redirect(redirectURL);
} catch (error) {
logger.error('SSO login controller error:', error);
if (error instanceof Error) {
return res.status(500).json({ success: false, error: error.message });
}
return res.status(500).json({ success: false, error });
}
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import { RequestHandler } from 'express';
import { decodeJWT, getTokens, normalizeUser } from '@bcgov/citz-imb-sso-js-core';
import type { SSOEnvironment, SSOProtocol } from '@bcgov/citz-imb-sso-js-core';
import logger from '@/utilities/winstonLogger';
import { SSO_OPTIONS } from '@/middleware/keycloak/keycloakOptions';
import {
BACKEND_URL_CONFIG,
FRONTEND_URL_CONFIG,
refreshCookieOptions,
ssoClient,
} from '../authConfig';

const loginCallbackURI = () => `${BACKEND_URL_CONFIG}/auth/login/callback`;

/**
* GET /auth/login/callback
* Exchanges the authorization code for tokens, stores the refresh token in an
* httpOnly cookie and bounces the browser back to the frontend, carrying the
* refresh_expires_in and the original post-login redirect target.
*/
export const loginCallback: RequestHandler = async (req, res) => {
try {
const { code } = req.query;
if (!code) {
return res.status(400).send('Missing authorization code.');
}
const { access_token, refresh_token, refresh_expires_in } = await getTokens({
code: String(code),
clientID: ssoClient.clientID,
clientSecret: ssoClient.clientSecret,
redirectURI: loginCallbackURI(),
ssoEnvironment: ssoClient.ssoEnvironment as SSOEnvironment,
ssoRealm: ssoClient.ssoRealm,
ssoProtocol: ssoClient.ssoProtocol as SSOProtocol,
});
const { post_login_redirect_url } = req.cookies;
const redirectURL = `${FRONTEND_URL_CONFIG}?refresh_expires_in=${refresh_expires_in}&post_login_redirect_url=${post_login_redirect_url}`;
res.cookie('refresh_token', refresh_token, refreshCookieOptions).redirect(redirectURL);
const normalizedUser = normalizeUser(decodeJWT(access_token));
if (normalizedUser) {
await SSO_OPTIONS.afterUserLogin(normalizedUser);
}
} catch (error) {
logger.error('SSO loginCallback controller error:', error);
if (error instanceof Error) {
return res.status(500).json({ success: false, error: error.message });
}
return res.status(500).json({ success: false, error });
}
};
49 changes: 49 additions & 0 deletions express-api/src/middleware/keycloak/controllers/logout.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import { RequestHandler } from 'express';
import { decodeJWT, getLogoutURL, normalizeUser } from '@bcgov/citz-imb-sso-js-core';
import type { SSOEnvironment, SSOProtocol } from '@bcgov/citz-imb-sso-js-core';
import logger from '@/utilities/winstonLogger';
import { SSO_OPTIONS } from '@/middleware/keycloak/keycloakOptions';
import {
BACKEND_URL_CONFIG,
FRONTEND_URL_CONFIG,
refreshCookieOptions,
ssoClient,
} from '../authConfig';

/**
* GET /auth/logout
* Redirects the browser through Keycloak (and SiteMinder) logout, clearing the
* refresh_token cookie either here or on the logout callback.
*/
export const logout: RequestHandler = async (req, res) => {
try {
const { id_token } = req.query;
if (!id_token || id_token === 'undefined') {
return res
.cookie('refresh_token', '', { ...refreshCookieOptions, maxAge: 0 })
.redirect(FRONTEND_URL_CONFIG ?? '');
}
const redirectURL = getLogoutURL({
idToken: String(id_token),
postLogoutRedirectURI: `${BACKEND_URL_CONFIG}/auth/logout/callback`,
ssoEnvironment: ssoClient.ssoEnvironment as SSOEnvironment,
ssoRealm: ssoClient.ssoRealm,
ssoProtocol: ssoClient.ssoProtocol as SSOProtocol,
});
res.redirect(redirectURL);
try {
const normalizedUser = normalizeUser(decodeJWT(String(id_token)));
if (normalizedUser) {
SSO_OPTIONS.afterUserLogout(normalizedUser);
}
} catch {
// Malformed id_token; the logout redirect still proceeds.
}
} catch (error) {
logger.error('SSO logout controller error:', error);
if (error instanceof Error) {
return res.status(500).json({ success: false, error: error.message });
}
return res.status(500).json({ success: false, error });
}
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { RequestHandler } from 'express';
import logger from '@/utilities/winstonLogger';
import { FRONTEND_URL_CONFIG, refreshCookieOptions } from '../authConfig';

/**
* GET /auth/logout/callback
* Keycloak redirects here after a successful logout. Clears the refresh token
* cookie and redirects the user to the frontend.
*/
export const logoutCallback: RequestHandler = async (_req, res) => {
try {
return res
.cookie('refresh_token', '', { ...refreshCookieOptions, maxAge: 0 })
.redirect(FRONTEND_URL_CONFIG ?? '');
} catch (error) {
logger.error('SSO logoutCallback controller error:', error);
if (error instanceof Error) {
return res.status(500).json({ success: false, error: error.message });
}
return res.status(500).json({ success: false, error });
}
};
46 changes: 46 additions & 0 deletions express-api/src/middleware/keycloak/controllers/token.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { RequestHandler } from 'express';
import { getNewTokens } from '@bcgov/citz-imb-sso-js-core';
import type { SSOEnvironment, SSOProtocol } from '@bcgov/citz-imb-sso-js-core';
import logger from '@/utilities/winstonLogger';
import { refreshCookieOptions, ssoClient } from '../authConfig';

/**
* POST /auth/token
* Refreshes tokens using the refresh_token cookie via js-core's `getNewTokens`,
* mirroring the citz-grs-dats implementation. getNewTokens first validates the
* refresh token locally (expiry check only - no introspection), then exchanges
* it at Keycloak's token endpoint. The response shape matches what the
* @bcgov/citz-imb-sso-react frontend package expects.
*/
export const token: RequestHandler = async (req, res) => {
const { refresh_token } = req.cookies;
if (!refresh_token || refresh_token === '') {
return res.status(401).send('Cookies must include refresh_token.');
}
try {
const tokens = await getNewTokens({
refreshToken: refresh_token,
clientID: ssoClient.clientID,
clientSecret: ssoClient.clientSecret,
ssoEnvironment: ssoClient.ssoEnvironment as SSOEnvironment,
ssoRealm: ssoClient.ssoRealm,
ssoProtocol: ssoClient.ssoProtocol as SSOProtocol,
});
if (!tokens) {
return res.status(401).json({ success: false, message: 'Invalid token.' });
}
// Keep the refresh cookie in sync in case the SSO server rotates it.
res.cookie('refresh_token', tokens.refresh_token, refreshCookieOptions);
return res.json({
access_token: tokens.access_token,
id_token: tokens.id_token,
expires_in: tokens.expires_in,
});
} catch (error) {
logger.error('SSO token controller error:', error);
if (error instanceof Error) {
return res.status(500).json({ success: false, error: error.message });
}
return res.status(500).json({ success: false, error });
}
};
9 changes: 7 additions & 2 deletions express-api/src/middleware/keycloak/keycloakOptions.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
import { SSOOptions, SSOUser } from '@bcgov/citz-imb-sso-express';
import { SSOUser } from '@/middleware/keycloak/ssoUser';
import logger from '@/utilities/winstonLogger';
import { AppDataSource } from '@/appDataSource';
import { User } from '@/typeorm/Entities/User';

const users = AppDataSource.getRepository(User);

export interface SSOOptions {
afterUserLogin: (user: SSOUser) => Promise<void>;
afterUserLogout: (user: SSOUser) => void;
}

/**
* Defined by SSO package. See package GitHub repo for options.
* Hooks called by the auth controllers on login and logout.
*/
export const SSO_OPTIONS: SSOOptions = {
afterUserLogin: async (user: SSOUser) => {
Expand Down
45 changes: 45 additions & 0 deletions express-api/src/middleware/keycloak/protectedRoute.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { NextFunction, Request, RequestHandler, Response } from 'express';
import { decodeJWT, isJWTValid, normalizeUser } from '@bcgov/citz-imb-sso-js-core';
import { ssoClient } from './authConfig';

/**
* Middleware that validates the access token presented in the Authorization
* header and attaches the normalized user to `req.user`. Must be followed by
* `userAuthCheck` for routes that need a PIMS user record.
*/
const protectedRoute = (): RequestHandler => {
const middleware = async (req: Request, res: Response, next: NextFunction) => {
const header = req.headers.authorization;
if (!header) {
return res.status(401).json({ error: 'No authorization header found.' });
}
const token = header.split(' ')[1];
if (!token) {
return res.status(401).json({ error: 'No authorization token found.' });
}
try {
const isTokenValid = await isJWTValid({ jwt: token, ...ssoClient });
if (!isTokenValid) {
return res
.status(401)
.json({ error: 'Unauthorized: Invalid token, re-log to get a new one.' });
}
const userInfo = decodeJWT(token);
const normalizedUser = normalizeUser(userInfo);
if (!userInfo || !normalizedUser) {
return res.status(404).json({ error: 'User not found.' });
}
req.token = token;
req.user = normalizedUser;
next();
} catch (error) {
if (error instanceof Error) {
return res.status(401).json({ error: error.message });
}
return res.status(401).json({ error: 'Unknown authentication error.' });
}
};
return middleware;
};

export default protectedRoute;
Loading
Loading