src/libsystemd-bus/kdbus.h

   1 /*
   2  * Copyright (C) 2013 Kay Sievers
   3  * Copyright (C) 2013 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
   4  * Copyright (C) 2013 Linux Foundation
   5  *
   6  * kdbus is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Lesser General Public License as published by the
   8  * Free Software Foundation; either version 2.1 of the License, or (at
   9  * your option) any later version.
  10  */
  11
  12 #ifndef _KDBUS_H_
  13 #define _KDBUS_H_
  14
  15 #ifndef __KERNEL__
  16 #include <sys/ioctl.h>
  17 #include <sys/types.h>
  18 #include <linux/types.h>
  19 #endif
  20
  21 #define KDBUS_IOC_MAGIC                 0x95
  22
  23 /* Message sent from kernel to userspace, when the owner or starter of
  24  * a well-known name changes */
  25 struct kdbus_manager_msg_name_change {
  26         __u64 old_id;
  27         __u64 new_id;
  28         __u64 flags;            /* 0 or (possibly?) KDBUS_CMD_NAME_IN_QUEUE */
  29         char name[0];
  30 };
  31
  32 struct kdbus_manager_msg_id_change {
  33         __u64 id;
  34         __u64 flags; /* The kernel flags field from KDBUS_CMD_HELLO */
  35 };
  36
  37 struct kdbus_creds {
  38         __u64 uid;
  39         __u64 gid;
  40         __u64 pid;
  41         __u64 tid;
  42
  43         /* The starttime of the process PID. This is useful to detect
  44         PID overruns from the client side. i.e. if you use the PID to
  45         look something up in /proc/$PID/ you can afterwards check the
  46         starttime field of it to ensure you didn't run into a PID
  47         ovretun. */
  48         __u64 starttime;
  49 };
  50
  51 #define KDBUS_SRC_ID_KERNEL             (0)
  52 #define KDBUS_DST_ID_WELL_KNOWN_NAME    (0)
  53 #define KDBUS_MATCH_SRC_ID_ANY          (~0ULL)
  54 #define KDBUS_DST_ID_BROADCAST          (~0ULL)
  55
  56 /* Message Data Types */
  57 enum {
  58         /* Filled in by userspace */
  59         KDBUS_MSG_NULL,                 /* empty record */
  60         KDBUS_MSG_PAYLOAD,              /* .data */
  61         KDBUS_MSG_PAYLOAD_VEC,          /* .data_vec, converted into _PAYLOAD at delivery */
  62         KDBUS_MSG_MMAP,                 /* .data_vec */
  63         KDBUS_MSG_MMAP_DONATE,          /* .data_vec, unmap the memory from the sender */
  64         KDBUS_MSG_UNIX_FDS,             /* .data_fds of file descriptors */
  65         KDBUS_MSG_BLOOM,                /* for broadcasts, carries bloom filter blob */
  66         KDBUS_MSG_DST_NAME,             /* destination's well-known name */
  67
  68         /* Filled in by kernelspace */
  69         KDBUS_MSG_SRC_NAMES     = 0x200,/* NUL separated string list with well-known names of source */
  70         KDBUS_MSG_TIMESTAMP,            /* .ts_ns of CLOCK_MONOTONIC */
  71         KDBUS_MSG_SRC_CREDS,            /* .creds */
  72         KDBUS_MSG_SRC_COMM,             /* optional */
  73         KDBUS_MSG_SRC_EXE,              /* optional */
  74         KDBUS_MSG_SRC_CMDLINE,          /* optional */
  75         KDBUS_MSG_SRC_CGROUP,           /* optional, specified which one */
  76         KDBUS_MSG_SRC_CAPS,             /* caps data blob */
  77         KDBUS_MSG_SRC_SECLABEL,         /* NUL terminated string */
  78         KDBUS_MSG_SRC_AUDIT,            /* array of two uint64_t of audit loginuid + sessiond */
  79
  80         /* Special messages from kernel, consisting of one and only one of these data blocks */
  81         KDBUS_MSG_NAME_ADD      = 0x400,/* .name_change */
  82         KDBUS_MSG_NAME_REMOVE,          /* .name_change */
  83         KDBUS_MSG_NAME_CHANGE,          /* .name_change */
  84         KDBUS_MSG_ID_ADD,               /* .id_change */
  85         KDBUS_MSG_ID_REMOVE,            /* .id_change */
  86         KDBUS_MSG_ID_CHANGE,            /* .id_change */
  87         KDBUS_MSG_REPLY_TIMEOUT,        /* empty, but .reply_cookie in .kdbus_msg is filled in */
  88         KDBUS_MSG_REPLY_DEAD,           /* dito */
  89 };
  90
  91 struct kdbus_vec {
  92         __u64 address;
  93         __u64 size;
  94 };
  95
  96 /**
  97  * struct  kdbus_msg_data - chain of data blocks
  98  *
  99  * size: overall data record size
 100  * type: kdbus_msg_data_type of data
 101  */
 102 struct kdbus_msg_data {
 103         __u64 size;
 104         __u64 type;
 105         union {
 106                 /* inline data */
 107                 __u8 data[0];
 108                 __u32 data_u32[0];
 109                 __u64 data_u64[0];
 110
 111                 /* data vector */
 112                 struct kdbus_vec vec;
 113
 114                 /* specific fields */
 115                 int fds[0];                             /* int array of file descriptors */
 116                 __u64 ts_ns;                            /* timestamp in nanoseconds */
 117                 struct kdbus_creds creds;
 118                 struct kdbus_manager_msg_name_change name_change;
 119                 struct kdbus_manager_msg_id_change id_change;
 120         };
 121 };
 122
 123 enum {
 124         KDBUS_MSG_FLAGS_EXPECT_REPLY    = 1,
 125         KDBUS_MSG_FLAGS_NO_AUTO_START   = 2, /* possibly? */
 126 };
 127
 128 enum {
 129         KDBUS_PAYLOAD_NONE      = 0,
 130         KDBUS_PAYLOAD_DBUS1     = 0x4442757356657231ULL, /* 'DBusVer1' */
 131         KDBUS_PAYLOAD_GVARIANT  = 0x4756617269616e74ULL, /* 'GVariant' */
 132 };
 133
 134 /**
 135  * struct kdbus_msg
 136  *
 137  * set by userspace:
 138  * dst_id: destination id
 139  * flags: KDBUS_MSG_FLAGS_*
 140  * data_size: overall message size
 141  * data: data records
 142  *
 143  * set by kernel:
 144  * src_id: who sent the message
 145  */
 146 struct kdbus_msg {
 147         __u64 size;
 148         __u64 flags;
 149         __u64 dst_id;           /* connection, 0 == name in data, ~0 broadcast */
 150         __u64 src_id;           /* connection, 0 == kernel */
 151         __u64 payload_type;     /* 'DBusVer1', 'GVariant', ... */
 152         __u64 cookie;           /* userspace-supplied cookie */
 153         union {
 154                 __u64 cookie_reply;     /* cookie we reply to */
 155                 __u64 timeout_ns;       /* timespan to wait for reply */
 156         };
 157         struct kdbus_msg_data data[0];
 158 };
 159
 160 enum {
 161         KDBUS_POLICY_NAME,
 162         KDBUS_POLICY_ACCESS,
 163 };
 164
 165 enum {
 166         KDBUS_POLICY_USER,
 167         KDBUS_POLICY_GROUP,
 168         KDBUS_POLICY_WORLD,
 169 };
 170
 171 enum {
 172         KDBUS_POLICY_RECV       = 4,
 173         KDBUS_POLICY_SEND       = 2,
 174         KDBUS_POLICY_OWN        = 1,
 175 };
 176
 177 struct kdbus_policy {
 178         __u64 size;
 179         __u64 type; /* NAME or ACCESS */
 180         union {
 181                 char name[0];
 182                 struct {
 183                         __u32 type;     /* USER, GROUP, WORLD */
 184                         __u32 bits;     /* RECV, SEND, OWN */
 185                         __u64 id;       /* uid, gid, 0 */
 186                 } access;
 187         };
 188 };
 189
 190 struct kdbus_cmd_policy {
 191         __u64 size;
 192         __u8 buffer[0]; /* a series of KDBUS_POLICY_NAME plus one or more KDBUS_POLICY_ACCESS each. */
 193 };
 194
 195 enum {
 196         KDBUS_CMD_HELLO_STARTER         =  1,
 197         KDBUS_CMD_HELLO_ACCEPT_FD       =  2,
 198         KDBUS_CMD_HELLO_ACCEPT_MMAP     =  4,
 199 };
 200
 201 enum {
 202         KDBUS_CMD_FNAME_ACCESS_GROUP    =  1,
 203         KDBUS_CMD_FNAME_ACCESS_WORLD    =  2,
 204         KDBUS_CMD_FNAME_POLICY_NONE     =  4,
 205 };
 206
 207 struct kdbus_cmd_hello {
 208         /* userspace → kernel, kernel → userspace */
 209         __u64 kernel_flags;     /* userspace specifies its
 210                                  * capabilities and more, kernel
 211                                  * returns its capabilites and
 212                                  * more. Kernel might refuse client's
 213                                  * capabilities by returning an error
 214                                  * from KDBUS_CMD_HELLO */
 215
 216         /* userspace → kernel */
 217         __u64 pid;              /* To allow translator services which
 218                                  * connect to the bus on behalf of
 219                                  * somebody else, allow specifiying
 220                                  * the PID of the client to connect on
 221                                  * behalf on. Normal clients should
 222                                  * pass this as 0 (i.e. to do things
 223                                  * under their own PID). Priviliged
 224                                  * clients can pass != 0, to operate
 225                                  * on behalf of somebody else. */
 226
 227         /* kernel → userspace */
 228         __u64 bus_flags;        /* this is .flags copied verbatim from
 229                                  * from original KDBUS_CMD_BUS_MAKE
 230                                  * ioctl. It's intended to be useful
 231                                  * to do negotiation of features of
 232                                  * the payload that is transfreted. */
 233         __u64 id;               /* peer id */
 234 };
 235
 236 struct kdbus_cmd_fname {
 237         __u64 size;
 238         __u64 kernel_flags;     /* userspace → kernel, kernel → userspace
 239                                  * When creating a bus/ns/ep feature
 240                                  * kernel negotiation done the same
 241                                  * way as for KDBUS_CMD_BUS_MAKE. */
 242         __u64 user_flags;       /* userspace → kernel
 243                                  * When a bus is created this value is
 244                                  * copied verbatim into the bus
 245                                  * structure and returned from
 246                                  * KDBUS_CMD_HELLO, later */
 247         char name[0];
 248 };
 249
 250 enum {
 251         /* userspace → kernel */
 252         KDBUS_CMD_NAME_REPLACE_EXISTING         =  1,
 253         KDBUS_CMD_NAME_QUEUE                    =  2,
 254         KDBUS_CMD_NAME_ALLOW_REPLACEMENT        =  4,
 255         KDBUS_CMD_NAME_STEAL_MESSAGES           =  8,
 256
 257         /* kernel → userspace */
 258         KDBUS_CMD_NAME_IN_QUEUE = 0x200,
 259 };
 260
 261 struct kdbus_cmd_name {
 262         __u64 size;
 263         __u64 flags;
 264         __u64 id;               /* We allow registration/deregestration of names of other peers */
 265         char name[0];
 266 };
 267
 268 struct kdbus_cmd_names {
 269         __u64 size;
 270         struct kdbus_cmd_name names[0];
 271 };
 272
 273 enum {
 274         KDBUS_CMD_NAME_INFO_ITEM_NAME,
 275         KDBUS_CMD_NAME_INFO_ITEM_SECLABEL,
 276         KDBUS_CMD_NAME_INFO_ITEM_AUDIT,
 277 };
 278
 279 struct kdbus_cmd_name_info_item {
 280         __u64 size;
 281         __u64 type;
 282         __u8 data[0];
 283 };
 284
 285 struct kdbus_cmd_name_info {
 286         __u64 size;                     /* overall size of info */
 287         __u64 flags;
 288         __u64 id;                       /* either ID, or 0 and _ITEM_NAME follows */
 289         struct kdbus_creds creds;
 290         struct kdbus_cmd_name_info_item item[0]; /* list of item records */
 291 };
 292
 293 enum {
 294         KDBUS_CMD_MATCH_BLOOM,          /* Matches a mask blob against KDBUS_MSG_BLOOM */
 295         KDBUS_CMD_MATCH_SRC_NAME,       /* Matches a name string against KDBUS_MSG_SRC_NAMES */
 296         KDBUS_CMD_MATCH_NAME_ADD,       /* Matches a name string against KDBUS_MSG_NAME_ADD */
 297         KDBUS_CMD_MATCH_NAME_REMOVE,    /* Matches a name string against KDBUS_MSG_NAME_REMOVE */
 298         KDBUS_CMD_MATCH_NAME_CHANGE,    /* Matches a name string against KDBUS_MSG_NAME_CHANGE */
 299         KDBUS_CMD_MATCH_ID_ADD,         /* Matches an ID against KDBUS_MSG_ID_ADD */
 300         KDBUS_CMD_MATCH_ID_REMOVE,      /* Matches an ID against KDBUS_MSG_ID_REMOVE */
 301         KDBUS_CMD_MATCH_ID_CHANGE,      /* Matches an ID against KDBUS_MSG_ID_CHANGE */
 302 };
 303
 304 struct kdbus_cmd_match_item {
 305         __u64 size;
 306         __u64 type;
 307         __u8 data[0];
 308 };
 309
 310 struct kdbus_cmd_match {
 311         __u64 size;
 312         __u64 id;       /* We allow registration/deregestration of matches for other peers */
 313         __u64 cookie;   /* userspace supplied cookie; when removing; kernel deletes everything with same cookie */
 314         __u64 src_id;   /* ~0: any. other: exact unique match */
 315         struct kdbus_cmd_match_item items[0];
 316 };
 317
 318 struct kdbus_cmd_monitor {
 319         __u64 id;               /* We allow setting the monitor flag of other peers */
 320         int enabled;            /* A boolean to enable/disable monitoring */
 321 };
 322
 323 /* FD states:
 324  * control nodes: unset
 325  *   bus owner  (via KDBUS_CMD_BUS_MAKE)
 326  *   ns owner   (via KDBUS_CMD_NS_MAKE)
 327  *
 328  * ep nodes: unset
 329  *   connected  (via KDBUS_CMD_HELLO)
 330  *   starter    (via KDBUS_CMD_HELLO with KDBUS_CMD_HELLO_STARTER)
 331  *   ep owner   (via KDBUS_CMD_EP_MAKE)
 332  */
 333 enum kdbus_cmd {
 334         /* kdbus control node commands: require unset state */
 335         KDBUS_CMD_BUS_MAKE =            _IOWR(KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_fname),
 336         KDBUS_CMD_NS_MAKE =             _IOWR(KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_fname),
 337
 338         /* kdbus control node commands: require bus owner state */
 339         KDBUS_CMD_BUS_POLICY_SET =      _IOWR(KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_policy),
 340
 341         /* kdbus ep node commands: require unset state */
 342         KDBUS_CMD_EP_MAKE =             _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_fname),
 343         KDBUS_CMD_HELLO =               _IOWR(KDBUS_IOC_MAGIC, 0x31, struct kdbus_cmd_hello),
 344
 345         /* kdbus ep node commands: require connected state */
 346         KDBUS_CMD_MSG_SEND =            _IOWR(KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
 347         KDBUS_CMD_MSG_RECV =            _IOWR(KDBUS_IOC_MAGIC, 0x41, struct kdbus_msg),
 348
 349         KDBUS_CMD_NAME_ACQUIRE =        _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name),
 350         KDBUS_CMD_NAME_RELEASE =        _IOWR(KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name),
 351         KDBUS_CMD_NAME_LIST =           _IOWR(KDBUS_IOC_MAGIC, 0x52, struct kdbus_cmd_names),
 352         KDBUS_CMD_NAME_QUERY =          _IOWR(KDBUS_IOC_MAGIC, 0x53, struct kdbus_cmd_name_info),
 353
 354         KDBUS_CMD_MATCH_ADD =           _IOWR(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_match),
 355         KDBUS_CMD_MATCH_REMOVE =        _IOWR(KDBUS_IOC_MAGIC, 0x61, struct kdbus_cmd_match),
 356         KDBUS_CMD_MONITOR =             _IOWR(KDBUS_IOC_MAGIC, 0x62, struct kdbus_cmd_monitor),
 357
 358         /* kdbus ep node commands: require ep owner state */
 359         KDBUS_CMD_EP_POLICY_SET =       _IOWR(KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_policy),
 360 };
 361 #endif