1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 Copyright 2013 Lennart Poettering
6 #include "alloc-util.h"
8 #include "bus-internal.h"
9 #include "bus-message.h"
12 #include "capability-util.h"
14 #include "format-util.h"
15 #include "locale-util.h"
17 #include "string-util.h"
19 #include "terminal-util.h"
22 static char *indent(unsigned level
, unsigned flags
) {
28 if (flags
& BUS_MESSAGE_DUMP_SUBTREE_ONLY
&& level
> 0)
31 if (flags
& BUS_MESSAGE_DUMP_WITH_HEADER
)
34 p
= new(char, n
+ level
*8 + 1);
38 if (flags
& BUS_MESSAGE_DUMP_WITH_HEADER
) {
43 memset(p
+ i
, ' ', level
*8);
49 int bus_message_dump(sd_bus_message
*m
, FILE *f
, unsigned flags
) {
58 if (flags
& BUS_MESSAGE_DUMP_WITH_HEADER
) {
60 "%s%s%s Type=%s%s%s Endian=%c Flags=%u Version=%u Priority=%"PRIi64
,
61 m
->header
->type
== SD_BUS_MESSAGE_METHOD_ERROR
? ansi_highlight_red() :
62 m
->header
->type
== SD_BUS_MESSAGE_METHOD_RETURN
? ansi_highlight_green() :
63 m
->header
->type
!= SD_BUS_MESSAGE_SIGNAL
? ansi_highlight() : "", special_glyph(TRIANGULAR_BULLET
), ansi_normal(),
64 ansi_highlight(), bus_message_type_to_string(m
->header
->type
), ansi_normal(),
70 /* Display synthetic message serial number in a more readable
71 * format than (uint32_t) -1 */
72 if (BUS_MESSAGE_COOKIE(m
) == 0xFFFFFFFFULL
)
73 fprintf(f
, " Cookie=-1");
75 fprintf(f
, " Cookie=%" PRIu64
, BUS_MESSAGE_COOKIE(m
));
77 if (m
->reply_cookie
!= 0)
78 fprintf(f
, " ReplyCookie=%" PRIu64
, m
->reply_cookie
);
83 fprintf(f
, " Sender=%s%s%s", ansi_highlight(), m
->sender
, ansi_normal());
85 fprintf(f
, " Destination=%s%s%s", ansi_highlight(), m
->destination
, ansi_normal());
87 fprintf(f
, " Path=%s%s%s", ansi_highlight(), m
->path
, ansi_normal());
89 fprintf(f
, " Interface=%s%s%s", ansi_highlight(), m
->interface
, ansi_normal());
91 fprintf(f
, " Member=%s%s%s", ansi_highlight(), m
->member
, ansi_normal());
93 if (m
->sender
|| m
->destination
|| m
->path
|| m
->interface
|| m
->member
)
96 if (sd_bus_error_is_set(&m
->error
))
99 " ErrorMessage=%s\"%s\"%s\n",
100 ansi_highlight_red(), strna(m
->error
.name
), ansi_normal(),
101 ansi_highlight_red(), strna(m
->error
.message
), ansi_normal());
103 if (m
->monotonic
!= 0)
104 fprintf(f
, " Monotonic="USEC_FMT
, m
->monotonic
);
105 if (m
->realtime
!= 0)
106 fprintf(f
, " Realtime="USEC_FMT
, m
->realtime
);
108 fprintf(f
, " SequenceNumber=%"PRIu64
, m
->seqnum
);
110 if (m
->monotonic
!= 0 || m
->realtime
!= 0 || m
->seqnum
!= 0)
113 bus_creds_dump(&m
->creds
, f
, true);
116 r
= sd_bus_message_rewind(m
, !(flags
& BUS_MESSAGE_DUMP_SUBTREE_ONLY
));
118 return log_error_errno(r
, "Failed to rewind: %m");
120 if (!(flags
& BUS_MESSAGE_DUMP_SUBTREE_ONLY
)) {
121 _cleanup_free_
char *prefix
= NULL
;
123 prefix
= indent(0, flags
);
127 fprintf(f
, "%sMESSAGE \"%s\" {\n", prefix
, strempty(m
->root_container
.signature
));
131 _cleanup_free_
char *prefix
= NULL
;
132 const char *contents
= NULL
;
147 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
149 return log_error_errno(r
, "Failed to peek type: %m");
155 r
= sd_bus_message_exit_container(m
);
157 return log_error_errno(r
, "Failed to exit container: %m");
161 prefix
= indent(level
, flags
);
165 fprintf(f
, "%s};\n", prefix
);
169 prefix
= indent(level
, flags
);
173 if (bus_type_is_container(type
) > 0) {
174 r
= sd_bus_message_enter_container(m
, type
, contents
);
176 return log_error_errno(r
, "Failed to enter container: %m");
178 if (type
== SD_BUS_TYPE_ARRAY
)
179 fprintf(f
, "%sARRAY \"%s\" {\n", prefix
, contents
);
180 else if (type
== SD_BUS_TYPE_VARIANT
)
181 fprintf(f
, "%sVARIANT \"%s\" {\n", prefix
, contents
);
182 else if (type
== SD_BUS_TYPE_STRUCT
)
183 fprintf(f
, "%sSTRUCT \"%s\" {\n", prefix
, contents
);
184 else if (type
== SD_BUS_TYPE_DICT_ENTRY
)
185 fprintf(f
, "%sDICT_ENTRY \"%s\" {\n", prefix
, contents
);
192 r
= sd_bus_message_read_basic(m
, type
, &basic
);
194 return log_error_errno(r
, "Failed to get basic: %m");
200 case SD_BUS_TYPE_BYTE
:
201 fprintf(f
, "%sBYTE %s%u%s;\n", prefix
, ansi_highlight(), basic
.u8
, ansi_normal());
204 case SD_BUS_TYPE_BOOLEAN
:
205 fprintf(f
, "%sBOOLEAN %s%s%s;\n", prefix
, ansi_highlight(), true_false(basic
.i
), ansi_normal());
208 case SD_BUS_TYPE_INT16
:
209 fprintf(f
, "%sINT16 %s%i%s;\n", prefix
, ansi_highlight(), basic
.s16
, ansi_normal());
212 case SD_BUS_TYPE_UINT16
:
213 fprintf(f
, "%sUINT16 %s%u%s;\n", prefix
, ansi_highlight(), basic
.u16
, ansi_normal());
216 case SD_BUS_TYPE_INT32
:
217 fprintf(f
, "%sINT32 %s%i%s;\n", prefix
, ansi_highlight(), basic
.s32
, ansi_normal());
220 case SD_BUS_TYPE_UINT32
:
221 fprintf(f
, "%sUINT32 %s%u%s;\n", prefix
, ansi_highlight(), basic
.u32
, ansi_normal());
224 case SD_BUS_TYPE_INT64
:
225 fprintf(f
, "%sINT64 %s%"PRIi64
"%s;\n", prefix
, ansi_highlight(), basic
.s64
, ansi_normal());
228 case SD_BUS_TYPE_UINT64
:
229 fprintf(f
, "%sUINT64 %s%"PRIu64
"%s;\n", prefix
, ansi_highlight(), basic
.u64
, ansi_normal());
232 case SD_BUS_TYPE_DOUBLE
:
233 fprintf(f
, "%sDOUBLE %s%g%s;\n", prefix
, ansi_highlight(), basic
.d64
, ansi_normal());
236 case SD_BUS_TYPE_STRING
:
237 fprintf(f
, "%sSTRING \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
240 case SD_BUS_TYPE_OBJECT_PATH
:
241 fprintf(f
, "%sOBJECT_PATH \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
244 case SD_BUS_TYPE_SIGNATURE
:
245 fprintf(f
, "%sSIGNATURE \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
248 case SD_BUS_TYPE_UNIX_FD
:
249 fprintf(f
, "%sUNIX_FD %s%i%s;\n", prefix
, ansi_highlight(), basic
.i
, ansi_normal());
253 assert_not_reached("Unknown basic type.");
257 if (!(flags
& BUS_MESSAGE_DUMP_SUBTREE_ONLY
)) {
258 _cleanup_free_
char *prefix
= NULL
;
260 prefix
= indent(0, flags
);
264 fprintf(f
, "%s};\n\n", prefix
);
270 static void dump_capabilities(
275 int (*has
)(sd_bus_creds
*c
, int capability
)) {
277 unsigned long i
, last_cap
;
291 fprintf(f
, "%s%s=%s", terse
? " " : "", name
, terse
? "" : ansi_highlight());
292 last_cap
= cap_last_cap();
300 fprintf(f
, terse
? "\n " : "\n ");
302 fprintf(f
, "%s", strna(capability_to_name(i
)));
317 fputs(ansi_normal(), f
);
320 int bus_creds_dump(sd_bus_creds
*c
, FILE *f
, bool terse
) {
321 uid_t owner
, audit_loginuid
;
322 uint32_t audit_sessionid
;
323 char **cmdline
= NULL
, **well_known
= NULL
;
324 const char *prefix
, *color
, *suffix
, *s
;
340 color
= ansi_highlight();
343 suffix
= strjoina(off
, "\n");
346 if (c
->mask
& SD_BUS_CREDS_PID
)
347 fprintf(f
, "%sPID=%s"PID_FMT
"%s", prefix
, color
, c
->pid
, suffix
);
348 if (c
->mask
& SD_BUS_CREDS_TID
)
349 fprintf(f
, "%sTID=%s"PID_FMT
"%s", prefix
, color
, c
->tid
, suffix
);
350 if (c
->mask
& SD_BUS_CREDS_PPID
) {
352 fprintf(f
, "%sPPID=%sn/a%s", prefix
, color
, suffix
);
354 fprintf(f
, "%sPPID=%s"PID_FMT
"%s", prefix
, color
, c
->ppid
, suffix
);
356 if (c
->mask
& SD_BUS_CREDS_TTY
)
357 fprintf(f
, "%sTTY=%s%s%s", prefix
, color
, strna(c
->tty
), suffix
);
359 if (terse
&& ((c
->mask
& (SD_BUS_CREDS_PID
|SD_BUS_CREDS_TID
|SD_BUS_CREDS_PPID
|SD_BUS_CREDS_TTY
))))
362 if (c
->mask
& SD_BUS_CREDS_UID
)
363 fprintf(f
, "%sUID=%s"UID_FMT
"%s", prefix
, color
, c
->uid
, suffix
);
364 if (c
->mask
& SD_BUS_CREDS_EUID
)
365 fprintf(f
, "%sEUID=%s"UID_FMT
"%s", prefix
, color
, c
->euid
, suffix
);
366 if (c
->mask
& SD_BUS_CREDS_SUID
)
367 fprintf(f
, "%sSUID=%s"UID_FMT
"%s", prefix
, color
, c
->suid
, suffix
);
368 if (c
->mask
& SD_BUS_CREDS_FSUID
)
369 fprintf(f
, "%sFSUID=%s"UID_FMT
"%s", prefix
, color
, c
->fsuid
, suffix
);
370 r
= sd_bus_creds_get_owner_uid(c
, &owner
);
372 fprintf(f
, "%sOwnerUID=%s"UID_FMT
"%s", prefix
, color
, owner
, suffix
);
373 if (c
->mask
& SD_BUS_CREDS_GID
)
374 fprintf(f
, "%sGID=%s"GID_FMT
"%s", prefix
, color
, c
->gid
, suffix
);
375 if (c
->mask
& SD_BUS_CREDS_EGID
)
376 fprintf(f
, "%sEGID=%s"GID_FMT
"%s", prefix
, color
, c
->egid
, suffix
);
377 if (c
->mask
& SD_BUS_CREDS_SGID
)
378 fprintf(f
, "%sSGID=%s"GID_FMT
"%s", prefix
, color
, c
->sgid
, suffix
);
379 if (c
->mask
& SD_BUS_CREDS_FSGID
)
380 fprintf(f
, "%sFSGID=%s"GID_FMT
"%s", prefix
, color
, c
->fsgid
, suffix
);
382 if (c
->mask
& SD_BUS_CREDS_SUPPLEMENTARY_GIDS
) {
385 fprintf(f
, "%sSupplementaryGIDs=%s", prefix
, color
);
386 for (i
= 0; i
< c
->n_supplementary_gids
; i
++)
387 fprintf(f
, "%s" GID_FMT
, i
> 0 ? " " : "", c
->supplementary_gids
[i
]);
388 fprintf(f
, "%s", suffix
);
391 if (terse
&& ((c
->mask
& (SD_BUS_CREDS_UID
|SD_BUS_CREDS_EUID
|SD_BUS_CREDS_SUID
|SD_BUS_CREDS_FSUID
|
392 SD_BUS_CREDS_GID
|SD_BUS_CREDS_EGID
|SD_BUS_CREDS_SGID
|SD_BUS_CREDS_FSGID
|
393 SD_BUS_CREDS_SUPPLEMENTARY_GIDS
)) || r
>= 0))
396 if (c
->mask
& SD_BUS_CREDS_COMM
)
397 fprintf(f
, "%sComm=%s%s%s", prefix
, color
, c
->comm
, suffix
);
398 if (c
->mask
& SD_BUS_CREDS_TID_COMM
)
399 fprintf(f
, "%sTIDComm=%s%s%s", prefix
, color
, c
->tid_comm
, suffix
);
400 if (c
->mask
& SD_BUS_CREDS_EXE
)
401 fprintf(f
, "%sExe=%s%s%s", prefix
, color
, strna(c
->exe
), suffix
);
403 if (terse
&& (c
->mask
& (SD_BUS_CREDS_EXE
|SD_BUS_CREDS_COMM
|SD_BUS_CREDS_TID_COMM
)))
406 r
= sd_bus_creds_get_cmdline(c
, &cmdline
);
410 fprintf(f
, "%sCommandLine=%s", prefix
, color
);
411 STRV_FOREACH(i
, cmdline
) {
418 fprintf(f
, "%s", suffix
);
419 } else if (r
!= -ENODATA
)
420 fprintf(f
, "%sCommandLine=%sn/a%s", prefix
, color
, suffix
);
422 if (c
->mask
& SD_BUS_CREDS_SELINUX_CONTEXT
)
423 fprintf(f
, "%sLabel=%s%s%s", prefix
, color
, c
->label
, suffix
);
424 if (c
->mask
& SD_BUS_CREDS_DESCRIPTION
)
425 fprintf(f
, "%sDescription=%s%s%s", prefix
, color
, c
->description
, suffix
);
427 if (terse
&& (c
->mask
& (SD_BUS_CREDS_SELINUX_CONTEXT
|SD_BUS_CREDS_DESCRIPTION
)))
430 if (c
->mask
& SD_BUS_CREDS_CGROUP
)
431 fprintf(f
, "%sCGroup=%s%s%s", prefix
, color
, c
->cgroup
, suffix
);
433 r
= sd_bus_creds_get_unit(c
, &s
);
435 fprintf(f
, "%sUnit=%s%s%s", prefix
, color
, strna(s
), suffix
);
437 v
= sd_bus_creds_get_slice(c
, &s
);
439 fprintf(f
, "%sSlice=%s%s%s", prefix
, color
, strna(s
), suffix
);
441 q
= sd_bus_creds_get_user_unit(c
, &s
);
443 fprintf(f
, "%sUserUnit=%s%s%s", prefix
, color
, strna(s
), suffix
);
445 w
= sd_bus_creds_get_user_slice(c
, &s
);
447 fprintf(f
, "%sUserSlice=%s%s%s", prefix
, color
, strna(s
), suffix
);
449 z
= sd_bus_creds_get_session(c
, &s
);
451 fprintf(f
, "%sSession=%s%s%s", prefix
, color
, strna(s
), suffix
);
453 if (terse
&& ((c
->mask
& SD_BUS_CREDS_CGROUP
) || r
!= -ENODATA
|| q
!= -ENODATA
|| v
!= -ENODATA
|| w
!= -ENODATA
|| z
!= -ENODATA
))
456 r
= sd_bus_creds_get_audit_login_uid(c
, &audit_loginuid
);
458 fprintf(f
, "%sAuditLoginUID=%s"UID_FMT
"%s", prefix
, color
, audit_loginuid
, suffix
);
459 else if (r
!= -ENODATA
)
460 fprintf(f
, "%sAuditLoginUID=%sn/a%s", prefix
, color
, suffix
);
461 q
= sd_bus_creds_get_audit_session_id(c
, &audit_sessionid
);
463 fprintf(f
, "%sAuditSessionID=%s%"PRIu32
"%s", prefix
, color
, audit_sessionid
, suffix
);
464 else if (q
!= -ENODATA
)
465 fprintf(f
, "%sAuditSessionID=%sn/a%s", prefix
, color
, suffix
);
467 if (terse
&& (r
!= -ENODATA
|| q
!= -ENODATA
))
470 if (c
->mask
& SD_BUS_CREDS_UNIQUE_NAME
)
471 fprintf(f
, "%sUniqueName=%s%s%s", prefix
, color
, c
->unique_name
, suffix
);
473 if (sd_bus_creds_get_well_known_names(c
, &well_known
) >= 0) {
476 fprintf(f
, "%sWellKnownNames=%s", prefix
, color
);
477 STRV_FOREACH(i
, well_known
) {
484 fprintf(f
, "%s", suffix
);
487 if (terse
&& (c
->mask
& SD_BUS_CREDS_UNIQUE_NAME
|| well_known
))
490 dump_capabilities(c
, f
, "EffectiveCapabilities", terse
, sd_bus_creds_has_effective_cap
);
491 dump_capabilities(c
, f
, "PermittedCapabilities", terse
, sd_bus_creds_has_permitted_cap
);
492 dump_capabilities(c
, f
, "InheritableCapabilities", terse
, sd_bus_creds_has_inheritable_cap
);
493 dump_capabilities(c
, f
, "BoundingCapabilities", terse
, sd_bus_creds_has_bounding_cap
);
499 * For details about the file format, see:
501 * http://wiki.wireshark.org/Development/LibpcapFileFormat
504 typedef struct _packed_ pcap_hdr_s
{
505 uint32_t magic_number
; /* magic number */
506 uint16_t version_major
; /* major version number */
507 uint16_t version_minor
; /* minor version number */
508 int32_t thiszone
; /* GMT to local correction */
509 uint32_t sigfigs
; /* accuracy of timestamps */
510 uint32_t snaplen
; /* max length of captured packets, in octets */
511 uint32_t network
; /* data link type */
514 typedef struct _packed_ pcaprec_hdr_s
{
515 uint32_t ts_sec
; /* timestamp seconds */
516 uint32_t ts_usec
; /* timestamp microseconds */
517 uint32_t incl_len
; /* number of octets of packet saved in file */
518 uint32_t orig_len
; /* actual length of packet */
521 int bus_pcap_header(size_t snaplen
, FILE *f
) {
524 .magic_number
= 0xa1b2c3d4U
,
527 .thiszone
= 0, /* UTC */
529 .network
= 231, /* D-Bus */
536 assert((size_t) (uint32_t) snaplen
== snaplen
);
538 hdr
.snaplen
= (uint32_t) snaplen
;
540 fwrite(&hdr
, 1, sizeof(hdr
), f
);
542 return fflush_and_check(f
);
545 int bus_message_pcap_frame(sd_bus_message
*m
, size_t snaplen
, FILE *f
) {
546 struct bus_body_part
*part
;
547 pcaprec_hdr_t hdr
= {};
557 assert((size_t) (uint32_t) snaplen
== snaplen
);
559 if (m
->realtime
!= 0)
560 timeval_store(&tv
, m
->realtime
);
562 assert_se(gettimeofday(&tv
, NULL
) >= 0);
564 hdr
.ts_sec
= tv
.tv_sec
;
565 hdr
.ts_usec
= tv
.tv_usec
;
566 hdr
.orig_len
= BUS_MESSAGE_SIZE(m
);
567 hdr
.incl_len
= MIN(hdr
.orig_len
, snaplen
);
569 /* write the pcap header */
570 fwrite(&hdr
, 1, sizeof(hdr
), f
);
572 /* write the dbus header */
573 w
= MIN(BUS_MESSAGE_BODY_BEGIN(m
), snaplen
);
574 fwrite(m
->header
, 1, w
, f
);
577 /* write the dbus body */
578 MESSAGE_FOREACH_PART(part
, i
, m
) {
582 w
= MIN(part
->size
, snaplen
);
583 fwrite(part
->data
, 1, w
, f
);
587 return fflush_and_check(f
);