D-Bus 1.12.4

dbus-nonce.c
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-nonce.c Nonce handling functions used by nonce-tcp (internal to D-Bus implementation)
3 *
4 * Copyright (C) 2009 Klaralvdalens Datakonsult AB, a KDAB Group company, info@kdab.net
5 *
6 * Licensed under the Academic Free License version 2.1
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#include <config.h>
25// major sections of this file are modified code from libassuan, (C) FSF
26#include "dbus-nonce.h"
27#include "dbus-internals.h"
28#include "dbus-protocol.h"
29#include "dbus-sysdeps.h"
30
31#include <stdio.h>
32
33 static dbus_bool_t
34do_check_nonce (DBusSocket fd, const DBusString *nonce, DBusError *error)
35{
36 DBusString buffer;
37 DBusString p;
38 size_t nleft;
39 dbus_bool_t result;
40 int n;
41
42 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
43
44 nleft = 16;
45
46 /* This is a trick to make it safe to call _dbus_string_free on these
47 * strings during error unwinding, even if allocating memory for them
48 * fails. A constant DBusString is considered to be valid to "free",
49 * even though there is nothing to free (of course the free operation
50 * is trivial, because it does not own its own buffer); but
51 * unlike a mutable DBusString, initializing a constant DBusString
52 * cannot fail.
53 *
54 * We must successfully re-initialize the strings to be mutable before
55 * writing to them, of course.
56 */
57 _dbus_string_init_const (&buffer, "");
58 _dbus_string_init_const (&p, "");
59
60 if ( !_dbus_string_init (&buffer)
61 || !_dbus_string_init (&p) ) {
62 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
63 _dbus_string_free (&p);
64 _dbus_string_free (&buffer);
65 return FALSE;
66 }
67
68 while (nleft)
69 {
70 int saved_errno;
71
72 n = _dbus_read_socket (fd, &p, nleft);
73 saved_errno = _dbus_save_socket_errno ();
74
75 if (n == -1 && _dbus_get_is_errno_eintr (saved_errno))
76 ;
77 else if (n == -1 && _dbus_get_is_errno_eagain_or_ewouldblock (saved_errno))
78 _dbus_sleep_milliseconds (100);
79 else if (n==-1)
80 {
81 dbus_set_error (error, DBUS_ERROR_IO_ERROR, "Could not read nonce from socket (fd=%" DBUS_SOCKET_FORMAT ")", _dbus_socket_printable (fd));
82 _dbus_string_free (&p);
83 _dbus_string_free (&buffer);
84 return FALSE;
85 }
86 else if (!n)
87 {
88 _dbus_string_free (&p);
89 _dbus_string_free (&buffer);
90 dbus_set_error (error, DBUS_ERROR_IO_ERROR, "Could not read nonce from socket (fd=%" DBUS_SOCKET_FORMAT ")", _dbus_socket_printable (fd));
91 return FALSE;
92 }
93 else
94 {
95 if (!_dbus_string_append_len (&buffer, _dbus_string_get_const_data (&p), n))
96 {
97 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
98 _dbus_string_free (&p);
99 _dbus_string_free (&buffer);
100 return FALSE;
101 }
102 nleft -= n;
103 }
104 }
105
106 result = _dbus_string_equal_len (&buffer, nonce, 16);
107 if (!result)
108 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED, "Nonces do not match, access denied (fd=%" DBUS_SOCKET_FORMAT ")", _dbus_socket_printable (fd));
109
110 _dbus_string_free (&p);
111 _dbus_string_free (&buffer);
112
113 return result;
114}
115
124 dbus_bool_t
125_dbus_read_nonce (const DBusString *fname, DBusString *nonce, DBusError* error)
126{
127 FILE *fp;
128 char buffer[17];
129 size_t nread;
130
131 buffer[sizeof buffer - 1] = '\0';
132
133 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
134
135 _dbus_verbose ("reading nonce from file: %s\n", _dbus_string_get_const_data (fname));
136
137
138 fp = fopen (_dbus_string_get_const_data (fname), "rb");
139 if (!fp)
140 {
141 dbus_set_error (error,
142 _dbus_error_from_system_errno (),
143 "Failed to open %s for read: %s",
144 _dbus_string_get_const_data (fname),
145 _dbus_strerror_from_errno ());
146 return FALSE;
147 }
148
149 nread = fread (buffer, 1, sizeof buffer - 1, fp);
150 fclose (fp);
151 if (!nread)
152 {
153 dbus_set_error (error, DBUS_ERROR_FILE_NOT_FOUND, "Could not read nonce from file %s", _dbus_string_get_const_data (fname));
154 return FALSE;
155 }
156
157 if (!_dbus_string_append_len (nonce, buffer, sizeof buffer - 1 ))
158 {
159 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
160 return FALSE;
161 }
162 return TRUE;
163}
164
165 DBusSocket
166_dbus_accept_with_noncefile (DBusSocket listen_fd, const DBusNonceFile *noncefile)
167{
168 DBusSocket fd = _dbus_socket_get_invalid ();
169 DBusString nonce;
170
171 _dbus_assert (noncefile != NULL);
172
173 /* Make it valid to "free" this even if _dbus_string_init() runs
174 * out of memory: see comment in do_check_nonce() */
175 _dbus_string_init_const (&nonce, "");
176
177 if (!_dbus_string_init (&nonce))
178 goto out;
179
180 //PENDING(kdab): set better errors
181 if (_dbus_read_nonce (_dbus_noncefile_get_path(noncefile), &nonce, NULL) != TRUE)
182 goto out;
183
184 fd = _dbus_accept (listen_fd);
185
186 if (!_dbus_socket_is_valid (fd))
187 goto out;
188
189 if (do_check_nonce(fd, &nonce, NULL) != TRUE) {
190 _dbus_verbose ("nonce check failed. Closing socket.\n");
191 _dbus_close_socket(fd, NULL);
192 _dbus_socket_invalidate (&fd);
193 goto out;
194 }
195
196out:
197 _dbus_string_free (&nonce);
198 return fd;
199}
200
201 static dbus_bool_t
202generate_and_write_nonce (const DBusString *filename, DBusError *error)
203{
204 DBusString nonce;
205 dbus_bool_t ret;
206
207 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
208
209 if (!_dbus_string_init (&nonce))
210 {
211 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
212 return FALSE;
213 }
214
215 if (!_dbus_generate_random_bytes (&nonce, 16, error))
216 {
217 _dbus_string_free (&nonce);
218 return FALSE;
219 }
220
221 ret = _dbus_string_save_to_file (&nonce, filename, FALSE, error);
222
223 _dbus_string_free (&nonce);
224
225 return ret;
226}
227
237 dbus_bool_t
238_dbus_send_nonce (DBusSocket fd,
239 const DBusString *noncefile,
240 DBusError *error)
241{
242 dbus_bool_t read_result;
243 int send_result;
244 DBusString nonce;
245
246 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
247
248 if (_dbus_string_get_length (noncefile) == 0)
249 return FALSE;
250
251 if (!_dbus_string_init (&nonce))
252 {
253 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
254 return FALSE;
255 }
256
257 read_result = _dbus_read_nonce (noncefile, &nonce, error);
258 if (!read_result)
259 {
260 _DBUS_ASSERT_ERROR_IS_SET (error);
261 _dbus_string_free (&nonce);
262 return FALSE;
263 }
264 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
265
266 send_result = _dbus_write_socket (fd, &nonce, 0, _dbus_string_get_length (&nonce));
267
268 _dbus_string_free (&nonce);
269
270 if (send_result == -1)
271 {
272 dbus_set_error (error,
273 _dbus_error_from_system_errno (),
274 "Failed to send nonce (fd=%" DBUS_SOCKET_FORMAT "): %s",
275 _dbus_socket_printable (fd),
276 _dbus_strerror_from_errno ());
277 return FALSE;
278 }
279
280 return TRUE;
281}
282
283 static dbus_bool_t
284do_noncefile_create (DBusNonceFile *noncefile,
285 DBusError *error,
286 dbus_bool_t use_subdir)
287{
288 DBusString randomStr;
289 const char *tmp;
290
291 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
292
293 _dbus_assert (noncefile);
294
295 /* Make it valid to "free" these even if _dbus_string_init() runs
296 * out of memory: see comment in do_check_nonce() */
297 _dbus_string_init_const (&randomStr, "");
298 _dbus_string_init_const (&noncefile->dir, "");
299 _dbus_string_init_const (&noncefile->path, "");
300
301 if (!_dbus_string_init (&randomStr))
302 {
303 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
304 goto on_error;
305 }
306
307 if (!_dbus_generate_random_ascii (&randomStr, 8, error))
308 {
309 goto on_error;
310 }
311
312 tmp = _dbus_get_tmpdir ();
313
314 if (!_dbus_string_init (&noncefile->dir)
315 || tmp == NULL
316 || !_dbus_string_append (&noncefile->dir, tmp))
317 {
318 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
319 goto on_error;
320 }
321 if (use_subdir)
322 {
323 if (!_dbus_string_append (&noncefile->dir, "/dbus_nonce-")
324 || !_dbus_string_append (&noncefile->dir, _dbus_string_get_const_data (&randomStr)) )
325 {
326 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
327 goto on_error;
328 }
329 if (!_dbus_string_init (&noncefile->path)
330 || !_dbus_string_copy (&noncefile->dir, 0, &noncefile->path, 0)
331 || !_dbus_string_append (&noncefile->path, "/nonce"))
332 {
333 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
334 goto on_error;
335 }
336 if (!_dbus_create_directory (&noncefile->dir, error))
337 {
338 _DBUS_ASSERT_ERROR_IS_SET (error);
339 goto on_error;
340 }
341 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
342
343 }
344 else
345 {
346 if (!_dbus_string_init (&noncefile->path)
347 || !_dbus_string_copy (&noncefile->dir, 0, &noncefile->path, 0)
348 || !_dbus_string_append (&noncefile->path, "/dbus_nonce-")
349 || !_dbus_string_append (&noncefile->path, _dbus_string_get_const_data (&randomStr)))
350 {
351 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
352 goto on_error;
353 }
354
355 }
356
357 if (!generate_and_write_nonce (&noncefile->path, error))
358 {
359 _DBUS_ASSERT_ERROR_IS_SET (error);
360 if (use_subdir)
361 _dbus_delete_directory (&noncefile->dir, NULL); //we ignore possible errors deleting the dir and return the write error instead
362 goto on_error;
363 }
364 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
365
366 _dbus_string_free (&randomStr);
367
368 return TRUE;
369 on_error:
370 if (use_subdir)
371 _dbus_delete_directory (&noncefile->dir, NULL);
372 _dbus_string_free (&noncefile->dir);
373 _dbus_string_free (&noncefile->path);
374 _dbus_string_free (&randomStr);
375 return FALSE;
376}
377
378#ifdef DBUS_WIN
386 dbus_bool_t
387_dbus_noncefile_create (DBusNonceFile *noncefile,
388 DBusError *error)
389{
390 return do_noncefile_create (noncefile, error, /*use_subdir=*/FALSE);
391}
392
400 dbus_bool_t
401_dbus_noncefile_delete (DBusNonceFile *noncefile,
402 DBusError *error)
403{
404 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
405
406 _dbus_delete_file (&noncefile->path, error);
407 _dbus_string_free (&noncefile->dir);
408 _dbus_string_free (&noncefile->path);
409 return TRUE;
410}
411
412#else
421 dbus_bool_t
422_dbus_noncefile_create (DBusNonceFile *noncefile,
423 DBusError *error)
424{
425 return do_noncefile_create (noncefile, error, /*use_subdir=*/TRUE);
426}
427
435 dbus_bool_t
436_dbus_noncefile_delete (DBusNonceFile *noncefile,
437 DBusError *error)
438{
439 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
440
441 _dbus_delete_directory (&noncefile->dir, error);
442 _dbus_string_free (&noncefile->dir);
443 _dbus_string_free (&noncefile->path);
444 return TRUE;
445}
446#endif
447
448
455 const DBusString*
456_dbus_noncefile_get_path (const DBusNonceFile *noncefile)
457{
458 _dbus_assert (noncefile);
459 return &noncefile->path;
460}
461
472 dbus_bool_t
473_dbus_noncefile_check_nonce (DBusSocket fd,
474 const DBusNonceFile *noncefile,
475 DBusError* error)
476{
477 return do_check_nonce (fd, _dbus_noncefile_get_path (noncefile), error);
478}
479
480
dbus_set_error
void dbus_set_error(DBusError *error, const char *name, const char *format,...)
Assigns an error name and message to a DBusError.
Definition: dbus-errors.c:354
_dbus_delete_file
dbus_bool_t _dbus_delete_file(const DBusString *filename, DBusError *error)
Deletes the given file.
Definition: dbus-file-unix.c:399
_dbus_string_save_to_file
dbus_bool_t _dbus_string_save_to_file(const DBusString *str, const DBusString *filename, dbus_bool_t world_readable, DBusError *error)
Writes a string out to a file.
Definition: dbus-file-unix.c:164
_dbus_assert
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
Definition: dbus-internals.h:152
_dbus_generate_random_ascii
dbus_bool_t _dbus_generate_random_ascii(DBusString *str, int n_bytes, DBusError *error)
Generates the given number of random bytes, where the bytes are chosen from the alphanumeric ASCII su...
Definition: dbus-sysdeps.c:552
_dbus_error_from_system_errno
const char * _dbus_error_from_system_errno(void)
Converts the current system errno value into a DBusError name.
Definition: dbus-sysdeps.c:684
_dbus_strerror_from_errno
const char * _dbus_strerror_from_errno(void)
Get error message from errno.
Definition: dbus-sysdeps.c:751
_dbus_get_is_errno_eintr
dbus_bool_t _dbus_get_is_errno_eintr(int e)
See if errno is EINTR.
Definition: dbus-sysdeps.c:717
NULL
#define NULL
A null pointer, defined appropriately for C or C++.
TRUE
#define TRUE
Expands to "1".
FALSE
#define FALSE
Expands to "0".
DBUS_ERROR_IO_ERROR
#define DBUS_ERROR_IO_ERROR
Something went wrong reading or writing to a socket, for example.
Definition: dbus-protocol.h:365
DBUS_ERROR_ACCESS_DENIED
#define DBUS_ERROR_ACCESS_DENIED
Security restrictions don't allow doing what you're trying to do.
Definition: dbus-protocol.h:373
DBUS_ERROR_NO_MEMORY
#define DBUS_ERROR_NO_MEMORY
There was not enough memory to complete an operation.
Definition: dbus-protocol.h:357
DBUS_ERROR_FILE_NOT_FOUND
#define DBUS_ERROR_FILE_NOT_FOUND
Missing file.
Definition: dbus-protocol.h:393
_dbus_string_append
dbus_bool_t _dbus_string_append(DBusString *str, const char *buffer)
Appends a nul-terminated C-style string to a DBusString.
Definition: dbus-string.c:935
_dbus_string_init
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
Definition: dbus-string.c:175
_dbus_string_init_const
void _dbus_string_init_const(DBusString *str, const char *value)
Initializes a constant string.
Definition: dbus-string.c:190
_dbus_string_copy
dbus_bool_t _dbus_string_copy(const DBusString *source, int start, DBusString *dest, int insert_at)
Like _dbus_string_move(), but does not delete the section of the source string that's copied to the d...
Definition: dbus-string.c:1283
_dbus_string_append_len
dbus_bool_t _dbus_string_append_len(DBusString *str, const char *buffer, int len)
Appends block of bytes with the given length to a DBusString.
Definition: dbus-string.c:1137
_dbus_string_free
void _dbus_string_free(DBusString *str)
Frees a string created by _dbus_string_init().
Definition: dbus-string.c:259
_dbus_string_equal_len
dbus_bool_t _dbus_string_equal_len(const DBusString *a, const DBusString *b, int len)
Tests two DBusString for equality up to the given length.
Definition: dbus-string.c:2056
_dbus_get_is_errno_eagain_or_ewouldblock
dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock(int e)
See if errno is EAGAIN or EWOULDBLOCK (this has to be done differently for Winsock so is abstracted)
Definition: dbus-sysdeps-unix.c:4303
_dbus_read_socket
int _dbus_read_socket(DBusSocket fd, DBusString *buffer, int count)
Like _dbus_read(), but only works on sockets so is available on Windows.
Definition: dbus-sysdeps-unix.c:302
_dbus_write_socket
int _dbus_write_socket(DBusSocket fd, const DBusString *buffer, int start, int len)
Like _dbus_write(), but only supports sockets and is thus available on Windows.
Definition: dbus-sysdeps-unix.c:320
_dbus_close_socket
dbus_bool_t _dbus_close_socket(DBusSocket fd, DBusError *error)
Closes a socket.
Definition: dbus-sysdeps-unix.c:286
_dbus_sleep_milliseconds
void _dbus_sleep_milliseconds(int milliseconds)
Sleeps the given number of milliseconds.
Definition: dbus-sysdeps-unix.c:3065
_dbus_generate_random_bytes
dbus_bool_t _dbus_generate_random_bytes(DBusString *str, int n_bytes, DBusError *error)
Generates the given number of securely random bytes, using the best mechanism we can come up with.
Definition: dbus-sysdeps-unix.c:3095
_dbus_delete_directory
dbus_bool_t _dbus_delete_directory(const DBusString *filename, DBusError *error)
Removes a directory; Directory must be empty.
Definition: dbus-sysdeps-unix.c:4316
_dbus_accept
DBusSocket _dbus_accept(DBusSocket listen_fd)
Accepts a connection on a listening socket.
Definition: dbus-sysdeps-unix.c:2221
_dbus_get_tmpdir
const char * _dbus_get_tmpdir(void)
Gets the temporary files directory by inspecting the environment variables TMPDIR,...
Definition: dbus-sysdeps-unix.c:3516
_dbus_create_directory
dbus_bool_t _dbus_create_directory(const DBusString *filename, DBusError *error)
Creates a directory.
Definition: dbus-sysdeps-unix.c:2989
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusNonceFile
Definition: dbus-nonce.h:37
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:149
DBusString
Definition: dbus-string.h:43