Merge branch 'chore/login' into docs/swagger-autogen
This commit is contained in:
		
						commit
						bf36790b28
					
				
					 30 changed files with 5058 additions and 315 deletions
				
			
		|  | @ -4,3 +4,13 @@ DWENGO_DB_PORT=5431 | |||
| DWENGO_DB_USERNAME=postgres | ||||
| DWENGO_DB_PASSWORD=postgres | ||||
| DWENGO_DB_UPDATE=true | ||||
| 
 | ||||
| DWENGO_AUTH_STUDENT_URL=http://localhost:7080/realms/student | ||||
| DWENGO_AUTH_STUDENT_CLIENT_ID=dwengo | ||||
| DWENGO_AUTH_STUDENT_JWKS_ENDPOINT=http://localhost:7080/realms/student/protocol/openid-connect/certs | ||||
| DWENGO_AUTH_TEACHER_URL=http://localhost:7080/realms/teacher | ||||
| DWENGO_AUTH_TEACHER_CLIENT_ID=dwengo | ||||
| DWENGO_AUTH_TEACHER_JWKS_ENDPOINT=http://localhost:7080/realms/teacher/protocol/openid-connect/certs | ||||
| 
 | ||||
| # Allow Vite dev-server to access the backend (for testing purposes). Don't forget to remove this in production! | ||||
| DWENGO_CORS_ALLOWED_ORIGINS=http://localhost:5173 | ||||
|  |  | |||
|  | @ -2,10 +2,31 @@ | |||
| # Basic configuration | ||||
| # | ||||
| 
 | ||||
| PORT=3000                              # The port the backend will listen on | ||||
| # The port the backend will listen on | ||||
| DWENGO_PORT=3000 | ||||
| DWENGO_DB_HOST=domain-or-ip-of-database | ||||
| DWENGO_DB_PORT=5432 | ||||
| 
 | ||||
| # Change this to the actual credentials of the user Dwengo should use in the backend | ||||
| DWENGO_DB_USERNAME=postgres | ||||
| DWENGO_DB_PASSWORD=postgres | ||||
| 
 | ||||
| # Set this to true when the database scheme needs to be updated. In that case, take a backup first. | ||||
| DWENGO_DB_UPDATE=false | ||||
| 
 | ||||
| # Data for the identity provider via which the students authenticate. | ||||
| DWENGO_AUTH_STUDENT_URL=http://localhost:7080/realms/student | ||||
| DWENGO_AUTH_STUDENT_CLIENT_ID=dwengo | ||||
| DWENGO_AUTH_STUDENT_JWKS_ENDPOINT=http://localhost:7080/realms/student/protocol/openid-connect/certs | ||||
| 
 | ||||
| # Data for the identity provider via which the teachers authenticate. | ||||
| DWENGO_AUTH_TEACHER_URL=http://localhost:7080/realms/teacher | ||||
| DWENGO_AUTH_TEACHER_CLIENT_ID=dwengo | ||||
| DWENGO_AUTH_TEACHER_JWKS_ENDPOINT=http://localhost:7080/realms/teacher/protocol/openid-connect/certs | ||||
| 
 | ||||
| # | ||||
| # Advanced configuration | ||||
| # | ||||
| 
 | ||||
| # LOKI_HOST=http://localhost:3102      # The address of the Loki instance, used for logging | ||||
| # The address of the Lokiinstance, used for logging | ||||
| # LOKI_HOST=http://localhost:3102 | ||||
|  |  | |||
|  | @ -18,11 +18,13 @@ | |||
|         "@mikro-orm/postgresql": "^6.4.6", | ||||
|         "@mikro-orm/reflection": "^6.4.6", | ||||
|         "@mikro-orm/sqlite": "6.4.6", | ||||
|         "@types/js-yaml": "^4.0.9", | ||||
|         "axios": "^1.8.1", | ||||
|         "dotenv": "^16.4.7", | ||||
|         "express": "^5.0.1", | ||||
|         "express-jwt": "^8.5.1", | ||||
|         "jwks-rsa": "^3.1.0", | ||||
|         "js-yaml": "^4.1.0", | ||||
|         "cors": "^2.8.5", | ||||
|         "loki-logger-ts": "^1.0.2", | ||||
|         "response-time": "^2.3.3", | ||||
|         "swagger-ui-express": "^5.0.1", | ||||
|  | @ -31,11 +33,13 @@ | |||
|         "winston-loki": "^6.1.3" | ||||
|     }, | ||||
|     "devDependencies": { | ||||
|         "@types/js-yaml": "^4.0.9", | ||||
|         "@mikro-orm/cli": "^6.4.6", | ||||
|         "@types/express": "^5.0.0", | ||||
|         "@types/node": "^22.13.4", | ||||
|         "@types/response-time": "^2.3.8", | ||||
|         "@types/swagger-ui-express": "^4.1.8", | ||||
|         "@types/cors": "^2.8.17", | ||||
|         "globals": "^15.15.0", | ||||
|         "ts-node": "^10.9.2", | ||||
|         "tsx": "^4.19.3", | ||||
|  |  | |||
|  | @ -11,7 +11,9 @@ import assignmentRouter from './routes/assignment.js'; | |||
| import submissionRouter from './routes/submission.js'; | ||||
| import classRouter from './routes/class.js'; | ||||
| import questionRouter from './routes/question.js'; | ||||
| import loginRouter from './routes/login.js'; | ||||
| import authRouter from './routes/auth.js'; | ||||
| import {authenticateUser} from './middleware/auth/auth.js'; | ||||
| import cors from './middleware/cors.js'; | ||||
| import { getLogger, Logger } from './logging/initalize.js'; | ||||
| import { responseTimeLogger } from './logging/responseTimeLogger.js'; | ||||
| import responseTime from 'response-time'; | ||||
|  | @ -25,6 +27,10 @@ const app: Express = express(); | |||
| const port: string | number = getNumericEnvVar(EnvVars.Port); | ||||
| 
 | ||||
| app.use(express.json()); | ||||
| app.use(cors); | ||||
| app.use(authenticateUser); | ||||
| // Add response time logging
 | ||||
| app.use(responseTime(responseTimeLogger)); | ||||
| 
 | ||||
| // TODO Replace with Express routes
 | ||||
| app.get('/', (_, res: Response) => { | ||||
|  | @ -41,15 +47,12 @@ app.use('/assignment', assignmentRouter /* #swagger.tags = ['Assignment'] */); | |||
| app.use('/submission', submissionRouter /* #swagger.tags = ['Submission'] */); | ||||
| app.use('/class', classRouter /* #swagger.tags = ['Class'] */); | ||||
| app.use('/question', questionRouter /* #swagger.tags = ['Question'] */); | ||||
| app.use('/login', loginRouter /* #swagger.tags = ['Login'] */); | ||||
| 
 | ||||
| app.use('/auth', authRouter /* #swagger.tags = ['Auth'] */); | ||||
| app.use('/theme', themeRoutes /* #swagger.tags = ['Theme'] */); | ||||
| 
 | ||||
| app.use('/learningPath', learningPathRoutes /* #swagger.tags = ['Learning Path'] */); | ||||
| app.use('/learningObject', learningObjectRoutes /* #swagger.tags = ['Learning Object'] */); | ||||
| 
 | ||||
| // Add response time loggin
 | ||||
| app.use(responseTime(responseTimeLogger)); | ||||
| 
 | ||||
| // Swagger UI for API documentation
 | ||||
| app.use('/api-docs', swaggerUi.serve, swaggerMiddleware); | ||||
| 
 | ||||
|  |  | |||
							
								
								
									
										33
									
								
								backend/src/controllers/auth.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								backend/src/controllers/auth.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,33 @@ | |||
| import {EnvVars, getEnvVar} from "../util/envvars.js"; | ||||
| 
 | ||||
| type FrontendIdpConfig = { | ||||
|     authority: string, | ||||
|     clientId: string, | ||||
|     scope: string, | ||||
|     responseType: string | ||||
| } | ||||
| 
 | ||||
| type FrontendAuthConfig = { | ||||
|     student: FrontendIdpConfig, | ||||
|     teacher: FrontendIdpConfig | ||||
| } | ||||
| 
 | ||||
| const SCOPE = "openid profile email"; | ||||
| const RESPONSE_TYPE = "code"; | ||||
| 
 | ||||
| export function getFrontendAuthConfig(): FrontendAuthConfig { | ||||
|     return { | ||||
|         student: { | ||||
|             authority: getEnvVar(EnvVars.IdpStudentUrl), | ||||
|             clientId: getEnvVar(EnvVars.IdpStudentClientId), | ||||
|             scope: SCOPE, | ||||
|             responseType: RESPONSE_TYPE | ||||
|         }, | ||||
|         teacher: { | ||||
|             authority: getEnvVar(EnvVars.IdpTeacherUrl), | ||||
|             clientId: getEnvVar(EnvVars.IdpTeacherClientId), | ||||
|             scope: SCOPE, | ||||
|             responseType: RESPONSE_TYPE | ||||
|         }, | ||||
|     }; | ||||
| } | ||||
							
								
								
									
										13
									
								
								backend/src/exceptions.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								backend/src/exceptions.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,13 @@ | |||
| export class UnauthorizedException extends Error { | ||||
|     status = 401; | ||||
|     constructor(message: string = "Unauthorized") { | ||||
|         super(message); | ||||
|     } | ||||
| } | ||||
| 
 | ||||
| export class ForbiddenException extends Error { | ||||
|     status = 403; | ||||
|     constructor(message: string = "Forbidden") { | ||||
|         super(message); | ||||
|     } | ||||
| } | ||||
							
								
								
									
										141
									
								
								backend/src/middleware/auth/auth.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										141
									
								
								backend/src/middleware/auth/auth.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,141 @@ | |||
| import {EnvVars, getEnvVar} from "../../util/envvars.js"; | ||||
| import {expressjwt} from 'express-jwt'; | ||||
| import {JwtPayload} from 'jsonwebtoken' | ||||
| import jwksClient from 'jwks-rsa'; | ||||
| import * as express from "express"; | ||||
| import * as jwt from "jsonwebtoken"; | ||||
| import {AuthenticatedRequest} from "./authenticated-request.js"; | ||||
| import {AuthenticationInfo} from "./authentication-info.js"; | ||||
| import {ForbiddenException, UnauthorizedException} from "../../exceptions"; | ||||
| 
 | ||||
| const JWKS_CACHE = true; | ||||
| const JWKS_RATE_LIMIT = true; | ||||
| const REQUEST_PROPERTY_FOR_JWT_PAYLOAD = "jwtPayload"; | ||||
| const JWT_ALGORITHM = "RS256"; // Not configurable via env vars since supporting other algorithms would
 | ||||
|                                         // require additional libraries to be added.
 | ||||
| 
 | ||||
| const JWT_PROPERTY_NAMES = { | ||||
|     username: "preferred_username", | ||||
|     firstName: "given_name", | ||||
|     lastName: "family_name", | ||||
|     name: "name", | ||||
|     email: "email" | ||||
| }; | ||||
| 
 | ||||
| function createJwksClient(uri: string): jwksClient.JwksClient { | ||||
|     return jwksClient({ | ||||
|         cache: JWKS_CACHE, | ||||
|         rateLimit: JWKS_RATE_LIMIT, | ||||
|         jwksUri: uri, | ||||
|     }); | ||||
| } | ||||
| 
 | ||||
| const idpConfigs = { | ||||
|     student: { | ||||
|         issuer: getEnvVar(EnvVars.IdpStudentUrl), | ||||
|         jwksClient: createJwksClient(getEnvVar(EnvVars.IdpStudentJwksEndpoint)), | ||||
|     }, | ||||
|     teacher: { | ||||
|         issuer: getEnvVar(EnvVars.IdpTeacherUrl), | ||||
|         jwksClient: createJwksClient(getEnvVar(EnvVars.IdpTeacherJwksEndpoint)), | ||||
|     } | ||||
| }; | ||||
| 
 | ||||
| /** | ||||
|  * Express middleware which verifies the JWT Bearer token if one is given in the request. | ||||
|  */ | ||||
| const verifyJwtToken = expressjwt({ | ||||
|     secret: async (_: express.Request, token: jwt.Jwt | undefined) => { | ||||
|         if (!token?.payload || !(token.payload as JwtPayload).iss) { | ||||
|             throw new Error("Invalid token"); | ||||
|         } | ||||
| 
 | ||||
|         let issuer = (token.payload as JwtPayload).iss; | ||||
| 
 | ||||
|         let idpConfig = Object.values(idpConfigs).find(config => config.issuer === issuer); | ||||
|         if (!idpConfig) { | ||||
|             throw new Error("Issuer not accepted."); | ||||
|         } | ||||
| 
 | ||||
|         const signingKey = await idpConfig.jwksClient.getSigningKey(token.header.kid); | ||||
|         if (!signingKey) { | ||||
|             throw new Error("Signing key not found."); | ||||
|         } | ||||
|         return signingKey.getPublicKey(); | ||||
|     }, | ||||
|     audience: getEnvVar(EnvVars.IdpAudience), | ||||
|     algorithms: [JWT_ALGORITHM], | ||||
|     credentialsRequired: false, | ||||
|     requestProperty: REQUEST_PROPERTY_FOR_JWT_PAYLOAD | ||||
| }); | ||||
| 
 | ||||
| /** | ||||
|  * Get an object with information about the authenticated user from a given authenticated request. | ||||
|  */ | ||||
| function getAuthenticationInfo(req: AuthenticatedRequest): AuthenticationInfo | undefined { | ||||
|     if (!req.jwtPayload) { | ||||
|         return; | ||||
|     } | ||||
|     let issuer = req.jwtPayload.iss; | ||||
|     let accountType: "student" | "teacher"; | ||||
| 
 | ||||
|     if (issuer === idpConfigs.student.issuer) { | ||||
|         accountType = "student"; | ||||
|     } else if (issuer === idpConfigs.teacher.issuer) { | ||||
|         accountType = "teacher"; | ||||
|     } else { | ||||
|         return; | ||||
|     } | ||||
|     return { | ||||
|         accountType: accountType, | ||||
|         username: req.jwtPayload[JWT_PROPERTY_NAMES.username]!, | ||||
|         name: req.jwtPayload[JWT_PROPERTY_NAMES.name], | ||||
|         firstName: req.jwtPayload[JWT_PROPERTY_NAMES.firstName], | ||||
|         lastName: req.jwtPayload[JWT_PROPERTY_NAMES.lastName], | ||||
|         email: req.jwtPayload[JWT_PROPERTY_NAMES.email], | ||||
|     } | ||||
| } | ||||
| 
 | ||||
| /** | ||||
|  * Add the AuthenticationInfo object with the information about the current authentication to the request in order | ||||
|  * to avoid that the routers have to deal with the JWT token. | ||||
|  */ | ||||
| const addAuthenticationInfo = (req: AuthenticatedRequest, res: express.Response, next: express.NextFunction) => { | ||||
|     req.auth = getAuthenticationInfo(req); | ||||
|     next(); | ||||
| }; | ||||
| 
 | ||||
| export const authenticateUser = [verifyJwtToken, addAuthenticationInfo]; | ||||
| 
 | ||||
| /** | ||||
|  * Middleware which rejects unauthenticated users (with HTTP 401) and authenticated users which do not fulfill | ||||
|  * the given access condition. | ||||
|  * @param accessCondition Predicate over the current AuthenticationInfo. Access is only granted when this evaluates | ||||
|  *                        to true. | ||||
|  */ | ||||
| export const authorize = (accessCondition: (auth: AuthenticationInfo) => boolean) => { | ||||
|     return (req: AuthenticatedRequest, res: express.Response, next: express.NextFunction): void => { | ||||
|         if (!req.auth) { | ||||
|             throw new UnauthorizedException(); | ||||
|         } else if (!accessCondition(req.auth)) { | ||||
|             throw new ForbiddenException(); | ||||
|         } else { | ||||
|             next(); | ||||
|         } | ||||
|     } | ||||
| } | ||||
| 
 | ||||
| /** | ||||
|  * Middleware which rejects all unauthenticated users, but accepts all authenticated users. | ||||
|  */ | ||||
| export const authenticatedOnly = authorize(_ => true); | ||||
| 
 | ||||
| /** | ||||
|  * Middleware which rejects requests from unauthenticated users or users that aren't students. | ||||
|  */ | ||||
| export const studentsOnly = authorize(auth => auth.accountType === "student"); | ||||
| 
 | ||||
| /** | ||||
|  * Middleware which rejects requests from unauthenticated users or users that aren't teachers. | ||||
|  */ | ||||
| export const teachersOnly = authorize(auth => auth.accountType === "teacher"); | ||||
							
								
								
									
										9
									
								
								backend/src/middleware/auth/authenticated-request.d.ts
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								backend/src/middleware/auth/authenticated-request.d.ts
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1,9 @@ | |||
| import { Request } from "express"; | ||||
| import { JwtPayload } from "jsonwebtoken"; | ||||
| import {AuthenticationInfo} from "./authentication-info.js"; | ||||
| 
 | ||||
| export interface AuthenticatedRequest extends Request { | ||||
|     // Properties are optional since the user is not necessarily authenticated.
 | ||||
|     jwtPayload?: JwtPayload; | ||||
|     auth?: AuthenticationInfo; | ||||
| } | ||||
							
								
								
									
										11
									
								
								backend/src/middleware/auth/authentication-info.d.ts
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								backend/src/middleware/auth/authentication-info.d.ts
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1,11 @@ | |||
| /** | ||||
|  * Object with information about the user who is currently logged in. | ||||
|  */ | ||||
| export type AuthenticationInfo = { | ||||
|     accountType: "student" | "teacher", | ||||
|     username: string, | ||||
|     name?: string, | ||||
|     firstName?: string, | ||||
|     lastName?: string, | ||||
|     email?: string | ||||
| }; | ||||
							
								
								
									
										7
									
								
								backend/src/middleware/cors.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								backend/src/middleware/cors.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,7 @@ | |||
| import cors from "cors"; | ||||
| import {EnvVars, getEnvVar} from "../util/envvars.js"; | ||||
| 
 | ||||
| export default cors({ | ||||
|     origin: getEnvVar(EnvVars.CorsAllowedOrigins).split(','), | ||||
|     allowedHeaders: getEnvVar(EnvVars.CorsAllowedHeaders).split(',') | ||||
| }); | ||||
							
								
								
									
										23
									
								
								backend/src/routes/auth.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										23
									
								
								backend/src/routes/auth.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,23 @@ | |||
| import express from 'express' | ||||
| import {getFrontendAuthConfig} from "../controllers/auth.js"; | ||||
| import {authenticatedOnly, studentsOnly, teachersOnly} from "../middleware/auth/auth.js"; | ||||
| const router = express.Router(); | ||||
| 
 | ||||
| // returns auth configuration for frontend
 | ||||
| router.get('/config', (req, res) => { | ||||
|     res.json(getFrontendAuthConfig()); | ||||
| }); | ||||
| 
 | ||||
| router.get('/testAuthenticatedOnly', authenticatedOnly, (req, res) => { | ||||
|     res.json({message: "If you see this, you should be authenticated!"}); | ||||
| }); | ||||
| 
 | ||||
| router.get('/testStudentsOnly', studentsOnly, (req, res) => { | ||||
|     res.json({message: "If you see this, you should be a student!"}); | ||||
| }); | ||||
| 
 | ||||
| router.get('/testTeachersOnly', teachersOnly, (req, res) => { | ||||
|     res.json({message: "If you see this, you should be a teacher!"}); | ||||
| }); | ||||
| 
 | ||||
| export default router; | ||||
|  | @ -1,14 +0,0 @@ | |||
| import express from 'express'; | ||||
| const router = express.Router(); | ||||
| 
 | ||||
| // Returns login paths for IDP
 | ||||
| router.get('/', (req, res) => { | ||||
|     res.json({ | ||||
|         // Dummy variables, needs to be changed
 | ||||
|         // With IDP endpoints
 | ||||
|         leerkracht: '/login-leerkracht', | ||||
|         leerling: '/login-leerling', | ||||
|     }); | ||||
| }); | ||||
| 
 | ||||
| export default router; | ||||
|  | @ -1,5 +1,9 @@ | |||
| const PREFIX = 'DWENGO_'; | ||||
| const DB_PREFIX = PREFIX + 'DB_'; | ||||
| const IDP_PREFIX = PREFIX + 'AUTH_'; | ||||
| const STUDENT_IDP_PREFIX = IDP_PREFIX + 'STUDENT_'; | ||||
| const TEACHER_IDP_PREFIX = IDP_PREFIX + 'TEACHER_'; | ||||
| const CORS_PREFIX = PREFIX + 'CORS_'; | ||||
| 
 | ||||
| type EnvVar = { key: string; required?: boolean; defaultValue?: any }; | ||||
| 
 | ||||
|  | @ -11,6 +15,15 @@ export const EnvVars: { [key: string]: EnvVar } = { | |||
|     DbUsername: { key: DB_PREFIX + 'USERNAME', required: true }, | ||||
|     DbPassword: { key: DB_PREFIX + 'PASSWORD', required: true }, | ||||
|     DbUpdate: { key: DB_PREFIX + 'UPDATE', defaultValue: false }, | ||||
|     IdpStudentUrl: { key: STUDENT_IDP_PREFIX + 'URL', required: true }, | ||||
|     IdpStudentClientId: { key: STUDENT_IDP_PREFIX + 'CLIENT_ID', required: true }, | ||||
|     IdpStudentJwksEndpoint: { key: STUDENT_IDP_PREFIX + 'JWKS_ENDPOINT', required: true }, | ||||
|     IdpTeacherUrl: { key: TEACHER_IDP_PREFIX + 'URL', required: true }, | ||||
|     IdpTeacherClientId: { key: TEACHER_IDP_PREFIX + 'CLIENT_ID', required: true }, | ||||
|     IdpTeacherJwksEndpoint: { key: TEACHER_IDP_PREFIX + 'JWKS_ENDPOINT', required: true }, | ||||
|     IdpAudience: { key: IDP_PREFIX + 'AUDIENCE', defaultValue: 'account' }, | ||||
|     CorsAllowedOrigins: { key: CORS_PREFIX + 'ALLOWED_ORIGINS', defaultValue: ''}, | ||||
|     CorsAllowedHeaders: { key: CORS_PREFIX + 'ALLOWED_HEADERS', defaultValue: 'Authorization,Content-Type'} | ||||
| } as const; | ||||
| 
 | ||||
| /** | ||||
|  |  | |||
|  | @ -10,6 +10,35 @@ services: | |||
|         volumes: | ||||
|             - dwengo_postgres_data:/var/lib/postgresql/data | ||||
| 
 | ||||
|     idp: # Bron: https://medium.com/@fingervinicius/easy-running-keycloak-with-docker-compose-b0d7a4ee2358 | ||||
|         image: quay.io/keycloak/keycloak:latest | ||||
|         volumes: | ||||
|             - ./idp:/opt/keycloak/data/import | ||||
|         environment: | ||||
|             KC_HOSTNAME: localhost | ||||
|             KC_HOSTNAME_PORT: 7080 | ||||
|             KC_HOSTNAME_STRICT_BACKCHANNEL: 'true' | ||||
|             KC_BOOTSTRAP_ADMIN_USERNAME: admin | ||||
|             KC_BOOTSTRAP_ADMIN_PASSWORD: admin | ||||
|             KC_HEALTH_ENABLED: 'true' | ||||
|             KC_LOG_LEVEL: info | ||||
|         healthcheck: | ||||
|             test: [ 'CMD', 'curl', '-f', 'http://localhost:7080/health/ready' ] | ||||
|             interval: 15s | ||||
|             timeout: 2s | ||||
|             retries: 15 | ||||
|         command: [ | ||||
|             'start-dev', | ||||
|             '--http-port', '7080', | ||||
|             '--https-port', '7443', | ||||
|             '--import-realm' | ||||
|         ] | ||||
|         ports: | ||||
|             - '7080:7080' | ||||
|             - '7443:7443' | ||||
|         depends_on: | ||||
|             - db | ||||
| 
 | ||||
|     logging: | ||||
|         image: grafana/loki:latest | ||||
|         ports: | ||||
|  |  | |||
|  | @ -18,7 +18,9 @@ | |||
|     "dependencies": { | ||||
|         "vue": "^3.5.13", | ||||
|         "vue-router": "^4.5.0", | ||||
|         "vuetify": "^3.7.12" | ||||
|         "vuetify": "^3.7.12", | ||||
|         "oidc-client-ts": "^3.1.0", | ||||
|         "axios": "^1.8.1" | ||||
|     }, | ||||
|     "devDependencies": { | ||||
|         "@playwright/test": "^1.50.1", | ||||
|  |  | |||
|  | @ -1,4 +1,7 @@ | |||
| <script setup lang="ts"></script> | ||||
| <script setup lang="ts"> | ||||
|     import auth from "@/services/auth/auth-service.ts"; | ||||
|     auth.loadUser(); | ||||
| </script> | ||||
| 
 | ||||
| <template> | ||||
|     <router-view /> | ||||
|  |  | |||
							
								
								
									
										5
									
								
								frontend/src/config.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								frontend/src/config.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,5 @@ | |||
| export const apiConfig = { | ||||
|     baseUrl: window.location.hostname == "localhost" ? "http://localhost:3000" : window.location.origin | ||||
| } | ||||
| 
 | ||||
| export const loginRoute = "/login"; | ||||
|  | @ -15,6 +15,7 @@ import NotFound from "@/components/errors/NotFound.vue"; | |||
| import CreateClass from "@/views/classes/CreateClass.vue"; | ||||
| import CreateAssignment from "@/views/assignments/CreateAssignment.vue"; | ||||
| import CreateDiscussion from "@/views/discussions/CreateDiscussion.vue"; | ||||
| import CallbackPage from "@/views/CallbackPage.vue"; | ||||
| 
 | ||||
| const router = createRouter({ | ||||
|     history: createWebHistory(import.meta.env.BASE_URL), | ||||
|  | @ -33,6 +34,10 @@ const router = createRouter({ | |||
|                 return import("../views/LoginPage.vue"); | ||||
|             }, | ||||
|         }, | ||||
|         { | ||||
|             path: "/callback", | ||||
|             component: CallbackPage | ||||
|         }, | ||||
|         { | ||||
|             path: "/student/:id", | ||||
|             component: MenuBar, | ||||
|  |  | |||
							
								
								
									
										10
									
								
								frontend/src/services/api-client.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								frontend/src/services/api-client.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,10 @@ | |||
| import axios from "axios"; | ||||
| import {apiConfig} from "@/config.ts"; | ||||
| 
 | ||||
| const apiClient = axios.create({ | ||||
|     baseURL: apiConfig.baseUrl, | ||||
|     headers: { | ||||
|         "Content-Type": "application/json", | ||||
|     }, | ||||
| }); | ||||
| export default apiClient; | ||||
							
								
								
									
										27
									
								
								frontend/src/services/auth/auth-config-loader.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								frontend/src/services/auth/auth-config-loader.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,27 @@ | |||
| import apiClient from "@/services/api-client.ts"; | ||||
| import type {FrontendAuthConfig} from "@/services/auth/auth.d.ts"; | ||||
| 
 | ||||
| /** | ||||
|  * Fetch the authentication configuration from the backend. | ||||
|  */ | ||||
| export async function loadAuthConfig() { | ||||
|     const authConfig = (await apiClient.get<FrontendAuthConfig>("auth/config")).data; | ||||
|     return { | ||||
|         student: { | ||||
|             authority: authConfig.student.authority, | ||||
|             client_id: authConfig.student.clientId, | ||||
|             redirect_uri: window.location.origin + "/callback", | ||||
|             response_type: authConfig.student.responseType, | ||||
|             scope: authConfig.student.scope, | ||||
|             post_logout_redirect_uri: window.location.origin, | ||||
|         }, | ||||
|         teacher: { | ||||
|             authority: authConfig.teacher.authority, | ||||
|             client_id: authConfig.teacher.clientId, | ||||
|             redirect_uri: window.location.origin + "/callback", | ||||
|             response_type: authConfig.teacher.responseType, | ||||
|             scope: authConfig.teacher.scope, | ||||
|             post_logout_redirect_uri: window.location.origin, | ||||
|         } | ||||
|     }; | ||||
| } | ||||
							
								
								
									
										132
									
								
								frontend/src/services/auth/auth-service.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										132
									
								
								frontend/src/services/auth/auth-service.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,132 @@ | |||
| /** | ||||
|  * Service for all authentication- and authorization-related tasks. | ||||
|  */ | ||||
| 
 | ||||
| import {computed, reactive} from "vue"; | ||||
| import type {AuthState, Role, UserManagersForRoles} from "@/services/auth/auth.d.ts"; | ||||
| import {User, UserManager} from "oidc-client-ts"; | ||||
| import {loadAuthConfig} from "@/services/auth/auth-config-loader.ts"; | ||||
| import authStorage from "./auth-storage.ts" | ||||
| import {loginRoute} from "@/config.ts"; | ||||
| import apiClient from "@/services/api-client.ts"; | ||||
| import router from "@/router"; | ||||
| import type {AxiosError} from "axios"; | ||||
| 
 | ||||
| const authConfig = await loadAuthConfig(); | ||||
| 
 | ||||
| const userManagers: UserManagersForRoles = { | ||||
|     student: new UserManager(authConfig.student), | ||||
|     teacher: new UserManager(authConfig.teacher), | ||||
| }; | ||||
| 
 | ||||
| /** | ||||
|  * Load the information about who is currently logged in from the IDP. | ||||
|  */ | ||||
| async function loadUser(): Promise<User | null> { | ||||
|     const activeRole = authStorage.getActiveRole(); | ||||
|     if (!activeRole) { | ||||
|         return null; | ||||
|     } | ||||
|     let user = await userManagers[activeRole].getUser(); | ||||
|     authState.user = user; | ||||
|     authState.accessToken = user?.access_token || null; | ||||
|     authState.activeRole = activeRole || null; | ||||
|     return user; | ||||
| } | ||||
| 
 | ||||
| /** | ||||
|  * Information about the current authentication state. | ||||
|  */ | ||||
| const authState = reactive<AuthState>({ | ||||
|     user: null, | ||||
|     accessToken: null, | ||||
|     activeRole: authStorage.getActiveRole() || null | ||||
| }); | ||||
| 
 | ||||
| const isLoggedIn = computed(() => authState.user !== null); | ||||
| 
 | ||||
| /** | ||||
|  * Redirect the user to the login page where he/she can choose whether to log in as a student or teacher. | ||||
|  */ | ||||
| async function initiateLogin() { | ||||
|     await router.push(loginRoute); | ||||
| } | ||||
| 
 | ||||
| /** | ||||
|  * Redirect the user to the IDP for the given role so that he can log in there. | ||||
|  * Only call this function when the user is not logged in yet! | ||||
|  */ | ||||
| async function loginAs(role: Role): Promise<void> { | ||||
|     // Storing it in local storage so that it won't be lost when redirecting outside of the app.
 | ||||
|     authStorage.setActiveRole(role); | ||||
|     await userManagers[role].signinRedirect(); | ||||
| } | ||||
| 
 | ||||
| /** | ||||
|  * To be called when the user is redirected to the callback-endpoint by the IDP after a successful login. | ||||
|  */ | ||||
| async function handleLoginCallback(): Promise<void> { | ||||
|     const activeRole = authStorage.getActiveRole(); | ||||
|     if (!activeRole) { | ||||
|         throw new Error("Login callback received, but the user is not logging in!"); | ||||
|     } | ||||
|     authState.user = await userManagers[activeRole].signinCallback() || null; | ||||
| } | ||||
| 
 | ||||
| /** | ||||
|  * Refresh an expired authorization token. | ||||
|  */ | ||||
| async function renewToken() { | ||||
|     const activeRole = authStorage.getActiveRole(); | ||||
|     if (!activeRole) { | ||||
|         console.log("Can't renew the token: Not logged in!"); | ||||
|         await initiateLogin(); | ||||
|         return; | ||||
|     } | ||||
|     try { | ||||
|         return await userManagers[activeRole].signinSilent(); | ||||
|     } catch (error) { | ||||
|         console.log("Can't renew the token:"); | ||||
|         console.log(error); | ||||
|         await initiateLogin(); | ||||
|     } | ||||
| } | ||||
| 
 | ||||
| /** | ||||
|  * End the session of the current user. | ||||
|  */ | ||||
| async function logout(): Promise<void> { | ||||
|     const activeRole = authStorage.getActiveRole(); | ||||
|     if (activeRole) { | ||||
|         await userManagers[activeRole].signoutRedirect(); | ||||
|         authStorage.deleteActiveRole(); | ||||
|     } | ||||
| } | ||||
| 
 | ||||
| // Registering interceptor to add the authorization header to each request when the user is logged in.
 | ||||
| apiClient.interceptors.request.use(async (reqConfig) => { | ||||
|     const token = authState?.user?.access_token; | ||||
|     if (token) { | ||||
|         reqConfig.headers.Authorization = `Bearer ${token}`; | ||||
|     } | ||||
|     return reqConfig; | ||||
| }, (error) => Promise.reject(error)); | ||||
| 
 | ||||
| // Registering interceptor to refresh the token when a request failed because it was expired.
 | ||||
| apiClient.interceptors.response.use( | ||||
|     response => response, | ||||
|     async (error: AxiosError<{message?: string}>) => { | ||||
|         if (error.response?.status === 401) { | ||||
|             if (error.response!.data.message === "token_expired") { | ||||
|                 console.log("Access token expired, trying to refresh..."); | ||||
|                 await renewToken(); | ||||
|                 return apiClient(error.config!); // Retry the request
 | ||||
|             } else { // Apparently, the user got a 401 because he was not logged in yet at all. Redirect him to login.
 | ||||
|                 await initiateLogin() | ||||
|             } | ||||
|         } | ||||
|         return Promise.reject(error); | ||||
|     } | ||||
| ); | ||||
| 
 | ||||
| export default {authState, isLoggedIn, initiateLogin, loadUser, handleLoginCallback, loginAs, logout}; | ||||
							
								
								
									
										26
									
								
								frontend/src/services/auth/auth-storage.ts
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								frontend/src/services/auth/auth-storage.ts
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,26 @@ | |||
| import type {Role} from "@/services/auth/auth.d.ts"; | ||||
| 
 | ||||
| export default { | ||||
|     /** | ||||
|      * Get the role the user is currently logged in as from the local persistent storage. | ||||
|      */ | ||||
|     getActiveRole(): Role | undefined { | ||||
|         return localStorage.getItem("activeRole") as Role | undefined; | ||||
|     }, | ||||
| 
 | ||||
|     /** | ||||
|      * Set the role the user is currently logged in as from the local persistent storage. | ||||
|      * This should happen when the user logs in with another account. | ||||
|      */ | ||||
|     setActiveRole(role: Role) { | ||||
|         localStorage.setItem("activeRole", role); | ||||
|     }, | ||||
| 
 | ||||
|     /** | ||||
|      * Remove the saved current role from the local persistent storage. | ||||
|      * This should happen when the user is logged out. | ||||
|      */ | ||||
|     deleteActiveRole() { | ||||
|         localStorage.removeItem("activeRole"); | ||||
|     } | ||||
| } | ||||
							
								
								
									
										22
									
								
								frontend/src/services/auth/auth.d.ts
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								frontend/src/services/auth/auth.d.ts
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1,22 @@ | |||
| import {type User, UserManager} from "oidc-client-ts"; | ||||
| 
 | ||||
| export type AuthState = { | ||||
|     user: User | null, | ||||
|     accessToken: string | null, | ||||
|     activeRole: Role | null | ||||
| }; | ||||
| 
 | ||||
| export type FrontendAuthConfig = { | ||||
|     student: FrontendIdpConfig, | ||||
|     teacher: FrontendIdpConfig | ||||
| }; | ||||
| 
 | ||||
| export type FrontendIdpConfig = { | ||||
|     authority: string, | ||||
|     clientId: string, | ||||
|     scope: string, | ||||
|     responseType: string | ||||
| }; | ||||
| 
 | ||||
| export type Role = "student" | "teacher"; | ||||
| export type UserManagersForRoles = {student: UserManager, teacher: UserManager}; | ||||
							
								
								
									
										24
									
								
								frontend/src/views/CallbackPage.vue
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								frontend/src/views/CallbackPage.vue
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,24 @@ | |||
| <script setup lang="ts"> | ||||
|     import {useRouter} from "vue-router"; | ||||
|     import {onMounted} from "vue"; | ||||
|     import auth from "../services/auth/auth-service.ts" | ||||
| 
 | ||||
|     const router = useRouter(); | ||||
| 
 | ||||
|     onMounted(async () => { | ||||
|         try { | ||||
|             await auth.handleLoginCallback(); | ||||
|             await router.replace("/"); // Redirect to home (or dashboard) | ||||
|         } catch (error) { | ||||
|             console.error("OIDC callback error:", error); | ||||
|         } | ||||
|     }); | ||||
| </script> | ||||
| 
 | ||||
| <template> | ||||
|     <p>Logging you in...</p> | ||||
| </template> | ||||
| 
 | ||||
| <style scoped> | ||||
| 
 | ||||
| </style> | ||||
|  | @ -1,8 +1,26 @@ | |||
| <script setup lang="ts"></script> | ||||
| <script setup lang="ts"> | ||||
|     import auth from "@/services/auth/auth-service.ts"; | ||||
|     import apiClient from "@/services/api-client.ts"; | ||||
|     import {ref} from "vue"; | ||||
| 
 | ||||
|     const testResponse = ref(null); | ||||
| 
 | ||||
|     async function testAuthenticated() { | ||||
|         testResponse.value = await apiClient.get("/auth/testAuthenticatedOnly") | ||||
|     } | ||||
| </script> | ||||
| 
 | ||||
| <template> | ||||
|     <main> | ||||
|         <b> Welcome to the dwengo homepage</b> | ||||
|         <!-- TODO Placeholder implementation to test the login - replace by a more beautiful page later --> | ||||
|         <b>Welcome to the dwengo homepage</b> | ||||
|         <div v-if="auth.isLoggedIn.value"> | ||||
|             <p>Hello {{auth.authState.user?.profile.name}}!</p> | ||||
|             <p>Your access token for the backend is: <code>{{auth.authState.user?.access_token}}</code></p> | ||||
|         </div> | ||||
| 
 | ||||
|         <v-btn @click="testAuthenticated">Send test request</v-btn> | ||||
|         <p v-if="testResponse">Response from the test request: {{ testResponse }}</p> | ||||
|     </main> | ||||
| </template> | ||||
| <style scoped></style> | ||||
|  |  | |||
|  | @ -1,7 +1,32 @@ | |||
| <script setup lang="ts"></script> | ||||
| <script setup lang="ts"> | ||||
|     import auth from "@/services/auth/auth-service.ts"; | ||||
| 
 | ||||
|     function loginAsStudent() { | ||||
|         auth.loginAs("student"); | ||||
|     } | ||||
| 
 | ||||
|     function loginAsTeacher() { | ||||
|         auth.loginAs("teacher"); | ||||
|     } | ||||
| 
 | ||||
|     function performLogout() { | ||||
|         auth.logout(); | ||||
|     } | ||||
| </script> | ||||
| 
 | ||||
| <template> | ||||
|     <main></main> | ||||
|     <main> | ||||
|         <!-- TODO Placeholder implementation to test the login - replace by a more beautiful page later --> | ||||
|         <div v-if="!auth.isLoggedIn.value"> | ||||
|             <p>You are currently not logged in.</p> | ||||
|             <v-btn @click="loginAsStudent">Login as student</v-btn> | ||||
|             <v-btn @click="loginAsTeacher">Login as teacher</v-btn> | ||||
|         </div> | ||||
|         <div v-if="auth.isLoggedIn.value"> | ||||
|             <p>You are currently logged in as {{ auth.authState.user!.profile.name }} ({{ auth.authState.activeRole }})</p> | ||||
|             <v-btn @click="performLogout">Logout</v-btn> | ||||
|         </div> | ||||
|     </main> | ||||
| </template> | ||||
| 
 | ||||
| <style scoped></style> | ||||
|  |  | |||
							
								
								
									
										7
									
								
								idp/README.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								idp/README.md
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,7 @@ | |||
| # Testdata in de IDP | ||||
| De IDP in `docker-compose.yml` is zo geconfigureerd dat hij automatisch bij het starten een testconfiguratie inlaadt. Deze houdt in: | ||||
| * Een realm `student` die de IDP voor leerlingen representeert. | ||||
|   * Hierin de gebruiker met username `testleerling1`, wachtwoord `password`. | ||||
| * Een realm `teacher` die de IDP voor leerkrachten representeert. | ||||
|   * Hierin de gebruiker met username `testleerkracht1`, wachtwoord `password`. | ||||
| * De admin-account (in de realm `master`) heeft username `admin` en wachtwoord `admin`. | ||||
							
								
								
									
										2062
									
								
								idp/student-realm.json
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										2062
									
								
								idp/student-realm.json
									
										
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because it is too large
												Load diff
											
										
									
								
							
							
								
								
									
										2060
									
								
								idp/teacher-realm.json
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										2060
									
								
								idp/teacher-realm.json
									
										
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because it is too large
												Load diff
											
										
									
								
							
							
								
								
									
										584
									
								
								package-lock.json
									
										
									
										generated
									
									
									
								
							
							
						
						
									
										584
									
								
								package-lock.json
									
										
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load diff
											
										
									
								
							
		Reference in a new issue