For users new to Python and FastAPI, keeping the FastAPI-fastkit open source healthy is one of the critical challenges.
To maintain the security and stability of FastAPI-fastkit for users new to Python and FastAPI & FastAPI-fastkit contributors, please follow these guidelines.
-
All template projects must meet these security requirements:
- Sensitive information management through environment variables (.env)
- Basic authentication/authorization system implementation
- CORS configuration implementation
- Proper exception handling and logging system
-
Dependency Management:
- No use of packages with known security vulnerabilities
- Version specification required in requirements.txt
- Use of versions with latest security patches
If you discover a security vulnerability:
- Report via GitHub Issues
- Contact project maintainer directly (bbbong9@gmail.com)
- Keep vulnerability private until resolved
All template projects must pass these automated security checks:
- Template validation through inspector.py
- Code quality and security static analysis
- Dependency vulnerability scanning through GitHub Actions
- Environment Variables: Always use
.env
files for sensitive data - Authentication: Implement proper authentication mechanisms
- Input Validation: Validate all user inputs
- Error Handling: Don't expose sensitive information in error messages
- Dependencies: Keep dependencies minimal and up-to-date
- No hardcoded secrets: Use environment variables
- SQL Injection Prevention: Use parameterized queries
- XSS Prevention: Properly sanitize outputs
- CSRF Protection: Implement CSRF tokens where needed
# Before committing changes
make dev-check # Runs code checks
# Regular dependency updates
pip list --outdated
make clean && make dev-setup # Refresh environment
Before submitting a new template, ensure:
- All sensitive data uses environment variables
- Authentication/authorization implemented
- CORS properly configured
- Input validation in place
- Error handling doesn't expose sensitive data
- Dependencies are up-to-date and secure
-
make dev-check
passes all tests - No hardcoded secrets or credentials
- SQL queries use parameterization
- Proper logging configuration
This project uses:
- GitHub Dependabot: Automatic dependency updates
- GitHub Actions: Security scanning on PRs
- Code scanning: Static analysis for vulnerabilities (will be added soon)
All security updates are documented in:
For security-related discussions, please use:
- GitHub Security Advisories (for vulnerabilities)
- GitHub Discussions - Security category (for general security topics)
- Direct email contact for sensitive matters
@author bnbong bbbong9@gmail.com