1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
5 #include "alloc-util.h"
7 #include "bus-internal.h"
8 #include "bus-message.h"
11 #include "capability-util.h"
13 #include "format-util.h"
14 #include "glyph-util.h"
17 #include "string-util.h"
19 #include "terminal-util.h"
21 static char *indent(unsigned level
, uint64_t flags
) {
27 if (flags
& SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
&& level
> 0)
30 if (flags
& SD_BUS_MESSAGE_DUMP_WITH_HEADER
)
33 p
= new(char, n
+ level
*8 + 1);
37 if (flags
& SD_BUS_MESSAGE_DUMP_WITH_HEADER
) {
42 memset(p
+ i
, ' ', level
*8);
48 _public_
int sd_bus_message_dump(sd_bus_message
*m
, FILE *f
, uint64_t flags
) {
52 assert_return(m
, -EINVAL
);
53 assert_return((flags
& ~_SD_BUS_MESSAGE_DUMP_KNOWN_FLAGS
) == 0, -EINVAL
);
58 if (flags
& SD_BUS_MESSAGE_DUMP_WITH_HEADER
) {
59 usec_t ts
= m
->realtime
;
62 ts
= now(CLOCK_REALTIME
);
65 "%s%s%s Type=%s%s%s Endian=%c Flags=%u Version=%u",
66 m
->header
->type
== SD_BUS_MESSAGE_METHOD_ERROR
? ansi_highlight_red() :
67 m
->header
->type
== SD_BUS_MESSAGE_METHOD_RETURN
? ansi_highlight_green() :
68 m
->header
->type
!= SD_BUS_MESSAGE_SIGNAL
? ansi_highlight() : "",
69 special_glyph(SPECIAL_GLYPH_TRIANGULAR_BULLET
),
73 bus_message_type_to_string(m
->header
->type
) ?: "(unknown)",
80 /* Display synthetic message serial number in a more readable
81 * format than UINT32_MAX */
82 if (BUS_MESSAGE_COOKIE(m
) == UINT32_MAX
)
83 fprintf(f
, " Cookie=-1");
85 fprintf(f
, " Cookie=%" PRIu64
, BUS_MESSAGE_COOKIE(m
));
87 if (m
->reply_cookie
!= 0)
88 fprintf(f
, " ReplyCookie=%" PRIu64
, m
->reply_cookie
);
90 fprintf(f
, " Timestamp=\"%s\"\n", strna(FORMAT_TIMESTAMP_STYLE(ts
, TIMESTAMP_US_UTC
)));
93 fprintf(f
, " Sender=%s%s%s", ansi_highlight(), m
->sender
, ansi_normal());
95 fprintf(f
, " Destination=%s%s%s", ansi_highlight(), m
->destination
, ansi_normal());
97 fprintf(f
, " Path=%s%s%s", ansi_highlight(), m
->path
, ansi_normal());
99 fprintf(f
, " Interface=%s%s%s", ansi_highlight(), m
->interface
, ansi_normal());
101 fprintf(f
, " Member=%s%s%s", ansi_highlight(), m
->member
, ansi_normal());
103 if (m
->sender
|| m
->destination
|| m
->path
|| m
->interface
|| m
->member
)
106 if (sd_bus_error_is_set(&m
->error
))
109 " ErrorMessage=%s\"%s\"%s\n",
110 ansi_highlight_red(), strna(m
->error
.name
), ansi_normal(),
111 ansi_highlight_red(), strna(m
->error
.message
), ansi_normal());
113 if (m
->monotonic
!= 0)
114 fprintf(f
, " Monotonic="USEC_FMT
, m
->monotonic
);
115 if (m
->realtime
!= 0)
116 fprintf(f
, " Realtime="USEC_FMT
, m
->realtime
);
118 fprintf(f
, " SequenceNumber=%"PRIu64
, m
->seqnum
);
120 if (m
->monotonic
!= 0 || m
->realtime
!= 0 || m
->seqnum
!= 0)
123 bus_creds_dump(&m
->creds
, f
, true);
126 r
= sd_bus_message_rewind(m
, !(flags
& SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
));
128 return log_error_errno(r
, "Failed to rewind: %m");
130 if (!(flags
& SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
)) {
131 _cleanup_free_
char *prefix
= NULL
;
133 prefix
= indent(0, flags
);
137 fprintf(f
, "%sMESSAGE \"%s\" {\n", prefix
, strempty(m
->root_container
.signature
));
141 _cleanup_free_
char *prefix
= NULL
;
142 const char *contents
= NULL
;
157 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
159 return log_error_errno(r
, "Failed to peek type: %m");
165 r
= sd_bus_message_exit_container(m
);
167 return log_error_errno(r
, "Failed to exit container: %m");
171 prefix
= indent(level
, flags
);
175 fprintf(f
, "%s};\n", prefix
);
179 prefix
= indent(level
, flags
);
183 if (bus_type_is_container(type
) > 0) {
184 r
= sd_bus_message_enter_container(m
, type
, contents
);
186 return log_error_errno(r
, "Failed to enter container: %m");
188 if (type
== SD_BUS_TYPE_ARRAY
)
189 fprintf(f
, "%sARRAY \"%s\" {\n", prefix
, contents
);
190 else if (type
== SD_BUS_TYPE_VARIANT
)
191 fprintf(f
, "%sVARIANT \"%s\" {\n", prefix
, contents
);
192 else if (type
== SD_BUS_TYPE_STRUCT
)
193 fprintf(f
, "%sSTRUCT \"%s\" {\n", prefix
, contents
);
194 else if (type
== SD_BUS_TYPE_DICT_ENTRY
)
195 fprintf(f
, "%sDICT_ENTRY \"%s\" {\n", prefix
, contents
);
202 r
= sd_bus_message_read_basic(m
, type
, &basic
);
204 return log_error_errno(r
, "Failed to get basic: %m");
210 case SD_BUS_TYPE_BYTE
:
211 fprintf(f
, "%sBYTE %s%u%s;\n", prefix
, ansi_highlight(), basic
.u8
, ansi_normal());
214 case SD_BUS_TYPE_BOOLEAN
:
215 fprintf(f
, "%sBOOLEAN %s%s%s;\n", prefix
, ansi_highlight(), true_false(basic
.i
), ansi_normal());
218 case SD_BUS_TYPE_INT16
:
219 fprintf(f
, "%sINT16 %s%i%s;\n", prefix
, ansi_highlight(), basic
.s16
, ansi_normal());
222 case SD_BUS_TYPE_UINT16
:
223 fprintf(f
, "%sUINT16 %s%u%s;\n", prefix
, ansi_highlight(), basic
.u16
, ansi_normal());
226 case SD_BUS_TYPE_INT32
:
227 fprintf(f
, "%sINT32 %s%i%s;\n", prefix
, ansi_highlight(), basic
.s32
, ansi_normal());
230 case SD_BUS_TYPE_UINT32
:
231 fprintf(f
, "%sUINT32 %s%u%s;\n", prefix
, ansi_highlight(), basic
.u32
, ansi_normal());
234 case SD_BUS_TYPE_INT64
:
235 fprintf(f
, "%sINT64 %s%"PRIi64
"%s;\n", prefix
, ansi_highlight(), basic
.s64
, ansi_normal());
238 case SD_BUS_TYPE_UINT64
:
239 fprintf(f
, "%sUINT64 %s%"PRIu64
"%s;\n", prefix
, ansi_highlight(), basic
.u64
, ansi_normal());
242 case SD_BUS_TYPE_DOUBLE
:
243 fprintf(f
, "%sDOUBLE %s%g%s;\n", prefix
, ansi_highlight(), basic
.d64
, ansi_normal());
246 case SD_BUS_TYPE_STRING
:
247 fprintf(f
, "%sSTRING \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
250 case SD_BUS_TYPE_OBJECT_PATH
:
251 fprintf(f
, "%sOBJECT_PATH \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
254 case SD_BUS_TYPE_SIGNATURE
:
255 fprintf(f
, "%sSIGNATURE \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
258 case SD_BUS_TYPE_UNIX_FD
:
259 fprintf(f
, "%sUNIX_FD %s%i%s;\n", prefix
, ansi_highlight(), basic
.i
, ansi_normal());
263 assert_not_reached();
267 if (!(flags
& SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
)) {
268 _cleanup_free_
char *prefix
= NULL
;
270 prefix
= indent(0, flags
);
274 fprintf(f
, "%s};\n\n", prefix
);
280 static void dump_capabilities(
285 int (*has
)(sd_bus_creds
*c
, int capability
)) {
287 unsigned long i
, last_cap
;
301 fprintf(f
, "%s%s=%s", terse
? " " : "", name
, terse
? "" : ansi_highlight());
302 last_cap
= cap_last_cap();
310 fprintf(f
, terse
? "\n " : "\n ");
312 fprintf(f
, "%s", strna(capability_to_name(i
)));
327 fputs(ansi_normal(), f
);
330 int bus_creds_dump(sd_bus_creds
*c
, FILE *f
, bool terse
) {
331 uid_t owner
, audit_loginuid
;
332 uint32_t audit_sessionid
;
333 char **cmdline
= NULL
, **well_known
= NULL
;
334 const char *prefix
, *color
, *suffix
, *s
;
350 color
= ansi_highlight();
353 suffix
= strjoina(off
, "\n");
356 if (c
->mask
& SD_BUS_CREDS_PID
)
357 fprintf(f
, "%sPID=%s"PID_FMT
"%s", prefix
, color
, c
->pid
, suffix
);
358 if (c
->mask
& SD_BUS_CREDS_PIDFD
)
359 fprintf(f
, "%sPIDFD=%syes%s", prefix
, color
, suffix
);
360 if (c
->mask
& SD_BUS_CREDS_TID
)
361 fprintf(f
, "%sTID=%s"PID_FMT
"%s", prefix
, color
, c
->tid
, suffix
);
362 if (c
->mask
& SD_BUS_CREDS_PPID
) {
364 fprintf(f
, "%sPPID=%sn/a%s", prefix
, color
, suffix
);
366 fprintf(f
, "%sPPID=%s"PID_FMT
"%s", prefix
, color
, c
->ppid
, suffix
);
368 if (c
->mask
& SD_BUS_CREDS_TTY
)
369 fprintf(f
, "%sTTY=%s%s%s", prefix
, color
, strna(c
->tty
), suffix
);
371 if (terse
&& ((c
->mask
& (SD_BUS_CREDS_PID
|SD_BUS_CREDS_TID
|SD_BUS_CREDS_PPID
|SD_BUS_CREDS_TTY
))))
374 if (c
->mask
& SD_BUS_CREDS_UID
)
375 fprintf(f
, "%sUID=%s"UID_FMT
"%s", prefix
, color
, c
->uid
, suffix
);
376 if (c
->mask
& SD_BUS_CREDS_EUID
)
377 fprintf(f
, "%sEUID=%s"UID_FMT
"%s", prefix
, color
, c
->euid
, suffix
);
378 if (c
->mask
& SD_BUS_CREDS_SUID
)
379 fprintf(f
, "%sSUID=%s"UID_FMT
"%s", prefix
, color
, c
->suid
, suffix
);
380 if (c
->mask
& SD_BUS_CREDS_FSUID
)
381 fprintf(f
, "%sFSUID=%s"UID_FMT
"%s", prefix
, color
, c
->fsuid
, suffix
);
382 r
= sd_bus_creds_get_owner_uid(c
, &owner
);
384 fprintf(f
, "%sOwnerUID=%s"UID_FMT
"%s", prefix
, color
, owner
, suffix
);
385 if (c
->mask
& SD_BUS_CREDS_GID
)
386 fprintf(f
, "%sGID=%s"GID_FMT
"%s", prefix
, color
, c
->gid
, suffix
);
387 if (c
->mask
& SD_BUS_CREDS_EGID
)
388 fprintf(f
, "%sEGID=%s"GID_FMT
"%s", prefix
, color
, c
->egid
, suffix
);
389 if (c
->mask
& SD_BUS_CREDS_SGID
)
390 fprintf(f
, "%sSGID=%s"GID_FMT
"%s", prefix
, color
, c
->sgid
, suffix
);
391 if (c
->mask
& SD_BUS_CREDS_FSGID
)
392 fprintf(f
, "%sFSGID=%s"GID_FMT
"%s", prefix
, color
, c
->fsgid
, suffix
);
394 if (c
->mask
& SD_BUS_CREDS_SUPPLEMENTARY_GIDS
) {
395 fprintf(f
, "%sSupplementaryGIDs=%s", prefix
, color
);
396 for (unsigned i
= 0; i
< c
->n_supplementary_gids
; i
++)
397 fprintf(f
, "%s" GID_FMT
, i
> 0 ? " " : "", c
->supplementary_gids
[i
]);
398 fprintf(f
, "%s", suffix
);
401 if (terse
&& ((c
->mask
& (SD_BUS_CREDS_UID
|SD_BUS_CREDS_EUID
|SD_BUS_CREDS_SUID
|SD_BUS_CREDS_FSUID
|
402 SD_BUS_CREDS_GID
|SD_BUS_CREDS_EGID
|SD_BUS_CREDS_SGID
|SD_BUS_CREDS_FSGID
|
403 SD_BUS_CREDS_SUPPLEMENTARY_GIDS
)) || r
>= 0))
406 if (c
->mask
& SD_BUS_CREDS_COMM
)
407 fprintf(f
, "%sComm=%s%s%s", prefix
, color
, c
->comm
, suffix
);
408 if (c
->mask
& SD_BUS_CREDS_TID_COMM
)
409 fprintf(f
, "%sTIDComm=%s%s%s", prefix
, color
, c
->tid_comm
, suffix
);
410 if (c
->mask
& SD_BUS_CREDS_EXE
)
411 fprintf(f
, "%sExe=%s%s%s", prefix
, color
, strna(c
->exe
), suffix
);
413 if (terse
&& (c
->mask
& (SD_BUS_CREDS_EXE
|SD_BUS_CREDS_COMM
|SD_BUS_CREDS_TID_COMM
)))
416 r
= sd_bus_creds_get_cmdline(c
, &cmdline
);
418 fprintf(f
, "%sCommandLine=%s", prefix
, color
);
419 STRV_FOREACH(i
, cmdline
) {
426 fprintf(f
, "%s", suffix
);
427 } else if (r
!= -ENODATA
)
428 fprintf(f
, "%sCommandLine=%sn/a%s", prefix
, color
, suffix
);
430 if (c
->mask
& SD_BUS_CREDS_SELINUX_CONTEXT
)
431 fprintf(f
, "%sLabel=%s%s%s", prefix
, color
, c
->label
, suffix
);
432 if (c
->mask
& SD_BUS_CREDS_DESCRIPTION
)
433 fprintf(f
, "%sDescription=%s%s%s", prefix
, color
, c
->description
, suffix
);
435 if (terse
&& (c
->mask
& (SD_BUS_CREDS_SELINUX_CONTEXT
|SD_BUS_CREDS_DESCRIPTION
)))
438 if (c
->mask
& SD_BUS_CREDS_CGROUP
)
439 fprintf(f
, "%sCGroup=%s%s%s", prefix
, color
, c
->cgroup
, suffix
);
441 r
= sd_bus_creds_get_unit(c
, &s
);
443 fprintf(f
, "%sUnit=%s%s%s", prefix
, color
, strna(s
), suffix
);
445 v
= sd_bus_creds_get_slice(c
, &s
);
447 fprintf(f
, "%sSlice=%s%s%s", prefix
, color
, strna(s
), suffix
);
449 q
= sd_bus_creds_get_user_unit(c
, &s
);
451 fprintf(f
, "%sUserUnit=%s%s%s", prefix
, color
, strna(s
), suffix
);
453 w
= sd_bus_creds_get_user_slice(c
, &s
);
455 fprintf(f
, "%sUserSlice=%s%s%s", prefix
, color
, strna(s
), suffix
);
457 z
= sd_bus_creds_get_session(c
, &s
);
459 fprintf(f
, "%sSession=%s%s%s", prefix
, color
, strna(s
), suffix
);
461 if (terse
&& ((c
->mask
& SD_BUS_CREDS_CGROUP
) || r
!= -ENODATA
|| q
!= -ENODATA
|| v
!= -ENODATA
|| w
!= -ENODATA
|| z
!= -ENODATA
))
464 r
= sd_bus_creds_get_audit_login_uid(c
, &audit_loginuid
);
466 fprintf(f
, "%sAuditLoginUID=%s"UID_FMT
"%s", prefix
, color
, audit_loginuid
, suffix
);
467 else if (r
!= -ENODATA
)
468 fprintf(f
, "%sAuditLoginUID=%sn/a%s", prefix
, color
, suffix
);
469 q
= sd_bus_creds_get_audit_session_id(c
, &audit_sessionid
);
471 fprintf(f
, "%sAuditSessionID=%s%"PRIu32
"%s", prefix
, color
, audit_sessionid
, suffix
);
472 else if (q
!= -ENODATA
)
473 fprintf(f
, "%sAuditSessionID=%sn/a%s", prefix
, color
, suffix
);
475 if (terse
&& (r
!= -ENODATA
|| q
!= -ENODATA
))
478 if (c
->mask
& SD_BUS_CREDS_UNIQUE_NAME
)
479 fprintf(f
, "%sUniqueName=%s%s%s", prefix
, color
, c
->unique_name
, suffix
);
481 if (sd_bus_creds_get_well_known_names(c
, &well_known
) >= 0) {
482 fprintf(f
, "%sWellKnownNames=%s", prefix
, color
);
483 STRV_FOREACH(i
, well_known
) {
490 fprintf(f
, "%s", suffix
);
493 if (terse
&& (c
->mask
& SD_BUS_CREDS_UNIQUE_NAME
|| well_known
))
496 dump_capabilities(c
, f
, "EffectiveCapabilities", terse
, sd_bus_creds_has_effective_cap
);
497 dump_capabilities(c
, f
, "PermittedCapabilities", terse
, sd_bus_creds_has_permitted_cap
);
498 dump_capabilities(c
, f
, "InheritableCapabilities", terse
, sd_bus_creds_has_inheritable_cap
);
499 dump_capabilities(c
, f
, "BoundingCapabilities", terse
, sd_bus_creds_has_bounding_cap
);
504 static uint16_t pcapng_optlen(size_t len
) {
505 return ALIGN4(len
+ sizeof(struct pcapng_option
));
508 static void pcapng_putopt(FILE *f
, uint16_t code
, const void *data
, size_t len
) {
509 struct pcapng_option opt
= {
515 assert((uint16_t) len
== len
);
516 assert(data
|| len
== 0);
518 fwrite(&opt
, 1, sizeof(opt
), f
);
520 size_t pad
= ALIGN4(len
) - len
;
522 fwrite(data
, 1, len
, f
);
524 assert(pad
< sizeof(uint32_t));
530 static void pcapng_section_header(FILE *f
, const char *os
, const char *app
) {
535 /* determine length of section header and options */
536 len
= sizeof(struct pcapng_section
);
538 len
+= pcapng_optlen(strlen(os
));
540 len
+= pcapng_optlen(strlen(app
));
541 len
+= pcapng_optlen(0); /* OPT_END */
542 len
+= sizeof(uint32_t); /* trailer length */
544 struct pcapng_section hdr
= {
545 .block_type
= PCAPNG_SECTION_BLOCK
,
547 .byte_order_magic
= PCAPNG_BYTE_ORDER_MAGIC
,
548 .major_version
= PCAPNG_MAJOR_VERS
,
549 .minor_version
= PCAPNG_MINOR_VERS
,
550 .section_length
= UINT64_MAX
,
553 fwrite(&hdr
, 1, sizeof(hdr
), f
);
555 pcapng_putopt(f
, PCAPNG_SHB_OS
, os
, strlen(os
));
557 pcapng_putopt(f
, PCAPNG_SHB_USERAPPL
, app
, strlen(app
));
558 pcapng_putopt(f
, PCAPNG_OPT_END
, NULL
, 0);
559 fwrite(&len
, 1, sizeof(uint32_t), f
);
562 /* Only have a single instance of dbus pseudo interface */
563 static void pcapng_interface_header(FILE *f
, size_t snaplen
) {
568 assert((size_t) (uint32_t) snaplen
== snaplen
);
570 /* no options (yet) */
571 len
= sizeof(struct pcapng_interface_block
) + sizeof(uint32_t);
572 struct pcapng_interface_block hdr
= {
573 .block_type
= PCAPNG_INTERFACE_BLOCK
,
575 .link_type
= 231, /* D-Bus */
579 fwrite(&hdr
, 1, sizeof(hdr
), f
);
580 fwrite(&len
, 1, sizeof(uint32_t), f
);
583 int bus_pcap_header(size_t snaplen
, const char *os
, const char *info
, FILE *f
) {
587 pcapng_section_header(f
, os
, info
);
588 pcapng_interface_header(f
, snaplen
);
589 return fflush_and_check(f
);
592 int bus_message_pcap_frame(sd_bus_message
*m
, size_t snaplen
, FILE *f
) {
593 struct bus_body_part
*part
;
594 size_t msglen
, caplen
, pad
;
605 assert((size_t) (uint32_t) snaplen
== snaplen
);
607 ts
= m
->realtime
?: now(CLOCK_REALTIME
);
608 msglen
= BUS_MESSAGE_SIZE(m
);
609 caplen
= MIN(msglen
, snaplen
);
610 pad
= ALIGN4(caplen
) - caplen
;
612 /* packet block has no options */
613 length
= sizeof(struct pcapng_enhance_packet_block
)
614 + caplen
+ pad
+ sizeof(uint32_t);
616 struct pcapng_enhance_packet_block epb
= {
617 .block_type
= PCAPNG_ENHANCED_PACKET_BLOCK
,
618 .block_length
= length
,
620 .timestamp_hi
= (uint32_t)(ts
>> 32),
621 .timestamp_lo
= (uint32_t)ts
,
622 .original_length
= msglen
,
623 .capture_length
= caplen
,
626 /* write the pcapng enhanced packet block header */
627 fwrite(&epb
, 1, sizeof(epb
), f
);
629 /* write the dbus header */
630 w
= MIN(BUS_MESSAGE_BODY_BEGIN(m
), snaplen
);
631 fwrite(m
->header
, 1, w
, f
);
634 /* write the dbus body */
635 MESSAGE_FOREACH_PART(part
, i
, m
) {
639 w
= MIN(part
->size
, snaplen
);
640 fwrite(part
->data
, 1, w
, f
);
647 /* trailing block length */
648 fwrite(&length
, 1, sizeof(uint32_t), f
);
650 return fflush_and_check(f
);