- About
- Getting Started
- Cybersecurity API - MVP Feature List
- Advanced Cybersecurity API - Feature List
- Swagger UI
- Routes
- TODO
Familiarising with the Fastify API framework, plugin ecosystem, Prisma ORM
-
User Registration
- Allow users to register with an email and password.
- Authenticate users and generate JWT tokens.
- Assign roles to users and restrict API access based on roles.
- Allow users to view their own profile information.
- Allow users to update their profile information.
- Allow users to delete their account.
- Allow users to create a new log entry.
- Retrieve logs based on different filters like log level.
- Allow deletion of logs.
- Allow users to create a new alert.
- Retrieve alerts based on different filters like alert level.
- Allow deletion of alerts.
- Allow users to report a new incident.
- Retrieve incidents based on different filters like status.
- Allow users to update the status and details of an incident.
- Allow deletion of incidents.
- Allow users to add a new vulnerability.
- Retrieve vulnerabilities based on different filters like severity.
- Allow users to update the details of a vulnerability.
- Allow deletion of vulnerabilities.
- Allow users to add a new asset.
- Retrieve assets based on different filters like type.
- Allow users to update the details of an asset.
- Allow deletion of assets.
- Allow users to add a new configuration for an asset.
- Retrieve configurations based on different filters.
- Allow users to update the details of a configuration.
- Allow deletion of configurations.
- Allow creation of Incidents, Vulnerabilities, Assets, and Configurations with both new and existing data entries
- Utilize AWS Cognito for enhanced security through MFA.
- Use machine learning models via AWS SageMaker to analyze user behavior and flag suspicious activities.
- Use AWS Comprehend to perform sentiment analysis on logs to automatically categorize them.
- Use AWS Lambda and SageMaker to send real-time alerts based on machine learning models that predict threat levels.
- Utilize AWS Forecast to predict future security incidents based on historical data.
- Use AWS Step Functions to automate the resolution of common incidents.
- Use AWS SageMaker to predict potential future vulnerabilities in the system.
- Use AWS Rekognition to automatically recognize and tag different types of assets from images or videos.
- Use AWS Config to automatically check the security configurations of assets.
- Use machine learning models on AWS SageMaker to analyze large datasets for potential threats.
- Utilize AWS Lex to allow users to query the system using natural language to find potential threats.
- Use AWS SageMaker to create a machine learning model that can simulate various types of phishing attacks for training purposes.
- Use AWS Personalize to offer real-time training recommendations to users based on their behavior and role.
- Use AWS QuickSight to generate automated compliance reports.
- Use AWS Forecast to predict future compliance risks.
npm start:devto start the server in development modeYou'll need to be a repository collaborator for access to the mongoDB instance in the cloud.
- PRIORITY: encapsulate all CRUD routes into plugins
- add auth layer (Clerk has some free tier limitations...)
- add Strange Beings phrase to English conversion
- Use fastify route print out to automatically update README declaration of routes
- Use plugin docs to add swagger to autoload correctly with TS
- Find out which parts of Swagger files I do not need for dynamic generation of routes
- Improve logger at init and runtime
- Configure separate formatter for markdown
- Get custom domain to host Clerk services on Heroku