Fix GCC 13 incompatibilities
[platform/core/system/libdbuspolicy.git] / README
1 Authors:
2     Kazimierz Krosman <k.krosman@samsung.com>
3     Arek Antoniak <a.antoniak2@samsung.com>
4
5 Library libdbuspolicy adds functionality of DBUS policy utilization in KDBUS, it complies with DBUS policy specification and supports Cynara check directive.
6
7 Usage:
8     ./autogen.sh
9     ./configure
10     make
11     make install
12
13 The library delivers following API:
14
15     /*!
16       libdbuspolicy init
17       \param bus_type bus type (SYSTEM or SESSION)
18      */
19     void* dbuspolicy1_init(unsigned int bus_type);
20
21     /*!
22       libdbuspolicy free
23       \param configuration pointer with policy configuration acquired using dbuspolicy1_init
24      */
25     void dbuspolicy1_free(void* configuration);
26
27     /*!
28       Check policy for outgoing message
29       \param configuration pointer with policy configuration
30       \param destination list of message destinations
31       \param sender list of message sender names
32       \param path path
33       \param interface interface name
34       \param member member name
35       \param message_type message type
36       \param error_name (future implementation)
37       \param reply_serial (future implementation)
38       \param requested_reply (future implementation)
39      */
40     int dbuspolicy1_check_out(void* configuration,
41             const char        *destination,
42             const char        *sender,
43             const char        *path,
44             const char        *interface,
45             const char        *member,
46             int               message_type,
47             const char        *error_name,
48             int               reply_serial,
49             int               requested_reply);
50
51     /*!
52       Check policy for incoming message
53       \param configuration pointer with policy configuration
54       \param destination list of message destinations
55       \param sender list of message sender names
56       \param sender_label sender label (should be manually extracted from incomming message)
57       \param sender_uid sender uid (should be manually extracted from incomming message)
58       \param sender_gid sender gid (should be manually extracted from incomming message)
59       \param path path
60       \param interface interface name
61       \param member member name
62       \param message_type message type
63       \param error_name (future implementation)
64       \param reply_serial (future implementation)
65       \param requested_reply (future implementation)
66      */
67     int dbuspolicy1_check_in(void* configuration,
68             const char        *destination,
69             const char        *sender,
70             const char        *sender_label,
71             uid_t             sender_uid,
72             gid_t             sender_gid,
73             const char        *path,
74             const char        *interface,
75             const char        *member,
76             int               message_type,
77             const char        *error_name,
78             int               reply_serial,
79             int               requested_reply);
80
81     /*!
82       Check policy for service ownership
83       \param configuration pointer with policy configuration
84       \param service service name
85      */
86     int dbuspolicy1_can_own(void* configuration, const char* const service);