summaryrefslogtreecommitdiffstats
path: root/src/sbus/sssd_dbus.h
blob: 15ca521184f82c7424549907b7afa912f891c3ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
/*
   SSSD

   SSSD - D-BUS interface

   Copyright (C) Stephen Gallagher         2008

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _SSSD_DBUS_H_
#define _SSSD_DBUS_H_

struct sbus_connection;
struct sbus_interface;
struct sbus_request;

#include <dbus/dbus.h>
#include <sys/types.h>
#include "util/util.h"

typedef int (*sbus_msg_handler_fn)(struct sbus_request *dbus_req,
                                   void *instance_data);

/*
 * sbus_conn_destructor_fn
 * Function to be called when a connection is finalized
 */
typedef int (*sbus_conn_destructor_fn)(void *);

typedef void (*sbus_conn_reconn_callback_fn)(struct sbus_connection *, int, void *);

/*
 * sbus_server_conn_init_fn
 * Set up function for connection-specific activities
 * This function should define the sbus_conn_destructor_fn
 * for this connection at a minimum
 */
typedef int (*sbus_server_conn_init_fn)(struct sbus_connection *, void *);

enum {
    SBUS_CONN_TYPE_PRIVATE = 1,
    SBUS_CONN_TYPE_SHARED,
    SBUS_CONN_TYPE_SYSBUS
};

enum {
    SBUS_RECONNECT_SUCCESS = 1,
    SBUS_RECONNECT_EXCEEDED_RETRIES,
    SBUS_RECONNECT_ERROR
};

/*
 * This represents vtable of interface handlers for methods and
 * properties and so on. The actual vtable structs derive from this struct
 * (ie: have this struct as their first member).
 *
 * The offsets for matching vtable function pointers are in sbus_method_meta
 * These are used to dynamically dispatch the method invocations.
 */
struct sbus_vtable {
    const struct sbus_interface_meta *meta;
    int flags; /* unused for now */

    /* derived structs place function pointers here. */
};

/* Special interface and method for D-BUS introspection */
#define DBUS_INTROSPECT_INTERFACE "org.freedesktop.DBus.Introspectable"
#define DBUS_INTROSPECT_METHOD "Introspect"

struct sbus_interface {
    const char *path;
    struct sbus_vtable *vtable;
    void *instance_data;
};

/*
 * Creates a new struct sbus_interface instance to be exported by a DBus
 * service.
 *
 * Pass the result to sbus_conn_add_interface(). The interface
 * will be exported at @object_path. The method handlers are represented by
 * @iface_vtable. @instance_data contains additional caller specific data
 * which is made available to handlers.
 */
struct sbus_interface *
sbus_new_interface(TALLOC_CTX *mem_ctx,
                   const char *object_path,
                   struct sbus_vtable *iface_vtable,
                   void *instance_data);

/* Server Functions */
int sbus_new_server(TALLOC_CTX *mem_ctx,
                    struct tevent_context *ev,
                    const char *address,
                    bool use_symlink,
                    struct sbus_connection **server,
                    sbus_server_conn_init_fn init_fn, void *init_pvt_data);

/* Connection Functions */

/* sbus_new_connection
 * Use this function when connecting a new process to
 * the standard SSSD interface.
 * This will connect to the address specified and then
 * call sbus_add_connection to integrate with the main
 * loop.
 */
int sbus_new_connection(TALLOC_CTX *ctx,
                        struct tevent_context *ev,
                        const char *address,
                        struct sbus_connection **conn);

/* sbus_add_connection
 * Integrates a D-BUS connection with the TEvent main
 * loop. Use this function when you already have a
 * DBusConnection object (for example from dbus_bus_get)
 * Connection type can be either:
 * SBUS_CONN_TYPE_PRIVATE: Used only from within a D-BUS
 *     server such as the Monitor in the
 *     new_connection_callback
 * SBUS_CONN_TYPE_SHARED: Used for all D-BUS client
 *     connections, including those retrieved from
 *     dbus_bus_get
 */
int sbus_init_connection(TALLOC_CTX *ctx,
                         struct tevent_context *ev,
                         DBusConnection *dbus_conn,
                         int connection_type,
                         struct sbus_connection **_conn);

DBusConnection *sbus_get_connection(struct sbus_connection *conn);
void sbus_disconnect(struct sbus_connection *conn);
int sbus_conn_add_interface(struct sbus_connection *conn,
                            struct sbus_interface *intf);
bool sbus_conn_disconnecting(struct sbus_connection *conn);

/* max_retries < 0: retry forever
 * max_retries = 0: never retry (why are you calling this function?)
 * max_retries > 0: obvious
 */
void sbus_reconnect_init(struct sbus_connection *conn,
                         int max_retries,
                         sbus_conn_reconn_callback_fn callback,
                         void *pvt);

/* Default message handler
 * Should be usable for most cases */
DBusHandlerResult sbus_message_handler(DBusConnection *conn,
                                  DBusMessage *message,
                                  void *user_data);

/*
 * Send a message across the SBUS
 * If requested, the DBusPendingCall object will
 * be returned to the caller.
 *
 * This function will return EAGAIN in the event
 * that the connection is not open for
 * communication.
 */
int sbus_conn_send(struct sbus_connection *conn,
                   DBusMessage *msg,
                   int timeout_ms,
                   DBusPendingCallNotifyFunction reply_handler,
                   void *pvt,
                   DBusPendingCall **pending);

void sbus_conn_send_reply(struct sbus_connection *conn,
                          DBusMessage *reply);

/*
 * This structure is passed to all dbus method and property
 * handlers. It is a talloc context which will be valid until
 * the request is completed with either the sbus_request_complete()
 * or sbus_request_fail() functions.
 */
struct sbus_request {
    int64_t client;
    struct sbus_connection *conn;
    DBusMessage *message;
    struct sbus_interface *intf;
    const struct sbus_method_meta *method;
};

/*
 * Complete a DBus request, and free the @dbus_req context. The @dbus_req
 * and associated talloc context are no longer valid after this function
 * returns.
 *
 * If @reply is non-NULL then the reply is sent to the caller. Not sending
 * a reply when the caller is expecting one is fairly rude behavior.
 *
 * The return value is useful for logging, but not much else. In particular
 * even if this function return !EOK, @dbus_req is still unusable after this
 * function returns.
 */
int sbus_request_finish(struct sbus_request *dbus_req,
                        DBusMessage *reply);

/*
 * Return a reply for a DBus method call request. The variable
 * arguments are (unfortunately) formatted exactly the same as those of the
 * dbus_message_append_args() function. Documented here:
 *
 * http://dbus.freedesktop.org/doc/api/html/group__DBusMessage.html
 *
 * Important: don't pass int or bool or such types as
 * values to this function. That's not portable. Use actual dbus types.
 * You must also pass pointers as the values:
 *
 *    dbus_bool_t val1 = TRUE;
 *    dbus_int32_t val2 = 5;
 *    ret = sbus_request_finish(dbus_req,
 *                              DBUS_TYPE_BOOLEAN, &val1,
 *                              DBUS_TYPE_INT32, &val2,
 *                              DBUS_TYPE_INVALID);
 *
 * To pass arrays to this function, use the following syntax. Never
 * pass actual C arrays with [] syntax to this function. The C standard is
 * rather vague with C arrays and varargs, and it just plain doesn't work.
 *
 *    const char *array[] = { "one", "two", "three" };
 *    int count = 3; // yes, a plain int
 *    const char **ptr = array;
 *    ret = sbus_request_finish(dbus_req,
 *                              DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, &ptr, 3,
 *                              DBUS_TYPE_INVALID);
 *
 * The @dbus_req and associated talloc context are no longer valid after this
 * function returns, even if this function returns an error code.
 */
int sbus_request_return_and_finish(struct sbus_request *dbus_req,
                                   int first_arg_type,
                                   ...);

/*
 * Return an error for a DBus method call request. The @error is a normal
 * DBusError.
 *
 * The @dbus_req and associated talloc context are no longer valid after this
 * function returns, even if this function returns an error code.
 */
int sbus_request_fail_and_finish(struct sbus_request *dbus_req,
                                 const DBusError *error);

/*
 * Construct a new DBusError instance which can be consumed by functions such
 * as @sbus_request_fail_and_finish().
 *
 * The @error is a string constant representing a DBus error as documented at
 * http://dbus.freedesktop.org/doc/api/html/group__DBusProtocol.html.
 * The parameter @err_msg is a human-readable error representation (or
 * NULL for none). The returned DBusError is a talloc context and the err_msg
 * is duplicated using the returned DBusError instance as a talloc parent.
 */
DBusError *sbus_error_new(TALLOC_CTX *mem_ctx,
                          const char *dbus_err_name,
                          const char *fmt,
                          ...) SSS_ATTRIBUTE_PRINTF(3,4);

/*
 * Parse a DBus method call request.
 *
 * If parsing the method call message does not succeed, then an error is
 * sent to the DBus caller and the request is finished. If this function
 * returns false then @request is no longer valid.
 *
 * This also means if this method returns false within a handler, you should
 * return EOK from the handler. The message has been handled, appropriate
 * logs have been written, and everything should just move on.
 *
 * If the method call does not match the expected arguments, then a
 * org.freedesktop.DBus.Error.InvalidArgs is returned to the caller as
 * expected.
 *
 * The variable arguments are (unfortunately) formatted exactly the same
 * as those of the dbus_message_get_args() function. Documented here:
 *
 * http://dbus.freedesktop.org/doc/api/html/group__DBusMessage.html
 *
 * Exception: You don't need to free string arrays returned by this
 * function. They are automatically talloc parented to the request memory
 * context and can be used until the request has been finished.
 *
 * Important: don't pass int or bool or such types as values to this
 * function. That's not portable. Use actual dbus types. You must also pass
 * pointers as the values:
 *
 *    dbus_bool_t val1;
 *    dbus_int32_t val2;
 *    ret = sbus_request_parse_or_finish(request,
 *                                       DBUS_TYPE_BOOLEAN, &val1,
 *                                       DBUS_TYPE_INT32, &val2,
 *                                       DBUS_TYPE_INVALID);
 *
 * To pass arrays to this function, use the following syntax. Never
 * pass actual C arrays with [] syntax to this function. The C standard is
 * rather vague with C arrays and varargs, and it just plain doesn't work.
 *
 *    int count; // yes, a plain int
 *    const char **array;
 *    ret = sbus_request_parse_or_finish(request,
 *                                       DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, &array, &count,
 *                                       DBUS_TYPE_INVALID);
 */
bool sbus_request_parse_or_finish(struct sbus_request *request,
                                  int first_arg_type,
                                  ...);

#endif /* _SSSD_DBUS_H_*/