forked from Sunbird-Obsrv/obsrv-api-service
-
Notifications
You must be signed in to change notification settings - Fork 9
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
Api access control #238
Merged
Merged
Api access control #238
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
77f20f4
#OBS-I164: added jwt token vwerification and access control to api's
Rakshitha-D 6aa8a8f
#OBS-I164: added jwt token vwerification and access control to api's
Rakshitha-D 9d31325
#OBS-I164: modified the access roles and permissions
Rakshitha-D 859a0cf
#OBS-I164: reading public key from env file
Rakshitha-D 2d0afbe
#OBS-I164: modified public key variable in config
Rakshitha-D f5f3667
#OBS-I164: modified public key variable in config
Rakshitha-D 4f5e155
#OBS-I164: added config for option rbac verification
Rakshitha-D 9d16185
#OBS-I164: changed the middleware to rbac_middleware
Rakshitha-D ac09f85
#OBS-I164: changed import name
Rakshitha-D 7dff860
#OBS-I164: modified config and rbac middleware
Rakshitha-D 435c50a
#OBS-I164: added rbac middleware
Rakshitha-D ee02f93
Merge branch 'v2-apis' of https://github.com/Sanketika-Obsrv/obsrv-ap…
Rakshitha-D b83a808
#OBS-I164: added jsonwebtoken package
Rakshitha-D File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| import { Request, Response, NextFunction } from "express"; | ||
| import jwt from "jsonwebtoken"; | ||
| import { ResponseHandler } from "../helpers/ResponseHandler"; | ||
| import { config } from "../configs/Config"; | ||
|
|
||
| enum roles { | ||
| Admin = "admin", | ||
| DatasetManager = "dataset_manager", | ||
| Viewer = "viewer", | ||
| DatasetCreator = "dataset_creator", | ||
| Ingestor = "ingestor", | ||
| } | ||
|
|
||
| enum permissions { | ||
| DatasetCreate = "api.datasets.create", | ||
| DatasetUpdate = "api.datasets.update", | ||
| DatasetRead = "api.datasets.read", | ||
| DatasetList = "api.datasets.list", | ||
| DataIngest = "api.data.in", | ||
| DataOut = "api.data.out", | ||
| DataExhaust = "api.data.exhaust", | ||
| QueryTemplateCreate = "api.query.template.create", | ||
| QueryTemplateRead = "api.query.template.read", | ||
| QueryTemplateDelete = "api.query.template.delete", | ||
| QueryTemplateList = "api.query.template.list", | ||
| QueryTemplateUpdate = "api.query.template.update", | ||
| QueryTemplate = "api.query.template.query", | ||
| SchemaValidator = "api.schema.validator", | ||
| GenerateSignedUrl = "api.files.generate-url", | ||
| DatasetStatusTransition = "api.datasets.status-transition", | ||
| DatasetHealth = "api.dataset.health", | ||
| DatasetReset = "api.dataset.reset", | ||
| DatasetSchemaGenerator = "api.datasets.dataschema", | ||
| DatasetExport = "api.datasets.export", | ||
| DatasetCopy = "api.datasets.copy", | ||
| ConnectorList = "api.connectors.list", | ||
| ConnectorRead = "api.connectors.read", | ||
| DatasetImport = "api.datasets.import", | ||
| SQLQuery = "api.obsrv.data.sql-query", | ||
| } | ||
|
|
||
| interface AccessControl { | ||
| [key: string]: string[]; | ||
| } | ||
|
|
||
| const accessControl: AccessControl = { | ||
| [roles.Ingestor]: [permissions.DataIngest], | ||
| [roles.Viewer]: [ | ||
| permissions.DatasetList, | ||
| permissions.DatasetRead, | ||
| permissions.DatasetExport, | ||
| permissions.ConnectorRead, | ||
| permissions.SQLQuery, | ||
| permissions.DataOut, | ||
| permissions.DataExhaust, | ||
| ], | ||
| [roles.DatasetCreator]: [ | ||
| permissions.DatasetList, | ||
| permissions.DatasetRead, | ||
| permissions.DatasetExport, | ||
| permissions.ConnectorRead, | ||
| permissions.SQLQuery, | ||
| permissions.DataOut, | ||
| permissions.DataExhaust, | ||
| permissions.DatasetImport, | ||
| permissions.DatasetCreate, | ||
| permissions.DatasetUpdate, | ||
| permissions.DatasetCopy, | ||
| permissions.QueryTemplateCreate, | ||
| permissions.QueryTemplateRead, | ||
| permissions.QueryTemplateDelete, | ||
| permissions.GenerateSignedUrl, | ||
| permissions.SchemaValidator, | ||
| permissions.DatasetSchemaGenerator, | ||
| ], | ||
| [roles.DatasetManager]: [ | ||
| permissions.DatasetList, | ||
| permissions.DatasetRead, | ||
| permissions.DatasetExport, | ||
| permissions.ConnectorRead, | ||
| permissions.SQLQuery, | ||
| permissions.DataOut, | ||
| permissions.DataExhaust, | ||
| permissions.DatasetImport, | ||
| permissions.DatasetCreate, | ||
| permissions.DatasetUpdate, | ||
| permissions.DatasetCopy, | ||
| permissions.QueryTemplateCreate, | ||
| permissions.QueryTemplateRead, | ||
| permissions.QueryTemplateDelete, | ||
| permissions.GenerateSignedUrl, | ||
| permissions.SchemaValidator, | ||
| permissions.DatasetSchemaGenerator, | ||
| permissions.DatasetReset, | ||
| permissions.DatasetStatusTransition, | ||
| ], | ||
| [roles.Admin]: [ | ||
| permissions.DatasetCreate, | ||
| permissions.DatasetList, | ||
| permissions.DatasetRead, | ||
| permissions.DatasetExport, | ||
| permissions.ConnectorRead, | ||
| permissions.SQLQuery, | ||
| permissions.DataOut, | ||
| permissions.DataExhaust, | ||
| permissions.DatasetImport, | ||
| permissions.DatasetCreate, | ||
| permissions.DatasetUpdate, | ||
| permissions.DatasetCopy, | ||
| permissions.QueryTemplateCreate, | ||
| permissions.QueryTemplateRead, | ||
| permissions.QueryTemplateDelete, | ||
| permissions.GenerateSignedUrl, | ||
| permissions.SchemaValidator, | ||
| permissions.DatasetSchemaGenerator, | ||
| permissions.DatasetReset, | ||
| permissions.DatasetStatusTransition, | ||
| ], | ||
| }; | ||
|
|
||
| export default { | ||
| name: "rbac:middleware", | ||
| handler: () => (req: Request, res: Response, next: NextFunction) => { | ||
| try { | ||
| if (config.is_RBAC_enabled === true) { | ||
| const public_key = config.user_token_public_key; | ||
| const token = req.get("x-user-token"); | ||
| if (!token) { | ||
| return ResponseHandler.errorResponse( | ||
| { | ||
| statusCode: 403, | ||
| errCode: "FORBIDDEN", | ||
| message: "No token provided", | ||
| }, | ||
| req, | ||
| res | ||
| ); | ||
| } | ||
| jwt.verify(token as string, public_key, (err, decoded) => { | ||
| if (err) { | ||
| return ResponseHandler.errorResponse( | ||
| { | ||
| statusCode: 403, | ||
| errCode: "FORBIDDEN", | ||
| message: "Token verification failed", | ||
| }, | ||
| req, | ||
| res | ||
| ); | ||
| } | ||
| if (decoded && typeof decoded == "object") { | ||
| const action = (req as any).id; | ||
| const hasAccess = decoded.roles.some( | ||
| (role: string) => | ||
| accessControl[role] && accessControl[role].includes(action) | ||
| ); | ||
| if (!hasAccess) { | ||
| return ResponseHandler.errorResponse( | ||
| { | ||
| statusCode: 401, | ||
| errCode: "Unauthorized access", | ||
| message: "Access denied for the user", | ||
| }, | ||
| req, | ||
| res | ||
| ); | ||
| } | ||
| next(); | ||
| } | ||
| }); | ||
| } else { | ||
| next(); | ||
| } | ||
| } catch (error) { | ||
| next(error); | ||
| } | ||
| }, | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.