https://github.com/cds-snc/scan-files
File scanning for CDS Platform products
https://github.com/cds-snc/scan-files
antivirus clamav lambda
Last synced: 5 months ago
JSON representation
File scanning for CDS Platform products
- Host: GitHub
- URL: https://github.com/cds-snc/scan-files
- Owner: cds-snc
- License: mit
- Created: 2021-11-12T17:46:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T12:19:39.000Z (12 months ago)
- Last Synced: 2024-10-22T20:48:04.899Z (12 months ago)
- Topics: antivirus, clamav, lambda
- Language: Python
- Homepage: https://scan-files.alpha.canada.ca/
- Size: 3.16 MB
- Stars: 2
- Watchers: 15
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Scan Files 🖨️
_La version française sera disponible bientôt_
This repository is for a file scanning product for CDS Platform applications.
## API docs
- https://scan-files.alpha.canada.ca/docs
## Supported scanners:
- [Assemblyline](https://cybercentrecanada.github.io/assemblyline4_docs/)
- [ClamAV](https://www.clamav.net/)
## Modules
- [S3 scan object](./module/s3-scan-object/)
# Development
Recommended: `devcontainer` extension for VSCode
To bring up your local dev environment, make sure you have install the requirements & run migrations:
```
make install
make install-dev
make migrations
```
Bring up the local dev environment:
```
make dev
```
## Load testing
The API contains a `locust` file to test a basic workflow:
1. Upload file
2. Check for results
Ensure that the `API_AUTH_TOKEN` environment variable is set before running load tests
You can start it by running `make load-test` in the `api` directory and the visiting: `http://localhost:8089/`. The URL to perform load tests against is https://scan-files.alpha.canada.ca.