6.1.1.3.1.2.1.2. linotp.lib.audit.base module

This is the BaseClass for logging Audit Trails

class linotp.lib.audit.base.AuditBase

Bases: object

getAuditId()

getTotal(param, AND=True, display_error=True)

This method returns the total number of audit entries in the audit store

initialize()

initialize_log(param)

This method initialized the log state. The fact, that the log state was initialized, also needs to be logged. Therefor the same params are passed as i the log method.

log(param)

This method is used to log the data. It should hash the data and do a hash chain and sign the data

readKeys()

search(param, AND=True, display_error=True, rp_dict=None)

This function is used to search audit events.

param:

Search parameters can be passed.

return:

A list of dictionaries is return. Each list element denotes an audit event.

searchQuery(param, AND=True, display_error=True, rp_dict=None)

This function is used to search audit events.

param:

Search parameters can be passed.

return:

An iterator is returned.

set()

This function could be used to set certain things like the signing key. But maybe it should only be read from linotp.ini?

linotp.lib.audit.base.getAudit()

linotp.lib.audit.base.getAuditClass(packageName, className)

helper method to load the Audit class from a given package in literal:

example:

getAuditClass(“SQLAudit”, “Audit”)

check:

checks, if the log method exists if not an error is thrown

linotp.lib.audit.base.logTokenNum()

linotp.lib.audit.base.search(param, user=None, columns=None)