https://github.com/mitre/cosa-client
COSA Client application which communicates with the COSA API server
https://github.com/mitre/cosa-client
cosa cosa-client mitre mitre-corporation mitre-cosa
Last synced: 8 months ago
JSON representation
COSA Client application which communicates with the COSA API server
- Host: GitHub
- URL: https://github.com/mitre/cosa-client
- Owner: mitre
- License: other
- Created: 2021-06-15T20:24:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-19T18:25:11.000Z (about 2 years ago)
- Last Synced: 2025-01-05T09:43:51.691Z (9 months ago)
- Topics: cosa, cosa-client, mitre, mitre-corporation, mitre-cosa
- Language: JavaScript
- Homepage:
- Size: 32.2 KB
- Stars: 2
- Watchers: 13
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# COSA Client
This is the source code to the COSA client application which communicates with the COSA API server.
This is the application that must be installed and configured on the system that will be performing scans. Usually, this is your Continuous Integration/ Continuous Deployment (CI/CD) server. However, there are other acceptable configurations, such as a quality assurance/testing server.
It does not require elevated privileges to work. Do not run as root or administrator.
Many instances of the client may communicate with a single COSA API server.
The client application is plug-in based. That is, it executes specific plugins when instructed by the COSA server. Thus, you will need to also install or develop plugins for your specific needs. A few sample plugins are provided.
There are two parameter when invoking this program, one of which is optional.
The first parameter is the system name. It must match a system as configured in COSA.
The second parameter (optional) sets the "stage". By default, COSA defines 3 stages: image, runtime, and build. The default
is build which is a static, build-time scan.
### Examples:
```bash
node client.js SYSTEM_IN_COSA
node client.js SYSTEM_IN_COSA -s runtime
```
## MITRE Public Release
see [NOTICE.md](./NOTICE.md) for MITRE public release statements.
## LICENSE
see [LICENSE.md](./LICENSE.md) for MITRE license statements.