r25175: Change to talloc_asprintf_append_buffer().
[jelmer/samba4-debian.git] / source / libcli / util / asn1.c
1 /* 
2    Unix SMB/CIFS implementation.
3    simple SPNEGO routines
4    Copyright (C) Andrew Tridgell 2001
5    
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "includes.h"
21 #include "libcli/util/asn_1.h"
22
23 /* allocate an asn1 structure */
24 struct asn1_data *asn1_init(TALLOC_CTX *mem_ctx)
25 {
26         struct asn1_data *ret = talloc_zero(mem_ctx, struct asn1_data);
27         if (ret == NULL) {
28                 DEBUG(0,("asn1_init failed! out of memory\n"));
29         }
30         return ret;
31 }
32
33 /* free an asn1 structure */
34 void asn1_free(struct asn1_data *data)
35 {
36         talloc_free(data);
37 }
38
39 /* write to the ASN1 buffer, advancing the buffer pointer */
40 BOOL asn1_write(struct asn1_data *data, const void *p, int len)
41 {
42         if (data->has_error) return False;
43         if (data->length < data->ofs+len) {
44                 uint8_t *newp;
45                 newp = talloc_realloc(data, data->data, uint8_t, data->ofs+len);
46                 if (!newp) {
47                         asn1_free(data);
48                         data->has_error = True;
49                         return False;
50                 }
51                 data->data = newp;
52                 data->length = data->ofs+len;
53         }
54         memcpy(data->data + data->ofs, p, len);
55         data->ofs += len;
56         return True;
57 }
58
59 /* useful fn for writing a uint8_t */
60 BOOL asn1_write_uint8(struct asn1_data *data, uint8_t v)
61 {
62         return asn1_write(data, &v, 1);
63 }
64
65 /* push a tag onto the asn1 data buffer. Used for nested structures */
66 BOOL asn1_push_tag(struct asn1_data *data, uint8_t tag)
67 {
68         struct nesting *nesting;
69
70         asn1_write_uint8(data, tag);
71         nesting = talloc(data, struct nesting);
72         if (!nesting) {
73                 data->has_error = True;
74                 return False;
75         }
76
77         nesting->start = data->ofs;
78         nesting->next = data->nesting;
79         data->nesting = nesting;
80         return asn1_write_uint8(data, 0xff);
81 }
82
83 /* pop a tag */
84 BOOL asn1_pop_tag(struct asn1_data *data)
85 {
86         struct nesting *nesting;
87         size_t len;
88
89         nesting = data->nesting;
90
91         if (!nesting) {
92                 data->has_error = True;
93                 return False;
94         }
95         len = data->ofs - (nesting->start+1);
96         /* yes, this is ugly. We don't know in advance how many bytes the length
97            of a tag will take, so we assumed 1 byte. If we were wrong then we 
98            need to correct our mistake */
99         if (len > 0xFFFFFF) {
100                 data->data[nesting->start] = 0x84;
101                 if (!asn1_write_uint8(data, 0)) return False;
102                 if (!asn1_write_uint8(data, 0)) return False;
103                 if (!asn1_write_uint8(data, 0)) return False;
104                 if (!asn1_write_uint8(data, 0)) return False;
105                 memmove(data->data+nesting->start+5, data->data+nesting->start+1, len);
106                 data->data[nesting->start+1] = (len>>24) & 0xFF;
107                 data->data[nesting->start+2] = (len>>16) & 0xFF;
108                 data->data[nesting->start+3] = (len>>8) & 0xFF;
109                 data->data[nesting->start+4] = len&0xff;
110         } else if (len > 0xFFFF) {
111                 data->data[nesting->start] = 0x83;
112                 if (!asn1_write_uint8(data, 0)) return False;
113                 if (!asn1_write_uint8(data, 0)) return False;
114                 if (!asn1_write_uint8(data, 0)) return False;
115                 memmove(data->data+nesting->start+4, data->data+nesting->start+1, len);
116                 data->data[nesting->start+1] = (len>>16) & 0xFF;
117                 data->data[nesting->start+2] = (len>>8) & 0xFF;
118                 data->data[nesting->start+3] = len&0xff;
119         } else if (len > 255) {
120                 data->data[nesting->start] = 0x82;
121                 if (!asn1_write_uint8(data, 0)) return False;
122                 if (!asn1_write_uint8(data, 0)) return False;
123                 memmove(data->data+nesting->start+3, data->data+nesting->start+1, len);
124                 data->data[nesting->start+1] = len>>8;
125                 data->data[nesting->start+2] = len&0xff;
126         } else if (len > 127) {
127                 data->data[nesting->start] = 0x81;
128                 if (!asn1_write_uint8(data, 0)) return False;
129                 memmove(data->data+nesting->start+2, data->data+nesting->start+1, len);
130                 data->data[nesting->start+1] = len;
131         } else {
132                 data->data[nesting->start] = len;
133         }
134
135         data->nesting = nesting->next;
136         talloc_free(nesting);
137         return True;
138 }
139
140 /* "i" is the one's complement representation, as is the normal result of an
141  * implicit signed->unsigned conversion */
142
143 static BOOL push_int_bigendian(struct asn1_data *data, unsigned int i, BOOL negative)
144 {
145         uint8_t lowest = i & 0xFF;
146
147         i = i >> 8;
148         if (i != 0)
149                 if (!push_int_bigendian(data, i, negative))
150                         return False;
151
152         if (data->nesting->start+1 == data->ofs) {
153
154                 /* We did not write anything yet, looking at the highest
155                  * valued byte */
156
157                 if (negative) {
158                         /* Don't write leading 0xff's */
159                         if (lowest == 0xFF)
160                                 return True;
161
162                         if ((lowest & 0x80) == 0) {
163                                 /* The only exception for a leading 0xff is if
164                                  * the highest bit is 0, which would indicate
165                                  * a positive value */
166                                 if (!asn1_write_uint8(data, 0xff))
167                                         return False;
168                         }
169                 } else {
170                         if (lowest & 0x80) {
171                                 /* The highest bit of a positive integer is 1,
172                                  * this would indicate a negative number. Push
173                                  * a 0 to indicate a positive one */
174                                 if (!asn1_write_uint8(data, 0))
175                                         return False;
176                         }
177                 }
178         }
179
180         return asn1_write_uint8(data, lowest);
181 }
182
183 /* write an Integer without the tag framing. Needed for example for the LDAP
184  * Abandon Operation */
185
186 BOOL asn1_write_implicit_Integer(struct asn1_data *data, int i)
187 {
188         if (i == -1) {
189                 /* -1 is special as it consists of all-0xff bytes. In
190                     push_int_bigendian this is the only case that is not
191                     properly handled, as all 0xff bytes would be handled as
192                     leading ones to be ignored. */
193                 return asn1_write_uint8(data, 0xff);
194         } else {
195                 return push_int_bigendian(data, i, i<0);
196         }
197 }
198
199
200 /* write an integer */
201 BOOL asn1_write_Integer(struct asn1_data *data, int i)
202 {
203         if (!asn1_push_tag(data, ASN1_INTEGER)) return False;
204         if (!asn1_write_implicit_Integer(data, i)) return False;
205         return asn1_pop_tag(data);
206 }
207
208 BOOL ber_write_OID_String(DATA_BLOB *blob, const char *OID)
209 {
210         uint_t v, v2;
211         const char *p = (const char *)OID;
212         char *newp;
213         int i;
214
215         v = strtoul(p, &newp, 10);
216         if (newp[0] != '.') return False;
217         p = newp + 1;
218
219         v2 = strtoul(p, &newp, 10);
220         if (newp[0] != '.') return False;
221         p = newp + 1;
222
223         /*the ber representation can't use more space then the string one */
224         *blob = data_blob(NULL, strlen(OID));
225         if (!blob->data) return False;
226
227         blob->data[0] = 40*v + v2;
228
229         i = 1;
230         while (*p) {
231                 v = strtoul(p, &newp, 10);
232                 if (newp[0] == '.') {
233                         p = newp + 1;
234                 } else if (newp[0] == '\0') {
235                         p = newp;
236                 } else {
237                         data_blob_free(blob);
238                         return False;
239                 }
240                 if (v >= (1<<28)) blob->data[i++] = (0x80 | ((v>>28)&0x7f));
241                 if (v >= (1<<21)) blob->data[i++] = (0x80 | ((v>>21)&0x7f));
242                 if (v >= (1<<14)) blob->data[i++] = (0x80 | ((v>>14)&0x7f));
243                 if (v >= (1<<7)) blob->data[i++] = (0x80 | ((v>>7)&0x7f));
244                 blob->data[i++] = (v&0x7f);
245         }
246
247         blob->length = i;
248
249         return True;
250 }
251
252 /* write an object ID to a ASN1 buffer */
253 BOOL asn1_write_OID(struct asn1_data *data, const char *OID)
254 {
255         DATA_BLOB blob;
256
257         if (!asn1_push_tag(data, ASN1_OID)) return False;
258
259         if (!ber_write_OID_String(&blob, OID)) {
260                 data->has_error = True;
261                 return False;
262         }
263
264         if (!asn1_write(data, blob.data, blob.length)) {
265                 data->has_error = True;
266                 return False;
267         }
268         data_blob_free(&blob);
269         return asn1_pop_tag(data);
270 }
271
272 /* write an octet string */
273 BOOL asn1_write_OctetString(struct asn1_data *data, const void *p, size_t length)
274 {
275         asn1_push_tag(data, ASN1_OCTET_STRING);
276         asn1_write(data, p, length);
277         asn1_pop_tag(data);
278         return !data->has_error;
279 }
280
281 /* write a LDAP string */
282 BOOL asn1_write_LDAPString(struct asn1_data *data, const char *s)
283 {
284         asn1_write(data, s, strlen(s));
285         return !data->has_error;
286 }
287
288 /* write a general string */
289 BOOL asn1_write_GeneralString(struct asn1_data *data, const char *s)
290 {
291         asn1_push_tag(data, ASN1_GENERAL_STRING);
292         asn1_write_LDAPString(data, s);
293         asn1_pop_tag(data);
294         return !data->has_error;
295 }
296
297 BOOL asn1_write_ContextSimple(struct asn1_data *data, uint8_t num, DATA_BLOB *blob)
298 {
299         asn1_push_tag(data, ASN1_CONTEXT_SIMPLE(num));
300         asn1_write(data, blob->data, blob->length);
301         asn1_pop_tag(data);
302         return !data->has_error;
303 }
304
305 /* write a BOOLEAN */
306 BOOL asn1_write_BOOLEAN(struct asn1_data *data, BOOL v)
307 {
308         asn1_push_tag(data, ASN1_BOOLEAN);
309         asn1_write_uint8(data, v ? 0xFF : 0);
310         asn1_pop_tag(data);
311         return !data->has_error;
312 }
313
314 BOOL asn1_read_BOOLEAN(struct asn1_data *data, BOOL *v)
315 {
316         uint8_t tmp = 0;
317         asn1_start_tag(data, ASN1_BOOLEAN);
318         asn1_read_uint8(data, &tmp);
319         if (tmp == 0xFF) {
320                 *v = True;
321         } else {
322                 *v = False;
323         }
324         asn1_end_tag(data);
325         return !data->has_error;
326 }
327
328 /* check a BOOLEAN */
329 BOOL asn1_check_BOOLEAN(struct asn1_data *data, BOOL v)
330 {
331         uint8_t b = 0;
332
333         asn1_read_uint8(data, &b);
334         if (b != ASN1_BOOLEAN) {
335                 data->has_error = True;
336                 return False;
337         }
338         asn1_read_uint8(data, &b);
339         if (b != v) {
340                 data->has_error = True;
341                 return False;
342         }
343         return !data->has_error;
344 }
345
346
347 /* load a struct asn1_data structure with a lump of data, ready to be parsed */
348 BOOL asn1_load(struct asn1_data *data, DATA_BLOB blob)
349 {
350         ZERO_STRUCTP(data);
351         data->data = talloc_memdup(data, blob.data, blob.length);
352         if (!data->data) {
353                 data->has_error = True;
354                 return False;
355         }
356         data->length = blob.length;
357         return True;
358 }
359
360 /* Peek into an ASN1 buffer, not advancing the pointer */
361 BOOL asn1_peek(struct asn1_data *data, void *p, int len)
362 {
363         if (len < 0 || data->ofs + len < data->ofs || data->ofs + len < len)
364                 return False;
365
366         if (data->ofs + len > data->length) {
367                 /* we need to mark the buffer as consumed, so the caller knows
368                    this was an out of data error, and not a decode error */
369                 data->ofs = data->length;
370                 return False;
371         }
372
373         memcpy(p, data->data + data->ofs, len);
374         return True;
375 }
376
377 /* read from a ASN1 buffer, advancing the buffer pointer */
378 BOOL asn1_read(struct asn1_data *data, void *p, int len)
379 {
380         if (!asn1_peek(data, p, len)) {
381                 data->has_error = True;
382                 return False;
383         }
384
385         data->ofs += len;
386         return True;
387 }
388
389 /* read a uint8_t from a ASN1 buffer */
390 BOOL asn1_read_uint8(struct asn1_data *data, uint8_t *v)
391 {
392         return asn1_read(data, v, 1);
393 }
394
395 BOOL asn1_peek_uint8(struct asn1_data *data, uint8_t *v)
396 {
397         return asn1_peek(data, v, 1);
398 }
399
400 BOOL asn1_peek_tag(struct asn1_data *data, uint8_t tag)
401 {
402         uint8_t b;
403
404         if (asn1_tag_remaining(data) <= 0) {
405                 return False;
406         }
407
408         if (!asn1_peek(data, &b, sizeof(b)))
409                 return False;
410
411         return (b == tag);
412 }
413
414 /* start reading a nested asn1 structure */
415 BOOL asn1_start_tag(struct asn1_data *data, uint8_t tag)
416 {
417         uint8_t b;
418         struct nesting *nesting;
419         
420         if (!asn1_read_uint8(data, &b))
421                 return False;
422
423         if (b != tag) {
424                 data->has_error = True;
425                 return False;
426         }
427         nesting = talloc(data, struct nesting);
428         if (!nesting) {
429                 data->has_error = True;
430                 return False;
431         }
432
433         if (!asn1_read_uint8(data, &b)) {
434                 return False;
435         }
436
437         if (b & 0x80) {
438                 int n = b & 0x7f;
439                 if (!asn1_read_uint8(data, &b))
440                         return False;
441                 nesting->taglen = b;
442                 while (n > 1) {
443                         if (!asn1_read_uint8(data, &b)) 
444                                 return False;
445                         nesting->taglen = (nesting->taglen << 8) | b;
446                         n--;
447                 }
448         } else {
449                 nesting->taglen = b;
450         }
451         nesting->start = data->ofs;
452         nesting->next = data->nesting;
453         data->nesting = nesting;
454         if (asn1_tag_remaining(data) == -1) {
455                 return False;
456         }
457         return !data->has_error;
458 }
459
460 /* stop reading a tag */
461 BOOL asn1_end_tag(struct asn1_data *data)
462 {
463         struct nesting *nesting;
464
465         /* make sure we read it all */
466         if (asn1_tag_remaining(data) != 0) {
467                 data->has_error = True;
468                 return False;
469         }
470
471         nesting = data->nesting;
472
473         if (!nesting) {
474                 data->has_error = True;
475                 return False;
476         }
477
478         data->nesting = nesting->next;
479         talloc_free(nesting);
480         return True;
481 }
482
483 /* work out how many bytes are left in this nested tag */
484 int asn1_tag_remaining(struct asn1_data *data)
485 {
486         int remaining;
487         if (data->has_error) {
488                 return -1;
489         }
490
491         if (!data->nesting) {
492                 data->has_error = True;
493                 return -1;
494         }
495         remaining = data->nesting->taglen - (data->ofs - data->nesting->start);
496         if (remaining > (data->length - data->ofs)) {
497                 data->has_error = True;
498                 return -1;
499         }
500         return remaining;
501 }
502
503 /* read an object ID from a data blob */
504 BOOL ber_read_OID_String(TALLOC_CTX *mem_ctx, DATA_BLOB blob, const char **OID)
505 {
506         int i;
507         uint8_t *b;
508         uint_t v;
509         char *tmp_oid = NULL;
510
511         if (blob.length < 2) return False;
512
513         b = blob.data;
514
515         tmp_oid = talloc_asprintf(mem_ctx, "%u",  b[0]/40);
516         if (!tmp_oid) goto nomem;
517         tmp_oid = talloc_asprintf_append_buffer(tmp_oid, ".%u",  b[0]%40);
518         if (!tmp_oid) goto nomem;
519
520         for(i = 1, v = 0; i < blob.length; i++) {
521                 v = (v<<7) | (b[i]&0x7f);
522                 if ( ! (b[i] & 0x80)) {
523                         tmp_oid = talloc_asprintf_append_buffer(tmp_oid, ".%u",  v);
524                         v = 0;
525                 }
526                 if (!tmp_oid) goto nomem;
527         }
528
529         if (v != 0) {
530                 talloc_free(tmp_oid);
531                 return False;
532         }
533
534         *OID = tmp_oid;
535         return True;
536
537 nomem:  
538         return False;
539 }
540
541 /* read an object ID from a ASN1 buffer */
542 BOOL asn1_read_OID(struct asn1_data *data, TALLOC_CTX *mem_ctx, const char **OID)
543 {
544         DATA_BLOB blob;
545         int len;
546
547         if (!asn1_start_tag(data, ASN1_OID)) return False;
548
549         len = asn1_tag_remaining(data);
550         if (len < 0) {
551                 data->has_error = True;
552                 return False;
553         }
554
555         blob = data_blob(NULL, len);
556         if (!blob.data) {
557                 data->has_error = True;
558                 return False;
559         }
560
561         asn1_read(data, blob.data, len);
562         asn1_end_tag(data);
563         if (data->has_error) {
564                 data_blob_free(&blob);
565                 return False;
566         }
567
568         if (!ber_read_OID_String(mem_ctx, blob, OID)) {
569                 data->has_error = True;
570                 data_blob_free(&blob);
571                 return False;
572         }
573
574         data_blob_free(&blob);
575         return True;
576 }
577
578 /* check that the next object ID is correct */
579 BOOL asn1_check_OID(struct asn1_data *data, const char *OID)
580 {
581         const char *id;
582
583         if (!asn1_read_OID(data, data, &id)) return False;
584
585         if (strcmp(id, OID) != 0) {
586                 talloc_free(discard_const(id));
587                 data->has_error = True;
588                 return False;
589         }
590         talloc_free(discard_const(id));
591         return True;
592 }
593
594 /* read a LDAPString from a ASN1 buffer */
595 BOOL asn1_read_LDAPString(struct asn1_data *data, TALLOC_CTX *mem_ctx, char **s)
596 {
597         int len;
598         len = asn1_tag_remaining(data);
599         if (len < 0) {
600                 data->has_error = True;
601                 return False;
602         }
603         *s = talloc_array(mem_ctx, char, len+1);
604         if (! *s) {
605                 data->has_error = True;
606                 return False;
607         }
608         asn1_read(data, *s, len);
609         (*s)[len] = 0;
610         return !data->has_error;
611 }
612
613
614 /* read a GeneralString from a ASN1 buffer */
615 BOOL asn1_read_GeneralString(struct asn1_data *data, TALLOC_CTX *mem_ctx, char **s)
616 {
617         if (!asn1_start_tag(data, ASN1_GENERAL_STRING)) return False;
618         if (!asn1_read_LDAPString(data, mem_ctx, s)) return False;
619         return asn1_end_tag(data);
620 }
621
622
623 /* read a octet string blob */
624 BOOL asn1_read_OctetString(struct asn1_data *data, TALLOC_CTX *mem_ctx, DATA_BLOB *blob)
625 {
626         int len;
627         ZERO_STRUCTP(blob);
628         if (!asn1_start_tag(data, ASN1_OCTET_STRING)) return False;
629         len = asn1_tag_remaining(data);
630         if (len < 0) {
631                 data->has_error = True;
632                 return False;
633         }
634         *blob = data_blob_talloc(mem_ctx, NULL, len+1);
635         if (!blob->data) {
636                 data->has_error = True;
637                 return False;
638         }
639         asn1_read(data, blob->data, len);
640         asn1_end_tag(data);
641         blob->length--;
642         blob->data[len] = 0;
643         
644         if (data->has_error) {
645                 data_blob_free(blob);
646                 *blob = data_blob(NULL, 0);
647                 return False;
648         }
649         return True;
650 }
651
652 BOOL asn1_read_ContextSimple(struct asn1_data *data, uint8_t num, DATA_BLOB *blob)
653 {
654         int len;
655         ZERO_STRUCTP(blob);
656         if (!asn1_start_tag(data, ASN1_CONTEXT_SIMPLE(num))) return False;
657         len = asn1_tag_remaining(data);
658         if (len < 0) {
659                 data->has_error = True;
660                 return False;
661         }
662         *blob = data_blob(NULL, len);
663         if ((len != 0) && (!blob->data)) {
664                 data->has_error = True;
665                 return False;
666         }
667         asn1_read(data, blob->data, len);
668         asn1_end_tag(data);
669         return !data->has_error;
670 }
671
672 /* read an interger without tag*/
673 BOOL asn1_read_implicit_Integer(struct asn1_data *data, int *i)
674 {
675         uint8_t b;
676         *i = 0;
677
678         while (!data->has_error && asn1_tag_remaining(data)>0) {
679                 if (!asn1_read_uint8(data, &b)) return False;
680                 *i = (*i << 8) + b;
681         }
682         return !data->has_error;        
683         
684 }
685
686 /* read an interger */
687 BOOL asn1_read_Integer(struct asn1_data *data, int *i)
688 {
689         *i = 0;
690
691         if (!asn1_start_tag(data, ASN1_INTEGER)) return False;
692         if (!asn1_read_implicit_Integer(data, i)) return False;
693         return asn1_end_tag(data);      
694 }
695
696 /* read an interger */
697 BOOL asn1_read_enumerated(struct asn1_data *data, int *v)
698 {
699         *v = 0;
700         
701         if (!asn1_start_tag(data, ASN1_ENUMERATED)) return False;
702         while (!data->has_error && asn1_tag_remaining(data)>0) {
703                 uint8_t b;
704                 asn1_read_uint8(data, &b);
705                 *v = (*v << 8) + b;
706         }
707         return asn1_end_tag(data);      
708 }
709
710 /* check a enumarted value is correct */
711 BOOL asn1_check_enumerated(struct asn1_data *data, int v)
712 {
713         uint8_t b;
714         if (!asn1_start_tag(data, ASN1_ENUMERATED)) return False;
715         asn1_read_uint8(data, &b);
716         asn1_end_tag(data);
717
718         if (v != b)
719                 data->has_error = False;
720
721         return !data->has_error;
722 }
723
724 /* write an enumarted value to the stream */
725 BOOL asn1_write_enumerated(struct asn1_data *data, uint8_t v)
726 {
727         if (!asn1_push_tag(data, ASN1_ENUMERATED)) return False;
728         asn1_write_uint8(data, v);
729         asn1_pop_tag(data);
730         return !data->has_error;
731 }
732
733 /*
734   check if a ASN.1 blob is a full tag
735 */
736 NTSTATUS asn1_full_tag(DATA_BLOB blob, uint8_t tag, size_t *packet_size)
737 {
738         struct asn1_data *asn1 = asn1_init(NULL);
739         int size;
740
741         NT_STATUS_HAVE_NO_MEMORY(asn1);
742
743         asn1->data = blob.data;
744         asn1->length = blob.length;
745         asn1_start_tag(asn1, tag);
746         if (asn1->has_error) {
747                 talloc_free(asn1);
748                 return STATUS_MORE_ENTRIES;
749         }
750         size = asn1_tag_remaining(asn1) + asn1->ofs;
751
752         talloc_free(asn1);
753
754         if (size > blob.length) {
755                 return STATUS_MORE_ENTRIES;
756         }               
757
758         *packet_size = size;
759         return NT_STATUS_OK;
760 }