check_chain_extensions(): Add check that Basic Constraints of CA cert are marked...
[openssl.git] / include / openssl / asn1.h
1 /*
2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef OPENSSL_ASN1_H
11 # define OPENSSL_ASN1_H
12 # pragma once
13
14 # include <openssl/macros.h>
15 # ifndef OPENSSL_NO_DEPRECATED_3_0
16 #  define HEADER_ASN1_H
17 # endif
18
19 # include <time.h>
20 # include <openssl/e_os2.h>
21 # include <openssl/opensslconf.h>
22 # include <openssl/bio.h>
23 # include <openssl/safestack.h>
24 # include <openssl/asn1err.h>
25 # include <openssl/symhacks.h>
26
27 # include <openssl/types.h>
28 # include <openssl/bn.h>
29
30 # ifdef OPENSSL_BUILD_SHLIBCRYPTO
31 #  undef OPENSSL_EXTERN
32 #  define OPENSSL_EXTERN OPENSSL_EXPORT
33 # endif
34
35 #ifdef  __cplusplus
36 extern "C" {
37 #endif
38
39 # define V_ASN1_UNIVERSAL                0x00
40 # define V_ASN1_APPLICATION              0x40
41 # define V_ASN1_CONTEXT_SPECIFIC         0x80
42 # define V_ASN1_PRIVATE                  0xc0
43
44 # define V_ASN1_CONSTRUCTED              0x20
45 # define V_ASN1_PRIMITIVE_TAG            0x1f
46 # define V_ASN1_PRIMATIVE_TAG /*compat*/ V_ASN1_PRIMITIVE_TAG
47
48 # define V_ASN1_APP_CHOOSE               -2/* let the recipient choose */
49 # define V_ASN1_OTHER                    -3/* used in ASN1_TYPE */
50 # define V_ASN1_ANY                      -4/* used in ASN1 template code */
51
52 # define V_ASN1_UNDEF                    -1
53 /* ASN.1 tag values */
54 # define V_ASN1_EOC                      0
55 # define V_ASN1_BOOLEAN                  1 /**/
56 # define V_ASN1_INTEGER                  2
57 # define V_ASN1_BIT_STRING               3
58 # define V_ASN1_OCTET_STRING             4
59 # define V_ASN1_NULL                     5
60 # define V_ASN1_OBJECT                   6
61 # define V_ASN1_OBJECT_DESCRIPTOR        7
62 # define V_ASN1_EXTERNAL                 8
63 # define V_ASN1_REAL                     9
64 # define V_ASN1_ENUMERATED               10
65 # define V_ASN1_UTF8STRING               12
66 # define V_ASN1_SEQUENCE                 16
67 # define V_ASN1_SET                      17
68 # define V_ASN1_NUMERICSTRING            18 /**/
69 # define V_ASN1_PRINTABLESTRING          19
70 # define V_ASN1_T61STRING                20
71 # define V_ASN1_TELETEXSTRING            20/* alias */
72 # define V_ASN1_VIDEOTEXSTRING           21 /**/
73 # define V_ASN1_IA5STRING                22
74 # define V_ASN1_UTCTIME                  23
75 # define V_ASN1_GENERALIZEDTIME          24 /**/
76 # define V_ASN1_GRAPHICSTRING            25 /**/
77 # define V_ASN1_ISO64STRING              26 /**/
78 # define V_ASN1_VISIBLESTRING            26/* alias */
79 # define V_ASN1_GENERALSTRING            27 /**/
80 # define V_ASN1_UNIVERSALSTRING          28 /**/
81 # define V_ASN1_BMPSTRING                30
82
83 /*
84  * NB the constants below are used internally by ASN1_INTEGER
85  * and ASN1_ENUMERATED to indicate the sign. They are *not* on
86  * the wire tag values.
87  */
88
89 # define V_ASN1_NEG                      0x100
90 # define V_ASN1_NEG_INTEGER              (2 | V_ASN1_NEG)
91 # define V_ASN1_NEG_ENUMERATED           (10 | V_ASN1_NEG)
92
93 /* For use with d2i_ASN1_type_bytes() */
94 # define B_ASN1_NUMERICSTRING    0x0001
95 # define B_ASN1_PRINTABLESTRING  0x0002
96 # define B_ASN1_T61STRING        0x0004
97 # define B_ASN1_TELETEXSTRING    0x0004
98 # define B_ASN1_VIDEOTEXSTRING   0x0008
99 # define B_ASN1_IA5STRING        0x0010
100 # define B_ASN1_GRAPHICSTRING    0x0020
101 # define B_ASN1_ISO64STRING      0x0040
102 # define B_ASN1_VISIBLESTRING    0x0040
103 # define B_ASN1_GENERALSTRING    0x0080
104 # define B_ASN1_UNIVERSALSTRING  0x0100
105 # define B_ASN1_OCTET_STRING     0x0200
106 # define B_ASN1_BIT_STRING       0x0400
107 # define B_ASN1_BMPSTRING        0x0800
108 # define B_ASN1_UNKNOWN          0x1000
109 # define B_ASN1_UTF8STRING       0x2000
110 # define B_ASN1_UTCTIME          0x4000
111 # define B_ASN1_GENERALIZEDTIME  0x8000
112 # define B_ASN1_SEQUENCE         0x10000
113 /* For use with ASN1_mbstring_copy() */
114 # define MBSTRING_FLAG           0x1000
115 # define MBSTRING_UTF8           (MBSTRING_FLAG)
116 # define MBSTRING_ASC            (MBSTRING_FLAG|1)
117 # define MBSTRING_BMP            (MBSTRING_FLAG|2)
118 # define MBSTRING_UNIV           (MBSTRING_FLAG|4)
119 # define SMIME_OLDMIME           0x400
120 # define SMIME_CRLFEOL           0x800
121 # define SMIME_STREAM            0x1000
122
123 /* Stacks for types not otherwise defined in this header */
124 DEFINE_OR_DECLARE_STACK_OF(X509_ALGOR)
125
126 # define ASN1_STRING_FLAG_BITS_LEFT 0x08/* Set if 0x07 has bits left value */
127 /*
128  * This indicates that the ASN1_STRING is not a real value but just a place
129  * holder for the location where indefinite length constructed data should be
130  * inserted in the memory buffer
131  */
132 # define ASN1_STRING_FLAG_NDEF 0x010
133
134 /*
135  * This flag is used by the CMS code to indicate that a string is not
136  * complete and is a place holder for content when it had all been accessed.
137  * The flag will be reset when content has been written to it.
138  */
139
140 # define ASN1_STRING_FLAG_CONT 0x020
141 /*
142  * This flag is used by ASN1 code to indicate an ASN1_STRING is an MSTRING
143  * type.
144  */
145 # define ASN1_STRING_FLAG_MSTRING 0x040
146 /* String is embedded and only content should be freed */
147 # define ASN1_STRING_FLAG_EMBED 0x080
148 /* String should be parsed in RFC 5280's time format */
149 # define ASN1_STRING_FLAG_X509_TIME 0x100
150 /* This is the base type that holds just about everything :-) */
151 struct asn1_string_st {
152     int length;
153     int type;
154     unsigned char *data;
155     /*
156      * The value of the following field depends on the type being held.  It
157      * is mostly being used for BIT_STRING so if the input data has a
158      * non-zero 'unused bits' value, it will be handled correctly
159      */
160     long flags;
161 };
162
163 /*
164  * ASN1_ENCODING structure: this is used to save the received encoding of an
165  * ASN1 type. This is useful to get round problems with invalid encodings
166  * which can break signatures.
167  */
168
169 typedef struct ASN1_ENCODING_st {
170     unsigned char *enc;         /* DER encoding */
171     long len;                   /* Length of encoding */
172     int modified;               /* set to 1 if 'enc' is invalid */
173 } ASN1_ENCODING;
174
175 /* Used with ASN1 LONG type: if a long is set to this it is omitted */
176 # define ASN1_LONG_UNDEF 0x7fffffffL
177
178 # define STABLE_FLAGS_MALLOC     0x01
179 /*
180  * A zero passed to ASN1_STRING_TABLE_new_add for the flags is interpreted
181  * as "don't change" and STABLE_FLAGS_MALLOC is always set. By setting
182  * STABLE_FLAGS_MALLOC only we can clear the existing value. Use the alias
183  * STABLE_FLAGS_CLEAR to reflect this.
184  */
185 # define STABLE_FLAGS_CLEAR      STABLE_FLAGS_MALLOC
186 # define STABLE_NO_MASK          0x02
187 # define DIRSTRING_TYPE  \
188  (B_ASN1_PRINTABLESTRING|B_ASN1_T61STRING|B_ASN1_BMPSTRING|B_ASN1_UTF8STRING)
189 # define PKCS9STRING_TYPE (DIRSTRING_TYPE|B_ASN1_IA5STRING)
190
191 struct asn1_string_table_st {
192     int nid;
193     long minsize;
194     long maxsize;
195     unsigned long mask;
196     unsigned long flags;
197 };
198
199 DEFINE_OR_DECLARE_STACK_OF(ASN1_STRING_TABLE)
200
201 /* size limits: this stuff is taken straight from RFC2459 */
202
203 # define ub_name                         32768
204 # define ub_common_name                  64
205 # define ub_locality_name                128
206 # define ub_state_name                   128
207 # define ub_organization_name            64
208 # define ub_organization_unit_name       64
209 # define ub_title                        64
210 # define ub_email_address                128
211
212 /*
213  * Declarations for template structures: for full definitions see asn1t.h
214  */
215 typedef struct ASN1_TEMPLATE_st ASN1_TEMPLATE;
216 typedef struct ASN1_TLC_st ASN1_TLC;
217 /* This is just an opaque pointer */
218 typedef struct ASN1_VALUE_st ASN1_VALUE;
219
220 /* Declare ASN1 functions: the implement macro in in asn1t.h */
221
222 # define DECLARE_ASN1_FUNCTIONS(type) DECLARE_ASN1_FUNCTIONS_name(type, type)
223
224 # define DECLARE_ASN1_ALLOC_FUNCTIONS(type) \
225         DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, type)
226
227 # define DECLARE_ASN1_FUNCTIONS_name(type, name) \
228         DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \
229         DECLARE_ASN1_ENCODE_FUNCTIONS_name(type, name)
230
231 # define DECLARE_ASN1_ENCODE_FUNCTIONS(type, itname, name) \
232         DECLARE_ASN1_ENCODE_FUNCTIONS_only(type, name) \
233         DECLARE_ASN1_ITEM(itname)
234
235 # define DECLARE_ASN1_ENCODE_FUNCTIONS_name(type, name) \
236          DECLARE_ASN1_ENCODE_FUNCTIONS(type, name, name)
237
238 # define DECLARE_ASN1_ENCODE_FUNCTIONS_only(type, name) \
239         type *d2i_##name(type **a, const unsigned char **in, long len); \
240         int i2d_##name(const type *a, unsigned char **out);
241
242 # define DECLARE_ASN1_NDEF_FUNCTION(name) \
243         int i2d_##name##_NDEF(const name *a, unsigned char **out);
244
245 # define DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \
246         type *name##_new(void); \
247         void name##_free(type *a);
248
249 # define DECLARE_ASN1_DUP_FUNCTION(type) \
250         DECLARE_ASN1_DUP_FUNCTION_name(type, type)
251
252 # define DECLARE_ASN1_DUP_FUNCTION_name(type, name) \
253         type *name##_dup(const type *a);
254
255 # define DECLARE_ASN1_PRINT_FUNCTION(stname) \
256         DECLARE_ASN1_PRINT_FUNCTION_fname(stname, stname)
257
258 # define DECLARE_ASN1_PRINT_FUNCTION_fname(stname, fname) \
259         int fname##_print_ctx(BIO *out, const stname *x, int indent, \
260                                          const ASN1_PCTX *pctx);
261
262 # define D2I_OF(type) type *(*)(type **,const unsigned char **,long)
263 # define I2D_OF(type) int (*)(const type *,unsigned char **)
264
265 # define CHECKED_D2I_OF(type, d2i) \
266     ((d2i_of_void*) (1 ? d2i : ((D2I_OF(type))0)))
267 # define CHECKED_I2D_OF(type, i2d) \
268     ((i2d_of_void*) (1 ? i2d : ((I2D_OF(type))0)))
269 # define CHECKED_NEW_OF(type, xnew) \
270     ((void *(*)(void)) (1 ? xnew : ((type *(*)(void))0)))
271 # define CHECKED_PTR_OF(type, p) \
272     ((void*) (1 ? p : (type*)0))
273 # define CHECKED_PPTR_OF(type, p) \
274     ((void**) (1 ? p : (type**)0))
275
276 # define TYPEDEF_D2I_OF(type) typedef type *d2i_of_##type(type **,const unsigned char **,long)
277 # define TYPEDEF_I2D_OF(type) typedef int i2d_of_##type(const type *,unsigned char **)
278 # define TYPEDEF_D2I2D_OF(type) TYPEDEF_D2I_OF(type); TYPEDEF_I2D_OF(type)
279
280 typedef void *d2i_of_void(void **, const unsigned char **, long);
281 typedef int i2d_of_void(const void *, unsigned char **);
282
283 /*-
284  * The following macros and typedefs allow an ASN1_ITEM
285  * to be embedded in a structure and referenced. Since
286  * the ASN1_ITEM pointers need to be globally accessible
287  * (possibly from shared libraries) they may exist in
288  * different forms. On platforms that support it the
289  * ASN1_ITEM structure itself will be globally exported.
290  * Other platforms will export a function that returns
291  * an ASN1_ITEM pointer.
292  *
293  * To handle both cases transparently the macros below
294  * should be used instead of hard coding an ASN1_ITEM
295  * pointer in a structure.
296  *
297  * The structure will look like this:
298  *
299  * typedef struct SOMETHING_st {
300  *      ...
301  *      ASN1_ITEM_EXP *iptr;
302  *      ...
303  * } SOMETHING;
304  *
305  * It would be initialised as e.g.:
306  *
307  * SOMETHING somevar = {...,ASN1_ITEM_ref(X509),...};
308  *
309  * and the actual pointer extracted with:
310  *
311  * const ASN1_ITEM *it = ASN1_ITEM_ptr(somevar.iptr);
312  *
313  * Finally an ASN1_ITEM pointer can be extracted from an
314  * appropriate reference with: ASN1_ITEM_rptr(X509). This
315  * would be used when a function takes an ASN1_ITEM * argument.
316  *
317  */
318
319
320 /*
321  * Platforms that can't easily handle shared global variables are declared as
322  * functions returning ASN1_ITEM pointers.
323  */
324
325 /* ASN1_ITEM pointer exported type */
326 typedef const ASN1_ITEM *ASN1_ITEM_EXP (void);
327
328 /* Macro to obtain ASN1_ITEM pointer from exported type */
329 # define ASN1_ITEM_ptr(iptr) (iptr())
330
331 /* Macro to include ASN1_ITEM pointer from base type */
332 # define ASN1_ITEM_ref(iptr) (iptr##_it)
333
334 # define ASN1_ITEM_rptr(ref) (ref##_it())
335
336 # define DECLARE_ASN1_ITEM(name) \
337         const ASN1_ITEM * name##_it(void);
338
339 /* Parameters used by ASN1_STRING_print_ex() */
340
341 /*
342  * These determine which characters to escape: RFC2253 special characters,
343  * control characters and MSB set characters
344  */
345
346 # define ASN1_STRFLGS_ESC_2253           1
347 # define ASN1_STRFLGS_ESC_CTRL           2
348 # define ASN1_STRFLGS_ESC_MSB            4
349
350 /*
351  * This flag determines how we do escaping: normally RC2253 backslash only,
352  * set this to use backslash and quote.
353  */
354
355 # define ASN1_STRFLGS_ESC_QUOTE          8
356
357 /* These three flags are internal use only. */
358
359 /* Character is a valid PrintableString character */
360 # define CHARTYPE_PRINTABLESTRING        0x10
361 /* Character needs escaping if it is the first character */
362 # define CHARTYPE_FIRST_ESC_2253         0x20
363 /* Character needs escaping if it is the last character */
364 # define CHARTYPE_LAST_ESC_2253          0x40
365
366 /*
367  * NB the internal flags are safely reused below by flags handled at the top
368  * level.
369  */
370
371 /*
372  * If this is set we convert all character strings to UTF8 first
373  */
374
375 # define ASN1_STRFLGS_UTF8_CONVERT       0x10
376
377 /*
378  * If this is set we don't attempt to interpret content: just assume all
379  * strings are 1 byte per character. This will produce some pretty odd
380  * looking output!
381  */
382
383 # define ASN1_STRFLGS_IGNORE_TYPE        0x20
384
385 /* If this is set we include the string type in the output */
386 # define ASN1_STRFLGS_SHOW_TYPE          0x40
387
388 /*
389  * This determines which strings to display and which to 'dump' (hex dump of
390  * content octets or DER encoding). We can only dump non character strings or
391  * everything. If we don't dump 'unknown' they are interpreted as character
392  * strings with 1 octet per character and are subject to the usual escaping
393  * options.
394  */
395
396 # define ASN1_STRFLGS_DUMP_ALL           0x80
397 # define ASN1_STRFLGS_DUMP_UNKNOWN       0x100
398
399 /*
400  * These determine what 'dumping' does, we can dump the content octets or the
401  * DER encoding: both use the RFC2253 #XXXXX notation.
402  */
403
404 # define ASN1_STRFLGS_DUMP_DER           0x200
405
406 /*
407  * This flag specifies that RC2254 escaping shall be performed.
408  */
409 #define ASN1_STRFLGS_ESC_2254           0x400
410
411 /*
412  * All the string flags consistent with RFC2253, escaping control characters
413  * isn't essential in RFC2253 but it is advisable anyway.
414  */
415
416 # define ASN1_STRFLGS_RFC2253    (ASN1_STRFLGS_ESC_2253 | \
417                                 ASN1_STRFLGS_ESC_CTRL | \
418                                 ASN1_STRFLGS_ESC_MSB | \
419                                 ASN1_STRFLGS_UTF8_CONVERT | \
420                                 ASN1_STRFLGS_DUMP_UNKNOWN | \
421                                 ASN1_STRFLGS_DUMP_DER)
422
423
424 struct asn1_type_st {
425     int type;
426     union {
427         char *ptr;
428         ASN1_BOOLEAN boolean;
429         ASN1_STRING *asn1_string;
430         ASN1_OBJECT *object;
431         ASN1_INTEGER *integer;
432         ASN1_ENUMERATED *enumerated;
433         ASN1_BIT_STRING *bit_string;
434         ASN1_OCTET_STRING *octet_string;
435         ASN1_PRINTABLESTRING *printablestring;
436         ASN1_T61STRING *t61string;
437         ASN1_IA5STRING *ia5string;
438         ASN1_GENERALSTRING *generalstring;
439         ASN1_BMPSTRING *bmpstring;
440         ASN1_UNIVERSALSTRING *universalstring;
441         ASN1_UTCTIME *utctime;
442         ASN1_GENERALIZEDTIME *generalizedtime;
443         ASN1_VISIBLESTRING *visiblestring;
444         ASN1_UTF8STRING *utf8string;
445         /*
446          * set and sequence are left complete and still contain the set or
447          * sequence bytes
448          */
449         ASN1_STRING *set;
450         ASN1_STRING *sequence;
451         ASN1_VALUE *asn1_value;
452     } value;
453 };
454
455 DEFINE_OR_DECLARE_STACK_OF(ASN1_TYPE)
456
457 typedef STACK_OF(ASN1_TYPE) ASN1_SEQUENCE_ANY;
458
459 DECLARE_ASN1_ENCODE_FUNCTIONS_name(ASN1_SEQUENCE_ANY, ASN1_SEQUENCE_ANY)
460 DECLARE_ASN1_ENCODE_FUNCTIONS_name(ASN1_SEQUENCE_ANY, ASN1_SET_ANY)
461
462 /* This is used to contain a list of bit names */
463 typedef struct BIT_STRING_BITNAME_st {
464     int bitnum;
465     const char *lname;
466     const char *sname;
467 } BIT_STRING_BITNAME;
468
469 # define B_ASN1_TIME \
470                         B_ASN1_UTCTIME | \
471                         B_ASN1_GENERALIZEDTIME
472
473 # define B_ASN1_PRINTABLE \
474                         B_ASN1_NUMERICSTRING| \
475                         B_ASN1_PRINTABLESTRING| \
476                         B_ASN1_T61STRING| \
477                         B_ASN1_IA5STRING| \
478                         B_ASN1_BIT_STRING| \
479                         B_ASN1_UNIVERSALSTRING|\
480                         B_ASN1_BMPSTRING|\
481                         B_ASN1_UTF8STRING|\
482                         B_ASN1_SEQUENCE|\
483                         B_ASN1_UNKNOWN
484
485 # define B_ASN1_DIRECTORYSTRING \
486                         B_ASN1_PRINTABLESTRING| \
487                         B_ASN1_TELETEXSTRING|\
488                         B_ASN1_BMPSTRING|\
489                         B_ASN1_UNIVERSALSTRING|\
490                         B_ASN1_UTF8STRING
491
492 # define B_ASN1_DISPLAYTEXT \
493                         B_ASN1_IA5STRING| \
494                         B_ASN1_VISIBLESTRING| \
495                         B_ASN1_BMPSTRING|\
496                         B_ASN1_UTF8STRING
497
498 DECLARE_ASN1_ALLOC_FUNCTIONS_name(ASN1_TYPE, ASN1_TYPE)
499 DECLARE_ASN1_ENCODE_FUNCTIONS(ASN1_TYPE, ASN1_ANY, ASN1_TYPE)
500
501 int ASN1_TYPE_get(const ASN1_TYPE *a);
502 void ASN1_TYPE_set(ASN1_TYPE *a, int type, void *value);
503 int ASN1_TYPE_set1(ASN1_TYPE *a, int type, const void *value);
504 int ASN1_TYPE_cmp(const ASN1_TYPE *a, const ASN1_TYPE *b);
505
506 ASN1_TYPE *ASN1_TYPE_pack_sequence(const ASN1_ITEM *it, void *s, ASN1_TYPE **t);
507 void *ASN1_TYPE_unpack_sequence(const ASN1_ITEM *it, const ASN1_TYPE *t);
508
509 DEFINE_OR_DECLARE_STACK_OF(ASN1_OBJECT)
510
511 DECLARE_ASN1_FUNCTIONS(ASN1_OBJECT)
512
513 ASN1_STRING *ASN1_STRING_new(void);
514 void ASN1_STRING_free(ASN1_STRING *a);
515 void ASN1_STRING_clear_free(ASN1_STRING *a);
516 int ASN1_STRING_copy(ASN1_STRING *dst, const ASN1_STRING *str);
517 DECLARE_ASN1_DUP_FUNCTION(ASN1_STRING)
518 ASN1_STRING *ASN1_STRING_type_new(int type);
519 int ASN1_STRING_cmp(const ASN1_STRING *a, const ASN1_STRING *b);
520   /*
521    * Since this is used to store all sorts of things, via macros, for now,
522    * make its data void *
523    */
524 int ASN1_STRING_set(ASN1_STRING *str, const void *data, int len);
525 void ASN1_STRING_set0(ASN1_STRING *str, void *data, int len);
526 int ASN1_STRING_length(const ASN1_STRING *x);
527 void ASN1_STRING_length_set(ASN1_STRING *x, int n);
528 int ASN1_STRING_type(const ASN1_STRING *x);
529 DEPRECATEDIN_1_1_0(unsigned char *ASN1_STRING_data(ASN1_STRING *x))
530 const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *x);
531
532 DECLARE_ASN1_FUNCTIONS(ASN1_BIT_STRING)
533 int ASN1_BIT_STRING_set(ASN1_BIT_STRING *a, unsigned char *d, int length);
534 int ASN1_BIT_STRING_set_bit(ASN1_BIT_STRING *a, int n, int value);
535 int ASN1_BIT_STRING_get_bit(const ASN1_BIT_STRING *a, int n);
536 int ASN1_BIT_STRING_check(const ASN1_BIT_STRING *a,
537                           const unsigned char *flags, int flags_len);
538
539 int ASN1_BIT_STRING_name_print(BIO *out, ASN1_BIT_STRING *bs,
540                                BIT_STRING_BITNAME *tbl, int indent);
541 int ASN1_BIT_STRING_num_asc(const char *name, BIT_STRING_BITNAME *tbl);
542 int ASN1_BIT_STRING_set_asc(ASN1_BIT_STRING *bs, const char *name, int value,
543                             BIT_STRING_BITNAME *tbl);
544
545 DEFINE_OR_DECLARE_STACK_OF(ASN1_INTEGER)
546
547 DECLARE_ASN1_FUNCTIONS(ASN1_INTEGER)
548 ASN1_INTEGER *d2i_ASN1_UINTEGER(ASN1_INTEGER **a, const unsigned char **pp,
549                                 long length);
550 DECLARE_ASN1_DUP_FUNCTION(ASN1_INTEGER)
551 int ASN1_INTEGER_cmp(const ASN1_INTEGER *x, const ASN1_INTEGER *y);
552
553 DECLARE_ASN1_FUNCTIONS(ASN1_ENUMERATED)
554
555 int ASN1_UTCTIME_check(const ASN1_UTCTIME *a);
556 ASN1_UTCTIME *ASN1_UTCTIME_set(ASN1_UTCTIME *s, time_t t);
557 ASN1_UTCTIME *ASN1_UTCTIME_adj(ASN1_UTCTIME *s, time_t t,
558                                int offset_day, long offset_sec);
559 int ASN1_UTCTIME_set_string(ASN1_UTCTIME *s, const char *str);
560 int ASN1_UTCTIME_cmp_time_t(const ASN1_UTCTIME *s, time_t t);
561
562 int ASN1_GENERALIZEDTIME_check(const ASN1_GENERALIZEDTIME *a);
563 ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_set(ASN1_GENERALIZEDTIME *s,
564                                                time_t t);
565 ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_adj(ASN1_GENERALIZEDTIME *s,
566                                                time_t t, int offset_day,
567                                                long offset_sec);
568 int ASN1_GENERALIZEDTIME_set_string(ASN1_GENERALIZEDTIME *s, const char *str);
569
570 int ASN1_TIME_diff(int *pday, int *psec,
571                    const ASN1_TIME *from, const ASN1_TIME *to);
572
573 DECLARE_ASN1_FUNCTIONS(ASN1_OCTET_STRING)
574 DECLARE_ASN1_DUP_FUNCTION(ASN1_OCTET_STRING)
575 int ASN1_OCTET_STRING_cmp(const ASN1_OCTET_STRING *a,
576                           const ASN1_OCTET_STRING *b);
577 int ASN1_OCTET_STRING_set(ASN1_OCTET_STRING *str, const unsigned char *data,
578                           int len);
579
580 DEFINE_OR_DECLARE_STACK_OF(ASN1_UTF8STRING)
581
582 DECLARE_ASN1_FUNCTIONS(ASN1_VISIBLESTRING)
583 DECLARE_ASN1_FUNCTIONS(ASN1_UNIVERSALSTRING)
584 DECLARE_ASN1_FUNCTIONS(ASN1_UTF8STRING)
585 DECLARE_ASN1_FUNCTIONS(ASN1_NULL)
586 DECLARE_ASN1_FUNCTIONS(ASN1_BMPSTRING)
587
588 int UTF8_getc(const unsigned char *str, int len, unsigned long *val);
589 int UTF8_putc(unsigned char *str, int len, unsigned long value);
590
591 DEFINE_OR_DECLARE_STACK_OF(ASN1_GENERALSTRING)
592
593 DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING, ASN1_PRINTABLE)
594
595 DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING, DIRECTORYSTRING)
596 DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING, DISPLAYTEXT)
597 DECLARE_ASN1_FUNCTIONS(ASN1_PRINTABLESTRING)
598 DECLARE_ASN1_FUNCTIONS(ASN1_T61STRING)
599 DECLARE_ASN1_FUNCTIONS(ASN1_IA5STRING)
600 DECLARE_ASN1_FUNCTIONS(ASN1_GENERALSTRING)
601 DECLARE_ASN1_FUNCTIONS(ASN1_UTCTIME)
602 DECLARE_ASN1_FUNCTIONS(ASN1_GENERALIZEDTIME)
603 DECLARE_ASN1_FUNCTIONS(ASN1_TIME)
604
605 DECLARE_ASN1_DUP_FUNCTION(ASN1_TIME)
606 DECLARE_ASN1_DUP_FUNCTION(ASN1_UTCTIME)
607 DECLARE_ASN1_DUP_FUNCTION(ASN1_GENERALIZEDTIME)
608
609 DECLARE_ASN1_ITEM(ASN1_OCTET_STRING_NDEF)
610
611 ASN1_TIME *ASN1_TIME_set(ASN1_TIME *s, time_t t);
612 ASN1_TIME *ASN1_TIME_adj(ASN1_TIME *s, time_t t,
613                          int offset_day, long offset_sec);
614 int ASN1_TIME_check(const ASN1_TIME *t);
615 ASN1_GENERALIZEDTIME *ASN1_TIME_to_generalizedtime(const ASN1_TIME *t,
616                                                    ASN1_GENERALIZEDTIME **out);
617 int ASN1_TIME_set_string(ASN1_TIME *s, const char *str);
618 int ASN1_TIME_set_string_X509(ASN1_TIME *s, const char *str);
619 int ASN1_TIME_to_tm(const ASN1_TIME *s, struct tm *tm);
620 int ASN1_TIME_normalize(ASN1_TIME *s);
621 int ASN1_TIME_cmp_time_t(const ASN1_TIME *s, time_t t);
622 int ASN1_TIME_compare(const ASN1_TIME *a, const ASN1_TIME *b);
623
624 int i2a_ASN1_INTEGER(BIO *bp, const ASN1_INTEGER *a);
625 int a2i_ASN1_INTEGER(BIO *bp, ASN1_INTEGER *bs, char *buf, int size);
626 int i2a_ASN1_ENUMERATED(BIO *bp, const ASN1_ENUMERATED *a);
627 int a2i_ASN1_ENUMERATED(BIO *bp, ASN1_ENUMERATED *bs, char *buf, int size);
628 int i2a_ASN1_OBJECT(BIO *bp, const ASN1_OBJECT *a);
629 int a2i_ASN1_STRING(BIO *bp, ASN1_STRING *bs, char *buf, int size);
630 int i2a_ASN1_STRING(BIO *bp, const ASN1_STRING *a, int type);
631 int i2t_ASN1_OBJECT(char *buf, int buf_len, const ASN1_OBJECT *a);
632
633 int a2d_ASN1_OBJECT(unsigned char *out, int olen, const char *buf, int num);
634 ASN1_OBJECT *ASN1_OBJECT_create(int nid, unsigned char *data, int len,
635                                 const char *sn, const char *ln);
636
637 int ASN1_INTEGER_get_int64(int64_t *pr, const ASN1_INTEGER *a);
638 int ASN1_INTEGER_set_int64(ASN1_INTEGER *a, int64_t r);
639 int ASN1_INTEGER_get_uint64(uint64_t *pr, const ASN1_INTEGER *a);
640 int ASN1_INTEGER_set_uint64(ASN1_INTEGER *a, uint64_t r);
641
642 int ASN1_INTEGER_set(ASN1_INTEGER *a, long v);
643 long ASN1_INTEGER_get(const ASN1_INTEGER *a);
644 ASN1_INTEGER *BN_to_ASN1_INTEGER(const BIGNUM *bn, ASN1_INTEGER *ai);
645 BIGNUM *ASN1_INTEGER_to_BN(const ASN1_INTEGER *ai, BIGNUM *bn);
646
647 int ASN1_ENUMERATED_get_int64(int64_t *pr, const ASN1_ENUMERATED *a);
648 int ASN1_ENUMERATED_set_int64(ASN1_ENUMERATED *a, int64_t r);
649
650
651 int ASN1_ENUMERATED_set(ASN1_ENUMERATED *a, long v);
652 long ASN1_ENUMERATED_get(const ASN1_ENUMERATED *a);
653 ASN1_ENUMERATED *BN_to_ASN1_ENUMERATED(const BIGNUM *bn, ASN1_ENUMERATED *ai);
654 BIGNUM *ASN1_ENUMERATED_to_BN(const ASN1_ENUMERATED *ai, BIGNUM *bn);
655
656 /* General */
657 /* given a string, return the correct type, max is the maximum length */
658 int ASN1_PRINTABLE_type(const unsigned char *s, int max);
659
660 unsigned long ASN1_tag2bit(int tag);
661
662 /* SPECIALS */
663 int ASN1_get_object(const unsigned char **pp, long *plength, int *ptag,
664                     int *pclass, long omax);
665 int ASN1_check_infinite_end(unsigned char **p, long len);
666 int ASN1_const_check_infinite_end(const unsigned char **p, long len);
667 void ASN1_put_object(unsigned char **pp, int constructed, int length,
668                      int tag, int xclass);
669 int ASN1_put_eoc(unsigned char **pp);
670 int ASN1_object_size(int constructed, int length, int tag);
671
672 /* Used to implement other functions */
673 void *ASN1_dup(i2d_of_void *i2d, d2i_of_void *d2i, const void *x);
674
675 # define ASN1_dup_of(type,i2d,d2i,x) \
676     ((type*)ASN1_dup(CHECKED_I2D_OF(type, i2d), \
677                      CHECKED_D2I_OF(type, d2i), \
678                      CHECKED_PTR_OF(const type, x)))
679
680 void *ASN1_item_dup(const ASN1_ITEM *it, const void *x);
681 int ASN1_item_sign_with_libctx(const ASN1_ITEM *it, X509_ALGOR *algor1,
682                                X509_ALGOR *algor2, ASN1_BIT_STRING *signature,
683                                const void *data, const ASN1_OCTET_STRING *id,
684                                EVP_PKEY *pkey, const EVP_MD *md,
685                                OPENSSL_CTX *libctx, const char *propq);
686 int ASN1_item_verify_with_libctx(const ASN1_ITEM *it, const X509_ALGOR *alg,
687                                  const ASN1_BIT_STRING *signature,
688                                  const void *data,
689                                  const ASN1_OCTET_STRING *id, EVP_PKEY *pkey,
690                                  OPENSSL_CTX *libctx, const char *propq);
691
692 /* ASN1 alloc/free macros for when a type is only used internally */
693
694 # define M_ASN1_new_of(type) (type *)ASN1_item_new(ASN1_ITEM_rptr(type))
695 # define M_ASN1_free_of(x, type) \
696                 ASN1_item_free(CHECKED_PTR_OF(type, x), ASN1_ITEM_rptr(type))
697
698 # ifndef OPENSSL_NO_STDIO
699 void *ASN1_d2i_fp(void *(*xnew) (void), d2i_of_void *d2i, FILE *in, void **x);
700
701 #  define ASN1_d2i_fp_of(type,xnew,d2i,in,x) \
702     ((type*)ASN1_d2i_fp(CHECKED_NEW_OF(type, xnew), \
703                         CHECKED_D2I_OF(type, d2i), \
704                         in, \
705                         CHECKED_PPTR_OF(type, x)))
706
707 void *ASN1_item_d2i_fp(const ASN1_ITEM *it, FILE *in, void *x);
708 int ASN1_i2d_fp(i2d_of_void *i2d, FILE *out, const void *x);
709
710 #  define ASN1_i2d_fp_of(type,i2d,out,x) \
711     (ASN1_i2d_fp(CHECKED_I2D_OF(type, i2d), \
712                  out, \
713                  CHECKED_PTR_OF(const type, x)))
714
715 int ASN1_item_i2d_fp(const ASN1_ITEM *it, FILE *out, const void *x);
716 int ASN1_STRING_print_ex_fp(FILE *fp, const ASN1_STRING *str, unsigned long flags);
717 # endif
718
719 int ASN1_STRING_to_UTF8(unsigned char **out, const ASN1_STRING *in);
720
721 void *ASN1_d2i_bio(void *(*xnew) (void), d2i_of_void *d2i, BIO *in, void **x);
722
723 #  define ASN1_d2i_bio_of(type,xnew,d2i,in,x) \
724     ((type*)ASN1_d2i_bio( CHECKED_NEW_OF(type, xnew), \
725                           CHECKED_D2I_OF(type, d2i), \
726                           in, \
727                           CHECKED_PPTR_OF(type, x)))
728
729 void *ASN1_item_d2i_bio(const ASN1_ITEM *it, BIO *in, void *x);
730 int ASN1_i2d_bio(i2d_of_void *i2d, BIO *out, const void *x);
731
732 #  define ASN1_i2d_bio_of(type,i2d,out,x) \
733     (ASN1_i2d_bio(CHECKED_I2D_OF(type, i2d), \
734                   out, \
735                   CHECKED_PTR_OF(const type, x)))
736
737 int ASN1_item_i2d_bio(const ASN1_ITEM *it, BIO *out, const void *x);
738 int ASN1_UTCTIME_print(BIO *fp, const ASN1_UTCTIME *a);
739 int ASN1_GENERALIZEDTIME_print(BIO *fp, const ASN1_GENERALIZEDTIME *a);
740 int ASN1_TIME_print(BIO *fp, const ASN1_TIME *a);
741 int ASN1_STRING_print(BIO *bp, const ASN1_STRING *v);
742 int ASN1_STRING_print_ex(BIO *out, const ASN1_STRING *str, unsigned long flags);
743 int ASN1_buf_print(BIO *bp, const unsigned char *buf, size_t buflen, int off);
744 int ASN1_bn_print(BIO *bp, const char *number, const BIGNUM *num,
745                   unsigned char *buf, int off);
746 int ASN1_parse(BIO *bp, const unsigned char *pp, long len, int indent);
747 int ASN1_parse_dump(BIO *bp, const unsigned char *pp, long len, int indent,
748                     int dump);
749 const char *ASN1_tag2str(int tag);
750
751 /* Used to load and write Netscape format cert */
752
753 int ASN1_UNIVERSALSTRING_to_string(ASN1_UNIVERSALSTRING *s);
754
755 int ASN1_TYPE_set_octetstring(ASN1_TYPE *a, unsigned char *data, int len);
756 int ASN1_TYPE_get_octetstring(const ASN1_TYPE *a, unsigned char *data, int max_len);
757 int ASN1_TYPE_set_int_octetstring(ASN1_TYPE *a, long num,
758                                   unsigned char *data, int len);
759 int ASN1_TYPE_get_int_octetstring(const ASN1_TYPE *a, long *num,
760                                   unsigned char *data, int max_len);
761
762 void *ASN1_item_unpack(const ASN1_STRING *oct, const ASN1_ITEM *it);
763
764 ASN1_STRING *ASN1_item_pack(void *obj, const ASN1_ITEM *it,
765                             ASN1_OCTET_STRING **oct);
766
767 void ASN1_STRING_set_default_mask(unsigned long mask);
768 int ASN1_STRING_set_default_mask_asc(const char *p);
769 unsigned long ASN1_STRING_get_default_mask(void);
770 int ASN1_mbstring_copy(ASN1_STRING **out, const unsigned char *in, int len,
771                        int inform, unsigned long mask);
772 int ASN1_mbstring_ncopy(ASN1_STRING **out, const unsigned char *in, int len,
773                         int inform, unsigned long mask,
774                         long minsize, long maxsize);
775
776 ASN1_STRING *ASN1_STRING_set_by_NID(ASN1_STRING **out,
777                                     const unsigned char *in, int inlen,
778                                     int inform, int nid);
779 ASN1_STRING_TABLE *ASN1_STRING_TABLE_get(int nid);
780 int ASN1_STRING_TABLE_add(int, long, long, unsigned long, unsigned long);
781 void ASN1_STRING_TABLE_cleanup(void);
782
783 /* ASN1 template functions */
784
785 /* Old API compatible functions */
786 ASN1_VALUE *ASN1_item_new(const ASN1_ITEM *it);
787 void ASN1_item_free(ASN1_VALUE *val, const ASN1_ITEM *it);
788 ASN1_VALUE *ASN1_item_d2i(ASN1_VALUE **val, const unsigned char **in,
789                           long len, const ASN1_ITEM *it);
790 int ASN1_item_i2d(const ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it);
791 int ASN1_item_ndef_i2d(const ASN1_VALUE *val, unsigned char **out,
792                        const ASN1_ITEM *it);
793
794 void ASN1_add_oid_module(void);
795 void ASN1_add_stable_module(void);
796
797 ASN1_TYPE *ASN1_generate_nconf(const char *str, CONF *nconf);
798 ASN1_TYPE *ASN1_generate_v3(const char *str, X509V3_CTX *cnf);
799 int ASN1_str2mask(const char *str, unsigned long *pmask);
800
801 /* ASN1 Print flags */
802
803 /* Indicate missing OPTIONAL fields */
804 # define ASN1_PCTX_FLAGS_SHOW_ABSENT             0x001
805 /* Mark start and end of SEQUENCE */
806 # define ASN1_PCTX_FLAGS_SHOW_SEQUENCE           0x002
807 /* Mark start and end of SEQUENCE/SET OF */
808 # define ASN1_PCTX_FLAGS_SHOW_SSOF               0x004
809 /* Show the ASN1 type of primitives */
810 # define ASN1_PCTX_FLAGS_SHOW_TYPE               0x008
811 /* Don't show ASN1 type of ANY */
812 # define ASN1_PCTX_FLAGS_NO_ANY_TYPE             0x010
813 /* Don't show ASN1 type of MSTRINGs */
814 # define ASN1_PCTX_FLAGS_NO_MSTRING_TYPE         0x020
815 /* Don't show field names in SEQUENCE */
816 # define ASN1_PCTX_FLAGS_NO_FIELD_NAME           0x040
817 /* Show structure names of each SEQUENCE field */
818 # define ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME  0x080
819 /* Don't show structure name even at top level */
820 # define ASN1_PCTX_FLAGS_NO_STRUCT_NAME          0x100
821
822 int ASN1_item_print(BIO *out, const ASN1_VALUE *ifld, int indent,
823                     const ASN1_ITEM *it, const ASN1_PCTX *pctx);
824 ASN1_PCTX *ASN1_PCTX_new(void);
825 void ASN1_PCTX_free(ASN1_PCTX *p);
826 unsigned long ASN1_PCTX_get_flags(const ASN1_PCTX *p);
827 void ASN1_PCTX_set_flags(ASN1_PCTX *p, unsigned long flags);
828 unsigned long ASN1_PCTX_get_nm_flags(const ASN1_PCTX *p);
829 void ASN1_PCTX_set_nm_flags(ASN1_PCTX *p, unsigned long flags);
830 unsigned long ASN1_PCTX_get_cert_flags(const ASN1_PCTX *p);
831 void ASN1_PCTX_set_cert_flags(ASN1_PCTX *p, unsigned long flags);
832 unsigned long ASN1_PCTX_get_oid_flags(const ASN1_PCTX *p);
833 void ASN1_PCTX_set_oid_flags(ASN1_PCTX *p, unsigned long flags);
834 unsigned long ASN1_PCTX_get_str_flags(const ASN1_PCTX *p);
835 void ASN1_PCTX_set_str_flags(ASN1_PCTX *p, unsigned long flags);
836
837 ASN1_SCTX *ASN1_SCTX_new(int (*scan_cb) (ASN1_SCTX *ctx));
838 void ASN1_SCTX_free(ASN1_SCTX *p);
839 const ASN1_ITEM *ASN1_SCTX_get_item(ASN1_SCTX *p);
840 const ASN1_TEMPLATE *ASN1_SCTX_get_template(ASN1_SCTX *p);
841 unsigned long ASN1_SCTX_get_flags(ASN1_SCTX *p);
842 void ASN1_SCTX_set_app_data(ASN1_SCTX *p, void *data);
843 void *ASN1_SCTX_get_app_data(ASN1_SCTX *p);
844
845 const BIO_METHOD *BIO_f_asn1(void);
846
847 /* cannot constify val because of CMS_stream() */
848 BIO *BIO_new_NDEF(BIO *out, ASN1_VALUE *val, const ASN1_ITEM *it);
849
850 int i2d_ASN1_bio_stream(BIO *out, ASN1_VALUE *val, BIO *in, int flags,
851                         const ASN1_ITEM *it);
852 int PEM_write_bio_ASN1_stream(BIO *out, ASN1_VALUE *val, BIO *in, int flags,
853                               const char *hdr, const ASN1_ITEM *it);
854 /* cannot constify val because of CMS_dataFinal() */
855 int SMIME_write_ASN1(BIO *bio, ASN1_VALUE *val, BIO *data, int flags,
856                      int ctype_nid, int econt_nid,
857                      STACK_OF(X509_ALGOR) *mdalgs, const ASN1_ITEM *it);
858 int SMIME_write_ASN1_with_libctx(BIO *bio, ASN1_VALUE *val, BIO *data, int flags,
859                                  int ctype_nid, int econt_nid,
860                                  STACK_OF(X509_ALGOR) *mdalgs,
861                                  const ASN1_ITEM *it,
862                                  OPENSSL_CTX *libctx, const char *propq);
863 ASN1_VALUE *SMIME_read_ASN1(BIO *bio, BIO **bcont, const ASN1_ITEM *it);
864 ASN1_VALUE *SMIME_read_ASN1_ex(BIO *bio, BIO **bcont, const ASN1_ITEM *it,
865                                ASN1_VALUE **x);
866 int SMIME_crlf_copy(BIO *in, BIO *out, int flags);
867 int SMIME_text(BIO *in, BIO *out);
868
869 const ASN1_ITEM *ASN1_ITEM_lookup(const char *name);
870 const ASN1_ITEM *ASN1_ITEM_get(size_t i);
871
872 /* Legacy compatibility */
873 # define DECLARE_ASN1_FUNCTIONS_fname(type, itname, name) \
874          DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \
875          DECLARE_ASN1_ENCODE_FUNCTIONS(type, itname, name)
876 # define DECLARE_ASN1_FUNCTIONS_const(type) DECLARE_ASN1_FUNCTIONS(type)
877 # define DECLARE_ASN1_ENCODE_FUNCTIONS_const(type, name) \
878          DECLARE_ASN1_ENCODE_FUNCTIONS(type, name)
879 # define I2D_OF_const(type) I2D_OF(type)
880 # define ASN1_dup_of_const(type,i2d,d2i,x) ASN1_dup_of(type,i2d,d2i,x)
881 # define ASN1_i2d_fp_of_const(type,i2d,out,x) ASN1_i2d_fp_of(type,i2d,out,x)
882 # define ASN1_i2d_bio_of_const(type,i2d,out,x) ASN1_i2d_bio_of(type,i2d,out,x)
883
884 # ifdef  __cplusplus
885 }
886 # endif
887 #endif