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  * Copyright (C) 2013 Lennart Poettering
   6  * Copyright (C) 2013 Daniel Mack <daniel@zonque.org>
   7  *
   8  * kdbus is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU Lesser General Public License as published by the
  10  * Free Software Foundation; either version 2.1 of the License, or (at
  11  * your option) any later version.
  12  */
  13
  14 #ifndef _KDBUS_H_
  15 #define _KDBUS_H_
  16
  17 #ifndef __KERNEL__
  18 #include <sys/ioctl.h>
  19 #include <sys/types.h>
  20 #include <linux/types.h>
  21 #endif
  22
  23 #define KDBUS_IOC_MAGIC                 0x95
  24 #define KDBUS_SRC_ID_KERNEL             (0)
  25 #define KDBUS_DST_ID_WELL_KNOWN_NAME    (0)
  26 #define KDBUS_MATCH_SRC_ID_ANY          (~0ULL)
  27 #define KDBUS_DST_ID_BROADCAST          (~0ULL)
  28
  29 /* Common first elements in a structure which are used to iterate over
  30  * a list of elements. */
  31 #define KDBUS_PART_HEADER \
  32         struct {                                                        \
  33                 __u64 size;                                             \
  34                 __u64 type;                                             \
  35         }
  36
  37 /* Message sent from kernel to userspace, when the owner or starter of
  38  * a well-known name changes */
  39 struct kdbus_notify_name_change {
  40         __u64 old_id;
  41         __u64 new_id;
  42         __u64 flags;                    /* 0 or (possibly?) KDBUS_NAME_IN_QUEUE */
  43         char name[0];
  44 };
  45
  46 struct kdbus_notify_id_change {
  47         __u64 id;
  48         __u64 flags;                    /* The kernel flags field from KDBUS_HELLO */
  49 };
  50
  51 struct kdbus_creds {
  52         __u64 uid;
  53         __u64 gid;
  54         __u64 pid;
  55         __u64 tid;
  56
  57         /* The starttime of the process PID. This is useful to detect
  58         PID overruns from the client side. i.e. if you use the PID to
  59         look something up in /proc/$PID/ you can afterwards check the
  60         starttime field of it to ensure you didn't run into a PID
  61         ovretun. */
  62         __u64 starttime;
  63 };
  64
  65 struct kdbus_audit {
  66         __u64 sessionid;
  67         __u64 loginuid;
  68 };
  69
  70 struct kdbus_timestamp {
  71         __u64 monotonic_ns;
  72         __u64 realtime_ns;
  73 };
  74
  75 struct kdbus_vec {
  76         __u64 size;
  77         union {
  78                 __u64 address;
  79                 __u64 offset;
  80         };
  81 };
  82
  83 struct kdbus_memfd {
  84         __u64 size;
  85         int fd;
  86         __u32 __pad;
  87 };
  88
  89 /* Message Item Types */
  90 enum {
  91         _KDBUS_ITEM_NULL,
  92
  93         /* Filled in by userspace */
  94         _KDBUS_ITEM_USER_BASE   = 1,
  95         KDBUS_ITEM_PAYLOAD_VEC  = 1,    /* .data_vec, reference to memory area */
  96         KDBUS_ITEM_PAYLOAD_OFF,         /* .data_vec, reference to memory area */
  97         KDBUS_ITEM_PAYLOAD_MEMFD,       /* file descriptor of a special data file */
  98         KDBUS_ITEM_FDS,                 /* .data_fds of file descriptors */
  99         KDBUS_ITEM_BLOOM,               /* for broadcasts, carries bloom filter blob in .data */
 100         KDBUS_ITEM_DST_NAME,            /* destination's well-known name, in .str */
 101         KDBUS_ITEM_PRIORITY,            /* queue priority for message */
 102
 103         /* Filled in by kernelspace */
 104         _KDBUS_ITEM_ATTACH_BASE = 0x400,
 105         KDBUS_ITEM_NAMES        = 0x400,/* NUL separated string list with well-known names of source */
 106         KDBUS_ITEM_STARTER_NAME,        /* Only used in HELLO for starter connection */
 107         KDBUS_ITEM_TIMESTAMP,           /* .timestamp */
 108
 109         /* when appended to a message, the following items refer to the sender */
 110         KDBUS_ITEM_CREDS,               /* .creds */
 111         KDBUS_ITEM_PID_COMM,            /* optional, in .str */
 112         KDBUS_ITEM_TID_COMM,            /* optional, in .str */
 113         KDBUS_ITEM_EXE,                 /* optional, in .str */
 114         KDBUS_ITEM_CMDLINE,             /* optional, in .str (a chain of NUL str) */
 115         KDBUS_ITEM_CGROUP,              /* optional, in .str */
 116         KDBUS_ITEM_CAPS,                /* caps data blob, in .data */
 117         KDBUS_ITEM_SECLABEL,            /* NUL terminated string, in .str */
 118         KDBUS_ITEM_AUDIT,               /* .audit */
 119
 120         /* Special messages from kernel, consisting of one and only one of these data blocks */
 121         _KDBUS_ITEM_KERNEL_BASE = 0x800,
 122         KDBUS_ITEM_NAME_ADD     = 0x800,/* .name_change */
 123         KDBUS_ITEM_NAME_REMOVE,         /* .name_change */
 124         KDBUS_ITEM_NAME_CHANGE,         /* .name_change */
 125         KDBUS_ITEM_ID_ADD,              /* .id_change */
 126         KDBUS_ITEM_ID_REMOVE,           /* .id_change */
 127         KDBUS_ITEM_REPLY_TIMEOUT,       /* empty, but .reply_cookie in .kdbus_msg is filled in */
 128         KDBUS_ITEM_REPLY_DEAD,          /* dito */
 129 };
 130
 131 /**
 132  * struct  kdbus_item - chain of data blocks
 133  *
 134  * size: overall data record size
 135  * type: kdbus_item type of data
 136  */
 137 struct kdbus_item {
 138         KDBUS_PART_HEADER;
 139         union {
 140                 /* inline data */
 141                 __u8 data[0];
 142                 __u32 data32[0];
 143                 __u64 data64[0];
 144                 char str[0];
 145
 146                 /* connection */
 147                 __u64 id;
 148
 149                 /* data vector */
 150                 struct kdbus_vec vec;
 151
 152                 /* process credentials and properties*/
 153                 struct kdbus_creds creds;
 154                 struct kdbus_audit audit;
 155                 struct kdbus_timestamp timestamp;
 156
 157                 /* specific fields */
 158                 struct kdbus_memfd memfd;
 159                 int fds[0];
 160                 struct kdbus_notify_name_change name_change;
 161                 struct kdbus_notify_id_change id_change;
 162         };
 163 };
 164
 165 enum {
 166         KDBUS_MSG_FLAGS_EXPECT_REPLY    = 1 << 0,
 167         KDBUS_MSG_FLAGS_NO_AUTO_START   = 1 << 1,
 168 };
 169
 170 enum {
 171         KDBUS_PAYLOAD_KERNEL,
 172         KDBUS_PAYLOAD_DBUS1     = 0x4442757356657231ULL, /* 'DBusVer1' */
 173         KDBUS_PAYLOAD_GVARIANT  = 0x4756617269616e74ULL, /* 'GVariant' */
 174 };
 175
 176 struct kdbus_msg {
 177         __u64 size;
 178         __u64 flags;
 179         __u64 dst_id;                   /* connection, 0 == name in data, ~0 broadcast */
 180         __u64 src_id;                   /* connection, 0 == kernel */
 181         __u64 payload_type;             /* 'DBusVer1', 'GVariant', ... */
 182         __u64 cookie;                   /* userspace-supplied cookie */
 183         union {
 184                 __u64 cookie_reply;     /* cookie we reply to */
 185                 __u64 timeout_ns;       /* timespan to wait for reply */
 186         };
 187         struct kdbus_item items[0];
 188 };
 189
 190 enum {
 191         _KDBUS_POLICY_NULL,
 192         KDBUS_POLICY_NAME,
 193         KDBUS_POLICY_ACCESS,
 194 };
 195
 196 enum {
 197         _KDBUS_POLICY_ACCESS_NULL,
 198         KDBUS_POLICY_ACCESS_USER,
 199         KDBUS_POLICY_ACCESS_GROUP,
 200         KDBUS_POLICY_ACCESS_WORLD,
 201 };
 202
 203 enum {
 204         KDBUS_POLICY_RECV               = 1 <<  2,
 205         KDBUS_POLICY_SEND               = 1 <<  1,
 206         KDBUS_POLICY_OWN                = 1 <<  0,
 207 };
 208
 209 struct kdbus_policy_access {
 210         __u64 type;                     /* USER, GROUP, WORLD */
 211         __u64 bits;                     /* RECV, SEND, OWN */
 212         __u64 id;                       /* uid, gid, 0 */
 213 };
 214
 215 struct kdbus_policy {
 216         KDBUS_PART_HEADER;
 217         union {
 218                 char name[0];
 219                 struct kdbus_policy_access access;
 220         };
 221 };
 222
 223 /* A series of KDBUS_POLICY_NAME, plus one or more KDBUS_POLICY_ACCESS */
 224 struct kdbus_cmd_policy {
 225         __u64 size;
 226         struct kdbus_policy policies[0];
 227 };
 228
 229 /* Flags for struct kdbus_cmd_hello */
 230 enum {
 231         KDBUS_HELLO_STARTER             =  1 <<  0,
 232         KDBUS_HELLO_ACCEPT_FD           =  1 <<  1,
 233 };
 234
 235 /* Flags for message attachments */
 236 enum {
 237         KDBUS_ATTACH_TIMESTAMP          =  1 <<  0,
 238         KDBUS_ATTACH_CREDS              =  1 <<  1,
 239         KDBUS_ATTACH_NAMES              =  1 <<  2,
 240         KDBUS_ATTACH_COMM               =  1 <<  3,
 241         KDBUS_ATTACH_EXE                =  1 <<  4,
 242         KDBUS_ATTACH_CMDLINE            =  1 <<  5,
 243         KDBUS_ATTACH_CGROUP             =  1 <<  6,
 244         KDBUS_ATTACH_CAPS               =  1 <<  7,
 245         KDBUS_ATTACH_SECLABEL           =  1 <<  8,
 246         KDBUS_ATTACH_AUDIT              =  1 <<  9,
 247 };
 248
 249 /* KDBUS_CMD_HELLO */
 250 struct kdbus_cmd_hello {
 251         __u64 size;
 252
 253         /* userspace → kernel, kernel → userspace */
 254         __u64 conn_flags;       /* userspace specifies its
 255                                  * capabilities and more, kernel
 256                                  * returns its capabilites and
 257                                  * more. Kernel might refuse client's
 258                                  * capabilities by returning an error
 259                                  * from KDBUS_HELLO */
 260         __u64 attach_flags;     /* userspace specifies the metadata
 261                                  * attachments it wishes to receive with
 262                                  * every message. */
 263
 264         /* kernel → userspace */
 265         __u64 bus_flags;        /* this is .flags copied verbatim from
 266                                  * from original KDBUS_CMD_BUS_MAKE
 267                                  * ioctl. It's intended to be useful
 268                                  * to do negotiation of features of
 269                                  * the payload that is transfreted. */
 270         __u64 id;               /* id assigned to this connection */
 271         __u64 bloom_size;       /* The bloom filter size chosen by the
 272                                  * bus owner */
 273         __u64 pool_size;        /* maximum size of pool buffer */
 274         __u8 id128[16];         /* the unique id of the bus */
 275
 276         struct kdbus_item items[0];
 277 };
 278
 279 /* Flags for kdbus_cmd_{bus,ep,ns}_make */
 280 enum {
 281         KDBUS_MAKE_ACCESS_GROUP         = 1 <<  0,
 282         KDBUS_MAKE_ACCESS_WORLD         = 1 <<  1,
 283         KDBUS_MAKE_POLICY_OPEN          = 1 <<  2,
 284 };
 285
 286 /* Items to append to kdbus_cmd_{bus,ep,ns}_make */
 287 enum {
 288         _KDBUS_MAKE_NULL,
 289         KDBUS_MAKE_NAME,
 290         KDBUS_MAKE_CRED,        /* allow translator services which connect
 291                                  * to the bus on behalf of somebody else,
 292                                  * allow specifying the credentials of the
 293                                  * client to connect on behalf on. Needs
 294                                  * privileges */
 295 };
 296
 297 struct kdbus_cmd_bus_make {
 298         __u64 size;
 299         __u64 flags;            /* userspace → kernel, kernel → userspace
 300                                  * When creating a bus feature
 301                                  * kernel negotiation. */
 302         __u64 bus_flags;        /* userspace → kernel
 303                                  * When a bus is created this value is
 304                                  * copied verbatim into the bus
 305                                  * structure and returned from
 306                                  * KDBUS_CMD_HELLO, later */
 307         __u64 bloom_size;       /* size of the bloom filter for this bus */
 308         struct kdbus_item items[0];
 309 };
 310
 311 struct kdbus_cmd_ep_make {
 312         __u64 size;
 313         __u64 flags;            /* userspace → kernel, kernel → userspace
 314                                  * When creating an entry point
 315                                  * feature kernel negotiation done the
 316                                  * same way as for
 317                                  * KDBUS_CMD_BUS_MAKE. Unused for
 318                                  * now. */
 319         struct kdbus_item items[0];
 320 };
 321
 322 struct kdbus_cmd_ns_make {
 323         __u64 size;
 324         __u64 flags;            /* userspace → kernel, kernel → userspace
 325                                  * When creating an entry point
 326                                  * feature kernel negotiation done the
 327                                  * same way as for
 328                                  * KDBUS_CMD_BUS_MAKE. Unused for
 329                                  * now. */
 330         struct kdbus_item items[0];
 331 };
 332
 333 enum {
 334         /* userspace → kernel */
 335         KDBUS_NAME_REPLACE_EXISTING             = 1 <<  0,
 336         KDBUS_NAME_QUEUE                        = 1 <<  1,
 337         KDBUS_NAME_ALLOW_REPLACEMENT            = 1 <<  2,
 338
 339         /* kernel → userspace */
 340         KDBUS_NAME_IN_QUEUE                     = 1 << 16,
 341 };
 342
 343 /* KDBUS_CMD_NAME_ACQUIRE */
 344 struct kdbus_cmd_name {
 345         __u64 size;
 346         __u64 flags;
 347         __u64 id;               /* we allow (de)registration of names of other peers */
 348         __u64 conn_flags;
 349         char name[0];
 350 };
 351
 352 /* KDBUS_CMD_NAME_LIST */
 353 enum {
 354         KDBUS_NAME_LIST_UNIQUE_NAMES            = 1 <<  0,
 355 };
 356
 357 struct kdbus_cmd_name_list {
 358         __u64 flags;
 359         __u64 offset;           /* returned offset in the caller's buffer */
 360 };
 361
 362 struct kdbus_name_list {
 363         __u64 size;
 364         struct kdbus_cmd_name names[0];
 365 };
 366
 367 /* KDBUS_CMD_NAME_INFO */
 368 struct kdbus_cmd_name_info {
 369         __u64 size;
 370         __u64 flags;                    /* query flags */
 371         __u64 attach_flags;             /* which meta data payload to attach */
 372         __u64 id;                       /* either ID, or 0 and name follows */
 373         __u64 offset;                   /* returned offset in the caller's buffer */
 374         char name[0];
 375 };
 376
 377 struct kdbus_name_info {
 378         __u64 size;
 379         __u64 id;
 380         __u64 flags;                    /* connection flags */
 381         struct kdbus_item items[0];     /* list of item records */
 382 };
 383
 384 /* KDBUS_CMD_MATCH_ADD/REMOVE */
 385 enum {
 386         _KDBUS_MATCH_NULL,
 387         KDBUS_MATCH_BLOOM,              /* Matches a mask blob against KDBUS_MSG_BLOOM */
 388         KDBUS_MATCH_SRC_NAME,           /* Matches a name string against KDBUS_MSG_SRC_NAMES */
 389         KDBUS_MATCH_NAME_ADD,           /* Matches a name string against KDBUS_MSG_NAME_ADD */
 390         KDBUS_MATCH_NAME_REMOVE,        /* Matches a name string against KDBUS_MSG_NAME_REMOVE */
 391         KDBUS_MATCH_NAME_CHANGE,        /* Matches a name string against KDBUS_MSG_NAME_CHANGE */
 392         KDBUS_MATCH_ID_ADD,             /* Matches an ID against KDBUS_MSG_ID_ADD */
 393         KDBUS_MATCH_ID_REMOVE,          /* Matches an ID against KDBUS_MSG_ID_REMOVE */
 394 };
 395
 396 struct kdbus_cmd_match {
 397         __u64 size;
 398         __u64 id;       /* We allow registration/deregestration of matches for other peers */
 399         __u64 cookie;   /* userspace supplied cookie; when removing; kernel deletes everything with same cookie */
 400         __u64 src_id;   /* ~0: any. other: exact unique match */
 401         struct kdbus_item items[0];
 402 };
 403
 404 /* KDBUS_CMD_MONITOR */
 405 enum {
 406         KDBUS_MONITOR_ENABLE            = 1 <<  0,
 407 };
 408
 409 struct kdbus_cmd_monitor {
 410         __u64 id;               /* We allow setting the monitor flag of other peers */
 411         __u64 flags;
 412 };
 413
 414 enum {
 415         /* kdbus control node commands: require unset state */
 416         KDBUS_CMD_BUS_MAKE =            _IOW(KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_bus_make),
 417         KDBUS_CMD_NS_MAKE =             _IOR(KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_ns_make),
 418
 419         /* kdbus ep node commands: require unset state */
 420         KDBUS_CMD_EP_MAKE =             _IOW(KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_ep_make),
 421         KDBUS_CMD_HELLO =               _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_hello),
 422
 423         /* kdbus ep node commands: require connected state */
 424         KDBUS_CMD_MSG_SEND =            _IOW(KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
 425         KDBUS_CMD_MSG_RECV =            _IOR(KDBUS_IOC_MAGIC, 0x41, __u64 *),
 426         KDBUS_CMD_FREE =                _IOW(KDBUS_IOC_MAGIC, 0x42, __u64 *),
 427
 428         KDBUS_CMD_NAME_ACQUIRE =        _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name),
 429         KDBUS_CMD_NAME_RELEASE =        _IOW(KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name),
 430         KDBUS_CMD_NAME_LIST =           _IOWR(KDBUS_IOC_MAGIC, 0x52, struct kdbus_cmd_name_list),
 431         KDBUS_CMD_NAME_INFO =           _IOWR(KDBUS_IOC_MAGIC, 0x53, struct kdbus_cmd_name_info),
 432
 433         KDBUS_CMD_MATCH_ADD =           _IOW(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_match),
 434         KDBUS_CMD_MATCH_REMOVE =        _IOW(KDBUS_IOC_MAGIC, 0x61, struct kdbus_cmd_match),
 435         KDBUS_CMD_MONITOR =             _IOW(KDBUS_IOC_MAGIC, 0x62, struct kdbus_cmd_monitor),
 436
 437         /* kdbus ep node commands: require ep owner state */
 438         KDBUS_CMD_EP_POLICY_SET =       _IOW(KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_policy),
 439
 440         /* kdbus memfd commands: */
 441         KDBUS_CMD_MEMFD_NEW =           _IOR(KDBUS_IOC_MAGIC, 0x80, int *),
 442         KDBUS_CMD_MEMFD_SIZE_GET =      _IOR(KDBUS_IOC_MAGIC, 0x81, __u64 *),
 443         KDBUS_CMD_MEMFD_SIZE_SET =      _IOW(KDBUS_IOC_MAGIC, 0x82, __u64 *),
 444         KDBUS_CMD_MEMFD_SEAL_GET =      _IOR(KDBUS_IOC_MAGIC, 0x83, int *),
 445         KDBUS_CMD_MEMFD_SEAL_SET =      _IO(KDBUS_IOC_MAGIC, 0x84),
 446 };
 447 #endif