Audit | Java SDK

The audit API is designed for recording a trail of application-based user activity in a scalable, tamper-proof log.

Deprecated use AuditClientBuilder instead.

Log an entry

log(cloud.pangeacyber.pangea.audit.Event)

Log an event to Audit Secure Log. By default does not sign event and verbose is left as server default

required parameters

event

cloud.pangeacyber.pangea.audit.Event

event to log

Response Object

LogResponse

 String msg = "Event's message";

 Event event = new Event(msg);

 LogResponse response = client.log(event);

Log an entry - event, sign, verbose

log(cloud.pangeacyber.pangea.audit.Event, cloud.pangeacyber.pangea.audit.SignMode,boolean,boolean)

Log an event to Audit Secure Log. Can select sign event or not and verbosity of the response.

required parameters

event

cloud.pangeacyber.pangea.audit.Event

event to log

signMode

cloud.pangeacyber.pangea.audit.SignMode

"Unsigned" or "Local"

verbose

boolean

true to more verbose response

Response Object

LogResponse

 String msg = "Event's message";

 Event event = new Event(msg);

 LogResponse response = client.log(event, "Local", true);

Get last root

getRoot()

Get last root from Pangea Server

Response Object

RootResponse

 RootResponse response = client.getRoot();

Tamperproof verification

getRoot(int)

Returns current root hash and consistency proof.

required parameters

treeSize

int

tree size to get root

Response Object

RootResponse

 RootResponse response = client.getRoot(treeSize);

Search

search(cloud.pangeacyber.pangea.audit.SearchInput)

Perform a search of logs according to input param. By default verify logs consistency and events hash and signature.

required parameters

input

cloud.pangeacyber.pangea.audit.SearchInput

query filters to perform search

Response Object

SearchResponse

 SearchInput input = new SearchInput("message:Integration test msg");

 input.setMaxResults(10);

 SearchResponse response = client.search(input);

Search - input, verifyConsistency, verifyEvents

search(cloud.pangeacyber.pangea.audit.SearchInput, boolean,boolean)

Perform a search of logs according to input param. Allow to select to verify or nor consistency proof and events.

required parameters

input

cloud.pangeacyber.pangea.audit.SearchInput

query filters to perform search

verifyConsistency

boolean

true to verify logs consistency proofs

verifyEvents

boolean

true to verify logs hash and signature

Response Object

SearchResponse

 SearchInput input = new SearchInput("message:Integration test msg");

 input.setMaxResults(10);

 SearchResponse response = client.search(input);

Results of a search

results(java.lang.String, java.lang.Integer,java.lang.Integer)

Fetch paginated results of a previously executed search. By default: verifyEvents is true and verifyConsistency is false.

required parameters

java.lang.String

A search results identifier returned by the search call.

limit

java.lang.Integer

Number of audit records to include in a single set of results.

offset

java.lang.Integer

Offset from the start of the result set to start returning results from.

Response Object

ResultsResponse

Results - id, limit, offset, verifyConsistency, verifyEvents

results(java.lang.String, java.lang.Integer,java.lang.Integer,boolean,boolean)

Fetch paginated results of a previously executed search.

required parameters

java.lang.String

A search results identifier returned by the search call.

limit

java.lang.Integer

Number of audit records to include in a single set of results.

offset

java.lang.Integer

Offset from the start of the result set to start returning results from.

verifyConsistency

boolean

true to verify logs consistency proofs

verifyEvents

boolean

true to verify logs hash and signature

Response Object

ResultsResponse