1 /* SPDX-License-Identifier: LGPL-2.1+ */
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 "locale-util.h"
16 #include "string-util.h"
18 #include "terminal-util.h"
21 static char *indent(unsigned level
, unsigned flags
) {
27 if (flags
& BUS_MESSAGE_DUMP_SUBTREE_ONLY
&& level
> 0)
30 if (flags
& BUS_MESSAGE_DUMP_WITH_HEADER
)
33 p
= new(char, n
+ level
*8 + 1);
37 if (flags
& BUS_MESSAGE_DUMP_WITH_HEADER
) {
42 memset(p
+ i
, ' ', level
*8);
48 int bus_message_dump(sd_bus_message
*m
, FILE *f
, unsigned flags
) {
57 if (flags
& BUS_MESSAGE_DUMP_WITH_HEADER
) {
59 "%s%s%s Type=%s%s%s Endian=%c Flags=%u Version=%u Priority=%"PRIi64
,
60 m
->header
->type
== SD_BUS_MESSAGE_METHOD_ERROR
? ansi_highlight_red() :
61 m
->header
->type
== SD_BUS_MESSAGE_METHOD_RETURN
? ansi_highlight_green() :
62 m
->header
->type
!= SD_BUS_MESSAGE_SIGNAL
? ansi_highlight() : "", special_glyph(TRIANGULAR_BULLET
), ansi_normal(),
63 ansi_highlight(), bus_message_type_to_string(m
->header
->type
), ansi_normal(),
69 /* Display synthetic message serial number in a more readable
70 * format than (uint32_t) -1 */
71 if (BUS_MESSAGE_COOKIE(m
) == 0xFFFFFFFFULL
)
72 fprintf(f
, " Cookie=-1");
74 fprintf(f
, " Cookie=%" PRIu64
, BUS_MESSAGE_COOKIE(m
));
76 if (m
->reply_cookie
!= 0)
77 fprintf(f
, " ReplyCookie=%" PRIu64
, m
->reply_cookie
);
82 fprintf(f
, " Sender=%s%s%s", ansi_highlight(), m
->sender
, ansi_normal());
84 fprintf(f
, " Destination=%s%s%s", ansi_highlight(), m
->destination
, ansi_normal());
86 fprintf(f
, " Path=%s%s%s", ansi_highlight(), m
->path
, ansi_normal());
88 fprintf(f
, " Interface=%s%s%s", ansi_highlight(), m
->interface
, ansi_normal());
90 fprintf(f
, " Member=%s%s%s", ansi_highlight(), m
->member
, ansi_normal());
92 if (m
->sender
|| m
->destination
|| m
->path
|| m
->interface
|| m
->member
)
95 if (sd_bus_error_is_set(&m
->error
))
98 " ErrorMessage=%s\"%s\"%s\n",
99 ansi_highlight_red(), strna(m
->error
.name
), ansi_normal(),
100 ansi_highlight_red(), strna(m
->error
.message
), ansi_normal());
102 if (m
->monotonic
!= 0)
103 fprintf(f
, " Monotonic="USEC_FMT
, m
->monotonic
);
104 if (m
->realtime
!= 0)
105 fprintf(f
, " Realtime="USEC_FMT
, m
->realtime
);
107 fprintf(f
, " SequenceNumber=%"PRIu64
, m
->seqnum
);
109 if (m
->monotonic
!= 0 || m
->realtime
!= 0 || m
->seqnum
!= 0)
112 bus_creds_dump(&m
->creds
, f
, true);
115 r
= sd_bus_message_rewind(m
, !(flags
& BUS_MESSAGE_DUMP_SUBTREE_ONLY
));
117 return log_error_errno(r
, "Failed to rewind: %m");
119 if (!(flags
& BUS_MESSAGE_DUMP_SUBTREE_ONLY
)) {
120 _cleanup_free_
char *prefix
= NULL
;
122 prefix
= indent(0, flags
);
126 fprintf(f
, "%sMESSAGE \"%s\" {\n", prefix
, strempty(m
->root_container
.signature
));
130 _cleanup_free_
char *prefix
= NULL
;
131 const char *contents
= NULL
;
146 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
148 return log_error_errno(r
, "Failed to peek type: %m");
154 r
= sd_bus_message_exit_container(m
);
156 return log_error_errno(r
, "Failed to exit container: %m");
160 prefix
= indent(level
, flags
);
164 fprintf(f
, "%s};\n", prefix
);
168 prefix
= indent(level
, flags
);
172 if (bus_type_is_container(type
) > 0) {
173 r
= sd_bus_message_enter_container(m
, type
, contents
);
175 return log_error_errno(r
, "Failed to enter container: %m");
177 if (type
== SD_BUS_TYPE_ARRAY
)
178 fprintf(f
, "%sARRAY \"%s\" {\n", prefix
, contents
);
179 else if (type
== SD_BUS_TYPE_VARIANT
)
180 fprintf(f
, "%sVARIANT \"%s\" {\n", prefix
, contents
);
181 else if (type
== SD_BUS_TYPE_STRUCT
)
182 fprintf(f
, "%sSTRUCT \"%s\" {\n", prefix
, contents
);
183 else if (type
== SD_BUS_TYPE_DICT_ENTRY
)
184 fprintf(f
, "%sDICT_ENTRY \"%s\" {\n", prefix
, contents
);
191 r
= sd_bus_message_read_basic(m
, type
, &basic
);
193 return log_error_errno(r
, "Failed to get basic: %m");
199 case SD_BUS_TYPE_BYTE
:
200 fprintf(f
, "%sBYTE %s%u%s;\n", prefix
, ansi_highlight(), basic
.u8
, ansi_normal());
203 case SD_BUS_TYPE_BOOLEAN
:
204 fprintf(f
, "%sBOOLEAN %s%s%s;\n", prefix
, ansi_highlight(), true_false(basic
.i
), ansi_normal());
207 case SD_BUS_TYPE_INT16
:
208 fprintf(f
, "%sINT16 %s%i%s;\n", prefix
, ansi_highlight(), basic
.s16
, ansi_normal());
211 case SD_BUS_TYPE_UINT16
:
212 fprintf(f
, "%sUINT16 %s%u%s;\n", prefix
, ansi_highlight(), basic
.u16
, ansi_normal());
215 case SD_BUS_TYPE_INT32
:
216 fprintf(f
, "%sINT32 %s%i%s;\n", prefix
, ansi_highlight(), basic
.s32
, ansi_normal());
219 case SD_BUS_TYPE_UINT32
:
220 fprintf(f
, "%sUINT32 %s%u%s;\n", prefix
, ansi_highlight(), basic
.u32
, ansi_normal());
223 case SD_BUS_TYPE_INT64
:
224 fprintf(f
, "%sINT64 %s%"PRIi64
"%s;\n", prefix
, ansi_highlight(), basic
.s64
, ansi_normal());
227 case SD_BUS_TYPE_UINT64
:
228 fprintf(f
, "%sUINT64 %s%"PRIu64
"%s;\n", prefix
, ansi_highlight(), basic
.u64
, ansi_normal());
231 case SD_BUS_TYPE_DOUBLE
:
232 fprintf(f
, "%sDOUBLE %s%g%s;\n", prefix
, ansi_highlight(), basic
.d64
, ansi_normal());
235 case SD_BUS_TYPE_STRING
:
236 fprintf(f
, "%sSTRING \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
239 case SD_BUS_TYPE_OBJECT_PATH
:
240 fprintf(f
, "%sOBJECT_PATH \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
243 case SD_BUS_TYPE_SIGNATURE
:
244 fprintf(f
, "%sSIGNATURE \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
247 case SD_BUS_TYPE_UNIX_FD
:
248 fprintf(f
, "%sUNIX_FD %s%i%s;\n", prefix
, ansi_highlight(), basic
.i
, ansi_normal());
252 assert_not_reached("Unknown basic type.");
256 if (!(flags
& BUS_MESSAGE_DUMP_SUBTREE_ONLY
)) {
257 _cleanup_free_
char *prefix
= NULL
;
259 prefix
= indent(0, flags
);
263 fprintf(f
, "%s};\n\n", prefix
);
269 static void dump_capabilities(
274 int (*has
)(sd_bus_creds
*c
, int capability
)) {
276 unsigned long i
, last_cap
;
290 fprintf(f
, "%s%s=%s", terse
? " " : "", name
, terse
? "" : ansi_highlight());
291 last_cap
= cap_last_cap();
299 fprintf(f
, terse
? "\n " : "\n ");
301 fprintf(f
, "%s", strna(capability_to_name(i
)));
316 fputs(ansi_normal(), f
);
319 int bus_creds_dump(sd_bus_creds
*c
, FILE *f
, bool terse
) {
320 uid_t owner
, audit_loginuid
;
321 uint32_t audit_sessionid
;
322 char **cmdline
= NULL
, **well_known
= NULL
;
323 const char *prefix
, *color
, *suffix
, *s
;
339 color
= ansi_highlight();
342 suffix
= strjoina(off
, "\n");
345 if (c
->mask
& SD_BUS_CREDS_PID
)
346 fprintf(f
, "%sPID=%s"PID_FMT
"%s", prefix
, color
, c
->pid
, suffix
);
347 if (c
->mask
& SD_BUS_CREDS_TID
)
348 fprintf(f
, "%sTID=%s"PID_FMT
"%s", prefix
, color
, c
->tid
, suffix
);
349 if (c
->mask
& SD_BUS_CREDS_PPID
) {
351 fprintf(f
, "%sPPID=%sn/a%s", prefix
, color
, suffix
);
353 fprintf(f
, "%sPPID=%s"PID_FMT
"%s", prefix
, color
, c
->ppid
, suffix
);
355 if (c
->mask
& SD_BUS_CREDS_TTY
)
356 fprintf(f
, "%sTTY=%s%s%s", prefix
, color
, strna(c
->tty
), suffix
);
358 if (terse
&& ((c
->mask
& (SD_BUS_CREDS_PID
|SD_BUS_CREDS_TID
|SD_BUS_CREDS_PPID
|SD_BUS_CREDS_TTY
))))
361 if (c
->mask
& SD_BUS_CREDS_UID
)
362 fprintf(f
, "%sUID=%s"UID_FMT
"%s", prefix
, color
, c
->uid
, suffix
);
363 if (c
->mask
& SD_BUS_CREDS_EUID
)
364 fprintf(f
, "%sEUID=%s"UID_FMT
"%s", prefix
, color
, c
->euid
, suffix
);
365 if (c
->mask
& SD_BUS_CREDS_SUID
)
366 fprintf(f
, "%sSUID=%s"UID_FMT
"%s", prefix
, color
, c
->suid
, suffix
);
367 if (c
->mask
& SD_BUS_CREDS_FSUID
)
368 fprintf(f
, "%sFSUID=%s"UID_FMT
"%s", prefix
, color
, c
->fsuid
, suffix
);
369 r
= sd_bus_creds_get_owner_uid(c
, &owner
);
371 fprintf(f
, "%sOwnerUID=%s"UID_FMT
"%s", prefix
, color
, owner
, suffix
);
372 if (c
->mask
& SD_BUS_CREDS_GID
)
373 fprintf(f
, "%sGID=%s"GID_FMT
"%s", prefix
, color
, c
->gid
, suffix
);
374 if (c
->mask
& SD_BUS_CREDS_EGID
)
375 fprintf(f
, "%sEGID=%s"GID_FMT
"%s", prefix
, color
, c
->egid
, suffix
);
376 if (c
->mask
& SD_BUS_CREDS_SGID
)
377 fprintf(f
, "%sSGID=%s"GID_FMT
"%s", prefix
, color
, c
->sgid
, suffix
);
378 if (c
->mask
& SD_BUS_CREDS_FSGID
)
379 fprintf(f
, "%sFSGID=%s"GID_FMT
"%s", prefix
, color
, c
->fsgid
, suffix
);
381 if (c
->mask
& SD_BUS_CREDS_SUPPLEMENTARY_GIDS
) {
384 fprintf(f
, "%sSupplementaryGIDs=%s", prefix
, color
);
385 for (i
= 0; i
< c
->n_supplementary_gids
; i
++)
386 fprintf(f
, "%s" GID_FMT
, i
> 0 ? " " : "", c
->supplementary_gids
[i
]);
387 fprintf(f
, "%s", suffix
);
390 if (terse
&& ((c
->mask
& (SD_BUS_CREDS_UID
|SD_BUS_CREDS_EUID
|SD_BUS_CREDS_SUID
|SD_BUS_CREDS_FSUID
|
391 SD_BUS_CREDS_GID
|SD_BUS_CREDS_EGID
|SD_BUS_CREDS_SGID
|SD_BUS_CREDS_FSGID
|
392 SD_BUS_CREDS_SUPPLEMENTARY_GIDS
)) || r
>= 0))
395 if (c
->mask
& SD_BUS_CREDS_COMM
)
396 fprintf(f
, "%sComm=%s%s%s", prefix
, color
, c
->comm
, suffix
);
397 if (c
->mask
& SD_BUS_CREDS_TID_COMM
)
398 fprintf(f
, "%sTIDComm=%s%s%s", prefix
, color
, c
->tid_comm
, suffix
);
399 if (c
->mask
& SD_BUS_CREDS_EXE
)
400 fprintf(f
, "%sExe=%s%s%s", prefix
, color
, strna(c
->exe
), suffix
);
402 if (terse
&& (c
->mask
& (SD_BUS_CREDS_EXE
|SD_BUS_CREDS_COMM
|SD_BUS_CREDS_TID_COMM
)))
405 r
= sd_bus_creds_get_cmdline(c
, &cmdline
);
409 fprintf(f
, "%sCommandLine=%s", prefix
, color
);
410 STRV_FOREACH(i
, cmdline
) {
417 fprintf(f
, "%s", suffix
);
418 } else if (r
!= -ENODATA
)
419 fprintf(f
, "%sCommandLine=%sn/a%s", prefix
, color
, suffix
);
421 if (c
->mask
& SD_BUS_CREDS_SELINUX_CONTEXT
)
422 fprintf(f
, "%sLabel=%s%s%s", prefix
, color
, c
->label
, suffix
);
423 if (c
->mask
& SD_BUS_CREDS_DESCRIPTION
)
424 fprintf(f
, "%sDescription=%s%s%s", prefix
, color
, c
->description
, suffix
);
426 if (terse
&& (c
->mask
& (SD_BUS_CREDS_SELINUX_CONTEXT
|SD_BUS_CREDS_DESCRIPTION
)))
429 if (c
->mask
& SD_BUS_CREDS_CGROUP
)
430 fprintf(f
, "%sCGroup=%s%s%s", prefix
, color
, c
->cgroup
, suffix
);
432 r
= sd_bus_creds_get_unit(c
, &s
);
434 fprintf(f
, "%sUnit=%s%s%s", prefix
, color
, strna(s
), suffix
);
436 v
= sd_bus_creds_get_slice(c
, &s
);
438 fprintf(f
, "%sSlice=%s%s%s", prefix
, color
, strna(s
), suffix
);
440 q
= sd_bus_creds_get_user_unit(c
, &s
);
442 fprintf(f
, "%sUserUnit=%s%s%s", prefix
, color
, strna(s
), suffix
);
444 w
= sd_bus_creds_get_user_slice(c
, &s
);
446 fprintf(f
, "%sUserSlice=%s%s%s", prefix
, color
, strna(s
), suffix
);
448 z
= sd_bus_creds_get_session(c
, &s
);
450 fprintf(f
, "%sSession=%s%s%s", prefix
, color
, strna(s
), suffix
);
452 if (terse
&& ((c
->mask
& SD_BUS_CREDS_CGROUP
) || r
!= -ENODATA
|| q
!= -ENODATA
|| v
!= -ENODATA
|| w
!= -ENODATA
|| z
!= -ENODATA
))
455 r
= sd_bus_creds_get_audit_login_uid(c
, &audit_loginuid
);
457 fprintf(f
, "%sAuditLoginUID=%s"UID_FMT
"%s", prefix
, color
, audit_loginuid
, suffix
);
458 else if (r
!= -ENODATA
)
459 fprintf(f
, "%sAuditLoginUID=%sn/a%s", prefix
, color
, suffix
);
460 q
= sd_bus_creds_get_audit_session_id(c
, &audit_sessionid
);
462 fprintf(f
, "%sAuditSessionID=%s%"PRIu32
"%s", prefix
, color
, audit_sessionid
, suffix
);
463 else if (q
!= -ENODATA
)
464 fprintf(f
, "%sAuditSessionID=%sn/a%s", prefix
, color
, suffix
);
466 if (terse
&& (r
!= -ENODATA
|| q
!= -ENODATA
))
469 if (c
->mask
& SD_BUS_CREDS_UNIQUE_NAME
)
470 fprintf(f
, "%sUniqueName=%s%s%s", prefix
, color
, c
->unique_name
, suffix
);
472 if (sd_bus_creds_get_well_known_names(c
, &well_known
) >= 0) {
475 fprintf(f
, "%sWellKnownNames=%s", prefix
, color
);
476 STRV_FOREACH(i
, well_known
) {
483 fprintf(f
, "%s", suffix
);
486 if (terse
&& (c
->mask
& SD_BUS_CREDS_UNIQUE_NAME
|| well_known
))
489 dump_capabilities(c
, f
, "EffectiveCapabilities", terse
, sd_bus_creds_has_effective_cap
);
490 dump_capabilities(c
, f
, "PermittedCapabilities", terse
, sd_bus_creds_has_permitted_cap
);
491 dump_capabilities(c
, f
, "InheritableCapabilities", terse
, sd_bus_creds_has_inheritable_cap
);
492 dump_capabilities(c
, f
, "BoundingCapabilities", terse
, sd_bus_creds_has_bounding_cap
);
498 * For details about the file format, see:
500 * http://wiki.wireshark.org/Development/LibpcapFileFormat
503 typedef struct _packed_ pcap_hdr_s
{
504 uint32_t magic_number
; /* magic number */
505 uint16_t version_major
; /* major version number */
506 uint16_t version_minor
; /* minor version number */
507 int32_t thiszone
; /* GMT to local correction */
508 uint32_t sigfigs
; /* accuracy of timestamps */
509 uint32_t snaplen
; /* max length of captured packets, in octets */
510 uint32_t network
; /* data link type */
513 typedef struct _packed_ pcaprec_hdr_s
{
514 uint32_t ts_sec
; /* timestamp seconds */
515 uint32_t ts_usec
; /* timestamp microseconds */
516 uint32_t incl_len
; /* number of octets of packet saved in file */
517 uint32_t orig_len
; /* actual length of packet */
520 int bus_pcap_header(size_t snaplen
, FILE *f
) {
523 .magic_number
= 0xa1b2c3d4U
,
526 .thiszone
= 0, /* UTC */
528 .network
= 231, /* D-Bus */
535 assert((size_t) (uint32_t) snaplen
== snaplen
);
537 hdr
.snaplen
= (uint32_t) snaplen
;
539 fwrite(&hdr
, 1, sizeof(hdr
), f
);
541 return fflush_and_check(f
);
544 int bus_message_pcap_frame(sd_bus_message
*m
, size_t snaplen
, FILE *f
) {
545 struct bus_body_part
*part
;
546 pcaprec_hdr_t hdr
= {};
556 assert((size_t) (uint32_t) snaplen
== snaplen
);
558 if (m
->realtime
!= 0)
559 timeval_store(&tv
, m
->realtime
);
561 assert_se(gettimeofday(&tv
, NULL
) >= 0);
563 hdr
.ts_sec
= tv
.tv_sec
;
564 hdr
.ts_usec
= tv
.tv_usec
;
565 hdr
.orig_len
= BUS_MESSAGE_SIZE(m
);
566 hdr
.incl_len
= MIN(hdr
.orig_len
, snaplen
);
568 /* write the pcap header */
569 fwrite(&hdr
, 1, sizeof(hdr
), f
);
571 /* write the dbus header */
572 w
= MIN(BUS_MESSAGE_BODY_BEGIN(m
), snaplen
);
573 fwrite(m
->header
, 1, w
, f
);
576 /* write the dbus body */
577 MESSAGE_FOREACH_PART(part
, i
, m
) {
581 w
= MIN(part
->size
, snaplen
);
582 fwrite(part
->data
, 1, w
, f
);
586 return fflush_and_check(f
);