datawave-audit-service
Tags:
The audit service is a DATAWAVE microservice that provides query audit capabilities.
Audit Context
User API
| Method | Operation | Description | Path Param | Request Body |
|---|---|---|---|---|
POST |
/audit | Sends an audit request | N/A | [AuditRequest] |
Replay Context
https://host:port/audit/v1/replay/
Replay API
| Method | Operation | Description | Path Param | Request Body |
|---|---|---|---|---|
POST |
/create | Creates an audit replay request | N/A | [ReplayRequest] |
POST |
/createAndStart | Creates an audit replay request, and starts it | N/A | [ReplayRequest] |
PUT |
/{id}/start | Starts an audit replay | [ReplayId] | N/A |
GET |
/{id}/status | Gets the status of an audit replay | [ReplayId] | N/A |
PUT |
/{id}/update | Updates an audit replay | [ReplayId] | [SendRate] |
PUT |
/{id}/stop | Stops an audit replay | [ReplayId] | N/A |
PUT |
/{id}/resume | Resumes an audit replay | [ReplayId] | N/A |
DELETE |
/{id}/delete | Deletes an audit replay | [ReplayId] | N/A |
PUT |
/startAll | Starts all audit replays | N/A | N/A |
GET |
/statusAll | Gets the status for all audit replays | N/A | N/A |
PUT |
/updateAll | Updates all audit replays | N/A | [SendRate] |
PUT |
/stopAll | Stops all audit replays | N/A | N/A |
PUT |
/resumeAll | Resumes all audit replays | N/A | N/A |
DELETE |
/deleteAll | Deletes all audit replays | N/A | N/A |
Getting Started
First, refer to services/README for launching the config and authorization services.
- The authorization service should be launched with the
mockprofile to leverage test PKI materials and associated user configuration (see authorization-mock.yml).
- The authorization service should be launched with the
Launch this service as follows, with the
remoteauthprofile to enable client cert authentication...java -jar service/target/audit-service*-exec.jar --spring.profiles.active=dev,remoteauth,mockEnsure that the PKI Dir is checked out locally somewhere, and set in the environment variable
PKI_DIR.Submit an audit request using curl.
curl -q -k --cacert $PKI_DIR/ca.pem -E $PKI_DIR/user.pem \ --data-urlencode "auditUserDN=testUser" \ --data-urlencode "auditType=LOCALONLY" \ --data-urlencode "query=no query--testing the audit service" \ --data-urlencode "queryDate=1514764800000" \ --data-urlencode "auditColumnVisibility=USER" \ --data-urlencode "logicClass=EventQuery" \ --data-urlencode "auths=TEST" \ https://localhost:8743/audit/v1/auditSee sample_configuration/audit-dev.yml and configure as desired
