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 "locale-util.h"
16 #include "string-util.h"
18 #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
) {
57 if (flags
& SD_BUS_MESSAGE_DUMP_WITH_HEADER
) {
58 usec_t ts
= m
->realtime
;
61 ts
= now(CLOCK_REALTIME
);
64 "%s%s%s Type=%s%s%s Endian=%c Flags=%u Version=%u",
65 m
->header
->type
== SD_BUS_MESSAGE_METHOD_ERROR
? ansi_highlight_red() :
66 m
->header
->type
== SD_BUS_MESSAGE_METHOD_RETURN
? ansi_highlight_green() :
67 m
->header
->type
!= SD_BUS_MESSAGE_SIGNAL
? ansi_highlight() : "",
68 special_glyph(SPECIAL_GLYPH_TRIANGULAR_BULLET
),
72 bus_message_type_to_string(m
->header
->type
) ?: "(unknown)",
79 /* Display synthetic message serial number in a more readable
80 * format than UINT32_MAX */
81 if (BUS_MESSAGE_COOKIE(m
) == 0xFFFFFFFFULL
)
82 fprintf(f
, " Cookie=-1");
84 fprintf(f
, " Cookie=%" PRIu64
, BUS_MESSAGE_COOKIE(m
));
86 if (m
->reply_cookie
!= 0)
87 fprintf(f
, " ReplyCookie=%" PRIu64
, m
->reply_cookie
);
89 fprintf(f
, " Timestamp=\"%s\"\n", strna(FORMAT_TIMESTAMP_STYLE(ts
, TIMESTAMP_US_UTC
)));
92 fprintf(f
, " Sender=%s%s%s", ansi_highlight(), m
->sender
, ansi_normal());
94 fprintf(f
, " Destination=%s%s%s", ansi_highlight(), m
->destination
, ansi_normal());
96 fprintf(f
, " Path=%s%s%s", ansi_highlight(), m
->path
, ansi_normal());
98 fprintf(f
, " Interface=%s%s%s", ansi_highlight(), m
->interface
, ansi_normal());
100 fprintf(f
, " Member=%s%s%s", ansi_highlight(), m
->member
, ansi_normal());
102 if (m
->sender
|| m
->destination
|| m
->path
|| m
->interface
|| m
->member
)
105 if (sd_bus_error_is_set(&m
->error
))
108 " ErrorMessage=%s\"%s\"%s\n",
109 ansi_highlight_red(), strna(m
->error
.name
), ansi_normal(),
110 ansi_highlight_red(), strna(m
->error
.message
), ansi_normal());
112 if (m
->monotonic
!= 0)
113 fprintf(f
, " Monotonic="USEC_FMT
, m
->monotonic
);
114 if (m
->realtime
!= 0)
115 fprintf(f
, " Realtime="USEC_FMT
, m
->realtime
);
117 fprintf(f
, " SequenceNumber=%"PRIu64
, m
->seqnum
);
119 if (m
->monotonic
!= 0 || m
->realtime
!= 0 || m
->seqnum
!= 0)
122 bus_creds_dump(&m
->creds
, f
, true);
125 r
= sd_bus_message_rewind(m
, !(flags
& SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
));
127 return log_error_errno(r
, "Failed to rewind: %m");
129 if (!(flags
& SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
)) {
130 _cleanup_free_
char *prefix
= NULL
;
132 prefix
= indent(0, flags
);
136 fprintf(f
, "%sMESSAGE \"%s\" {\n", prefix
, strempty(m
->root_container
.signature
));
140 _cleanup_free_
char *prefix
= NULL
;
141 const char *contents
= NULL
;
156 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
158 return log_error_errno(r
, "Failed to peek type: %m");
164 r
= sd_bus_message_exit_container(m
);
166 return log_error_errno(r
, "Failed to exit container: %m");
170 prefix
= indent(level
, flags
);
174 fprintf(f
, "%s};\n", prefix
);
178 prefix
= indent(level
, flags
);
182 if (bus_type_is_container(type
) > 0) {
183 r
= sd_bus_message_enter_container(m
, type
, contents
);
185 return log_error_errno(r
, "Failed to enter container: %m");
187 if (type
== SD_BUS_TYPE_ARRAY
)
188 fprintf(f
, "%sARRAY \"%s\" {\n", prefix
, contents
);
189 else if (type
== SD_BUS_TYPE_VARIANT
)
190 fprintf(f
, "%sVARIANT \"%s\" {\n", prefix
, contents
);
191 else if (type
== SD_BUS_TYPE_STRUCT
)
192 fprintf(f
, "%sSTRUCT \"%s\" {\n", prefix
, contents
);
193 else if (type
== SD_BUS_TYPE_DICT_ENTRY
)
194 fprintf(f
, "%sDICT_ENTRY \"%s\" {\n", prefix
, contents
);
201 r
= sd_bus_message_read_basic(m
, type
, &basic
);
203 return log_error_errno(r
, "Failed to get basic: %m");
209 case SD_BUS_TYPE_BYTE
:
210 fprintf(f
, "%sBYTE %s%u%s;\n", prefix
, ansi_highlight(), basic
.u8
, ansi_normal());
213 case SD_BUS_TYPE_BOOLEAN
:
214 fprintf(f
, "%sBOOLEAN %s%s%s;\n", prefix
, ansi_highlight(), true_false(basic
.i
), ansi_normal());
217 case SD_BUS_TYPE_INT16
:
218 fprintf(f
, "%sINT16 %s%i%s;\n", prefix
, ansi_highlight(), basic
.s16
, ansi_normal());
221 case SD_BUS_TYPE_UINT16
:
222 fprintf(f
, "%sUINT16 %s%u%s;\n", prefix
, ansi_highlight(), basic
.u16
, ansi_normal());
225 case SD_BUS_TYPE_INT32
:
226 fprintf(f
, "%sINT32 %s%i%s;\n", prefix
, ansi_highlight(), basic
.s32
, ansi_normal());
229 case SD_BUS_TYPE_UINT32
:
230 fprintf(f
, "%sUINT32 %s%u%s;\n", prefix
, ansi_highlight(), basic
.u32
, ansi_normal());
233 case SD_BUS_TYPE_INT64
:
234 fprintf(f
, "%sINT64 %s%"PRIi64
"%s;\n", prefix
, ansi_highlight(), basic
.s64
, ansi_normal());
237 case SD_BUS_TYPE_UINT64
:
238 fprintf(f
, "%sUINT64 %s%"PRIu64
"%s;\n", prefix
, ansi_highlight(), basic
.u64
, ansi_normal());
241 case SD_BUS_TYPE_DOUBLE
:
242 fprintf(f
, "%sDOUBLE %s%g%s;\n", prefix
, ansi_highlight(), basic
.d64
, ansi_normal());
245 case SD_BUS_TYPE_STRING
:
246 fprintf(f
, "%sSTRING \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
249 case SD_BUS_TYPE_OBJECT_PATH
:
250 fprintf(f
, "%sOBJECT_PATH \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
253 case SD_BUS_TYPE_SIGNATURE
:
254 fprintf(f
, "%sSIGNATURE \"%s%s%s\";\n", prefix
, ansi_highlight(), basic
.string
, ansi_normal());
257 case SD_BUS_TYPE_UNIX_FD
:
258 fprintf(f
, "%sUNIX_FD %s%i%s;\n", prefix
, ansi_highlight(), basic
.i
, ansi_normal());
262 assert_not_reached();
266 if (!(flags
& SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY
)) {
267 _cleanup_free_
char *prefix
= NULL
;
269 prefix
= indent(0, flags
);
273 fprintf(f
, "%s};\n\n", prefix
);
279 static void dump_capabilities(
284 int (*has
)(sd_bus_creds
*c
, int capability
)) {
286 unsigned long i
, last_cap
;
300 fprintf(f
, "%s%s=%s", terse
? " " : "", name
, terse
? "" : ansi_highlight());
301 last_cap
= cap_last_cap();
309 fprintf(f
, terse
? "\n " : "\n ");
311 fprintf(f
, "%s", strna(capability_to_name(i
)));
326 fputs(ansi_normal(), f
);
329 int bus_creds_dump(sd_bus_creds
*c
, FILE *f
, bool terse
) {
330 uid_t owner
, audit_loginuid
;
331 uint32_t audit_sessionid
;
332 char **cmdline
= NULL
, **well_known
= NULL
;
333 const char *prefix
, *color
, *suffix
, *s
;
349 color
= ansi_highlight();
352 suffix
= strjoina(off
, "\n");
355 if (c
->mask
& SD_BUS_CREDS_PID
)
356 fprintf(f
, "%sPID=%s"PID_FMT
"%s", prefix
, color
, c
->pid
, suffix
);
357 if (c
->mask
& SD_BUS_CREDS_TID
)
358 fprintf(f
, "%sTID=%s"PID_FMT
"%s", prefix
, color
, c
->tid
, suffix
);
359 if (c
->mask
& SD_BUS_CREDS_PPID
) {
361 fprintf(f
, "%sPPID=%sn/a%s", prefix
, color
, suffix
);
363 fprintf(f
, "%sPPID=%s"PID_FMT
"%s", prefix
, color
, c
->ppid
, suffix
);
365 if (c
->mask
& SD_BUS_CREDS_TTY
)
366 fprintf(f
, "%sTTY=%s%s%s", prefix
, color
, strna(c
->tty
), suffix
);
368 if (terse
&& ((c
->mask
& (SD_BUS_CREDS_PID
|SD_BUS_CREDS_TID
|SD_BUS_CREDS_PPID
|SD_BUS_CREDS_TTY
))))
371 if (c
->mask
& SD_BUS_CREDS_UID
)
372 fprintf(f
, "%sUID=%s"UID_FMT
"%s", prefix
, color
, c
->uid
, suffix
);
373 if (c
->mask
& SD_BUS_CREDS_EUID
)
374 fprintf(f
, "%sEUID=%s"UID_FMT
"%s", prefix
, color
, c
->euid
, suffix
);
375 if (c
->mask
& SD_BUS_CREDS_SUID
)
376 fprintf(f
, "%sSUID=%s"UID_FMT
"%s", prefix
, color
, c
->suid
, suffix
);
377 if (c
->mask
& SD_BUS_CREDS_FSUID
)
378 fprintf(f
, "%sFSUID=%s"UID_FMT
"%s", prefix
, color
, c
->fsuid
, suffix
);
379 r
= sd_bus_creds_get_owner_uid(c
, &owner
);
381 fprintf(f
, "%sOwnerUID=%s"UID_FMT
"%s", prefix
, color
, owner
, suffix
);
382 if (c
->mask
& SD_BUS_CREDS_GID
)
383 fprintf(f
, "%sGID=%s"GID_FMT
"%s", prefix
, color
, c
->gid
, suffix
);
384 if (c
->mask
& SD_BUS_CREDS_EGID
)
385 fprintf(f
, "%sEGID=%s"GID_FMT
"%s", prefix
, color
, c
->egid
, suffix
);
386 if (c
->mask
& SD_BUS_CREDS_SGID
)
387 fprintf(f
, "%sSGID=%s"GID_FMT
"%s", prefix
, color
, c
->sgid
, suffix
);
388 if (c
->mask
& SD_BUS_CREDS_FSGID
)
389 fprintf(f
, "%sFSGID=%s"GID_FMT
"%s", prefix
, color
, c
->fsgid
, suffix
);
391 if (c
->mask
& SD_BUS_CREDS_SUPPLEMENTARY_GIDS
) {
392 fprintf(f
, "%sSupplementaryGIDs=%s", prefix
, color
);
393 for (unsigned i
= 0; i
< c
->n_supplementary_gids
; i
++)
394 fprintf(f
, "%s" GID_FMT
, i
> 0 ? " " : "", c
->supplementary_gids
[i
]);
395 fprintf(f
, "%s", suffix
);
398 if (terse
&& ((c
->mask
& (SD_BUS_CREDS_UID
|SD_BUS_CREDS_EUID
|SD_BUS_CREDS_SUID
|SD_BUS_CREDS_FSUID
|
399 SD_BUS_CREDS_GID
|SD_BUS_CREDS_EGID
|SD_BUS_CREDS_SGID
|SD_BUS_CREDS_FSGID
|
400 SD_BUS_CREDS_SUPPLEMENTARY_GIDS
)) || r
>= 0))
403 if (c
->mask
& SD_BUS_CREDS_COMM
)
404 fprintf(f
, "%sComm=%s%s%s", prefix
, color
, c
->comm
, suffix
);
405 if (c
->mask
& SD_BUS_CREDS_TID_COMM
)
406 fprintf(f
, "%sTIDComm=%s%s%s", prefix
, color
, c
->tid_comm
, suffix
);
407 if (c
->mask
& SD_BUS_CREDS_EXE
)
408 fprintf(f
, "%sExe=%s%s%s", prefix
, color
, strna(c
->exe
), suffix
);
410 if (terse
&& (c
->mask
& (SD_BUS_CREDS_EXE
|SD_BUS_CREDS_COMM
|SD_BUS_CREDS_TID_COMM
)))
413 r
= sd_bus_creds_get_cmdline(c
, &cmdline
);
417 fprintf(f
, "%sCommandLine=%s", prefix
, color
);
418 STRV_FOREACH(i
, cmdline
) {
425 fprintf(f
, "%s", suffix
);
426 } else if (r
!= -ENODATA
)
427 fprintf(f
, "%sCommandLine=%sn/a%s", prefix
, color
, suffix
);
429 if (c
->mask
& SD_BUS_CREDS_SELINUX_CONTEXT
)
430 fprintf(f
, "%sLabel=%s%s%s", prefix
, color
, c
->label
, suffix
);
431 if (c
->mask
& SD_BUS_CREDS_DESCRIPTION
)
432 fprintf(f
, "%sDescription=%s%s%s", prefix
, color
, c
->description
, suffix
);
434 if (terse
&& (c
->mask
& (SD_BUS_CREDS_SELINUX_CONTEXT
|SD_BUS_CREDS_DESCRIPTION
)))
437 if (c
->mask
& SD_BUS_CREDS_CGROUP
)
438 fprintf(f
, "%sCGroup=%s%s%s", prefix
, color
, c
->cgroup
, suffix
);
440 r
= sd_bus_creds_get_unit(c
, &s
);
442 fprintf(f
, "%sUnit=%s%s%s", prefix
, color
, strna(s
), suffix
);
444 v
= sd_bus_creds_get_slice(c
, &s
);
446 fprintf(f
, "%sSlice=%s%s%s", prefix
, color
, strna(s
), suffix
);
448 q
= sd_bus_creds_get_user_unit(c
, &s
);
450 fprintf(f
, "%sUserUnit=%s%s%s", prefix
, color
, strna(s
), suffix
);
452 w
= sd_bus_creds_get_user_slice(c
, &s
);
454 fprintf(f
, "%sUserSlice=%s%s%s", prefix
, color
, strna(s
), suffix
);
456 z
= sd_bus_creds_get_session(c
, &s
);
458 fprintf(f
, "%sSession=%s%s%s", prefix
, color
, strna(s
), suffix
);
460 if (terse
&& ((c
->mask
& SD_BUS_CREDS_CGROUP
) || r
!= -ENODATA
|| q
!= -ENODATA
|| v
!= -ENODATA
|| w
!= -ENODATA
|| z
!= -ENODATA
))
463 r
= sd_bus_creds_get_audit_login_uid(c
, &audit_loginuid
);
465 fprintf(f
, "%sAuditLoginUID=%s"UID_FMT
"%s", prefix
, color
, audit_loginuid
, suffix
);
466 else if (r
!= -ENODATA
)
467 fprintf(f
, "%sAuditLoginUID=%sn/a%s", prefix
, color
, suffix
);
468 q
= sd_bus_creds_get_audit_session_id(c
, &audit_sessionid
);
470 fprintf(f
, "%sAuditSessionID=%s%"PRIu32
"%s", prefix
, color
, audit_sessionid
, suffix
);
471 else if (q
!= -ENODATA
)
472 fprintf(f
, "%sAuditSessionID=%sn/a%s", prefix
, color
, suffix
);
474 if (terse
&& (r
!= -ENODATA
|| q
!= -ENODATA
))
477 if (c
->mask
& SD_BUS_CREDS_UNIQUE_NAME
)
478 fprintf(f
, "%sUniqueName=%s%s%s", prefix
, color
, c
->unique_name
, suffix
);
480 if (sd_bus_creds_get_well_known_names(c
, &well_known
) >= 0) {
483 fprintf(f
, "%sWellKnownNames=%s", prefix
, color
);
484 STRV_FOREACH(i
, well_known
) {
491 fprintf(f
, "%s", suffix
);
494 if (terse
&& (c
->mask
& SD_BUS_CREDS_UNIQUE_NAME
|| well_known
))
497 dump_capabilities(c
, f
, "EffectiveCapabilities", terse
, sd_bus_creds_has_effective_cap
);
498 dump_capabilities(c
, f
, "PermittedCapabilities", terse
, sd_bus_creds_has_permitted_cap
);
499 dump_capabilities(c
, f
, "InheritableCapabilities", terse
, sd_bus_creds_has_inheritable_cap
);
500 dump_capabilities(c
, f
, "BoundingCapabilities", terse
, sd_bus_creds_has_bounding_cap
);
506 * For details about the file format, see:
508 * http://wiki.wireshark.org/Development/LibpcapFileFormat
511 typedef struct _packed_ pcap_hdr_s
{
512 uint32_t magic_number
; /* magic number */
513 uint16_t version_major
; /* major version number */
514 uint16_t version_minor
; /* minor version number */
515 int32_t thiszone
; /* GMT to local correction */
516 uint32_t sigfigs
; /* accuracy of timestamps */
517 uint32_t snaplen
; /* max length of captured packets, in octets */
518 uint32_t network
; /* data link type */
521 typedef struct _packed_ pcaprec_hdr_s
{
522 uint32_t ts_sec
; /* timestamp seconds */
523 uint32_t ts_usec
; /* timestamp microseconds */
524 uint32_t incl_len
; /* number of octets of packet saved in file */
525 uint32_t orig_len
; /* actual length of packet */
528 int bus_pcap_header(size_t snaplen
, FILE *f
) {
531 .magic_number
= 0xa1b2c3d4U
,
534 .thiszone
= 0, /* UTC */
536 .network
= 231, /* D-Bus */
543 assert((size_t) (uint32_t) snaplen
== snaplen
);
545 hdr
.snaplen
= (uint32_t) snaplen
;
547 fwrite(&hdr
, 1, sizeof(hdr
), f
);
549 return fflush_and_check(f
);
552 int bus_message_pcap_frame(sd_bus_message
*m
, size_t snaplen
, FILE *f
) {
553 struct bus_body_part
*part
;
554 pcaprec_hdr_t hdr
= {};
564 assert((size_t) (uint32_t) snaplen
== snaplen
);
566 if (m
->realtime
!= 0)
567 timeval_store(&tv
, m
->realtime
);
569 assert_se(gettimeofday(&tv
, NULL
) >= 0);
571 hdr
.ts_sec
= tv
.tv_sec
;
572 hdr
.ts_usec
= tv
.tv_usec
;
573 hdr
.orig_len
= BUS_MESSAGE_SIZE(m
);
574 hdr
.incl_len
= MIN(hdr
.orig_len
, snaplen
);
576 /* write the pcap header */
577 fwrite(&hdr
, 1, sizeof(hdr
), f
);
579 /* write the dbus header */
580 w
= MIN(BUS_MESSAGE_BODY_BEGIN(m
), snaplen
);
581 fwrite(m
->header
, 1, w
, f
);
584 /* write the dbus body */
585 MESSAGE_FOREACH_PART(part
, i
, m
) {
589 w
= MIN(part
->size
, snaplen
);
590 fwrite(part
->data
, 1, w
, f
);
594 return fflush_and_check(f
);