Add UUID support to Asterisk.
[asterisk/asterisk.git] / main / uuid.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, Digium, Inc.
5  *
6  * Mark Michelson <mmmichelson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Universally unique identifier support
21  */
22
23 #include "asterisk.h"
24 #include <uuid/uuid.h>
25 #include <fcntl.h>
26
27 #include "asterisk/uuid.h"
28 #include "asterisk/utils.h"
29 #include "asterisk/strings.h"
30 #include "asterisk/logger.h"
31 #include "asterisk/lock.h"
32
33 AST_MUTEX_DEFINE_STATIC(uuid_lock);
34
35 static int has_dev_urandom;
36
37 struct ast_uuid {
38         uuid_t uu;
39 };
40
41 struct ast_uuid *ast_uuid_generate(void)
42 {
43         struct ast_uuid *uuid = ast_malloc(sizeof(*uuid));
44
45         if (!uuid) {
46                 return NULL;
47         }
48         /* libuuid provides three methods of generating uuids,
49          * uuid_generate(), uuid_generate_random(), and uuid_generate_time().
50          *
51          * uuid_generate_random() creates a UUID based on random numbers. The method
52          * attempts to use either /dev/urandom or /dev/random to generate random values.
53          * If these resources are unavailable, then random numbers will be generated
54          * using C library calls to generate pseudorandom numbers.
55          * This method of generating UUIDs corresponds to section 4.4 of RFC 4122.
56          *
57          * uuid_generate_time() creates a UUID based on the current time plus
58          * a system identifier (MAC address of the ethernet interface). This
59          * method of generating UUIDs corresponds to section 4.2 of RFC 4122.
60          *
61          * uuid_generate() will check if /dev/urandom or /dev/random is available to
62          * use. If so, it will use uuid_generate_random(). Otherwise, it will use
63          * uuid_generate_time(). The idea is that it avoids using pseudorandom
64          * numbers if necessary.
65          *
66          * For our purposes, we do not use the time-based UUID at all. There are
67          * several reasons for this:
68          *
69          * 1) The time-based algorithm makes use of a daemon process (uuidd) in order
70          * to ensure that any concurrent requests for UUIDs result in unique results.
71          * Use of this daemon is a bit dodgy for a few reasons
72          *
73          *     a) libuuid assumes a hardcoded location for the .pid file of the daemon.
74          *     However, the daemon could already be running on the system in a different
75          *     location than expected. If this is the case, then attempting to connect
76          *     to the daemon will fail, and attempting to launch another instance in
77          *     the expected location will also fail.
78          *
79          *     b) If the daemon is not running, then the first attempt to create a
80          *     time-based UUID will result in launching the daemon. Because of the hard-
81          *     coded locations that libuuid assumes for the daemon, Asterisk must be
82          *     run with permissions that will allow for the daemon to be launched in
83          *     the expected directories.
84          *
85          *     c) Once the daemon is running, concurrent requests for UUIDs are thread-safe.
86          *     However, the actual launching of the daemon is not thread-safe since libuuid
87          *     uses no synchronization primitives to ensure that only one thread (or process)
88          *     launches the daemon.
89          *
90          *     d) When libuuid launches the daemon, it sets an inactivity timer.
91          *     If no UUID generation requests are issued in that time period,
92          *     then the daemon will exit. If a new request should occur after the daemon
93          *     exits, then the daemon will be relaunched. Given point c), we cannot
94          *     necessarily guarantee the thread-safety of time-based UUID generation since
95          *     we cannot necessarily guarantee the daemon is running as we expect.
96          *     We could set up a watchdog thread to generate UUIDs at regular intervals to
97          *     prevent the daemon from exiting, but frankly, that sucks.
98          *
99          * 2) Since the MAC address of the Ethernet interface is part of the UUID when
100          * using the time-based method, there is information leaked.
101          *
102          * Given these drawbacks, we stick to only using random UUIDs. The chance of /dev/random
103          * or /dev/urandom not existing on systems in this age is next to none.
104          */
105
106         /* XXX Currently, we only protect this call if the user has no /dev/urandon on their system.
107          * If it turns out that there are issues with UUID generation despite the presence of
108          * /dev/urandom, then we may need to make the locking/unlocking unconditional.
109          */
110         if (!has_dev_urandom) {
111                 ast_mutex_lock(&uuid_lock);
112         }
113         uuid_generate_random(uuid->uu);
114         if (!has_dev_urandom) {
115                 ast_mutex_unlock(&uuid_lock);
116         }
117         return uuid;
118 }
119
120 char *ast_uuid_to_str(const struct ast_uuid *uuid, char *buf, size_t size)
121 {
122         ast_assert(size >= AST_UUID_STR_LEN);
123         uuid_unparse_lower(uuid->uu, buf);
124         return buf;
125 }
126
127 struct ast_uuid *ast_str_to_uuid(const char *str)
128 {
129         struct ast_uuid *uuid = ast_malloc(sizeof(*uuid));
130         int res;
131         if (!uuid) {
132                 return NULL;
133         }
134         res = uuid_parse(str, uuid->uu);
135         if (res) {
136                 ast_log(LOG_WARNING, "Unable to convert string %s into a UUID\n", str);
137                 ast_free(uuid);
138                 return NULL;
139         }
140         return uuid;
141 }
142
143 struct ast_uuid *ast_uuid_copy(const struct ast_uuid *src)
144 {
145         struct ast_uuid *dst = ast_malloc(sizeof(*dst));
146         if (!dst) {
147                 return NULL;
148         }
149         uuid_copy(dst->uu, src->uu);
150         return dst;
151 }
152
153 int ast_uuid_compare(const struct ast_uuid *left, const struct ast_uuid *right)
154 {
155         return uuid_compare(left->uu, right->uu);
156 }
157
158 void ast_uuid_clear(struct ast_uuid *uuid)
159 {
160         uuid_clear(uuid->uu);
161 }
162
163 int ast_uuid_is_nil(const struct ast_uuid *uuid)
164 {
165         return uuid_is_null(uuid->uu);
166 }
167
168 void ast_uuid_init(void)
169 {
170         /* This requires some explanation.
171          *
172          * libuuid generates UUIDs based on random number generation. This involves
173          * opening a handle to /dev/urandom or /dev/random in order to get random
174          * data for the UUIDs.
175          *
176          * This is thread-safe, to a point. The problem is that the first attempt
177          * to generate a UUID will result in opening the random number handle. Once
178          * the handle is opened, all further generation is thread safe. This
179          * first generation can be potentially risky if multiple threads attempt
180          * to generate a UUID at the same time, though, since there is no thread
181          * synchronization used within libuuid. To get around this potential
182          * issue, we go ahead and generate a UUID up front so that the underlying
183          * work is done before we start requesting UUIDs for real.
184          *
185          * Think of this along the same lines as initializing a singleton.
186          */
187         uuid_t uu;
188         int dev_urandom_fd;
189
190         dev_urandom_fd = open("/dev/urandom", O_RDONLY);
191         if (dev_urandom_fd < 0) {
192                 ast_log(LOG_WARNING, "It appears your system does not have /dev/urandom on it. This\n"
193                                 "means that UUID generation will use a pseudorandom number generator. Since\n"
194                                 "the thread-safety of your system's random number generator cannot\n"
195                                 "be guaranteed, we have to synchronize UUID generation. This may result\n"
196                                 "in decreased performance. It is highly recommended that you set up your\n"
197                                 "system to have /dev/urandom\n");
198         } else {
199                 has_dev_urandom = 1;
200                 close(dev_urandom_fd);
201         }
202         uuid_generate_random(uu);
203
204         ast_debug(1, "UUID system initiated\n");
205         return;
206 }