Consent Management Backend

Description

This is the backend component (hosted on Docker) for the consent management service in the SPECIAL architecture. It is responsible for CRUD operations of both data subject and data controller policies.

It takes care of validating the inputs before writing them into rethinkdb.

It also emits 2 streams of data for downstream consumption:

• Policy Change Feed for audit purposes
• Full Policy Feed for replication purposes

The CI configuration takes care of testing the code and automatically building properly tagged docker images for deployment.

Configuration

All options are specified as environment variables for the nodejs process

• LOGGING_LEVEL: The verbosity of the logs. oneOf: [trace, debug, info, warn, error, fatal] (default: info)
• SERVER_HOST: The hostname of the server (default: localhost)
• SERVER_PORT: The port of the server (default: 80)
• SERVER_AUTH_CALLBACK_ENDPOINT: The callback URL where the authentication server should redirect the user after authentication (default: http://localhost/callback)
• SESSION_SECRET: The secret used to sign the session id cookie (default: consent-management-backend)
• HTTP_MAX_SOCKETS: The maximum number of HTTP sockets that can be opened (default: 10)
• RETHINKDB_HOST: The hostname of the rethinkdb server (default: localhost)
• RETHINKDB_PORT: The port on which the rethinkdb server is listening (default: 28015)
• RETHINKDB_TIMEOUT: The timeout in seconds when connecting to RethinkDB (default: 60)
• KAFKA_BROKER_LIST: A list of kafka endpoints to try when connecting to the kafka cluster (default: localhost:9092)
• KAFKA_TIMEOUT: The timeout in milliseconds when connecting to Kafka (default: localhost:60000)
• KAFKA_VERSION_REQUEST: Whether the Kafka client should try to obtain the Kafka version, was to set to false to avoid a known bug (default: false)
• KAFKA_CHANGE_LOGS_TOPIC: The name of the topic where the audit log gets written (default: policies-audit)
• KAFKA_FULL_POLICIES_TOPIC: The name of the topic where the the replication log gets written (default: full-policies)
• AUTH_CLIENT_ID: The ID of your OAUTH client (default: special-platform)
• AUTH_CLIENT_SECRET: The secret of your OAUTH client (default: special-platform-secret)
• AUTH_LOGIN_ENDPOINT: The authentication URL of your OAUTH server (default: http://localhost:8080/auth/realms/master/protocol/openid-connect/auth)
• AUTH_TOKEN_ENDPOINT: The token URL of your OAUTH server (default: http://localhost:8080/auth/realms/master/protocol/openid-connect/token)
• AUTH_USERINFO_ENDPOINT: The token URL of your OAUTH server (default: http://localhost:8080/auth/realms/master/protocol/openid-connect/userinfo)