audit_value_needs_encoding(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | AUTHOR | COLOPHON

AUDIT_VALUE...DS_ENCODING(3) Linux Audit API AUDIT_VALUE...DS_ENCODING(3)

NAME         top

       audit_value_needs_encoding - check a string to see if it needs
       encoding

SYNOPSIS         top

       #include <libaudit.h>

       int audit_value_needs_encoding(const char *str, unsigned int size);

DESCRIPTION         top

       audit_value_needs_encoding() checks size bytes from str to see if
       the value must be encoded before it is logged in an audit
       name/value field.  Specifically, this function checks for a
       double-quote, any byte in the range 0x00 through 0x20, or any byte
       in the range 0x7F through 0xFF.  The 0x00 through 0x20 range
       includes C0 control bytes and space.

       str is the byte string to check.  It does not have to be NUL-
       terminated and may contain embedded NUL bytes.  size is the number
       of bytes to check from str.  If str is NULL, encoding is not
       needed.

RETURN VALUE         top

       The return value if encoding is needed is 1. If not needed is 0.

SEE ALSO         top

       audit_encode_nv_string(3), audit_encode_value(3).

AUTHOR         top

       Steve Grubb

COLOPHON         top

       This page is part of the audit (Linux Audit) project.  Information
       about the project can be found at 
       ⟨http://people.redhat.com/sgrubb/audit/⟩.  If you have a bug report
       for this manual page, send it to linux-audit@redhat.com.  This
       page was obtained from the project's upstream Git repository
       ⟨https://github.com/linux-audit/audit-userspace.git⟩ on
       2026-05-24.  (At that time, the date of the most recent commit
       that was found in the repository was 2026-05-17.)  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a
       mail to man-pages@man7.org

Red Hat                          May 2026    AUDIT_VALUE...DS_ENCODING(3)

Pages that refer to this page: audit_encode_nv_string(3)audit_encode_value(3)