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