KasperskyOS Community Edition 1.3
English
KasperskyOS API  >  libkos library  >  Receiving security audit data (vlog_api.h)

Receiving security audit data (vlog_api.h)

This API is defined in the header file sysroot-*-kos/include/coresrv/vlog/vlog_api.h from the KasperskyOS SDK.

The API lets you read from the KasperskyOS kernel log containing security audit data and is used in the code of the static library sysroot-*-kos/lib/libklog_system_audit.a, which is linked to the Klog system program.

Information about API functions is provided in the table below.

Using the API

The API usage scenario includes the following steps:

  1. Open the kernel log containing security audit data by calling the KnAuOpen() function.
  2. Receive messages from the kernel log containing security audit data via calls of the KnAuRead() function.

    This log is a cyclic buffer, and therefore you must prevent overwrites in this log because they could lead to a loss of security audit data that has not yet been read. To monitor overwrites in the log, the outDropMsgs parameter of the KnAuRead() function is used to pass the number of dropped messages. (The counter of these messages is reset to zero after this value is read each time the function is called.) If messages have been dropped, you must either increase the speed at which messages are read from the log, for example, by performing the read operation from parallel threads, or reduce the speed of message generation by editing the security audit profile.

  3. Close the kernel log containing security audit data by calling the KnAuClose() function.

Information about API functions

vlog_api.h functions

Function

Information about the function

KnAuOpen()

Purpose

Opens the kernel log containing security audit data.

Parameters

  • [in] name – pointer to the name of the kernel log containing security audit data (kss must be specified).
  • [out] outRID – pointer to the handle of the kernel log containing security audit data.

Returned values

If successful, the function returns rcOk, otherwise it returns an error code.

KnAuClose()

Purpose

Closes the kernel log containing security audit data.

Parameters

  • [in] rid – handle of the kernel log containing security audit data.

Returned values

If successful, the function returns rcOk, otherwise it returns an error code.

KnAuRead()

Purpose

Receives a message from the kernel log containing security audit data.

Parameters

  • [in] rid – handle of the kernel log containing security audit data.
  • [out] msg – pointer to the buffer used to store the message. The type of message is defined in the header file sysroot-*-kos/include/vlog/audit.h. The buffer size must be at least FULL_AUDIT_MESSAGE_LENGTH_MAX bytes.
  • [out] outDropMsgs – pointer to the number of messages that were lost due to overwrites in the kernel log containing security audit data.

Returned values

If successful, the function returns rcOk, otherwise it returns an error code.

Article ID: libkos_vlog_api, Last review: Feb 20, 2025
Page top