2 * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
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
11 # define HEADER_ASN1_H
14 # include <openssl/e_os2.h>
15 # include <openssl/opensslconf.h>
16 # include <openssl/bio.h>
17 # include <openssl/safestack.h>
18 # include <openssl/asn1err.h>
19 # include <openssl/symhacks.h>
21 # include <openssl/ossl_typ.h>
22 # if !OPENSSL_API_1_1_0
23 # include <openssl/bn.h>
26 # ifdef OPENSSL_BUILD_SHLIBCRYPTO
27 # undef OPENSSL_EXTERN
28 # define OPENSSL_EXTERN OPENSSL_EXPORT
35 # define V_ASN1_UNIVERSAL 0x00
36 # define V_ASN1_APPLICATION 0x40
37 # define V_ASN1_CONTEXT_SPECIFIC 0x80
38 # define V_ASN1_PRIVATE 0xc0
40 # define V_ASN1_CONSTRUCTED 0x20
41 # define V_ASN1_PRIMITIVE_TAG 0x1f
42 # define V_ASN1_PRIMATIVE_TAG /*compat*/ V_ASN1_PRIMITIVE_TAG
44 # define V_ASN1_APP_CHOOSE -2/* let the recipient choose */
45 # define V_ASN1_OTHER -3/* used in ASN1_TYPE */
46 # define V_ASN1_ANY -4/* used in ASN1 template code */
48 # define V_ASN1_UNDEF -1
49 /* ASN.1 tag values */
51 # define V_ASN1_BOOLEAN 1 /**/
52 # define V_ASN1_INTEGER 2
53 # define V_ASN1_BIT_STRING 3
54 # define V_ASN1_OCTET_STRING 4
55 # define V_ASN1_NULL 5
56 # define V_ASN1_OBJECT 6
57 # define V_ASN1_OBJECT_DESCRIPTOR 7
58 # define V_ASN1_EXTERNAL 8
59 # define V_ASN1_REAL 9
60 # define V_ASN1_ENUMERATED 10
61 # define V_ASN1_UTF8STRING 12
62 # define V_ASN1_SEQUENCE 16
63 # define V_ASN1_SET 17
64 # define V_ASN1_NUMERICSTRING 18 /**/
65 # define V_ASN1_PRINTABLESTRING 19
66 # define V_ASN1_T61STRING 20
67 # define V_ASN1_TELETEXSTRING 20/* alias */
68 # define V_ASN1_VIDEOTEXSTRING 21 /**/
69 # define V_ASN1_IA5STRING 22
70 # define V_ASN1_UTCTIME 23
71 # define V_ASN1_GENERALIZEDTIME 24 /**/
72 # define V_ASN1_GRAPHICSTRING 25 /**/
73 # define V_ASN1_ISO64STRING 26 /**/
74 # define V_ASN1_VISIBLESTRING 26/* alias */
75 # define V_ASN1_GENERALSTRING 27 /**/
76 # define V_ASN1_UNIVERSALSTRING 28 /**/
77 # define V_ASN1_BMPSTRING 30
80 * NB the constants below are used internally by ASN1_INTEGER
81 * and ASN1_ENUMERATED to indicate the sign. They are *not* on
82 * the wire tag values.
85 # define V_ASN1_NEG 0x100
86 # define V_ASN1_NEG_INTEGER (2 | V_ASN1_NEG)
87 # define V_ASN1_NEG_ENUMERATED (10 | V_ASN1_NEG)
89 /* For use with d2i_ASN1_type_bytes() */
90 # define B_ASN1_NUMERICSTRING 0x0001
91 # define B_ASN1_PRINTABLESTRING 0x0002
92 # define B_ASN1_T61STRING 0x0004
93 # define B_ASN1_TELETEXSTRING 0x0004
94 # define B_ASN1_VIDEOTEXSTRING 0x0008
95 # define B_ASN1_IA5STRING 0x0010
96 # define B_ASN1_GRAPHICSTRING 0x0020
97 # define B_ASN1_ISO64STRING 0x0040
98 # define B_ASN1_VISIBLESTRING 0x0040
99 # define B_ASN1_GENERALSTRING 0x0080
100 # define B_ASN1_UNIVERSALSTRING 0x0100
101 # define B_ASN1_OCTET_STRING 0x0200
102 # define B_ASN1_BIT_STRING 0x0400
103 # define B_ASN1_BMPSTRING 0x0800
104 # define B_ASN1_UNKNOWN 0x1000
105 # define B_ASN1_UTF8STRING 0x2000
106 # define B_ASN1_UTCTIME 0x4000
107 # define B_ASN1_GENERALIZEDTIME 0x8000
108 # define B_ASN1_SEQUENCE 0x10000
109 /* For use with ASN1_mbstring_copy() */
110 # define MBSTRING_FLAG 0x1000
111 # define MBSTRING_UTF8 (MBSTRING_FLAG)
112 # define MBSTRING_ASC (MBSTRING_FLAG|1)
113 # define MBSTRING_BMP (MBSTRING_FLAG|2)
114 # define MBSTRING_UNIV (MBSTRING_FLAG|4)
115 # define SMIME_OLDMIME 0x400
116 # define SMIME_CRLFEOL 0x800
117 # define SMIME_STREAM 0x1000
118 struct X509_algor_st;
119 DEFINE_STACK_OF(X509_ALGOR)
121 # define ASN1_STRING_FLAG_BITS_LEFT 0x08/* Set if 0x07 has bits left value */
123 * This indicates that the ASN1_STRING is not a real value but just a place
124 * holder for the location where indefinite length constructed data should be
125 * inserted in the memory buffer
127 # define ASN1_STRING_FLAG_NDEF 0x010
130 * This flag is used by the CMS code to indicate that a string is not
131 * complete and is a place holder for content when it had all been accessed.
132 * The flag will be reset when content has been written to it.
135 # define ASN1_STRING_FLAG_CONT 0x020
137 * This flag is used by ASN1 code to indicate an ASN1_STRING is an MSTRING
140 # define ASN1_STRING_FLAG_MSTRING 0x040
141 /* String is embedded and only content should be freed */
142 # define ASN1_STRING_FLAG_EMBED 0x080
143 /* String should be parsed in RFC 5280's time format */
144 # define ASN1_STRING_FLAG_X509_TIME 0x100
145 /* This is the base type that holds just about everything :-) */
146 struct asn1_string_st {
151 * The value of the following field depends on the type being held. It
152 * is mostly being used for BIT_STRING so if the input data has a
153 * non-zero 'unused bits' value, it will be handled correctly
159 * ASN1_ENCODING structure: this is used to save the received encoding of an
160 * ASN1 type. This is useful to get round problems with invalid encodings
161 * which can break signatures.
164 typedef struct ASN1_ENCODING_st {
165 unsigned char *enc; /* DER encoding */
166 long len; /* Length of encoding */
167 int modified; /* set to 1 if 'enc' is invalid */
170 /* Used with ASN1 LONG type: if a long is set to this it is omitted */
171 # define ASN1_LONG_UNDEF 0x7fffffffL
173 # define STABLE_FLAGS_MALLOC 0x01
175 * A zero passed to ASN1_STRING_TABLE_new_add for the flags is interpreted
176 * as "don't change" and STABLE_FLAGS_MALLOC is always set. By setting
177 * STABLE_FLAGS_MALLOC only we can clear the existing value. Use the alias
178 * STABLE_FLAGS_CLEAR to reflect this.
180 # define STABLE_FLAGS_CLEAR STABLE_FLAGS_MALLOC
181 # define STABLE_NO_MASK 0x02
182 # define DIRSTRING_TYPE \
183 (B_ASN1_PRINTABLESTRING|B_ASN1_T61STRING|B_ASN1_BMPSTRING|B_ASN1_UTF8STRING)
184 # define PKCS9STRING_TYPE (DIRSTRING_TYPE|B_ASN1_IA5STRING)
186 typedef struct asn1_string_table_st {
194 DEFINE_STACK_OF(ASN1_STRING_TABLE)
196 /* size limits: this stuff is taken straight from RFC2459 */
198 # define ub_name 32768
199 # define ub_common_name 64
200 # define ub_locality_name 128
201 # define ub_state_name 128
202 # define ub_organization_name 64
203 # define ub_organization_unit_name 64
205 # define ub_email_address 128
208 * Declarations for template structures: for full definitions see asn1t.h
210 typedef struct ASN1_TEMPLATE_st ASN1_TEMPLATE;
211 typedef struct ASN1_TLC_st ASN1_TLC;
212 /* This is just an opaque pointer */
213 typedef struct ASN1_VALUE_st ASN1_VALUE;
215 /* Declare ASN1 functions: the implement macro in in asn1t.h */
217 # define DECLARE_ASN1_FUNCTIONS(type) DECLARE_ASN1_FUNCTIONS_name(type, type)
219 # define DECLARE_ASN1_ALLOC_FUNCTIONS(type) \
220 DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, type)
222 # define DECLARE_ASN1_FUNCTIONS_name(type, name) \
223 DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \
224 DECLARE_ASN1_ENCODE_FUNCTIONS_name(type, name)
226 # define DECLARE_ASN1_ENCODE_FUNCTIONS(type, itname, name) \
227 DECLARE_ASN1_ENCODE_FUNCTIONS_only(type, name) \
228 DECLARE_ASN1_ITEM(itname)
230 # define DECLARE_ASN1_ENCODE_FUNCTIONS_name(type, name) \
231 DECLARE_ASN1_ENCODE_FUNCTIONS(type, name, name)
233 # define DECLARE_ASN1_ENCODE_FUNCTIONS_only(type, name) \
234 type *d2i_##name(type **a, const unsigned char **in, long len); \
235 int i2d_##name(const type *a, unsigned char **out);
237 # define DECLARE_ASN1_NDEF_FUNCTION(name) \
238 int i2d_##name##_NDEF(const name *a, unsigned char **out);
240 # define DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \
241 type *name##_new(void); \
242 void name##_free(type *a);
244 # define DECLARE_ASN1_DUP_FUNCTION(type) \
245 DECLARE_ASN1_DUP_FUNCTION_name(type, type)
247 # define DECLARE_ASN1_DUP_FUNCTION_name(type, name) \
248 type *name##_dup(const 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, const 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 (*)(const type *,unsigned char **)
260 # define CHECKED_D2I_OF(type, d2i) \
261 ((d2i_of_void*) (1 ? d2i : ((D2I_OF(type))0)))
262 # define CHECKED_I2D_OF(type, i2d) \
263 ((i2d_of_void*) (1 ? i2d : ((I2D_OF(type))0)))
264 # define CHECKED_NEW_OF(type, xnew) \
265 ((void *(*)(void)) (1 ? xnew : ((type *(*)(void))0)))
266 # define CHECKED_PTR_OF(type, p) \
267 ((void*) (1 ? p : (type*)0))
268 # define CHECKED_PPTR_OF(type, p) \
269 ((void**) (1 ? p : (type**)0))
271 # define TYPEDEF_D2I_OF(type) typedef type *d2i_of_##type(type **,const unsigned char **,long)
272 # define TYPEDEF_I2D_OF(type) typedef int i2d_of_##type(const type *,unsigned char **)
273 # define TYPEDEF_D2I2D_OF(type) TYPEDEF_D2I_OF(type); TYPEDEF_I2D_OF(type)
275 TYPEDEF_D2I2D_OF(void);
278 * The following macros and typedefs allow an ASN1_ITEM
279 * to be embedded in a structure and referenced. Since
280 * the ASN1_ITEM pointers need to be globally accessible
281 * (possibly from shared libraries) they may exist in
282 * different forms. On platforms that support it the
283 * ASN1_ITEM structure itself will be globally exported.
284 * Other platforms will export a function that returns
285 * an ASN1_ITEM pointer.
287 * To handle both cases transparently the macros below
288 * should be used instead of hard coding an ASN1_ITEM
289 * pointer in a structure.
291 * The structure will look like this:
293 * typedef struct SOMETHING_st {
295 * ASN1_ITEM_EXP *iptr;
299 * It would be initialised as e.g.:
301 * SOMETHING somevar = {...,ASN1_ITEM_ref(X509),...};
303 * and the actual pointer extracted with:
305 * const ASN1_ITEM *it = ASN1_ITEM_ptr(somevar.iptr);
307 * Finally an ASN1_ITEM pointer can be extracted from an
308 * appropriate reference with: ASN1_ITEM_rptr(X509). This
309 * would be used when a function takes an ASN1_ITEM * argument.
313 # ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION
315 /* ASN1_ITEM pointer exported type */
316 typedef const ASN1_ITEM ASN1_ITEM_EXP;
318 /* Macro to obtain ASN1_ITEM pointer from exported type */
319 # define ASN1_ITEM_ptr(iptr) (iptr)
321 /* Macro to include ASN1_ITEM pointer from base type */
322 # define ASN1_ITEM_ref(iptr) (&(iptr##_it))
324 # define ASN1_ITEM_rptr(ref) (&(ref##_it))
326 # define DECLARE_ASN1_ITEM(name) \
327 OPENSSL_EXTERN const ASN1_ITEM name##_it;
332 * Platforms that can't easily handle shared global variables are declared as
333 * functions returning ASN1_ITEM pointers.
336 /* ASN1_ITEM pointer exported type */
337 typedef const ASN1_ITEM *ASN1_ITEM_EXP (void);
339 /* Macro to obtain ASN1_ITEM pointer from exported type */
340 # define ASN1_ITEM_ptr(iptr) (iptr())
342 /* Macro to include ASN1_ITEM pointer from base type */
343 # define ASN1_ITEM_ref(iptr) (iptr##_it)
345 # define ASN1_ITEM_rptr(ref) (ref##_it())
347 # define DECLARE_ASN1_ITEM(name) \
348 const ASN1_ITEM * name##_it(void);
352 /* Parameters used by ASN1_STRING_print_ex() */
355 * These determine which characters to escape: RFC2253 special characters,
356 * control characters and MSB set characters
359 # define ASN1_STRFLGS_ESC_2253 1
360 # define ASN1_STRFLGS_ESC_CTRL 2
361 # define ASN1_STRFLGS_ESC_MSB 4
364 * This flag determines how we do escaping: normally RC2253 backslash only,
365 * set this to use backslash and quote.
368 # define ASN1_STRFLGS_ESC_QUOTE 8
370 /* These three flags are internal use only. */
372 /* Character is a valid PrintableString character */
373 # define CHARTYPE_PRINTABLESTRING 0x10
374 /* Character needs escaping if it is the first character */
375 # define CHARTYPE_FIRST_ESC_2253 0x20
376 /* Character needs escaping if it is the last character */
377 # define CHARTYPE_LAST_ESC_2253 0x40
380 * NB the internal flags are safely reused below by flags handled at the top
385 * If this is set we convert all character strings to UTF8 first
388 # define ASN1_STRFLGS_UTF8_CONVERT 0x10
391 * If this is set we don't attempt to interpret content: just assume all
392 * strings are 1 byte per character. This will produce some pretty odd
396 # define ASN1_STRFLGS_IGNORE_TYPE 0x20
398 /* If this is set we include the string type in the output */
399 # define ASN1_STRFLGS_SHOW_TYPE 0x40
402 * This determines which strings to display and which to 'dump' (hex dump of
403 * content octets or DER encoding). We can only dump non character strings or
404 * everything. If we don't dump 'unknown' they are interpreted as character
405 * strings with 1 octet per character and are subject to the usual escaping
409 # define ASN1_STRFLGS_DUMP_ALL 0x80
410 # define ASN1_STRFLGS_DUMP_UNKNOWN 0x100
413 * These determine what 'dumping' does, we can dump the content octets or the
414 * DER encoding: both use the RFC2253 #XXXXX notation.
417 # define ASN1_STRFLGS_DUMP_DER 0x200
420 * This flag specifies that RC2254 escaping shall be performed.
422 #define ASN1_STRFLGS_ESC_2254 0x400
425 * All the string flags consistent with RFC2253, escaping control characters
426 * isn't essential in RFC2253 but it is advisable anyway.
429 # define ASN1_STRFLGS_RFC2253 (ASN1_STRFLGS_ESC_2253 | \
430 ASN1_STRFLGS_ESC_CTRL | \
431 ASN1_STRFLGS_ESC_MSB | \
432 ASN1_STRFLGS_UTF8_CONVERT | \
433 ASN1_STRFLGS_DUMP_UNKNOWN | \
434 ASN1_STRFLGS_DUMP_DER)
436 DEFINE_STACK_OF(ASN1_INTEGER)
438 DEFINE_STACK_OF(ASN1_GENERALSTRING)
440 DEFINE_STACK_OF(ASN1_UTF8STRING)
442 typedef struct asn1_type_st {
446 ASN1_BOOLEAN boolean;
447 ASN1_STRING *asn1_string;
449 ASN1_INTEGER *integer;
450 ASN1_ENUMERATED *enumerated;
451 ASN1_BIT_STRING *bit_string;
452 ASN1_OCTET_STRING *octet_string;
453 ASN1_PRINTABLESTRING *printablestring;
454 ASN1_T61STRING *t61string;
455 ASN1_IA5STRING *ia5string;
456 ASN1_GENERALSTRING *generalstring;
457 ASN1_BMPSTRING *bmpstring;
458 ASN1_UNIVERSALSTRING *universalstring;
459 ASN1_UTCTIME *utctime;
460 ASN1_GENERALIZEDTIME *generalizedtime;
461 ASN1_VISIBLESTRING *visiblestring;
462 ASN1_UTF8STRING *utf8string;
464 * set and sequence are left complete and still contain the set or
468 ASN1_STRING *sequence;
469 ASN1_VALUE *asn1_value;
473 DEFINE_STACK_OF(ASN1_TYPE)
475 typedef STACK_OF(ASN1_TYPE) ASN1_SEQUENCE_ANY;
477 DECLARE_ASN1_ENCODE_FUNCTIONS_name(ASN1_SEQUENCE_ANY, ASN1_SEQUENCE_ANY)
478 DECLARE_ASN1_ENCODE_FUNCTIONS_name(ASN1_SEQUENCE_ANY, ASN1_SET_ANY)
480 /* This is used to contain a list of bit names */
481 typedef struct BIT_STRING_BITNAME_st {
485 } BIT_STRING_BITNAME;
487 # define B_ASN1_TIME \
489 B_ASN1_GENERALIZEDTIME
491 # define B_ASN1_PRINTABLE \
492 B_ASN1_NUMERICSTRING| \
493 B_ASN1_PRINTABLESTRING| \
497 B_ASN1_UNIVERSALSTRING|\
503 # define B_ASN1_DIRECTORYSTRING \
504 B_ASN1_PRINTABLESTRING| \
505 B_ASN1_TELETEXSTRING|\
507 B_ASN1_UNIVERSALSTRING|\
510 # define B_ASN1_DISPLAYTEXT \
512 B_ASN1_VISIBLESTRING| \
516 DECLARE_ASN1_ALLOC_FUNCTIONS_name(ASN1_TYPE, ASN1_TYPE)
517 DECLARE_ASN1_ENCODE_FUNCTIONS(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 DECLARE_ASN1_FUNCTIONS(ASN1_OBJECT)
528 DEFINE_STACK_OF(ASN1_OBJECT)
530 ASN1_STRING *ASN1_STRING_new(void);
531 void ASN1_STRING_free(ASN1_STRING *a);
532 void ASN1_STRING_clear_free(ASN1_STRING *a);
533 int ASN1_STRING_copy(ASN1_STRING *dst, const ASN1_STRING *str);
534 DECLARE_ASN1_DUP_FUNCTION(ASN1_STRING)
535 ASN1_STRING *ASN1_STRING_type_new(int type);
536 int ASN1_STRING_cmp(const ASN1_STRING *a, const ASN1_STRING *b);
538 * Since this is used to store all sorts of things, via macros, for now,
539 * make its data void *
541 int ASN1_STRING_set(ASN1_STRING *str, const void *data, int len);
542 void ASN1_STRING_set0(ASN1_STRING *str, void *data, int len);
543 int ASN1_STRING_length(const ASN1_STRING *x);
544 void ASN1_STRING_length_set(ASN1_STRING *x, int n);
545 int ASN1_STRING_type(const ASN1_STRING *x);
546 DEPRECATEDIN_1_1_0(unsigned char *ASN1_STRING_data(ASN1_STRING *x))
547 const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *x);
549 DECLARE_ASN1_FUNCTIONS(ASN1_BIT_STRING)
550 int ASN1_BIT_STRING_set(ASN1_BIT_STRING *a, unsigned char *d, int length);
551 int ASN1_BIT_STRING_set_bit(ASN1_BIT_STRING *a, int n, int value);
552 int ASN1_BIT_STRING_get_bit(const ASN1_BIT_STRING *a, int n);
553 int ASN1_BIT_STRING_check(const ASN1_BIT_STRING *a,
554 const unsigned char *flags, int flags_len);
556 int ASN1_BIT_STRING_name_print(BIO *out, ASN1_BIT_STRING *bs,
557 BIT_STRING_BITNAME *tbl, int indent);
558 int ASN1_BIT_STRING_num_asc(const char *name, BIT_STRING_BITNAME *tbl);
559 int ASN1_BIT_STRING_set_asc(ASN1_BIT_STRING *bs, const char *name, int value,
560 BIT_STRING_BITNAME *tbl);
562 DECLARE_ASN1_FUNCTIONS(ASN1_INTEGER)
563 ASN1_INTEGER *d2i_ASN1_UINTEGER(ASN1_INTEGER **a, const unsigned char **pp,
565 DECLARE_ASN1_DUP_FUNCTION(ASN1_INTEGER)
566 int ASN1_INTEGER_cmp(const ASN1_INTEGER *x, const ASN1_INTEGER *y);
568 DECLARE_ASN1_FUNCTIONS(ASN1_ENUMERATED)
570 int ASN1_UTCTIME_check(const ASN1_UTCTIME *a);
571 ASN1_UTCTIME *ASN1_UTCTIME_set(ASN1_UTCTIME *s, time_t t);
572 ASN1_UTCTIME *ASN1_UTCTIME_adj(ASN1_UTCTIME *s, time_t t,
573 int offset_day, long offset_sec);
574 int ASN1_UTCTIME_set_string(ASN1_UTCTIME *s, const char *str);
575 int ASN1_UTCTIME_cmp_time_t(const ASN1_UTCTIME *s, time_t t);
577 int ASN1_GENERALIZEDTIME_check(const ASN1_GENERALIZEDTIME *a);
578 ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_set(ASN1_GENERALIZEDTIME *s,
580 ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_adj(ASN1_GENERALIZEDTIME *s,
581 time_t t, int offset_day,
583 int ASN1_GENERALIZEDTIME_set_string(ASN1_GENERALIZEDTIME *s, const char *str);
585 int ASN1_TIME_diff(int *pday, int *psec,
586 const ASN1_TIME *from, const ASN1_TIME *to);
588 DECLARE_ASN1_FUNCTIONS(ASN1_OCTET_STRING)
589 DECLARE_ASN1_DUP_FUNCTION(ASN1_OCTET_STRING)
590 int ASN1_OCTET_STRING_cmp(const ASN1_OCTET_STRING *a,
591 const ASN1_OCTET_STRING *b);
592 int ASN1_OCTET_STRING_set(ASN1_OCTET_STRING *str, const unsigned char *data,
595 DECLARE_ASN1_FUNCTIONS(ASN1_VISIBLESTRING)
596 DECLARE_ASN1_FUNCTIONS(ASN1_UNIVERSALSTRING)
597 DECLARE_ASN1_FUNCTIONS(ASN1_UTF8STRING)
598 DECLARE_ASN1_FUNCTIONS(ASN1_NULL)
599 DECLARE_ASN1_FUNCTIONS(ASN1_BMPSTRING)
601 int UTF8_getc(const unsigned char *str, int len, unsigned long *val);
602 int UTF8_putc(unsigned char *str, int len, unsigned long value);
604 DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING, ASN1_PRINTABLE)
606 DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING, DIRECTORYSTRING)
607 DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING, DISPLAYTEXT)
608 DECLARE_ASN1_FUNCTIONS(ASN1_PRINTABLESTRING)
609 DECLARE_ASN1_FUNCTIONS(ASN1_T61STRING)
610 DECLARE_ASN1_FUNCTIONS(ASN1_IA5STRING)
611 DECLARE_ASN1_FUNCTIONS(ASN1_GENERALSTRING)
612 DECLARE_ASN1_FUNCTIONS(ASN1_UTCTIME)
613 DECLARE_ASN1_FUNCTIONS(ASN1_GENERALIZEDTIME)
614 DECLARE_ASN1_FUNCTIONS(ASN1_TIME)
616 DECLARE_ASN1_ITEM(ASN1_OCTET_STRING_NDEF)
618 ASN1_TIME *ASN1_TIME_set(ASN1_TIME *s, time_t t);
619 ASN1_TIME *ASN1_TIME_adj(ASN1_TIME *s, time_t t,
620 int offset_day, long offset_sec);
621 int ASN1_TIME_check(const ASN1_TIME *t);
622 ASN1_GENERALIZEDTIME *ASN1_TIME_to_generalizedtime(const ASN1_TIME *t,
623 ASN1_GENERALIZEDTIME **out);
624 int ASN1_TIME_set_string(ASN1_TIME *s, const char *str);
625 int ASN1_TIME_set_string_X509(ASN1_TIME *s, const char *str);
626 int ASN1_TIME_to_tm(const ASN1_TIME *s, struct tm *tm);
627 int ASN1_TIME_normalize(ASN1_TIME *s);
628 int ASN1_TIME_cmp_time_t(const ASN1_TIME *s, time_t t);
629 int ASN1_TIME_compare(const ASN1_TIME *a, const ASN1_TIME *b);
631 int i2a_ASN1_INTEGER(BIO *bp, const ASN1_INTEGER *a);
632 int a2i_ASN1_INTEGER(BIO *bp, ASN1_INTEGER *bs, char *buf, int size);
633 int i2a_ASN1_ENUMERATED(BIO *bp, const ASN1_ENUMERATED *a);
634 int a2i_ASN1_ENUMERATED(BIO *bp, ASN1_ENUMERATED *bs, char *buf, int size);
635 int i2a_ASN1_OBJECT(BIO *bp, const ASN1_OBJECT *a);
636 int a2i_ASN1_STRING(BIO *bp, ASN1_STRING *bs, char *buf, int size);
637 int i2a_ASN1_STRING(BIO *bp, const ASN1_STRING *a, int type);
638 int i2t_ASN1_OBJECT(char *buf, int buf_len, const ASN1_OBJECT *a);
640 int a2d_ASN1_OBJECT(unsigned char *out, int olen, const char *buf, int num);
641 ASN1_OBJECT *ASN1_OBJECT_create(int nid, unsigned char *data, int len,
642 const char *sn, const char *ln);
644 int ASN1_INTEGER_get_int64(int64_t *pr, const ASN1_INTEGER *a);
645 int ASN1_INTEGER_set_int64(ASN1_INTEGER *a, int64_t r);
646 int ASN1_INTEGER_get_uint64(uint64_t *pr, const ASN1_INTEGER *a);
647 int ASN1_INTEGER_set_uint64(ASN1_INTEGER *a, uint64_t r);
649 int ASN1_INTEGER_set(ASN1_INTEGER *a, long v);
650 long ASN1_INTEGER_get(const ASN1_INTEGER *a);
651 ASN1_INTEGER *BN_to_ASN1_INTEGER(const BIGNUM *bn, ASN1_INTEGER *ai);
652 BIGNUM *ASN1_INTEGER_to_BN(const ASN1_INTEGER *ai, BIGNUM *bn);
654 int ASN1_ENUMERATED_get_int64(int64_t *pr, const ASN1_ENUMERATED *a);
655 int ASN1_ENUMERATED_set_int64(ASN1_ENUMERATED *a, int64_t r);
658 int ASN1_ENUMERATED_set(ASN1_ENUMERATED *a, long v);
659 long ASN1_ENUMERATED_get(const ASN1_ENUMERATED *a);
660 ASN1_ENUMERATED *BN_to_ASN1_ENUMERATED(const BIGNUM *bn, ASN1_ENUMERATED *ai);
661 BIGNUM *ASN1_ENUMERATED_to_BN(const ASN1_ENUMERATED *ai, BIGNUM *bn);
664 /* given a string, return the correct type, max is the maximum length */
665 int ASN1_PRINTABLE_type(const unsigned char *s, int max);
667 unsigned long ASN1_tag2bit(int tag);
670 int ASN1_get_object(const unsigned char **pp, long *plength, int *ptag,
671 int *pclass, long omax);
672 int ASN1_check_infinite_end(unsigned char **p, long len);
673 int ASN1_const_check_infinite_end(const unsigned char **p, long len);
674 void ASN1_put_object(unsigned char **pp, int constructed, int length,
675 int tag, int xclass);
676 int ASN1_put_eoc(unsigned char **pp);
677 int ASN1_object_size(int constructed, int length, int tag);
679 /* Used to implement other functions */
680 void *ASN1_dup(i2d_of_void *i2d, d2i_of_void *d2i, const void *x);
682 # define ASN1_dup_of(type,i2d,d2i,x) \
683 ((type*)ASN1_dup(CHECKED_I2D_OF(type, i2d), \
684 CHECKED_D2I_OF(type, d2i), \
685 CHECKED_PTR_OF(const type, x)))
687 void *ASN1_item_dup(const ASN1_ITEM *it, const void *x);
689 /* ASN1 alloc/free macros for when a type is only used internally */
691 # define M_ASN1_new_of(type) (type *)ASN1_item_new(ASN1_ITEM_rptr(type))
692 # define M_ASN1_free_of(x, type) \
693 ASN1_item_free(CHECKED_PTR_OF(type, x), ASN1_ITEM_rptr(type))
695 # ifndef OPENSSL_NO_STDIO
696 void *ASN1_d2i_fp(void *(*xnew) (void), d2i_of_void *d2i, FILE *in, void **x);
698 # define ASN1_d2i_fp_of(type,xnew,d2i,in,x) \
699 ((type*)ASN1_d2i_fp(CHECKED_NEW_OF(type, xnew), \
700 CHECKED_D2I_OF(type, d2i), \
702 CHECKED_PPTR_OF(type, x)))
704 void *ASN1_item_d2i_fp(const ASN1_ITEM *it, FILE *in, void *x);
705 int ASN1_i2d_fp(i2d_of_void *i2d, FILE *out, const void *x);
707 # define ASN1_i2d_fp_of(type,i2d,out,x) \
708 (ASN1_i2d_fp(CHECKED_I2D_OF(type, i2d), \
710 CHECKED_PTR_OF(const type, x)))
712 int ASN1_item_i2d_fp(const ASN1_ITEM *it, FILE *out, const void *x);
713 int ASN1_STRING_print_ex_fp(FILE *fp, const ASN1_STRING *str, unsigned long flags);
716 int ASN1_STRING_to_UTF8(unsigned char **out, const ASN1_STRING *in);
718 void *ASN1_d2i_bio(void *(*xnew) (void), d2i_of_void *d2i, BIO *in, void **x);
720 # define ASN1_d2i_bio_of(type,xnew,d2i,in,x) \
721 ((type*)ASN1_d2i_bio( CHECKED_NEW_OF(type, xnew), \
722 CHECKED_D2I_OF(type, d2i), \
724 CHECKED_PPTR_OF(type, x)))
726 void *ASN1_item_d2i_bio(const ASN1_ITEM *it, BIO *in, void *x);
727 int ASN1_i2d_bio(i2d_of_void *i2d, BIO *out, const void *x);
729 # define ASN1_i2d_bio_of(type,i2d,out,x) \
730 (ASN1_i2d_bio(CHECKED_I2D_OF(type, i2d), \
732 CHECKED_PTR_OF(const type, x)))
734 int ASN1_item_i2d_bio(const ASN1_ITEM *it, BIO *out, const void *x);
735 int ASN1_UTCTIME_print(BIO *fp, const ASN1_UTCTIME *a);
736 int ASN1_GENERALIZEDTIME_print(BIO *fp, const ASN1_GENERALIZEDTIME *a);
737 int ASN1_TIME_print(BIO *fp, const ASN1_TIME *a);
738 int ASN1_STRING_print(BIO *bp, const ASN1_STRING *v);
739 int ASN1_STRING_print_ex(BIO *out, const ASN1_STRING *str, unsigned long flags);
740 int ASN1_buf_print(BIO *bp, const unsigned char *buf, size_t buflen, int off);
741 int ASN1_bn_print(BIO *bp, const char *number, const BIGNUM *num,
742 unsigned char *buf, int off);
743 int ASN1_parse(BIO *bp, const unsigned char *pp, long len, int indent);
744 int ASN1_parse_dump(BIO *bp, const unsigned char *pp, long len, int indent,
746 const char *ASN1_tag2str(int tag);
748 /* Used to load and write Netscape format cert */
750 int ASN1_UNIVERSALSTRING_to_string(ASN1_UNIVERSALSTRING *s);
752 int ASN1_TYPE_set_octetstring(ASN1_TYPE *a, unsigned char *data, int len);
753 int ASN1_TYPE_get_octetstring(const ASN1_TYPE *a, unsigned char *data, int max_len);
754 int ASN1_TYPE_set_int_octetstring(ASN1_TYPE *a, long num,
755 unsigned char *data, int len);
756 int ASN1_TYPE_get_int_octetstring(const ASN1_TYPE *a, long *num,
757 unsigned char *data, int max_len);
759 void *ASN1_item_unpack(const ASN1_STRING *oct, const ASN1_ITEM *it);
761 ASN1_STRING *ASN1_item_pack(void *obj, const ASN1_ITEM *it,
762 ASN1_OCTET_STRING **oct);
764 void ASN1_STRING_set_default_mask(unsigned long mask);
765 int ASN1_STRING_set_default_mask_asc(const char *p);
766 unsigned long ASN1_STRING_get_default_mask(void);
767 int ASN1_mbstring_copy(ASN1_STRING **out, const unsigned char *in, int len,
768 int inform, unsigned long mask);
769 int ASN1_mbstring_ncopy(ASN1_STRING **out, const unsigned char *in, int len,
770 int inform, unsigned long mask,
771 long minsize, long maxsize);
773 ASN1_STRING *ASN1_STRING_set_by_NID(ASN1_STRING **out,
774 const unsigned char *in, int inlen,
775 int inform, int nid);
776 ASN1_STRING_TABLE *ASN1_STRING_TABLE_get(int nid);
777 int ASN1_STRING_TABLE_add(int, long, long, unsigned long, unsigned long);
778 void ASN1_STRING_TABLE_cleanup(void);
780 /* ASN1 template functions */
782 /* Old API compatible functions */
783 ASN1_VALUE *ASN1_item_new(const ASN1_ITEM *it);
784 void ASN1_item_free(ASN1_VALUE *val, const ASN1_ITEM *it);
785 ASN1_VALUE *ASN1_item_d2i(ASN1_VALUE **val, const unsigned char **in,
786 long len, const ASN1_ITEM *it);
787 int ASN1_item_i2d(const ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it);
788 int ASN1_item_ndef_i2d(const ASN1_VALUE *val, unsigned char **out,
789 const ASN1_ITEM *it);
791 void ASN1_add_oid_module(void);
792 void ASN1_add_stable_module(void);
794 ASN1_TYPE *ASN1_generate_nconf(const char *str, CONF *nconf);
795 ASN1_TYPE *ASN1_generate_v3(const char *str, X509V3_CTX *cnf);
796 int ASN1_str2mask(const char *str, unsigned long *pmask);
798 /* ASN1 Print flags */
800 /* Indicate missing OPTIONAL fields */
801 # define ASN1_PCTX_FLAGS_SHOW_ABSENT 0x001
802 /* Mark start and end of SEQUENCE */
803 # define ASN1_PCTX_FLAGS_SHOW_SEQUENCE 0x002
804 /* Mark start and end of SEQUENCE/SET OF */
805 # define ASN1_PCTX_FLAGS_SHOW_SSOF 0x004
806 /* Show the ASN1 type of primitives */
807 # define ASN1_PCTX_FLAGS_SHOW_TYPE 0x008
808 /* Don't show ASN1 type of ANY */
809 # define ASN1_PCTX_FLAGS_NO_ANY_TYPE 0x010
810 /* Don't show ASN1 type of MSTRINGs */
811 # define ASN1_PCTX_FLAGS_NO_MSTRING_TYPE 0x020
812 /* Don't show field names in SEQUENCE */
813 # define ASN1_PCTX_FLAGS_NO_FIELD_NAME 0x040
814 /* Show structure names of each SEQUENCE field */
815 # define ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME 0x080
816 /* Don't show structure name even at top level */
817 # define ASN1_PCTX_FLAGS_NO_STRUCT_NAME 0x100
819 int ASN1_item_print(BIO *out, const ASN1_VALUE *ifld, int indent,
820 const ASN1_ITEM *it, const ASN1_PCTX *pctx);
821 ASN1_PCTX *ASN1_PCTX_new(void);
822 void ASN1_PCTX_free(ASN1_PCTX *p);
823 unsigned long ASN1_PCTX_get_flags(const ASN1_PCTX *p);
824 void ASN1_PCTX_set_flags(ASN1_PCTX *p, unsigned long flags);
825 unsigned long ASN1_PCTX_get_nm_flags(const ASN1_PCTX *p);
826 void ASN1_PCTX_set_nm_flags(ASN1_PCTX *p, unsigned long flags);
827 unsigned long ASN1_PCTX_get_cert_flags(const ASN1_PCTX *p);
828 void ASN1_PCTX_set_cert_flags(ASN1_PCTX *p, unsigned long flags);
829 unsigned long ASN1_PCTX_get_oid_flags(const ASN1_PCTX *p);
830 void ASN1_PCTX_set_oid_flags(ASN1_PCTX *p, unsigned long flags);
831 unsigned long ASN1_PCTX_get_str_flags(const ASN1_PCTX *p);
832 void ASN1_PCTX_set_str_flags(ASN1_PCTX *p, unsigned long flags);
834 ASN1_SCTX *ASN1_SCTX_new(int (*scan_cb) (ASN1_SCTX *ctx));
835 void ASN1_SCTX_free(ASN1_SCTX *p);
836 const ASN1_ITEM *ASN1_SCTX_get_item(ASN1_SCTX *p);
837 const ASN1_TEMPLATE *ASN1_SCTX_get_template(ASN1_SCTX *p);
838 unsigned long ASN1_SCTX_get_flags(ASN1_SCTX *p);
839 void ASN1_SCTX_set_app_data(ASN1_SCTX *p, void *data);
840 void *ASN1_SCTX_get_app_data(ASN1_SCTX *p);
842 const BIO_METHOD *BIO_f_asn1(void);
844 /* cannot constify val because of CMS_stream() */
845 BIO *BIO_new_NDEF(BIO *out, ASN1_VALUE *val, const ASN1_ITEM *it);
847 int i2d_ASN1_bio_stream(BIO *out, ASN1_VALUE *val, BIO *in, int flags,
848 const ASN1_ITEM *it);
849 int PEM_write_bio_ASN1_stream(BIO *out, ASN1_VALUE *val, BIO *in, int flags,
850 const char *hdr, const ASN1_ITEM *it);
851 /* cannot constify val because of CMS_dataFinal() */
852 int SMIME_write_ASN1(BIO *bio, ASN1_VALUE *val, BIO *data, int flags,
853 int ctype_nid, int econt_nid,
854 STACK_OF(X509_ALGOR) *mdalgs, const ASN1_ITEM *it);
855 ASN1_VALUE *SMIME_read_ASN1(BIO *bio, BIO **bcont, const ASN1_ITEM *it);
856 int SMIME_crlf_copy(BIO *in, BIO *out, int flags);
857 int SMIME_text(BIO *in, BIO *out);
859 const ASN1_ITEM *ASN1_ITEM_lookup(const char *name);
860 const ASN1_ITEM *ASN1_ITEM_get(size_t i);
862 /* Legacy compatibility */
863 # define DECLARE_ASN1_FUNCTIONS_fname(type, itname, name) \
864 DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \
865 DECLARE_ASN1_ENCODE_FUNCTIONS(type, itname, name)
866 # define DECLARE_ASN1_FUNCTIONS_const(type) DECLARE_ASN1_FUNCTIONS(type)
867 # define DECLARE_ASN1_ENCODE_FUNCTIONS_const(type, name) \
868 DECLARE_ASN1_ENCODE_FUNCTIONS(type, name)
869 # define I2D_OF_const(type) I2D_OF(type)
870 # define ASN1_dup_of_const(type,i2d,d2i,x) ASN1_dup_of(type,i2d,d2i,x)
871 # define ASN1_i2d_fp_of_const(type,i2d,out,x) ASN1_i2d_fp_of(type,i2d,out,x)
872 # define ASN1_i2d_bio_of_const(type,i2d,out,x) ASN1_i2d_bio_of(type,i2d,out,x)