2003-05-17 Havoc Pennington <hp@pobox.com>
[platform/upstream/dbus.git] / bus / policy.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* policy.h  Bus security policy
3  *
4  * Copyright (C) 2003  Red Hat, Inc.
5  *
6  * Licensed under the Academic Free License version 1.2
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  */
23
24 #ifndef BUS_POLICY_H
25 #define BUS_POLICY_H
26
27 #include <dbus/dbus.h>
28 #include <dbus/dbus-string.h>
29 #include <dbus/dbus-sysdeps.h>
30 #include "bus.h"
31
32 typedef enum
33 {
34   BUS_POLICY_RULE_SEND,
35   BUS_POLICY_RULE_RECEIVE,
36   BUS_POLICY_RULE_OWN,
37   BUS_POLICY_RULE_USER,
38   BUS_POLICY_RULE_GROUP
39 } BusPolicyRuleType;
40
41 /** determines whether the rule affects a connection, or some global item */
42 #define BUS_POLICY_RULE_IS_PER_CLIENT(rule) (!((rule)->type == BUS_POLICY_RULE_USER || \
43                                                (rule)->type == BUS_POLICY_RULE_GROUP))
44
45 struct BusPolicyRule
46 {
47   int refcount;
48   
49   BusPolicyRuleType type;
50
51   unsigned int allow : 1; /**< #TRUE if this allows, #FALSE if it denies */
52   
53   union
54   {
55     struct
56     {
57       /* either can be NULL meaning "any" */
58       char *message_name;
59       char *destination;
60     } send;
61
62     struct
63     {
64       /* either can be NULL meaning "any" */
65       char *message_name;
66       char *origin;
67     } receive;
68
69     struct
70     {
71       /* can be NULL meaning "any" */
72       char *service_name;
73     } own;
74
75     struct
76     {
77       /* can be DBUS_UID_UNSET meaning "any" */
78       dbus_uid_t uid;
79     } user;
80
81     struct
82     {
83       /* can be DBUS_GID_UNSET meaning "any" */
84       dbus_gid_t gid;
85     } group;
86     
87   } d;
88 };
89
90 BusPolicyRule* bus_policy_rule_new   (BusPolicyRuleType type,
91                                       dbus_bool_t       allow);
92 void           bus_policy_rule_ref   (BusPolicyRule    *rule);
93 void           bus_policy_rule_unref (BusPolicyRule    *rule);
94
95 BusPolicy*       bus_policy_new                   (void);
96 void             bus_policy_ref                   (BusPolicy        *policy);
97 void             bus_policy_unref                 (BusPolicy        *policy);
98 BusClientPolicy* bus_policy_create_client_policy  (BusPolicy        *policy,
99                                                    DBusConnection   *connection,
100                                                    DBusError        *error);
101 dbus_bool_t      bus_policy_allow_user            (BusPolicy        *policy,
102                                                    DBusUserDatabase *user_database,
103                                                    unsigned long     uid);
104 dbus_bool_t      bus_policy_append_default_rule   (BusPolicy        *policy,
105                                                    BusPolicyRule    *rule);
106 dbus_bool_t      bus_policy_append_mandatory_rule (BusPolicy        *policy,
107                                                    BusPolicyRule    *rule);
108 dbus_bool_t      bus_policy_append_user_rule      (BusPolicy        *policy,
109                                                    dbus_uid_t        uid,
110                                                    BusPolicyRule    *rule);
111 dbus_bool_t      bus_policy_append_group_rule     (BusPolicy        *policy,
112                                                    dbus_gid_t        gid,
113                                                    BusPolicyRule    *rule);
114 dbus_bool_t      bus_policy_merge                 (BusPolicy        *policy,
115                                                    BusPolicy        *to_absorb);
116
117 BusClientPolicy* bus_client_policy_new               (void);
118 void             bus_client_policy_ref               (BusClientPolicy  *policy);
119 void             bus_client_policy_unref             (BusClientPolicy  *policy);
120 dbus_bool_t      bus_client_policy_check_can_send    (BusClientPolicy  *policy,
121                                                       BusRegistry      *registry,
122                                                       DBusConnection   *receiver,
123                                                       DBusMessage      *message);
124 dbus_bool_t      bus_client_policy_check_can_receive (BusClientPolicy  *policy,
125                                                       BusRegistry      *registry,
126                                                       DBusConnection   *sender,
127                                                       DBusMessage      *message);
128 dbus_bool_t      bus_client_policy_check_can_own     (BusClientPolicy  *policy,
129                                                       DBusConnection   *connection,
130                                                       const DBusString *service_name);
131 dbus_bool_t      bus_client_policy_append_rule       (BusClientPolicy  *policy,
132                                                       BusPolicyRule    *rule);
133 void             bus_client_policy_optimize          (BusClientPolicy  *policy);
134
135
136 #endif /* BUS_POLICY_H */