zeek/doc/scripts/base/files/x509/log-ocsp.zeek.rst
Tim Wojtulewicz ded98cd373 Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
2025-09-26 02:58:29 +00:00

126 lines
3.4 KiB
ReStructuredText

:tocdepth: 3
base/files/x509/log-ocsp.zeek
=============================
.. zeek:namespace:: OCSP
Enable logging of OCSP responses.
:Namespace: OCSP
Summary
~~~~~~~
Types
#####
============================================ ==========================================================
:zeek:type:`OCSP::Info`: :zeek:type:`record` The record type which contains the fields of the OCSP log.
============================================ ==========================================================
Redefinitions
#############
======================================= ========================
:zeek:type:`Log::ID`: :zeek:type:`enum`
* :zeek:enum:`OCSP::LOG`
======================================= ========================
Events
######
============================================= ===================================================
:zeek:id:`OCSP::log_ocsp`: :zeek:type:`event` Event that can be handled to access the OCSP record
as it is sent to the logging framework.
============================================= ===================================================
Hooks
#####
========================================================= =
:zeek:id:`OCSP::log_policy`: :zeek:type:`Log::PolicyHook`
========================================================= =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Types
#####
.. zeek:type:: OCSP::Info
:source-code: base/files/x509/log-ocsp.zeek 11 34
:Type: :zeek:type:`record`
.. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
Time when the OCSP reply was encountered.
.. zeek:field:: id :zeek:type:`string` :zeek:attr:`&log`
File id of the OCSP reply.
.. zeek:field:: hashAlgorithm :zeek:type:`string` :zeek:attr:`&log`
Hash algorithm used to generate issuerNameHash and issuerKeyHash.
.. zeek:field:: issuerNameHash :zeek:type:`string` :zeek:attr:`&log`
Hash of the issuer's distinguished name.
.. zeek:field:: issuerKeyHash :zeek:type:`string` :zeek:attr:`&log`
Hash of the issuer's public key.
.. zeek:field:: serialNumber :zeek:type:`string` :zeek:attr:`&log`
Serial number of the affected certificate.
.. zeek:field:: certStatus :zeek:type:`string` :zeek:attr:`&log`
Status of the affected certificate.
.. zeek:field:: revoketime :zeek:type:`time` :zeek:attr:`&log` :zeek:attr:`&optional`
Time at which the certificate was revoked.
.. zeek:field:: revokereason :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
Reason for which the certificate was revoked.
.. zeek:field:: thisUpdate :zeek:type:`time` :zeek:attr:`&log`
The time at which the status being shows is known to have been correct.
.. zeek:field:: nextUpdate :zeek:type:`time` :zeek:attr:`&log` :zeek:attr:`&optional`
The latest time at which new information about the status of the certificate will be available.
The record type which contains the fields of the OCSP log.
Events
######
.. zeek:id:: OCSP::log_ocsp
:source-code: base/files/x509/log-ocsp.zeek 38 38
:Type: :zeek:type:`event` (rec: :zeek:type:`OCSP::Info`)
Event that can be handled to access the OCSP record
as it is sent to the logging framework.
Hooks
#####
.. zeek:id:: OCSP::log_policy
:source-code: base/files/x509/log-ocsp.zeek 8 8
:Type: :zeek:type:`Log::PolicyHook`