chiark / gitweb /
sd-bus: sync kdbus.h
[elogind.git] / src / libsystemd / sd-bus / kdbus.h
1 /*
2  * kdbus is free software; you can redistribute it and/or modify it under
3  * the terms of the GNU Lesser General Public License as published by the
4  * Free Software Foundation; either version 2.1 of the License, or (at
5  * your option) any later version.
6  */
7
8 #ifndef _KDBUS_UAPI_H_
9 #define _KDBUS_UAPI_H_
10
11 #include <linux/ioctl.h>
12 #include <linux/types.h>
13
14 #define KDBUS_IOCTL_MAGIC               0x95
15 #define KDBUS_SRC_ID_KERNEL             (0)
16 #define KDBUS_DST_ID_NAME               (0)
17 #define KDBUS_MATCH_ID_ANY              (~0ULL)
18 #define KDBUS_DST_ID_BROADCAST          (~0ULL)
19 #define KDBUS_FLAG_KERNEL               (1ULL << 63)
20
21 /**
22  * struct kdbus_notify_id_change - name registry change message
23  * @id:                 New or former owner of the name
24  * @flags:              flags field from KDBUS_HELLO_*
25  *
26  * Sent from kernel to userspace when the owner or activator of
27  * a well-known name changes.
28  *
29  * Attached to:
30  *   KDBUS_ITEM_ID_ADD
31  *   KDBUS_ITEM_ID_REMOVE
32  */
33 struct kdbus_notify_id_change {
34         __u64 id;
35         __u64 flags;
36 };
37
38 /**
39  * struct kdbus_notify_name_change - name registry change message
40  * @old_id:             ID and flags of former owner of a name
41  * @new_id:             ID and flags of new owner of a name
42  * @name:               Well-known name
43  *
44  * Sent from kernel to userspace when the owner or activator of
45  * a well-known name changes.
46  *
47  * Attached to:
48  *   KDBUS_ITEM_NAME_ADD
49  *   KDBUS_ITEM_NAME_REMOVE
50  *   KDBUS_ITEM_NAME_CHANGE
51  */
52 struct kdbus_notify_name_change {
53         struct kdbus_notify_id_change old_id;
54         struct kdbus_notify_id_change new_id;
55         char name[0];
56 };
57
58 /**
59  * struct kdbus_creds - process credentials
60  * @uid:                User ID
61  * @euid:               Effective UID
62  * @suid:               Saved UID
63  * @fsuid:              Filesystem UID
64  * @gid:                Group ID
65  * @egid:               Effective GID
66  * @sgid:               Saved GID
67  * @fsgid:              Filesystem GID
68  *
69  * Attached to:
70  *   KDBUS_ITEM_CREDS
71  */
72 struct kdbus_creds {
73         __u32 uid;
74         __u32 euid;
75         __u32 suid;
76         __u32 fsuid;
77         __u32 gid;
78         __u32 egid;
79         __u32 sgid;
80         __u32 fsgid;
81 };
82
83 /**
84  * struct kdbus_pids - process identifiers
85  * @pid:                Process ID
86  * @tid:                Thread ID
87  * @ppid:               Parent process ID
88  *
89  * The PID and TID of a process.
90  *
91  * Attached to:
92  *   KDBUS_ITEM_PIDS
93  */
94 struct kdbus_pids {
95         __u64 pid;
96         __u64 tid;
97         __u64 ppid;
98 };
99
100 /**
101  * struct kdbus_caps - process capabilities
102  * @last_cap:   Highest currently known capability bit
103  * @caps:       Variable number of 32-bit capabilities flags
104  *
105  * Contains a variable number of 32-bit capabilities flags.
106  *
107  * Attached to:
108  *   KDBUS_ITEM_CAPS
109  */
110 struct kdbus_caps {
111         __u32 last_cap;
112         __u32 caps[0];
113 };
114
115 /**
116  * struct kdbus_audit - audit information
117  * @sessionid:          The audit session ID
118  * @loginuid:           The audit login uid
119  *
120  * Attached to:
121  *   KDBUS_ITEM_AUDIT
122  */
123 struct kdbus_audit {
124         __u32 sessionid;
125         __u32 loginuid;
126 };
127
128 /**
129  * struct kdbus_timestamp
130  * @seqnum:             Global per-domain message sequence number
131  * @monotonic_ns:       Monotonic timestamp, in nanoseconds
132  * @realtime_ns:        Realtime timestamp, in nanoseconds
133  *
134  * Attached to:
135  *   KDBUS_ITEM_TIMESTAMP
136  */
137 struct kdbus_timestamp {
138         __u64 seqnum;
139         __u64 monotonic_ns;
140         __u64 realtime_ns;
141 };
142
143 /**
144  * struct kdbus_vec - I/O vector for kdbus payload items
145  * @size:               The size of the vector
146  * @address:            Memory address of data buffer
147  * @offset:             Offset in the in-message payload memory,
148  *                      relative to the message head
149  *
150  * Attached to:
151  *   KDBUS_ITEM_PAYLOAD_VEC, KDBUS_ITEM_PAYLOAD_OFF
152  */
153 struct kdbus_vec {
154         __u64 size;
155         union {
156                 __u64 address;
157                 __u64 offset;
158         };
159 };
160
161 /**
162  * struct kdbus_bloom_parameter - bus-wide bloom parameters
163  * @size:               Size of the bit field in bytes (m / 8)
164  * @n_hash:             Number of hash functions used (k)
165  */
166 struct kdbus_bloom_parameter {
167         __u64 size;
168         __u64 n_hash;
169 };
170
171 /**
172  * struct kdbus_bloom_filter - bloom filter containing n elements
173  * @generation:         Generation of the element set in the filter
174  * @data:               Bit field, multiple of 8 bytes
175  */
176 struct kdbus_bloom_filter {
177         __u64 generation;
178         __u64 data[0];
179 };
180
181 /**
182  * struct kdbus_memfd - a kdbus memfd
183  * @start:              The offset into the memfd where the segment starts
184  * @size:               The size of the memfd segment
185  * @fd:                 The file descriptor number
186  * @__pad:              Padding to ensure proper alignment and size
187  *
188  * Attached to:
189  *   KDBUS_ITEM_PAYLOAD_MEMFD
190  */
191 struct kdbus_memfd {
192         __u64 start;
193         __u64 size;
194         int fd;
195         __u32 __pad;
196 };
197
198 /**
199  * struct kdbus_name - a registered well-known name with its flags
200  * @flags:              Flags from KDBUS_NAME_*
201  * @name:               Well-known name
202  *
203  * Attached to:
204  *   KDBUS_ITEM_OWNED_NAME
205  */
206 struct kdbus_name {
207         __u64 flags;
208         char name[0];
209 };
210
211 /**
212  * struct kdbus_policy_access - policy access item
213  * @type:               One of KDBUS_POLICY_ACCESS_* types
214  * @access:             Access to grant
215  * @id:                 For KDBUS_POLICY_ACCESS_USER, the uid
216  *                      For KDBUS_POLICY_ACCESS_GROUP, the gid
217  */
218 struct kdbus_policy_access {
219         __u64 type;     /* USER, GROUP, WORLD */
220         __u64 access;   /* OWN, TALK, SEE */
221         __u64 id;       /* uid, gid, 0 */
222 };
223
224 /**
225  * enum kdbus_item_type - item types to chain data in a list
226  * @_KDBUS_ITEM_NULL:                   Uninitialized/invalid
227  * @_KDBUS_ITEM_USER_BASE:              Start of user items
228  * @KDBUS_ITEM_PAYLOAD_VEC:             Vector to data
229  * @KDBUS_ITEM_PAYLOAD_OFF:             Data at returned offset to message head
230  * @KDBUS_ITEM_PAYLOAD_MEMFD:           Data as sealed memfd
231  * @KDBUS_ITEM_FDS:                     Attached file descriptors
232  * @KDBUS_ITEM_CANCEL_FD:               FD used to cancel a synchronous
233  *                                      operation by writing to it from
234  *                                      userspace
235  * @KDBUS_ITEM_BLOOM_PARAMETER:         Bus-wide bloom parameters, used with
236  *                                      KDBUS_CMD_BUS_MAKE, carries a
237  *                                      struct kdbus_bloom_parameter
238  * @KDBUS_ITEM_BLOOM_FILTER:            Bloom filter carried with a message,
239  *                                      used to match against a bloom mask of a
240  *                                      connection, carries a struct
241  *                                      kdbus_bloom_filter
242  * @KDBUS_ITEM_BLOOM_MASK:              Bloom mask used to match against a
243  *                                      message'sbloom filter
244  * @KDBUS_ITEM_DST_NAME:                Destination's well-known name
245  * @KDBUS_ITEM_MAKE_NAME:               Name of domain, bus, endpoint
246  * @KDBUS_ITEM_ATTACH_FLAGS_SEND:       Attach-flags, used for updating which
247  *                                      metadata a connection opts in to send
248  * @KDBUS_ITEM_ATTACH_FLAGS_RECV:       Attach-flags, used for updating which
249  *                                      metadata a connection requests to
250  *                                      receive for each reeceived message
251  * @KDBUS_ITEM_ID:                      Connection ID
252  * @KDBUS_ITEM_NAME:                    Well-know name with flags
253  * @_KDBUS_ITEM_ATTACH_BASE:            Start of metadata attach items
254  * @KDBUS_ITEM_TIMESTAMP:               Timestamp
255  * @KDBUS_ITEM_CREDS:                   Process credentials
256  * @KDBUS_ITEM_PIDS:                    Process identifiers
257  * @KDBUS_ITEM_AUXGROUPS:               Auxiliary process groups
258  * @KDBUS_ITEM_OWNED_NAME:              A name owned by the associated
259  *                                      connection
260  * @KDBUS_ITEM_TID_COMM:                Thread ID "comm" identifier
261  *                                      (Don't trust this, see below.)
262  * @KDBUS_ITEM_PID_COMM:                Process ID "comm" identifier
263  *                                      (Don't trust this, see below.)
264  * @KDBUS_ITEM_EXE:                     The path of the executable
265  *                                      (Don't trust this, see below.)
266  * @KDBUS_ITEM_CMDLINE:                 The process command line
267  *                                      (Don't trust this, see below.)
268  * @KDBUS_ITEM_CGROUP:                  The croup membership
269  * @KDBUS_ITEM_CAPS:                    The process capabilities
270  * @KDBUS_ITEM_SECLABEL:                The security label
271  * @KDBUS_ITEM_AUDIT:                   The audit IDs
272  * @KDBUS_ITEM_CONN_DESCRIPTION:        The connection's human-readable name
273  *                                      (debugging)
274  * @_KDBUS_ITEM_POLICY_BASE:            Start of policy items
275  * @KDBUS_ITEM_POLICY_ACCESS:           Policy access block
276  * @_KDBUS_ITEM_KERNEL_BASE:            Start of kernel-generated message items
277  * @KDBUS_ITEM_NAME_ADD:                Notification in kdbus_notify_name_change
278  * @KDBUS_ITEM_NAME_REMOVE:             Notification in kdbus_notify_name_change
279  * @KDBUS_ITEM_NAME_CHANGE:             Notification in kdbus_notify_name_change
280  * @KDBUS_ITEM_ID_ADD:                  Notification in kdbus_notify_id_change
281  * @KDBUS_ITEM_ID_REMOVE:               Notification in kdbus_notify_id_change
282  * @KDBUS_ITEM_REPLY_TIMEOUT:           Timeout has been reached
283  * @KDBUS_ITEM_REPLY_DEAD:              Destination died
284  *
285  * N.B: The process and thread COMM fields, as well as the CMDLINE and
286  * EXE fields may be altered by unprivileged processes und should
287  * hence *not* used for security decisions. Peers should make use of
288  * these items only for informational purposes, such as generating log
289  * records.
290  */
291 enum kdbus_item_type {
292         _KDBUS_ITEM_NULL,
293         _KDBUS_ITEM_USER_BASE,
294         KDBUS_ITEM_PAYLOAD_VEC  = _KDBUS_ITEM_USER_BASE,
295         KDBUS_ITEM_PAYLOAD_OFF,
296         KDBUS_ITEM_PAYLOAD_MEMFD,
297         KDBUS_ITEM_FDS,
298         KDBUS_ITEM_CANCEL_FD,
299         KDBUS_ITEM_BLOOM_PARAMETER,
300         KDBUS_ITEM_BLOOM_FILTER,
301         KDBUS_ITEM_BLOOM_MASK,
302         KDBUS_ITEM_DST_NAME,
303         KDBUS_ITEM_MAKE_NAME,
304         KDBUS_ITEM_ATTACH_FLAGS_SEND,
305         KDBUS_ITEM_ATTACH_FLAGS_RECV,
306         KDBUS_ITEM_ID,
307         KDBUS_ITEM_NAME,
308         KDBUS_ITEM_SIGMASK,
309
310         /* keep these item types in sync with KDBUS_ATTACH_* flags */
311         _KDBUS_ITEM_ATTACH_BASE = 0x1000,
312         KDBUS_ITEM_TIMESTAMP    = _KDBUS_ITEM_ATTACH_BASE,
313         KDBUS_ITEM_CREDS,
314         KDBUS_ITEM_PIDS,
315         KDBUS_ITEM_AUXGROUPS,
316         KDBUS_ITEM_OWNED_NAME,
317         KDBUS_ITEM_TID_COMM,
318         KDBUS_ITEM_PID_COMM,
319         KDBUS_ITEM_EXE,
320         KDBUS_ITEM_CMDLINE,
321         KDBUS_ITEM_CGROUP,
322         KDBUS_ITEM_CAPS,
323         KDBUS_ITEM_SECLABEL,
324         KDBUS_ITEM_AUDIT,
325         KDBUS_ITEM_CONN_DESCRIPTION,
326
327         _KDBUS_ITEM_POLICY_BASE = 0x2000,
328         KDBUS_ITEM_POLICY_ACCESS = _KDBUS_ITEM_POLICY_BASE,
329
330         _KDBUS_ITEM_KERNEL_BASE = 0x8000,
331         KDBUS_ITEM_NAME_ADD     = _KDBUS_ITEM_KERNEL_BASE,
332         KDBUS_ITEM_NAME_REMOVE,
333         KDBUS_ITEM_NAME_CHANGE,
334         KDBUS_ITEM_ID_ADD,
335         KDBUS_ITEM_ID_REMOVE,
336         KDBUS_ITEM_REPLY_TIMEOUT,
337         KDBUS_ITEM_REPLY_DEAD,
338 };
339
340 /**
341  * struct kdbus_item - chain of data blocks
342  * @size:               Overall data record size
343  * @type:               Kdbus_item type of data
344  * @data:               Generic bytes
345  * @data32:             Generic 32 bit array
346  * @data64:             Generic 64 bit array
347  * @str:                Generic string
348  * @id:                 Connection ID
349  * @vec:                KDBUS_ITEM_PAYLOAD_VEC
350  * @creds:              KDBUS_ITEM_CREDS
351  * @audit:              KDBUS_ITEM_AUDIT
352  * @timestamp:          KDBUS_ITEM_TIMESTAMP
353  * @name:               KDBUS_ITEM_NAME
354  * @bloom_parameter:    KDBUS_ITEM_BLOOM_PARAMETER
355  * @bloom_filter:       KDBUS_ITEM_BLOOM_FILTER
356  * @memfd:              KDBUS_ITEM_PAYLOAD_MEMFD
357  * @name_change:        KDBUS_ITEM_NAME_ADD
358  *                      KDBUS_ITEM_NAME_REMOVE
359  *                      KDBUS_ITEM_NAME_CHANGE
360  * @id_change:          KDBUS_ITEM_ID_ADD
361  *                      KDBUS_ITEM_ID_REMOVE
362  * @policy:             KDBUS_ITEM_POLICY_ACCESS
363  */
364 struct kdbus_item {
365         __u64 size;
366         __u64 type;
367         union {
368                 __u8 data[0];
369                 __u32 data32[0];
370                 __u64 data64[0];
371                 char str[0];
372
373                 __u64 id;
374                 struct kdbus_vec vec;
375                 struct kdbus_creds creds;
376                 struct kdbus_pids pids;
377                 struct kdbus_audit audit;
378                 struct kdbus_caps caps;
379                 struct kdbus_timestamp timestamp;
380                 struct kdbus_name name;
381                 struct kdbus_bloom_parameter bloom_parameter;
382                 struct kdbus_bloom_filter bloom_filter;
383                 struct kdbus_memfd memfd;
384                 int fds[0];
385                 struct kdbus_notify_name_change name_change;
386                 struct kdbus_notify_id_change id_change;
387                 struct kdbus_policy_access policy_access;
388                 __u64 sigmask;
389         };
390 };
391
392 /**
393  * struct kdbus_item_list - A list of items
394  * @size:               The total size of the structure
395  * @items:              Array of items
396  */
397 struct kdbus_item_list {
398         __u64 size;
399         struct kdbus_item items[0];
400 };
401
402 /**
403  * enum kdbus_msg_flags - type of message
404  * @KDBUS_MSG_EXPECT_REPLY:     Expect a reply message, used for
405  *                              method calls. The userspace-supplied
406  *                              cookie identifies the message and the
407  *                              respective reply carries the cookie
408  *                              in cookie_reply
409  * @KDBUS_MSG_NO_AUTO_START:    Do not start a service, if the addressed
410  *                              name is not currently active
411  * @KDBUS_MSG_SIGNAL:           Treat this message as signal
412  */
413 enum kdbus_msg_flags {
414         KDBUS_MSG_EXPECT_REPLY  = 1ULL << 0,
415         KDBUS_MSG_NO_AUTO_START = 1ULL << 1,
416         KDBUS_MSG_SIGNAL        = 1ULL << 2,
417 };
418
419 /**
420  * enum kdbus_payload_type - type of payload carried by message
421  * @KDBUS_PAYLOAD_KERNEL:       Kernel-generated simple message
422  * @KDBUS_PAYLOAD_DBUS:         D-Bus marshalling "DBusDBus"
423  *
424  * Any payload-type is accepted. Common types will get added here once
425  * established.
426  */
427 enum kdbus_payload_type {
428         KDBUS_PAYLOAD_KERNEL,
429         KDBUS_PAYLOAD_DBUS      = 0x4442757344427573ULL,
430 };
431
432 /**
433  * struct kdbus_msg - the representation of a kdbus message
434  * @size:               Total size of the message
435  * @flags:              Message flags (KDBUS_MSG_*), userspace → kernel
436  * @priority:           Message queue priority value
437  * @dst_id:             64-bit ID of the destination connection
438  * @src_id:             64-bit ID of the source connection
439  * @payload_type:       Payload type (KDBUS_PAYLOAD_*)
440  * @cookie:             Userspace-supplied cookie, for the connection
441  *                      to identify its messages
442  * @timeout_ns:         The time to wait for a message reply from the peer.
443  *                      If there is no reply, a kernel-generated message
444  *                      with an attached KDBUS_ITEM_REPLY_TIMEOUT item
445  *                      is sent to @src_id. The timeout is expected in
446  *                      nanoseconds and as absolute CLOCK_MONOTONIC value.
447  * @cookie_reply:       A reply to the requesting message with the same
448  *                      cookie. The requesting connection can match its
449  *                      request and the reply with this value
450  * @items:              A list of kdbus_items containing the message payload
451  */
452 struct kdbus_msg {
453         __u64 size;
454         __u64 flags;
455         __s64 priority;
456         __u64 dst_id;
457         __u64 src_id;
458         __u64 payload_type;
459         __u64 cookie;
460         union {
461                 __u64 timeout_ns;
462                 __u64 cookie_reply;
463         };
464         struct kdbus_item items[0];
465 } __attribute__((aligned(8)));
466
467 /**
468  * struct kdbus_reply - reply container
469  * @offset:             Offset of kdbus_msg slice in pool
470  * @msg_size:           Copy of the kdbus_msg.size field
471  * @return_flags:       Command return flags, kernel → userspace
472  */
473 struct kdbus_reply {
474         __u64 offset;
475         __u64 msg_size;
476         __u64 return_flags;
477 };
478
479 /**
480  * enum kdbus_send_flags - flags for sending messages
481  * @KDBUS_SEND_SYNC_REPLY:      Wait for destination connection to
482  *                              reply to this message. The
483  *                              KDBUS_CMD_SEND ioctl() will block
484  *                              until the reply is received, and
485  *                              offset_reply in struct kdbus_msg will
486  *                              yield the offset in the sender's pool
487  *                              where the reply can be found.
488  *                              This flag is only valid if
489  *                              @KDBUS_MSG_EXPECT_REPLY is set as well.
490  */
491 enum kdbus_send_flags {
492         KDBUS_SEND_SYNC_REPLY           = 1ULL << 0,
493 };
494
495 /**
496  * struct kdbus_cmd_send - send message
497  * @size:               Overall size of this structure
498  * @flags:              Flags to change send behavior (KDBUS_SEND_*)
499  * @kernel_flags:       Supported send flags, kernel → userspace
500  * @kernel_msg_flags:   Supported message flags, kernel → userspace
501  * @return_flags:       Command return flags, kernel → userspace
502  * @msg_address:        Storage address of the kdbus_msg to send
503  * @reply:              Storage for message reply if KDBUS_SEND_SYNC_REPLY
504  *                      was given
505  * @items:              Additional items for this command
506  */
507 struct kdbus_cmd_send {
508         __u64 size;
509         __u64 flags;
510         __u64 kernel_flags;
511         __u64 kernel_msg_flags;
512         __u64 return_flags;
513         __u64 msg_address;
514         struct kdbus_reply reply;
515         struct kdbus_item items[0];
516 } __attribute__((aligned(8)));
517
518 /**
519  * enum kdbus_recv_flags - flags for de-queuing messages
520  * @KDBUS_RECV_PEEK:            Return the next queued message without
521  *                              actually de-queuing it, and without installing
522  *                              any file descriptors or other resources. It is
523  *                              usually used to determine the activating
524  *                              connection of a bus name.
525  * @KDBUS_RECV_DROP:            Drop and free the next queued message and all
526  *                              its resources without actually receiving it.
527  * @KDBUS_RECV_USE_PRIORITY:    Only de-queue messages with the specified or
528  *                              higher priority (lowest values); if not set,
529  *                              the priority value is ignored.
530  */
531 enum kdbus_recv_flags {
532         KDBUS_RECV_PEEK         = 1ULL <<  0,
533         KDBUS_RECV_DROP         = 1ULL <<  1,
534         KDBUS_RECV_USE_PRIORITY = 1ULL <<  2,
535 };
536
537 /**
538  * enum kdbus_recv_return_flags - return flags for message receive commands
539  * @KDBUS_RECV_RETURN_INCOMPLETE_FDS:   One or more file descriptors could not
540  *                                      be installed. These descriptors in
541  *                                      KDBUS_ITEM_FDS will carry the value -1.
542  */
543 enum kdbus_recv_return_flags {
544         KDBUS_RECV_RETURN_INCOMPLETE_FDS        = 1ULL <<  0,
545 };
546
547 /**
548  * struct kdbus_cmd_recv - struct to de-queue a buffered message
549  * @size:               Overall size of this object
550  * @flags:              KDBUS_RECV_* flags, userspace → kernel
551  * @kernel_flags:       Supported KDBUS_RECV_* flags, kernel → userspace
552  * @return_flags:       Command return flags, kernel → userspace
553  * @priority:           Minimum priority of the messages to de-queue. Lowest
554  *                      values have the highest priority.
555  * @dropped_msgs:       In case the KDBUS_CMD_RECV ioctl returns
556  *                      -EOVERFLOW, this field will contain the number of
557  *                      broadcast messages that have been lost since the
558  *                      last call.
559  * @reply:              Return storage for received message.
560  * @items:              Additional items for this command.
561  *
562  * This struct is used with the KDBUS_CMD_RECV ioctl.
563  */
564 struct kdbus_cmd_recv {
565         __u64 size;
566         __u64 flags;
567         __u64 kernel_flags;
568         __u64 return_flags;
569         __s64 priority;
570         __u64 dropped_msgs;
571         struct kdbus_reply reply;
572         struct kdbus_item items[0];
573 } __attribute__((aligned(8)));
574
575 /**
576  * struct kdbus_cmd_free - struct to free a slice of memory in the pool
577  * @size:               Overall size of this structure
578  * @offset:             The offset of the memory slice, as returned by other
579  *                      ioctls
580  * @flags:              Flags for the free command, userspace → kernel
581  * @return_flags:       Command return flags, kernel → userspace
582  * @kernel_flags:       Supported flags of the free command, userspace → kernel
583  * @items:              Additional items to modify the behavior
584  *
585  * This struct is used with the KDBUS_CMD_FREE ioctl.
586  */
587 struct kdbus_cmd_free {
588         __u64 size;
589         __u64 offset;
590         __u64 flags;
591         __u64 kernel_flags;
592         __u64 return_flags;
593         struct kdbus_item items[0];
594 } __attribute__((aligned(8)));
595
596 /**
597  * enum kdbus_policy_access_type - permissions of a policy record
598  * @_KDBUS_POLICY_ACCESS_NULL:  Uninitialized/invalid
599  * @KDBUS_POLICY_ACCESS_USER:   Grant access to a uid
600  * @KDBUS_POLICY_ACCESS_GROUP:  Grant access to gid
601  * @KDBUS_POLICY_ACCESS_WORLD:  World-accessible
602  */
603 enum kdbus_policy_access_type {
604         _KDBUS_POLICY_ACCESS_NULL,
605         KDBUS_POLICY_ACCESS_USER,
606         KDBUS_POLICY_ACCESS_GROUP,
607         KDBUS_POLICY_ACCESS_WORLD,
608 };
609
610 /**
611  * enum kdbus_policy_access_flags - mode flags
612  * @KDBUS_POLICY_OWN:           Allow to own a well-known name
613  *                              Implies KDBUS_POLICY_TALK and KDBUS_POLICY_SEE
614  * @KDBUS_POLICY_TALK:          Allow communication to a well-known name
615  *                              Implies KDBUS_POLICY_SEE
616  * @KDBUS_POLICY_SEE:           Allow to see a well-known name
617  */
618 enum kdbus_policy_type {
619         KDBUS_POLICY_SEE        = 0,
620         KDBUS_POLICY_TALK,
621         KDBUS_POLICY_OWN,
622 };
623
624 /**
625  * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
626  * @KDBUS_HELLO_ACCEPT_FD:      The connection allows the reception of
627  *                              any passed file descriptors
628  * @KDBUS_HELLO_ACTIVATOR:      Special-purpose connection which registers
629  *                              a well-know name for a process to be started
630  *                              when traffic arrives
631  * @KDBUS_HELLO_POLICY_HOLDER:  Special-purpose connection which registers
632  *                              policy entries for a name. The provided name
633  *                              is not activated and not registered with the
634  *                              name database, it only allows unprivileged
635  *                              connections to acquire a name, talk or discover
636  *                              a service
637  * @KDBUS_HELLO_MONITOR:        Special-purpose connection to monitor
638  *                              bus traffic
639  * @KDBUS_HELLO_UNPRIVILEGED:   Don't treat this connection as privileged once
640  *                              the bus connection was established.
641  */
642 enum kdbus_hello_flags {
643         KDBUS_HELLO_ACCEPT_FD           =  1ULL <<  0,
644         KDBUS_HELLO_ACTIVATOR           =  1ULL <<  1,
645         KDBUS_HELLO_POLICY_HOLDER       =  1ULL <<  2,
646         KDBUS_HELLO_MONITOR             =  1ULL <<  3,
647         KDBUS_HELLO_UNPRIVILEGED        =  1ULL <<  4,
648 };
649
650 /**
651  * enum kdbus_attach_flags - flags for metadata attachments
652  * @KDBUS_ATTACH_TIMESTAMP:             Timestamp
653  * @KDBUS_ATTACH_CREDS:                 Credentials
654  * @KDBUS_ATTACH_PIDS:                  PIDs
655  * @KDBUS_ATTACH_AUXGROUPS:             Auxiliary groups
656  * @KDBUS_ATTACH_NAMES:                 Well-known names
657  * @KDBUS_ATTACH_TID_COMM:              The "comm" process identifier of the TID
658  * @KDBUS_ATTACH_PID_COMM:              The "comm" process identifier of the PID
659  * @KDBUS_ATTACH_EXE:                   The path of the executable
660  * @KDBUS_ATTACH_CMDLINE:               The process command line
661  * @KDBUS_ATTACH_CGROUP:                The croup membership
662  * @KDBUS_ATTACH_CAPS:                  The process capabilities
663  * @KDBUS_ATTACH_SECLABEL:              The security label
664  * @KDBUS_ATTACH_AUDIT:                 The audit IDs
665  * @KDBUS_ATTACH_CONN_DESCRIPTION:      The human-readable connection name
666  * @_KDBUS_ATTACH_ALL:                  All of the above
667  * @_KDBUS_ATTACH_ANY:                  Wildcard match to enable any kind of
668  *                                      metatdata.
669  */
670 enum kdbus_attach_flags {
671         KDBUS_ATTACH_TIMESTAMP          =  1ULL <<  0,
672         KDBUS_ATTACH_CREDS              =  1ULL <<  1,
673         KDBUS_ATTACH_PIDS               =  1ULL <<  2,
674         KDBUS_ATTACH_AUXGROUPS          =  1ULL <<  3,
675         KDBUS_ATTACH_NAMES              =  1ULL <<  4,
676         KDBUS_ATTACH_TID_COMM           =  1ULL <<  5,
677         KDBUS_ATTACH_PID_COMM           =  1ULL <<  6,
678         KDBUS_ATTACH_EXE                =  1ULL <<  7,
679         KDBUS_ATTACH_CMDLINE            =  1ULL <<  8,
680         KDBUS_ATTACH_CGROUP             =  1ULL <<  9,
681         KDBUS_ATTACH_CAPS               =  1ULL << 10,
682         KDBUS_ATTACH_SECLABEL           =  1ULL << 11,
683         KDBUS_ATTACH_AUDIT              =  1ULL << 12,
684         KDBUS_ATTACH_CONN_DESCRIPTION   =  1ULL << 13,
685         _KDBUS_ATTACH_ALL               =  (1ULL << 14) - 1,
686         _KDBUS_ATTACH_ANY               =  ~0ULL
687 };
688
689 /**
690  * struct kdbus_cmd_hello - struct to say hello to kdbus
691  * @size:               The total size of the structure
692  * @flags:              Connection flags (KDBUS_HELLO_*), userspace → kernel
693  * @kernel_flags:       Supported connection flags, kernel → userspace
694  * @return_flags:       Command return flags, kernel → userspace
695  * @attach_flags_send:  Mask of metadata to attach to each message sent
696  *                      off by this connection (KDBUS_ATTACH_*)
697  * @attach_flags_recv:  Mask of metadata to attach to each message receieved
698  *                      by the new connection (KDBUS_ATTACH_*)
699  * @bus_flags:          The flags field copied verbatim from the original
700  *                      KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
701  *                      to do negotiation of features of the payload that is
702  *                      transferred (kernel → userspace)
703  * @id:                 The ID of this connection (kernel → userspace)
704  * @pool_size:          Size of the connection's buffer where the received
705  *                      messages are placed
706  * @offset:             Pool offset where additional items of type
707  *                      kdbus_item_list are stored. They contain information
708  *                      about the bus and the newly created connection.
709  * @items_size:         Copy of item_list.size stored in @offset.
710  * @id128:              Unique 128-bit ID of the bus (kernel → userspace)
711  * @items:              A list of items
712  *
713  * This struct is used with the KDBUS_CMD_HELLO ioctl.
714  */
715 struct kdbus_cmd_hello {
716         __u64 size;
717         __u64 flags;
718         __u64 kernel_flags;
719         __u64 return_flags;
720         __u64 attach_flags_send;
721         __u64 attach_flags_recv;
722         __u64 bus_flags;
723         __u64 id;
724         __u64 pool_size;
725         __u64 offset;
726         __u64 items_size;
727         __u8 id128[16];
728         struct kdbus_item items[0];
729 } __attribute__((aligned(8)));
730
731 /**
732  * enum kdbus_make_flags - Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE
733  * @KDBUS_MAKE_ACCESS_GROUP:    Make the bus or endpoint node group-accessible
734  * @KDBUS_MAKE_ACCESS_WORLD:    Make the bus or endpoint node world-accessible
735  */
736 enum kdbus_make_flags {
737         KDBUS_MAKE_ACCESS_GROUP         = 1ULL <<  0,
738         KDBUS_MAKE_ACCESS_WORLD         = 1ULL <<  1,
739 };
740
741 /**
742  * struct kdbus_cmd_make - struct to make a bus, an endpoint or a domain
743  * @size:               The total size of the struct
744  * @flags:              Properties for the bus/ep/domain to create,
745  *                      userspace → kernel
746  * @kernel_flags:       Supported flags for the used command, kernel → userspace
747  * @return_flags:       Command return flags, kernel → userspace
748  * @items:              Items describing details
749  *
750  * This structure is used with the KDBUS_CMD_BUS_MAKE and
751  * KDBUS_CMD_ENDPOINT_MAKE ioctls.
752  */
753 struct kdbus_cmd_make {
754         __u64 size;
755         __u64 flags;
756         __u64 kernel_flags;
757         __u64 return_flags;
758         struct kdbus_item items[0];
759 } __attribute__((aligned(8)));
760
761 /**
762  * enum kdbus_name_flags - properties of a well-known name
763  * @KDBUS_NAME_REPLACE_EXISTING:        Try to replace name of other connections
764  * @KDBUS_NAME_ALLOW_REPLACEMENT:       Allow the replacement of the name
765  * @KDBUS_NAME_QUEUE:                   Name should be queued if busy
766  * @KDBUS_NAME_IN_QUEUE:                Name is queued
767  * @KDBUS_NAME_ACTIVATOR:               Name is owned by a activator connection
768  */
769 enum kdbus_name_flags {
770         KDBUS_NAME_REPLACE_EXISTING     = 1ULL <<  0,
771         KDBUS_NAME_ALLOW_REPLACEMENT    = 1ULL <<  1,
772         KDBUS_NAME_QUEUE                = 1ULL <<  2,
773         KDBUS_NAME_IN_QUEUE             = 1ULL <<  3,
774         KDBUS_NAME_ACTIVATOR            = 1ULL <<  4,
775 };
776
777 /**
778  * struct kdbus_cmd_name - struct to describe a well-known name
779  * @size:               The total size of the struct
780  * @flags:              Flags for a name entry (KDBUS_NAME_*),
781  *                      userspace → kernel, kernel → userspace
782  * @kernel_flags:       Supported flags for a name entry, kernel → userspace
783  * @return_flags:       Command return flags, kernel → userspace
784  * @items:              Item list, containing the well-known name as
785  *                      KDBUS_ITEM_NAME
786  *
787  * This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
788  */
789 struct kdbus_cmd_name {
790         __u64 size;
791         __u64 flags;
792         __u64 kernel_flags;
793         __u64 return_flags;
794         struct kdbus_item items[0];
795 } __attribute__((aligned(8)));
796
797 /**
798  * struct kdbus_name_info - struct to describe a well-known name
799  * @size:               The total size of the struct
800  * @conn_flags:         The flags of the owning connection (KDBUS_HELLO_*)
801  * @owner_id:           The current owner of the name
802  * @items:              Item list, containing the well-known name as
803  *                      KDBUS_ITEM_OWNED_NAME
804  *
805  * This structure is used as return struct for the KDBUS_CMD_NAME_LIST ioctl.
806  */
807 struct kdbus_name_info {
808         __u64 size;
809         __u64 conn_flags;
810         __u64 owner_id;
811         struct kdbus_item items[0];
812 } __attribute__((aligned(8)));
813
814 /**
815  * struct kdbus_name_list - information returned by KDBUS_CMD_NAME_LIST
816  * @size:               The total size of the structure
817  * @names:              A list of names
818  *
819  * Note that the user is responsible for freeing the allocated memory with
820  * the KDBUS_CMD_FREE ioctl.
821  */
822 struct kdbus_name_list {
823         __u64 size;
824         struct kdbus_name_info names[0];
825 };
826
827 /**
828  * enum kdbus_name_list_flags - what to include into the returned list
829  * @KDBUS_NAME_LIST_UNIQUE:     All active connections
830  * @KDBUS_NAME_LIST_NAMES:      All known well-known names
831  * @KDBUS_NAME_LIST_ACTIVATORS: All activator connections
832  * @KDBUS_NAME_LIST_QUEUED:     All queued-up names
833  */
834 enum kdbus_name_list_flags {
835         KDBUS_NAME_LIST_UNIQUE          = 1ULL <<  0,
836         KDBUS_NAME_LIST_NAMES           = 1ULL <<  1,
837         KDBUS_NAME_LIST_ACTIVATORS      = 1ULL <<  2,
838         KDBUS_NAME_LIST_QUEUED          = 1ULL <<  3,
839 };
840
841 /**
842  * struct kdbus_cmd_name_list - request a list of name entries
843  * @flags:              Flags for the query (KDBUS_NAME_LIST_*),
844  *                      userspace → kernel
845  * @kernel_flags:       Supported flags for queries, kernel → userspace
846  * @return_flags:       Command return flags, kernel → userspace
847  * @offset:             The returned offset in the caller's pool buffer.
848  *                      The user must use KDBUS_CMD_FREE to free the
849  *                      allocated memory.
850  * @list_size:          Returned size of list in bytes
851  * @size:               Output buffer to report size of data at @offset.
852  * @items:              Items for the command. Reserved for future use.
853  *
854  * This structure is used with the KDBUS_CMD_NAME_LIST ioctl.
855  */
856 struct kdbus_cmd_name_list {
857         __u64 size;
858         __u64 flags;
859         __u64 kernel_flags;
860         __u64 return_flags;
861         __u64 offset;
862         __u64 list_size;
863         struct kdbus_item items[0];
864 } __attribute__((aligned(8)));
865
866 /**
867  * struct kdbus_info - information returned by KDBUS_CMD_*_INFO
868  * @size:               The total size of the struct
869  * @id:                 The connection's or bus' 64-bit ID
870  * @flags:              The connection's or bus' flags
871  * @items:              A list of struct kdbus_item
872  *
873  * Note that the user is responsible for freeing the allocated memory with
874  * the KDBUS_CMD_FREE ioctl.
875  */
876 struct kdbus_info {
877         __u64 size;
878         __u64 id;
879         __u64 flags;
880         struct kdbus_item items[0];
881 };
882
883 /**
884  * struct kdbus_cmd_info - struct used for KDBUS_CMD_CONN_INFO ioctl
885  * @size:               The total size of the struct
886  * @flags:              KDBUS_ATTACH_* flags, userspace → kernel
887  * @kernel_flags:       Supported KDBUS_ATTACH_* flags, kernel → userspace
888  * @return_flags:       Command return flags, kernel → userspace
889  * @id:                 The 64-bit ID of the connection. If set to zero, passing
890  *                      @name is required. kdbus will look up the name to
891  *                      determine the ID in this case.
892  * @offset:             Returned offset in the caller's pool buffer where the
893  *                      kdbus_info struct result is stored. The user must
894  *                      use KDBUS_CMD_FREE to free the allocated memory.
895  * @info_size:          Output buffer to report size of data at @offset.
896  * @items:              The optional item list, containing the
897  *                      well-known name to look up as a KDBUS_ITEM_NAME.
898  *                      Only needed in case @id is zero.
899  *
900  * On success, the KDBUS_CMD_CONN_INFO ioctl will return 0 and @offset will
901  * tell the user the offset in the connection pool buffer at which to find the
902  * result in a struct kdbus_info.
903  */
904 struct kdbus_cmd_info {
905         __u64 size;
906         __u64 flags;
907         __u64 kernel_flags;
908         __u64 return_flags;
909         __u64 id;
910         __u64 offset;
911         __u64 info_size;
912         struct kdbus_item items[0];
913 } __attribute__((aligned(8)));
914
915 /**
916  * struct kdbus_cmd_update - update flags of a connection
917  * @size:               The total size of the struct
918  * @flags:              Flags for the update command, userspace → kernel
919  * @kernel_flags:       Supported flags for this command, kernel → userspace
920  * @return_flags:       Command return flags, kernel → userspace
921  * @items:              A list of struct kdbus_item
922  *
923  * This struct is used with the KDBUS_CMD_CONN_UPDATE ioctl.
924  */
925 struct kdbus_cmd_update {
926         __u64 size;
927         __u64 flags;
928         __u64 kernel_flags;
929         __u64 return_flags;
930         struct kdbus_item items[0];
931 } __attribute__((aligned(8)));
932
933 /**
934  * enum kdbus_cmd_match_flags - flags to control the KDBUS_CMD_MATCH_ADD ioctl
935  * @KDBUS_MATCH_REPLACE:        If entries with the supplied cookie already
936  *                              exists, remove them before installing the new
937  *                              matches.
938  */
939 enum kdbus_cmd_match_flags {
940         KDBUS_MATCH_REPLACE     = 1ULL <<  0,
941 };
942
943 /**
944  * struct kdbus_cmd_match - struct to add or remove matches
945  * @size:               The total size of the struct
946  * @cookie:             Userspace supplied cookie. When removing, the cookie
947  *                      identifies the match to remove
948  * @flags:              Flags for match command (KDBUS_MATCH_*),
949  *                      userspace → kernel
950  * @kernel_flags:       Supported flags of the used command, kernel → userspace
951  * @return_flags:       Command return flags, kernel → userspace
952  * @items:              A list of items for additional information
953  *
954  * This structure is used with the KDBUS_CMD_MATCH_ADD and
955  * KDBUS_CMD_MATCH_REMOVE ioctl.
956  */
957 struct kdbus_cmd_match {
958         __u64 size;
959         __u64 cookie;
960         __u64 flags;
961         __u64 kernel_flags;
962         __u64 return_flags;
963         struct kdbus_item items[0];
964 } __attribute__((aligned(8)));
965
966 /**
967  * Ioctl API
968  * KDBUS_CMD_BUS_MAKE:          After opening the "control" node, this command
969  *                              creates a new bus with the specified
970  *                              name. The bus is immediately shut down and
971  *                              cleaned up when the opened file descriptor is
972  *                              closed.
973  * KDBUS_CMD_ENDPOINT_MAKE:     Creates a new named special endpoint to talk to
974  *                              the bus. Such endpoints usually carry a more
975  *                              restrictive policy and grant restricted access
976  *                              to specific applications.
977  * KDBUS_CMD_HELLO:             By opening the bus node, a connection is
978  *                              created. After a HELLO the opened connection
979  *                              becomes an active peer on the bus.
980  * KDBUS_CMD_BYEBYE:            Disconnect a connection. If there are no
981  *                              messages queued up in the connection's pool,
982  *                              the call succeeds, and the handle is rendered
983  *                              unusable. Otherwise, -EBUSY is returned without
984  *                              any further side-effects.
985  * KDBUS_CMD_SEND:              Send a message and pass data from userspace to
986  *                              the kernel.
987  * KDBUS_CMD_RECV:              Receive a message from the kernel which is
988  *                              placed in the receiver's pool.
989  * KDBUS_CMD_FREE:              Release the allocated memory in the receiver's
990  *                              pool.
991  * KDBUS_CMD_NAME_ACQUIRE:      Request a well-known bus name to associate with
992  *                              the connection. Well-known names are used to
993  *                              address a peer on the bus.
994  * KDBUS_CMD_NAME_RELEASE:      Release a well-known name the connection
995  *                              currently owns.
996  * KDBUS_CMD_NAME_LIST:         Retrieve the list of all currently registered
997  *                              well-known and unique names.
998  * KDBUS_CMD_CONN_INFO:         Retrieve credentials and properties of the
999  *                              initial creator of the connection. The data was
1000  *                              stored at registration time and does not
1001  *                              necessarily represent the connected process or
1002  *                              the actual state of the process.
1003  * KDBUS_CMD_CONN_UPDATE:       Update the properties of a connection. Used to
1004  *                              update the metadata subscription mask and
1005  *                              policy.
1006  * KDBUS_CMD_BUS_CREATOR_INFO:  Retrieve information of the creator of the bus
1007  *                              a connection is attached to.
1008  * KDBUS_CMD_ENDPOINT_UPDATE:   Update the properties of a custom enpoint. Used
1009  *                              to update the policy.
1010  * KDBUS_CMD_MATCH_ADD:         Install a match which broadcast messages should
1011  *                              be delivered to the connection.
1012  * KDBUS_CMD_MATCH_REMOVE:      Remove a current match for broadcast messages.
1013  */
1014 #define KDBUS_CMD_BUS_MAKE              _IOW(KDBUS_IOCTL_MAGIC, 0x00,   \
1015                                              struct kdbus_cmd_make)
1016 #define KDBUS_CMD_ENDPOINT_MAKE         _IOW(KDBUS_IOCTL_MAGIC, 0x10,   \
1017                                              struct kdbus_cmd_make)
1018
1019 #define KDBUS_CMD_HELLO                 _IOWR(KDBUS_IOCTL_MAGIC, 0x20,  \
1020                                               struct kdbus_cmd_hello)
1021 #define KDBUS_CMD_BYEBYE                _IO(KDBUS_IOCTL_MAGIC, 0x21)    \
1022
1023 #define KDBUS_CMD_SEND                  _IOWR(KDBUS_IOCTL_MAGIC, 0x30,  \
1024                                               struct kdbus_cmd_send)
1025 #define KDBUS_CMD_RECV                  _IOWR(KDBUS_IOCTL_MAGIC, 0x31,  \
1026                                               struct kdbus_cmd_recv)
1027 #define KDBUS_CMD_FREE                  _IOW(KDBUS_IOCTL_MAGIC, 0x32,   \
1028                                              struct kdbus_cmd_free)
1029
1030 #define KDBUS_CMD_NAME_ACQUIRE          _IOWR(KDBUS_IOCTL_MAGIC, 0x40,  \
1031                                               struct kdbus_cmd_name)
1032 #define KDBUS_CMD_NAME_RELEASE          _IOW(KDBUS_IOCTL_MAGIC, 0x41,   \
1033                                              struct kdbus_cmd_name)
1034 #define KDBUS_CMD_NAME_LIST             _IOWR(KDBUS_IOCTL_MAGIC, 0x42,  \
1035                                               struct kdbus_cmd_name_list)
1036
1037 #define KDBUS_CMD_CONN_INFO             _IOWR(KDBUS_IOCTL_MAGIC, 0x50,  \
1038                                               struct kdbus_cmd_info)
1039 #define KDBUS_CMD_CONN_UPDATE           _IOW(KDBUS_IOCTL_MAGIC, 0x51,   \
1040                                              struct kdbus_cmd_update)
1041 #define KDBUS_CMD_BUS_CREATOR_INFO      _IOWR(KDBUS_IOCTL_MAGIC, 0x52,  \
1042                                               struct kdbus_cmd_info)
1043
1044 #define KDBUS_CMD_ENDPOINT_UPDATE       _IOW(KDBUS_IOCTL_MAGIC, 0x61,   \
1045                                              struct kdbus_cmd_update)
1046
1047 #define KDBUS_CMD_MATCH_ADD             _IOW(KDBUS_IOCTL_MAGIC, 0x70,   \
1048                                              struct kdbus_cmd_match)
1049 #define KDBUS_CMD_MATCH_REMOVE          _IOW(KDBUS_IOCTL_MAGIC, 0x71,   \
1050                                              struct kdbus_cmd_match)
1051
1052 #endif /* _KDBUS_UAPI_H_ */