sd_bus_message_sensitive(3) — Linux manual page


SD_BUS_M...ENSITIVE(3)  sd_bus_message_sensitive  SD_BUS_M...ENSITIVE(3)

NAME         top

       sd_bus_message_sensitive - Mark a message object as containing
       sensitive data

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_message_sensitive(sd_bus_message *message);

DESCRIPTION         top

       sd_bus_message_sensitive() marks an allocated bus message as
       containing sensitive data. This ensures that the message data is
       carefully removed from memory (specifically, overwritten with
       zero bytes) when released. It is recommended to mark all incoming
       and outgoing messages like this that contain security credentials
       and similar data that should be dealt with carefully. Note that
       it is not possible to unmark messages like this, it's a one way
       operation. If a message is already marked sensitive and then
       marked sensitive a second time the message remains marked so and
       no further operation is executed.

       As a safety precaution all messages that are created as reply to
       messages that are marked sensitive are also implicitly marked so.

RETURN VALUE         top

       On success, this functions return 0 or a positive integer. On
       failure, it returns a negative errno-style error code.

       Returned errors may indicate the following problems:

           The message parameter is NULL.

           Added in version 245.

NOTES         top

       Functions described here are available as a shared library, which
       can be compiled against and linked to with the
       libsystemd pkg-config(1) file.

       The code described here uses getenv(3), which is declared to be
       not multi-thread-safe. This means that the code calling the
       functions described here must not call setenv(3) from a parallel
       thread. It is recommended to only do calls to setenv() from an
       early phase of the program when no other threads have been

HISTORY         top

       sd_bus_message_sensitive() was added in version 245.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_message_new_method_call(3)

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨⟩.  If you have
       a bug report for this manual page, see
       This page was obtained from the project's upstream Git repository
       ⟨⟩ on 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-12-22.)  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

systemd 255                                       SD_BUS_M...ENSITIVE(3)

Pages that refer to this page: sd_bus_add_object(3)systemd.directives(7)systemd.index(7)