This is a service to validate documents against the CSAF standard. It uses the csaf-validator-lib under the hood which is included as a git subtree module.
To run the validator service you basically need the same as for developing.
npm run distNODE_ENV to productionlocal-production.json file in
backend/config. All available parameters are outlined in backend/config/development.json. See https://www.npmjs.com/package/config for more information on how to configure using different techniques such as environment variables.node backend/server.jsTo manage the process you can use Docker or an init system of your choice.
You most likely also want to run this behind a reverse proxy to handle TLS termination or CORS headers if the service is accessed from other domains. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS for more information.
The documentation is available as a swagger resource provided by the service itself under /docs. So once the server is running, visit http://localhost:<config port>/docs in your browser. The default port of the application 8082. See configuration to learn about ways to change it.
The project uses the config npm package for configuration. It provides a variety of possibilities to inject configuration values e.g. environment variables or environment specific files.
Fastify CORS options can be configured by passing an options object by the name cors
The following options are available:
origin, methods, allowedHeaders, exposedHeaders, credentials, maxAge
See Fastify CORS options for more information
You need at least Node.js version 20 or higher. Nodesource provides binary distributions for various Linux distributions.
npm ciStart the server
npm run devThe server needs to be running and the openapi-generator-cli must be installed. The file backend/lib/app.js needs to reflect the target version. Then, you can use the following commands to generate the documentation:
openapi-generator-cli generate -i http://localhost:8082/docs/json -g html -o ./documents/generated/html/
openapi-generator-cli generate -i http://localhost:8082/docs/json -g asciidoc -o ./documents/generated/asciidoc/Many tests are integration tests which need a running server. So make sure to start it before running the tests:
npm run devTests are implemented using mocha. They can be run using the following command:
npm testBuild docker image
docker build -t csaf/validator-service .Start container
docker run -d -p 8082:8082 --name csaf-validator-service csaf/validator-serviceIf you want to start the service with pm2 you have to adjust the instance_var attribute for pm2.
You can do this by adding the following configuration in the backend folder.
Depending on the directory you chose, you have to adjust the cwd and NODE_CONFIG_DIR attributes accordingly.
// pm2.config.cjs
module.exports = {
apps: [
{
name: 'csaf-validator-service',
script: './server.js',
cwd: '/var/www/csaf-validator-service/backend',
instance_var: 'INSTANCE_ID',
env: {
NODE_ENV: 'development',
NODE_CONFIG_DIR: '/var/www/csaf-validator-service/backend/config/',
},
env_production: {
NODE_ENV: 'production',
NODE_CONFIG_DIR: '/var/www/csaf-validator-service/backend/config/',
},
},
],
}To start the service execute this command inside the backend directory:
pm2 start pm2.config.js --env productionYou can find our guidelines here CONTRIBUTING.md
For the complete list of dependencies please take a look at package.json