Source code for privacyidea.lib.auditmodules.base

#  privacyIDEA is a fork of LinOTP
#  May 08, 2014 Cornelius Kölbel
#  License:  AGPLv3
#  contact:
#  2014-10-17 Fix the empty result problem
#             Cornelius Kölbel, <>
#  Copyright (C) 2010 - 2014 LSE Leading Security Experts GmbH
#  License:  AGPLv3
#  contact:
# This code is free software; you can redistribute it and/or
# modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
# License as published by the Free Software Foundation; either
# version 3 of the License, or any later version.
# This code is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# You should have received a copy of the GNU Affero General Public
# License along with this program.  If not, see <>.
__doc__="""This is the BaseClass for audit trails

The audit is supposed to work like this. First we need to create an audit
object. E.g. this can be done in the before_request:

    g.audit_object = getAudit(file_config)

During the request, the g.audit_object can be used to add audit information:

    g.audit_object.log({"client": "", "action": "validate/check"})

Thus at many different places in the code, audit information can be added to
the audit object.
Finally the audit_object needs to be stored to the audit storage. So we call:


which creates a signature of the audit data and writes the data to the audit

import logging
import traceback
from privacyidea.lib.log import log_with
import datetime

log = logging.getLogger(__name__)

class Paginate(object):
    This is a pagination object, that is used for searching audit trails.
    def __init__(self):
        # The audit data
        self.auditdata = []
        # The number of the previous page
        self.prev = None
        # the number of the next page = None
        # the number of the current page
        self.current = 1 = 1
        # the total entry numbers = 0

[docs]class Audit(object): # pragma: no cover is_readable = False def __init__(self, config=None, startdate=None): """ Create a new audit object. :param config: The web config is passed to the audit module, so that the special module implementation can get its configuration. :type config: dict :param startdate: The datetime of the beginning of the request :type startdate: datetime :return: Audit object """ = "AuditBase" self.audit_data = {'startdate': startdate or} self.config = config or {} self.private = "" self.public = ""
[docs] def log_token_num(self, count): """ Log the number of the tokens. Can be passed like log_token_num(get_tokens(count=True)) :param count: Number of tokens :type count: int :return: """ self.audit_data['action_detail'] = "tokennum = {0!s}".format(str(count))
[docs] @log_with(log) def read_keys(self, pub, priv): """ Set the private and public key for the audit class. This is achieved by passing the values: .. code-block:: python priv = config.get("privacyideaAudit.key.private") pub = config.get("privacyideaAudit.key.public") :param pub: Public key, used for verifying the signature :type pub: string with filename :param priv: Private key, used to sign the audit entry :type priv: string with filename :return: None """ try: with open(priv, "rb") as privkey_file: self.private = with open(pub, 'rb') as pubkey_file: self.public = except Exception as e: log.error("Error reading key file: {0!r})".format(e)) log.debug(traceback.format_exc()) raise e
[docs] def get_audit_id(self): return
@property def available_audit_columns(self): return ['number', 'action', 'success', 'authentication', 'serial', 'date', 'startdate', 'duration', 'token_type', 'user', 'realm', 'administrator', 'action_detail', 'info', 'privacyidea_server', 'client', 'user_agent', 'user_agent_version', 'log_level', 'policies', 'clearance_level', 'sig_check', 'missing_line', 'resolver', 'thread_id']
[docs] def get_total(self, param, AND=True, display_error=True, timelimit=None): """ This method returns the total number of audit entries in the audit store """ return None
@property def has_data(self): # We check if there is actually audit_data with an action. # Since the audit_data is initialized with the startdate. return bool(self.audit_data and "action" in self.audit_data)
[docs] @log_with(log) def log(self, param): """ This method is used to log the data. During a request this method can be called several times to fill the internal audit_data dictionary. Add new log details in param to the internal log data self.audit_data. :param param: Log data that is to be added :type param: dict :return: None """ for k, v in param.items(): self.audit_data[k] = v
[docs] def add_to_log(self, param, add_with_comma=False): """ Add to existing log entry. :param param: :param add_with_comma: If set to true, new values will be appended comma separated :return: """ for k, v in param.items(): if k not in self.audit_data: # We need to create the entry self.audit_data[k] = v else: if add_with_comma: self.audit_data[k] += "," self.audit_data[k] += v
[docs] def add_policy(self, policyname): """ This method adds a triggered policyname to the list of triggered policies. :param policyname: A string or a list of strings as policynames :return: """ if "policies" not in self.audit_data: self.audit_data["policies"] = [] if type(policyname) == list: for p in policyname: self.audit_data["policies"].append(p) else: self.audit_data["policies"].append(policyname)
[docs] def finalize_log(self): """ This method is called to finalize the audit_data. I.e. sign the data and write it to the database. It should hash the data and do a hash chain and sign the data """ pass
[docs] def initialize_log(self, param): """ This method initialized the log state. The fact, that the log state was initialized, also needs to be logged. Therefor the same parameters are passed as in the log method. """ pass
# def set(self): # """ # This function could be used to set certain things like the signing key. # But maybe it should only be read from pi.cfg? # """ # pass
[docs] def search(self, search_dict, page_size=15, page=1, sortorder="asc", timelimit=None): """ This function is used to search audit events. :param: Search parameters can be passed. :return: A pagination object """ return Paginate()
[docs] def get_count(self, search_dict, timedelta=None, success=None): """ Returns the number of found log entries. E.g. used for checking the timelimit. :param param: List of filter parameters :return: number of found entries """ return 0
[docs] def csv_generator(self, param=None, user=None, timelimit=None): """ A generator that can be used to stream the audit log :param param: :return: """ pass
[docs] def search_query(self, search_dict, page_size=15, page=1, sortorder="asc", sortname="number", timelimit=None): """ This function returns the audit log as an iterator on the result """ return None
[docs] def audit_entry_to_dict(self, audit_entry): """ If the search_query returns an iterator with elements that are not a dictionary, the audit module needs to provide this function, to convert the audit entry to a dictionary. """ return {}