librpc/ndr/uuid.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    UUID/GUID functions
   5
   6    Copyright (C) Theodore Ts'o               1996, 1997,
   7    Copyright (C) Jim McDonough                     2002.
   8    Copyright (C) Andrew Tridgell                   2003.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #include "includes.h"
  25 #include "librpc/ndr/libndr.h"
  26 #include "librpc/gen_ndr/ndr_misc.h"
  27
  28 /**
  29   build a NDR blob from a GUID
  30 */
  31 _PUBLIC_ NTSTATUS GUID_to_ndr_blob(const struct GUID *guid, TALLOC_CTX *mem_ctx, DATA_BLOB *b)
  32 {
  33         enum ndr_err_code ndr_err;
  34         ndr_err = ndr_push_struct_blob(b, mem_ctx, guid,
  35                                        (ndr_push_flags_fn_t)ndr_push_GUID);
  36         return ndr_map_error2ntstatus(ndr_err);
  37 }
  38
  39
  40 /**
  41   build a GUID from a NDR data blob
  42 */
  43 _PUBLIC_ NTSTATUS GUID_from_ndr_blob(const DATA_BLOB *b, struct GUID *guid)
  44 {
  45         enum ndr_err_code ndr_err;
  46         TALLOC_CTX *mem_ctx;
  47
  48         mem_ctx = talloc_new(NULL);
  49         NT_STATUS_HAVE_NO_MEMORY(mem_ctx);
  50
  51         ndr_err = ndr_pull_struct_blob_all(b, mem_ctx, guid,
  52                                            (ndr_pull_flags_fn_t)ndr_pull_GUID);
  53         talloc_free(mem_ctx);
  54         return ndr_map_error2ntstatus(ndr_err);
  55 }
  56
  57
  58 /**
  59   build a GUID from a string
  60 */
  61 _PUBLIC_ NTSTATUS GUID_from_data_blob(const DATA_BLOB *s, struct GUID *guid)
  62 {
  63         NTSTATUS status = NT_STATUS_INVALID_PARAMETER;
  64         uint32_t time_low;
  65         uint32_t time_mid, time_hi_and_version;
  66         uint32_t clock_seq[2];
  67         uint32_t node[6];
  68         uint8_t buf16[16];
  69
  70         DATA_BLOB blob16 = data_blob_const(buf16, sizeof(buf16));
  71         int i;
  72
  73         if (s->data == NULL) {
  74                 return NT_STATUS_INVALID_PARAMETER;
  75         }
  76
  77         switch(s->length) {
  78         case 36:
  79         {
  80                 TALLOC_CTX *mem_ctx;
  81                 const char *string;
  82
  83                 mem_ctx = talloc_new(NULL);
  84                 NT_STATUS_HAVE_NO_MEMORY(mem_ctx);
  85                 string = talloc_strndup(mem_ctx, (const char *)s->data, s->length);
  86                 NT_STATUS_HAVE_NO_MEMORY(string);
  87                 if (11 == sscanf(string,
  88                                  "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
  89                                  &time_low, &time_mid, &time_hi_and_version,
  90                                  &clock_seq[0], &clock_seq[1],
  91                                  &node[0], &node[1], &node[2], &node[3], &node[4], &node[5])) {
  92                         status = NT_STATUS_OK;
  93                 }
  94                 talloc_free(mem_ctx);
  95                 break;
  96         }
  97         case 38:
  98         {
  99                 TALLOC_CTX *mem_ctx;
 100                 const char *string;
 101
 102                 mem_ctx = talloc_new(NULL);
 103                 NT_STATUS_HAVE_NO_MEMORY(mem_ctx);
 104                 string = talloc_strndup(mem_ctx, (const char *)s->data, s->length);
 105                 NT_STATUS_HAVE_NO_MEMORY(string);
 106                 if (11 == sscanf((const char *)s->data,
 107                                  "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
 108                                  &time_low, &time_mid, &time_hi_and_version,
 109                                  &clock_seq[0], &clock_seq[1],
 110                                  &node[0], &node[1], &node[2], &node[3], &node[4], &node[5])) {
 111                         status = NT_STATUS_OK;
 112                 }
 113                 talloc_free(mem_ctx);
 114                 break;
 115         }
 116         case 32:
 117         {
 118                 size_t rlen = strhex_to_str((char *)blob16.data, blob16.length,
 119                                             (const char *)s->data, s->length);
 120                 if (rlen != blob16.length) {
 121                         return NT_STATUS_INVALID_PARAMETER;
 122                 }
 123
 124                 s = &blob16;
 125                 return GUID_from_ndr_blob(s, guid);
 126         }
 127         case 16:
 128                 return GUID_from_ndr_blob(s, guid);
 129         default:
 130                 status = NT_STATUS_INVALID_PARAMETER;
 131                 break;
 132         }
 133
 134         if (!NT_STATUS_IS_OK(status)) {
 135                 return status;
 136         }
 137
 138         guid->time_low = time_low;
 139         guid->time_mid = time_mid;
 140         guid->time_hi_and_version = time_hi_and_version;
 141         guid->clock_seq[0] = clock_seq[0];
 142         guid->clock_seq[1] = clock_seq[1];
 143         for (i=0;i<6;i++) {
 144                 guid->node[i] = node[i];
 145         }
 146
 147         return NT_STATUS_OK;
 148 }
 149
 150 /**
 151   build a GUID from a string
 152 */
 153 _PUBLIC_ NTSTATUS GUID_from_string(const char *s, struct GUID *guid)
 154 {
 155         DATA_BLOB blob = data_blob_string_const(s);
 156         return GUID_from_data_blob(&blob, guid);
 157 }
 158
 159 /**
 160  * generate a random GUID
 161  */
 162 _PUBLIC_ struct GUID GUID_random(void)
 163 {
 164         struct GUID guid;
 165
 166         generate_random_buffer((uint8_t *)&guid, sizeof(guid));
 167         guid.clock_seq[0] = (guid.clock_seq[0] & 0x3F) | 0x80;
 168         guid.time_hi_and_version = (guid.time_hi_and_version & 0x0FFF) | 0x4000;
 169
 170         return guid;
 171 }
 172
 173 /**
 174  * generate an empty GUID
 175  */
 176 _PUBLIC_ struct GUID GUID_zero(void)
 177 {
 178         struct GUID guid;
 179
 180         ZERO_STRUCT(guid);
 181
 182         return guid;
 183 }
 184
 185 _PUBLIC_ bool GUID_all_zero(const struct GUID *u)
 186 {
 187         if (u->time_low != 0 ||
 188             u->time_mid != 0 ||
 189             u->time_hi_and_version != 0 ||
 190             u->clock_seq[0] != 0 ||
 191             u->clock_seq[1] != 0 ||
 192             !all_zero(u->node, 6)) {
 193                 return false;
 194         }
 195         return true;
 196 }
 197
 198 _PUBLIC_ bool GUID_equal(const struct GUID *u1, const struct GUID *u2)
 199 {
 200         return (GUID_compare(u1, u2) == 0);
 201 }
 202
 203 _PUBLIC_ int GUID_compare(const struct GUID *u1, const struct GUID *u2)
 204 {
 205         if (u1->time_low != u2->time_low) {
 206                 return u1->time_low > u2->time_low ? 1 : -1;
 207         }
 208
 209         if (u1->time_mid != u2->time_mid) {
 210                 return u1->time_mid > u2->time_mid ? 1 : -1;
 211         }
 212
 213         if (u1->time_hi_and_version != u2->time_hi_and_version) {
 214                 return u1->time_hi_and_version > u2->time_hi_and_version ? 1 : -1;
 215         }
 216
 217         if (u1->clock_seq[0] != u2->clock_seq[0]) {
 218                 return u1->clock_seq[0] > u2->clock_seq[0] ? 1 : -1;
 219         }
 220
 221         if (u1->clock_seq[1] != u2->clock_seq[1]) {
 222                 return u1->clock_seq[1] > u2->clock_seq[1] ? 1 : -1;
 223         }
 224
 225         return memcmp(u1->node, u2->node, 6);
 226 }
 227
 228 /**
 229   its useful to be able to display these in debugging messages
 230 */
 231 _PUBLIC_ char *GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid)
 232 {
 233         struct GUID_txt_buf buf;
 234         return talloc_strdup(mem_ctx, GUID_buf_string(guid, &buf));
 235 }
 236
 237 /**
 238  * Does the same without allocating memory, using the structure buffer.
 239  * Useful for debug messages, so that you do not have to talloc_free the result
 240  */
 241 _PUBLIC_ char* GUID_buf_string(const struct GUID *guid,
 242                                struct GUID_txt_buf *dst)
 243 {
 244         if (!guid) {
 245                 return NULL;
 246         }
 247         snprintf(dst->buf, sizeof(dst->buf),
 248                  "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
 249                  guid->time_low, guid->time_mid,
 250                  guid->time_hi_and_version,
 251                  guid->clock_seq[0],
 252                  guid->clock_seq[1],
 253                  guid->node[0], guid->node[1],
 254                  guid->node[2], guid->node[3],
 255                  guid->node[4], guid->node[5]);
 256         return dst->buf;
 257 }
 258
 259 _PUBLIC_ char *GUID_string2(TALLOC_CTX *mem_ctx, const struct GUID *guid)
 260 {
 261         char *ret, *s = GUID_string(mem_ctx, guid);
 262         ret = talloc_asprintf(mem_ctx, "{%s}", s);
 263         talloc_free(s);
 264         return ret;
 265 }
 266
 267 _PUBLIC_ char *GUID_hexstring(TALLOC_CTX *mem_ctx, const struct GUID *guid)
 268 {
 269         char *ret;
 270         DATA_BLOB guid_blob;
 271         TALLOC_CTX *tmp_mem;
 272         NTSTATUS status;
 273
 274         tmp_mem = talloc_new(mem_ctx);
 275         if (!tmp_mem) {
 276                 return NULL;
 277         }
 278         status = GUID_to_ndr_blob(guid, tmp_mem, &guid_blob);
 279         if (!NT_STATUS_IS_OK(status)) {
 280                 talloc_free(tmp_mem);
 281                 return NULL;
 282         }
 283
 284         ret = data_blob_hex_string_upper(mem_ctx, &guid_blob);
 285         talloc_free(tmp_mem);
 286         return ret;
 287 }
 288
 289 _PUBLIC_ bool ndr_policy_handle_empty(const struct policy_handle *h)
 290 {
 291         return (h->handle_type == 0 && GUID_all_zero(&h->uuid));
 292 }
 293
 294 _PUBLIC_ bool ndr_policy_handle_equal(const struct policy_handle *hnd1,
 295                                   const struct policy_handle *hnd2)
 296 {
 297         if (!hnd1 || !hnd2) {
 298                 return false;
 299         }
 300
 301         return (memcmp(hnd1, hnd2, sizeof(*hnd1)) == 0);
 302 }