1 /* Copyright (c) 2008, 2009, 2010, 2011, 2013 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
24 #include <sys/types.h>
29 #include "ovs-thread.h"
34 static struct aes128 key
;
35 static uint64_t counter
[2];
36 BUILD_ASSERT_DECL(sizeof counter
== 16);
38 static void do_init(void);
41 * Initialize the UUID module. Aborts the program with an error message if
42 * initialization fails (which should never happen on a properly configured
45 * Currently initialization is only needed by uuid_generate(). uuid_generate()
46 * will automatically call uuid_init() itself, so it's only necessary to call
47 * this function explicitly if you want to abort the program earlier than the
48 * first UUID generation in case of failure.
53 static pthread_once_t once
= PTHREAD_ONCE_INIT
;
54 pthread_once(&once
, do_init
);
57 /* Generates a new random UUID in 'uuid'.
59 * We go to some trouble to ensure as best we can that the generated UUID has
62 * - Uniqueness. The random number generator is seeded using both the
63 * system clock and the system random number generator, plus a few
64 * other identifiers, which is about as good as we can get in any kind
67 * - Unpredictability. In some situations it could be bad for an
68 * adversary to be able to guess the next UUID to be generated with some
69 * probability of success. This property may or may not be important
70 * for our purposes, but it is better if we can get it.
72 * To ensure both of these, we start by taking our seed data and passing it
73 * through SHA-1. We use the result as an AES-128 key. We also generate a
74 * random 16-byte value[*] which we then use as the counter for CTR mode. To
75 * generate a UUID in a manner compliant with the above goals, we merely
76 * increment the counter and encrypt it.
78 * [*] It is not actually important that the initial value of the counter be
79 * random. AES-128 in counter mode is secure either way.
82 uuid_generate(struct uuid
*uuid
)
84 static pthread_mutex_t mutex
= PTHREAD_ADAPTIVE_MUTEX_INITIALIZER
;
89 /* Copy out the counter's current value, then increment it. */
90 xpthread_mutex_lock(&mutex
);
93 if (++counter
[1] == 0) {
96 xpthread_mutex_unlock(&mutex
);
98 /* AES output is exactly 16 bytes, so we encrypt directly into 'uuid'. */
99 aes128_encrypt(&key
, copy
, uuid
);
101 /* Set bits to indicate a random UUID. See RFC 4122 section 4.4. */
102 uuid
->parts
[2] &= ~0xc0000000;
103 uuid
->parts
[2] |= 0x80000000;
104 uuid
->parts
[1] &= ~0x0000f000;
105 uuid
->parts
[1] |= 0x00004000;
108 /* Sets 'uuid' to all-zero-bits. */
110 uuid_zero(struct uuid
*uuid
)
112 uuid
->parts
[0] = uuid
->parts
[1] = uuid
->parts
[2] = uuid
->parts
[3] = 0;
115 /* Returns true if 'uuid' is all zero, otherwise false. */
117 uuid_is_zero(const struct uuid
*uuid
)
119 return (!uuid
->parts
[0] && !uuid
->parts
[1]
120 && !uuid
->parts
[2] && !uuid
->parts
[3]);
123 /* Compares 'a' and 'b'. Returns a negative value if 'a < b', zero if 'a ==
124 * b', or positive if 'a > b'. The ordering is lexicographical order of the
125 * conventional way of writing out UUIDs as strings. */
127 uuid_compare_3way(const struct uuid
*a
, const struct uuid
*b
)
129 if (a
->parts
[0] != b
->parts
[0]) {
130 return a
->parts
[0] > b
->parts
[0] ? 1 : -1;
131 } else if (a
->parts
[1] != b
->parts
[1]) {
132 return a
->parts
[1] > b
->parts
[1] ? 1 : -1;
133 } else if (a
->parts
[2] != b
->parts
[2]) {
134 return a
->parts
[2] > b
->parts
[2] ? 1 : -1;
135 } else if (a
->parts
[3] != b
->parts
[3]) {
136 return a
->parts
[3] > b
->parts
[3] ? 1 : -1;
142 /* Attempts to convert string 's' into a UUID in 'uuid'. Returns true if
143 * successful, which will be the case only if 's' has the exact format
144 * specified by RFC 4122. Returns false on failure. On failure, 'uuid' will
145 * be set to all-zero-bits. */
147 uuid_from_string(struct uuid
*uuid
, const char *s
)
149 if (!uuid_from_string_prefix(uuid
, s
)) {
151 } else if (s
[UUID_LEN
] != '\0') {
159 /* Same as uuid_from_string() but s[UUID_LEN] is not required to be a null byte
160 * to succeed; that is, 's' need only begin with UUID syntax, not consist
163 uuid_from_string_prefix(struct uuid
*uuid
, const char *s
)
166 /* 012345678901234567890123456789012345 */
167 /* ------------------------------------ */
168 /* 00000000-1111-1111-2222-222233333333 */
172 uuid
->parts
[0] = hexits_value(s
, 8, &ok
);
173 if (!ok
|| s
[8] != '-') {
177 uuid
->parts
[1] = hexits_value(s
+ 9, 4, &ok
) << 16;
178 if (!ok
|| s
[13] != '-') {
182 uuid
->parts
[1] += hexits_value(s
+ 14, 4, &ok
);
183 if (!ok
|| s
[18] != '-') {
187 uuid
->parts
[2] = hexits_value(s
+ 19, 4, &ok
) << 16;
188 if (!ok
|| s
[23] != '-') {
192 uuid
->parts
[2] += hexits_value(s
+ 24, 4, &ok
);
197 uuid
->parts
[3] = hexits_value(s
+ 28, 8, &ok
);
211 uint8_t sha1
[SHA1_DIGEST_SIZE
];
212 struct sha1_ctx sha1_ctx
;
213 uint8_t random_seed
[16];
220 get_entropy_or_die(random_seed
, sizeof random_seed
);
227 /* Convert seed into key. */
228 sha1_init(&sha1_ctx
);
229 sha1_update(&sha1_ctx
, random_seed
, sizeof random_seed
);
230 sha1_update(&sha1_ctx
, &pid
, sizeof pid
);
231 sha1_update(&sha1_ctx
, &ppid
, sizeof ppid
);
232 sha1_update(&sha1_ctx
, &uid
, sizeof uid
);
233 sha1_update(&sha1_ctx
, &gid
, sizeof gid
);
234 sha1_final(&sha1_ctx
, sha1
);
237 BUILD_ASSERT(sizeof sha1
>= 16);
238 aes128_schedule(&key
, sha1
);
240 /* Generate initial counter. */
241 get_entropy_or_die(counter
, sizeof counter
);