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