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/types.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.
315 * Platforms that can't easily handle shared global variables are declared as
316 * functions returning ASN1_ITEM pointers.
319 /* ASN1_ITEM pointer exported type */
320 typedef const ASN1_ITEM
*ASN1_ITEM_EXP (void);
322 /* Macro to obtain ASN1_ITEM pointer from exported type */
323 # define ASN1_ITEM_ptr(iptr) (iptr())
325 /* Macro to include ASN1_ITEM pointer from base type */
326 # define ASN1_ITEM_ref(iptr) (iptr##_it)
328 # define ASN1_ITEM_rptr(ref) (ref##_it())
330 # define DECLARE_ASN1_ITEM(name) \
331 const ASN1_ITEM * name##_it(void);
333 /* Parameters used by ASN1_STRING_print_ex() */
336 * These determine which characters to escape: RFC2253 special characters,
337 * control characters and MSB set characters
340 # define ASN1_STRFLGS_ESC_2253 1
341 # define ASN1_STRFLGS_ESC_CTRL 2
342 # define ASN1_STRFLGS_ESC_MSB 4
345 * This flag determines how we do escaping: normally RC2253 backslash only,
346 * set this to use backslash and quote.
349 # define ASN1_STRFLGS_ESC_QUOTE 8
351 /* These three flags are internal use only. */
353 /* Character is a valid PrintableString character */
354 # define CHARTYPE_PRINTABLESTRING 0x10
355 /* Character needs escaping if it is the first character */
356 # define CHARTYPE_FIRST_ESC_2253 0x20
357 /* Character needs escaping if it is the last character */
358 # define CHARTYPE_LAST_ESC_2253 0x40
361 * NB the internal flags are safely reused below by flags handled at the top
366 * If this is set we convert all character strings to UTF8 first
369 # define ASN1_STRFLGS_UTF8_CONVERT 0x10
372 * If this is set we don't attempt to interpret content: just assume all
373 * strings are 1 byte per character. This will produce some pretty odd
377 # define ASN1_STRFLGS_IGNORE_TYPE 0x20
379 /* If this is set we include the string type in the output */
380 # define ASN1_STRFLGS_SHOW_TYPE 0x40
383 * This determines which strings to display and which to 'dump' (hex dump of
384 * content octets or DER encoding). We can only dump non character strings or
385 * everything. If we don't dump 'unknown' they are interpreted as character
386 * strings with 1 octet per character and are subject to the usual escaping
390 # define ASN1_STRFLGS_DUMP_ALL 0x80
391 # define ASN1_STRFLGS_DUMP_UNKNOWN 0x100
394 * These determine what 'dumping' does, we can dump the content octets or the
395 * DER encoding: both use the RFC2253 #XXXXX notation.
398 # define ASN1_STRFLGS_DUMP_DER 0x200
401 * This flag specifies that RC2254 escaping shall be performed.
403 #define ASN1_STRFLGS_ESC_2254 0x400
406 * All the string flags consistent with RFC2253, escaping control characters
407 * isn't essential in RFC2253 but it is advisable anyway.
410 # define ASN1_STRFLGS_RFC2253 (ASN1_STRFLGS_ESC_2253 | \
411 ASN1_STRFLGS_ESC_CTRL | \
412 ASN1_STRFLGS_ESC_MSB | \
413 ASN1_STRFLGS_UTF8_CONVERT | \
414 ASN1_STRFLGS_DUMP_UNKNOWN | \
415 ASN1_STRFLGS_DUMP_DER)
417 DEFINE_STACK_OF(ASN1_INTEGER
)
419 DEFINE_STACK_OF(ASN1_GENERALSTRING
)
421 DEFINE_STACK_OF(ASN1_UTF8STRING
)
423 typedef struct asn1_type_st
{
427 ASN1_BOOLEAN boolean
;
428 ASN1_STRING
*asn1_string
;
430 ASN1_INTEGER
*integer
;
431 ASN1_ENUMERATED
*enumerated
;
432 ASN1_BIT_STRING
*bit_string
;
433 ASN1_OCTET_STRING
*octet_string
;
434 ASN1_PRINTABLESTRING
*printablestring
;
435 ASN1_T61STRING
*t61string
;
436 ASN1_IA5STRING
*ia5string
;
437 ASN1_GENERALSTRING
*generalstring
;
438 ASN1_BMPSTRING
*bmpstring
;
439 ASN1_UNIVERSALSTRING
*universalstring
;
440 ASN1_UTCTIME
*utctime
;
441 ASN1_GENERALIZEDTIME
*generalizedtime
;
442 ASN1_VISIBLESTRING
*visiblestring
;
443 ASN1_UTF8STRING
*utf8string
;
445 * set and sequence are left complete and still contain the set or
449 ASN1_STRING
*sequence
;
450 ASN1_VALUE
*asn1_value
;
454 DEFINE_STACK_OF(ASN1_TYPE
)
456 typedef STACK_OF(ASN1_TYPE
) ASN1_SEQUENCE_ANY
;
458 DECLARE_ASN1_ENCODE_FUNCTIONS_name(ASN1_SEQUENCE_ANY
, ASN1_SEQUENCE_ANY
)
459 DECLARE_ASN1_ENCODE_FUNCTIONS_name(ASN1_SEQUENCE_ANY
, ASN1_SET_ANY
)
461 /* This is used to contain a list of bit names */
462 typedef struct BIT_STRING_BITNAME_st
{
466 } BIT_STRING_BITNAME
;
468 # define B_ASN1_TIME \
470 B_ASN1_GENERALIZEDTIME
472 # define B_ASN1_PRINTABLE \
473 B_ASN1_NUMERICSTRING| \
474 B_ASN1_PRINTABLESTRING| \
478 B_ASN1_UNIVERSALSTRING|\
484 # define B_ASN1_DIRECTORYSTRING \
485 B_ASN1_PRINTABLESTRING| \
486 B_ASN1_TELETEXSTRING|\
488 B_ASN1_UNIVERSALSTRING|\
491 # define B_ASN1_DISPLAYTEXT \
493 B_ASN1_VISIBLESTRING| \
497 DECLARE_ASN1_ALLOC_FUNCTIONS_name(ASN1_TYPE
, ASN1_TYPE
)
498 DECLARE_ASN1_ENCODE_FUNCTIONS(ASN1_TYPE
, ASN1_ANY
, ASN1_TYPE
)
500 int ASN1_TYPE_get(const ASN1_TYPE
*a
);
501 void ASN1_TYPE_set(ASN1_TYPE
*a
, int type
, void *value
);
502 int ASN1_TYPE_set1(ASN1_TYPE
*a
, int type
, const void *value
);
503 int ASN1_TYPE_cmp(const ASN1_TYPE
*a
, const ASN1_TYPE
*b
);
505 ASN1_TYPE
*ASN1_TYPE_pack_sequence(const ASN1_ITEM
*it
, void *s
, ASN1_TYPE
**t
);
506 void *ASN1_TYPE_unpack_sequence(const ASN1_ITEM
*it
, const ASN1_TYPE
*t
);
508 DECLARE_ASN1_FUNCTIONS(ASN1_OBJECT
)
509 DEFINE_STACK_OF(ASN1_OBJECT
)
511 ASN1_STRING
*ASN1_STRING_new(void);
512 void ASN1_STRING_free(ASN1_STRING
*a
);
513 void ASN1_STRING_clear_free(ASN1_STRING
*a
);
514 int ASN1_STRING_copy(ASN1_STRING
*dst
, const ASN1_STRING
*str
);
515 DECLARE_ASN1_DUP_FUNCTION(ASN1_STRING
)
516 ASN1_STRING
*ASN1_STRING_type_new(int type
);
517 int ASN1_STRING_cmp(const ASN1_STRING
*a
, const ASN1_STRING
*b
);
519 * Since this is used to store all sorts of things, via macros, for now,
520 * make its data void *
522 int ASN1_STRING_set(ASN1_STRING
*str
, const void *data
, int len
);
523 void ASN1_STRING_set0(ASN1_STRING
*str
, void *data
, int len
);
524 int ASN1_STRING_length(const ASN1_STRING
*x
);
525 void ASN1_STRING_length_set(ASN1_STRING
*x
, int n
);
526 int ASN1_STRING_type(const ASN1_STRING
*x
);
527 DEPRECATEDIN_1_1_0(unsigned char *ASN1_STRING_data(ASN1_STRING
*x
))
528 const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING
*x
);
530 DECLARE_ASN1_FUNCTIONS(ASN1_BIT_STRING
)
531 int ASN1_BIT_STRING_set(ASN1_BIT_STRING
*a
, unsigned char *d
, int length
);
532 int ASN1_BIT_STRING_set_bit(ASN1_BIT_STRING
*a
, int n
, int value
);
533 int ASN1_BIT_STRING_get_bit(const ASN1_BIT_STRING
*a
, int n
);
534 int ASN1_BIT_STRING_check(const ASN1_BIT_STRING
*a
,
535 const unsigned char *flags
, int flags_len
);
537 int ASN1_BIT_STRING_name_print(BIO
*out
, ASN1_BIT_STRING
*bs
,
538 BIT_STRING_BITNAME
*tbl
, int indent
);
539 int ASN1_BIT_STRING_num_asc(const char *name
, BIT_STRING_BITNAME
*tbl
);
540 int ASN1_BIT_STRING_set_asc(ASN1_BIT_STRING
*bs
, const char *name
, int value
,
541 BIT_STRING_BITNAME
*tbl
);
543 DECLARE_ASN1_FUNCTIONS(ASN1_INTEGER
)
544 ASN1_INTEGER
*d2i_ASN1_UINTEGER(ASN1_INTEGER
**a
, const unsigned char **pp
,
546 DECLARE_ASN1_DUP_FUNCTION(ASN1_INTEGER
)
547 int ASN1_INTEGER_cmp(const ASN1_INTEGER
*x
, const ASN1_INTEGER
*y
);
549 DECLARE_ASN1_FUNCTIONS(ASN1_ENUMERATED
)
551 int ASN1_UTCTIME_check(const ASN1_UTCTIME
*a
);
552 ASN1_UTCTIME
*ASN1_UTCTIME_set(ASN1_UTCTIME
*s
, time_t t
);
553 ASN1_UTCTIME
*ASN1_UTCTIME_adj(ASN1_UTCTIME
*s
, time_t t
,
554 int offset_day
, long offset_sec
);
555 int ASN1_UTCTIME_set_string(ASN1_UTCTIME
*s
, const char *str
);
556 int ASN1_UTCTIME_cmp_time_t(const ASN1_UTCTIME
*s
, time_t t
);
558 int ASN1_GENERALIZEDTIME_check(const ASN1_GENERALIZEDTIME
*a
);
559 ASN1_GENERALIZEDTIME
*ASN1_GENERALIZEDTIME_set(ASN1_GENERALIZEDTIME
*s
,
561 ASN1_GENERALIZEDTIME
*ASN1_GENERALIZEDTIME_adj(ASN1_GENERALIZEDTIME
*s
,
562 time_t t
, int offset_day
,
564 int ASN1_GENERALIZEDTIME_set_string(ASN1_GENERALIZEDTIME
*s
, const char *str
);
566 int ASN1_TIME_diff(int *pday
, int *psec
,
567 const ASN1_TIME
*from
, const ASN1_TIME
*to
);
569 DECLARE_ASN1_FUNCTIONS(ASN1_OCTET_STRING
)
570 DECLARE_ASN1_DUP_FUNCTION(ASN1_OCTET_STRING
)
571 int ASN1_OCTET_STRING_cmp(const ASN1_OCTET_STRING
*a
,
572 const ASN1_OCTET_STRING
*b
);
573 int ASN1_OCTET_STRING_set(ASN1_OCTET_STRING
*str
, const unsigned char *data
,
576 DECLARE_ASN1_FUNCTIONS(ASN1_VISIBLESTRING
)
577 DECLARE_ASN1_FUNCTIONS(ASN1_UNIVERSALSTRING
)
578 DECLARE_ASN1_FUNCTIONS(ASN1_UTF8STRING
)
579 DECLARE_ASN1_FUNCTIONS(ASN1_NULL
)
580 DECLARE_ASN1_FUNCTIONS(ASN1_BMPSTRING
)
582 int UTF8_getc(const unsigned char *str
, int len
, unsigned long *val
);
583 int UTF8_putc(unsigned char *str
, int len
, unsigned long value
);
585 DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING
, ASN1_PRINTABLE
)
587 DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING
, DIRECTORYSTRING
)
588 DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING
, DISPLAYTEXT
)
589 DECLARE_ASN1_FUNCTIONS(ASN1_PRINTABLESTRING
)
590 DECLARE_ASN1_FUNCTIONS(ASN1_T61STRING
)
591 DECLARE_ASN1_FUNCTIONS(ASN1_IA5STRING
)
592 DECLARE_ASN1_FUNCTIONS(ASN1_GENERALSTRING
)
593 DECLARE_ASN1_FUNCTIONS(ASN1_UTCTIME
)
594 DECLARE_ASN1_FUNCTIONS(ASN1_GENERALIZEDTIME
)
595 DECLARE_ASN1_FUNCTIONS(ASN1_TIME
)
597 DECLARE_ASN1_ITEM(ASN1_OCTET_STRING_NDEF
)
599 ASN1_TIME
*ASN1_TIME_set(ASN1_TIME
*s
, time_t t
);
600 ASN1_TIME
*ASN1_TIME_adj(ASN1_TIME
*s
, time_t t
,
601 int offset_day
, long offset_sec
);
602 int ASN1_TIME_check(const ASN1_TIME
*t
);
603 ASN1_GENERALIZEDTIME
*ASN1_TIME_to_generalizedtime(const ASN1_TIME
*t
,
604 ASN1_GENERALIZEDTIME
**out
);
605 int ASN1_TIME_set_string(ASN1_TIME
*s
, const char *str
);
606 int ASN1_TIME_set_string_X509(ASN1_TIME
*s
, const char *str
);
607 int ASN1_TIME_to_tm(const ASN1_TIME
*s
, struct tm
*tm
);
608 int ASN1_TIME_normalize(ASN1_TIME
*s
);
609 int ASN1_TIME_cmp_time_t(const ASN1_TIME
*s
, time_t t
);
610 int ASN1_TIME_compare(const ASN1_TIME
*a
, const ASN1_TIME
*b
);
612 int i2a_ASN1_INTEGER(BIO
*bp
, const ASN1_INTEGER
*a
);
613 int a2i_ASN1_INTEGER(BIO
*bp
, ASN1_INTEGER
*bs
, char *buf
, int size
);
614 int i2a_ASN1_ENUMERATED(BIO
*bp
, const ASN1_ENUMERATED
*a
);
615 int a2i_ASN1_ENUMERATED(BIO
*bp
, ASN1_ENUMERATED
*bs
, char *buf
, int size
);
616 int i2a_ASN1_OBJECT(BIO
*bp
, const ASN1_OBJECT
*a
);
617 int a2i_ASN1_STRING(BIO
*bp
, ASN1_STRING
*bs
, char *buf
, int size
);
618 int i2a_ASN1_STRING(BIO
*bp
, const ASN1_STRING
*a
, int type
);
619 int i2t_ASN1_OBJECT(char *buf
, int buf_len
, const ASN1_OBJECT
*a
);
621 int a2d_ASN1_OBJECT(unsigned char *out
, int olen
, const char *buf
, int num
);
622 ASN1_OBJECT
*ASN1_OBJECT_create(int nid
, unsigned char *data
, int len
,
623 const char *sn
, const char *ln
);
625 int ASN1_INTEGER_get_int64(int64_t *pr
, const ASN1_INTEGER
*a
);
626 int ASN1_INTEGER_set_int64(ASN1_INTEGER
*a
, int64_t r
);
627 int ASN1_INTEGER_get_uint64(uint64_t *pr
, const ASN1_INTEGER
*a
);
628 int ASN1_INTEGER_set_uint64(ASN1_INTEGER
*a
, uint64_t r
);
630 int ASN1_INTEGER_set(ASN1_INTEGER
*a
, long v
);
631 long ASN1_INTEGER_get(const ASN1_INTEGER
*a
);
632 ASN1_INTEGER
*BN_to_ASN1_INTEGER(const BIGNUM
*bn
, ASN1_INTEGER
*ai
);
633 BIGNUM
*ASN1_INTEGER_to_BN(const ASN1_INTEGER
*ai
, BIGNUM
*bn
);
635 int ASN1_ENUMERATED_get_int64(int64_t *pr
, const ASN1_ENUMERATED
*a
);
636 int ASN1_ENUMERATED_set_int64(ASN1_ENUMERATED
*a
, int64_t r
);
639 int ASN1_ENUMERATED_set(ASN1_ENUMERATED
*a
, long v
);
640 long ASN1_ENUMERATED_get(const ASN1_ENUMERATED
*a
);
641 ASN1_ENUMERATED
*BN_to_ASN1_ENUMERATED(const BIGNUM
*bn
, ASN1_ENUMERATED
*ai
);
642 BIGNUM
*ASN1_ENUMERATED_to_BN(const ASN1_ENUMERATED
*ai
, BIGNUM
*bn
);
645 /* given a string, return the correct type, max is the maximum length */
646 int ASN1_PRINTABLE_type(const unsigned char *s
, int max
);
648 unsigned long ASN1_tag2bit(int tag
);
651 int ASN1_get_object(const unsigned char **pp
, long *plength
, int *ptag
,
652 int *pclass
, long omax
);
653 int ASN1_check_infinite_end(unsigned char **p
, long len
);
654 int ASN1_const_check_infinite_end(const unsigned char **p
, long len
);
655 void ASN1_put_object(unsigned char **pp
, int constructed
, int length
,
656 int tag
, int xclass
);
657 int ASN1_put_eoc(unsigned char **pp
);
658 int ASN1_object_size(int constructed
, int length
, int tag
);
660 /* Used to implement other functions */
661 void *ASN1_dup(i2d_of_void
*i2d
, d2i_of_void
*d2i
, const void *x
);
663 # define ASN1_dup_of(type,i2d,d2i,x) \
664 ((type*)ASN1_dup(CHECKED_I2D_OF(type, i2d), \
665 CHECKED_D2I_OF(type, d2i), \
666 CHECKED_PTR_OF(const type, x)))
668 void *ASN1_item_dup(const ASN1_ITEM
*it
, const void *x
);
670 /* ASN1 alloc/free macros for when a type is only used internally */
672 # define M_ASN1_new_of(type) (type *)ASN1_item_new(ASN1_ITEM_rptr(type))
673 # define M_ASN1_free_of(x, type) \
674 ASN1_item_free(CHECKED_PTR_OF(type, x), ASN1_ITEM_rptr(type))
676 # ifndef OPENSSL_NO_STDIO
677 void *ASN1_d2i_fp(void *(*xnew
) (void), d2i_of_void
*d2i
, FILE *in
, void **x
);
679 # define ASN1_d2i_fp_of(type,xnew,d2i,in,x) \
680 ((type*)ASN1_d2i_fp(CHECKED_NEW_OF(type, xnew), \
681 CHECKED_D2I_OF(type, d2i), \
683 CHECKED_PPTR_OF(type, x)))
685 void *ASN1_item_d2i_fp(const ASN1_ITEM
*it
, FILE *in
, void *x
);
686 int ASN1_i2d_fp(i2d_of_void
*i2d
, FILE *out
, const void *x
);
688 # define ASN1_i2d_fp_of(type,i2d,out,x) \
689 (ASN1_i2d_fp(CHECKED_I2D_OF(type, i2d), \
691 CHECKED_PTR_OF(const type, x)))
693 int ASN1_item_i2d_fp(const ASN1_ITEM
*it
, FILE *out
, const void *x
);
694 int ASN1_STRING_print_ex_fp(FILE *fp
, const ASN1_STRING
*str
, unsigned long flags
);
697 int ASN1_STRING_to_UTF8(unsigned char **out
, const ASN1_STRING
*in
);
699 void *ASN1_d2i_bio(void *(*xnew
) (void), d2i_of_void
*d2i
, BIO
*in
, void **x
);
701 # define ASN1_d2i_bio_of(type,xnew,d2i,in,x) \
702 ((type*)ASN1_d2i_bio( CHECKED_NEW_OF(type, xnew), \
703 CHECKED_D2I_OF(type, d2i), \
705 CHECKED_PPTR_OF(type, x)))
707 void *ASN1_item_d2i_bio(const ASN1_ITEM
*it
, BIO
*in
, void *x
);
708 int ASN1_i2d_bio(i2d_of_void
*i2d
, BIO
*out
, const void *x
);
710 # define ASN1_i2d_bio_of(type,i2d,out,x) \
711 (ASN1_i2d_bio(CHECKED_I2D_OF(type, i2d), \
713 CHECKED_PTR_OF(const type, x)))
715 int ASN1_item_i2d_bio(const ASN1_ITEM
*it
, BIO
*out
, const void *x
);
716 int ASN1_UTCTIME_print(BIO
*fp
, const ASN1_UTCTIME
*a
);
717 int ASN1_GENERALIZEDTIME_print(BIO
*fp
, const ASN1_GENERALIZEDTIME
*a
);
718 int ASN1_TIME_print(BIO
*fp
, const ASN1_TIME
*a
);
719 int ASN1_STRING_print(BIO
*bp
, const ASN1_STRING
*v
);
720 int ASN1_STRING_print_ex(BIO
*out
, const ASN1_STRING
*str
, unsigned long flags
);
721 int ASN1_buf_print(BIO
*bp
, const unsigned char *buf
, size_t buflen
, int off
);
722 int ASN1_bn_print(BIO
*bp
, const char *number
, const BIGNUM
*num
,
723 unsigned char *buf
, int off
);
724 int ASN1_parse(BIO
*bp
, const unsigned char *pp
, long len
, int indent
);
725 int ASN1_parse_dump(BIO
*bp
, const unsigned char *pp
, long len
, int indent
,
727 const char *ASN1_tag2str(int tag
);
729 /* Used to load and write Netscape format cert */
731 int ASN1_UNIVERSALSTRING_to_string(ASN1_UNIVERSALSTRING
*s
);
733 int ASN1_TYPE_set_octetstring(ASN1_TYPE
*a
, unsigned char *data
, int len
);
734 int ASN1_TYPE_get_octetstring(const ASN1_TYPE
*a
, unsigned char *data
, int max_len
);
735 int ASN1_TYPE_set_int_octetstring(ASN1_TYPE
*a
, long num
,
736 unsigned char *data
, int len
);
737 int ASN1_TYPE_get_int_octetstring(const ASN1_TYPE
*a
, long *num
,
738 unsigned char *data
, int max_len
);
740 void *ASN1_item_unpack(const ASN1_STRING
*oct
, const ASN1_ITEM
*it
);
742 ASN1_STRING
*ASN1_item_pack(void *obj
, const ASN1_ITEM
*it
,
743 ASN1_OCTET_STRING
**oct
);
745 void ASN1_STRING_set_default_mask(unsigned long mask
);
746 int ASN1_STRING_set_default_mask_asc(const char *p
);
747 unsigned long ASN1_STRING_get_default_mask(void);
748 int ASN1_mbstring_copy(ASN1_STRING
**out
, const unsigned char *in
, int len
,
749 int inform
, unsigned long mask
);
750 int ASN1_mbstring_ncopy(ASN1_STRING
**out
, const unsigned char *in
, int len
,
751 int inform
, unsigned long mask
,
752 long minsize
, long maxsize
);
754 ASN1_STRING
*ASN1_STRING_set_by_NID(ASN1_STRING
**out
,
755 const unsigned char *in
, int inlen
,
756 int inform
, int nid
);
757 ASN1_STRING_TABLE
*ASN1_STRING_TABLE_get(int nid
);
758 int ASN1_STRING_TABLE_add(int, long, long, unsigned long, unsigned long);
759 void ASN1_STRING_TABLE_cleanup(void);
761 /* ASN1 template functions */
763 /* Old API compatible functions */
764 ASN1_VALUE
*ASN1_item_new(const ASN1_ITEM
*it
);
765 void ASN1_item_free(ASN1_VALUE
*val
, const ASN1_ITEM
*it
);
766 ASN1_VALUE
*ASN1_item_d2i(ASN1_VALUE
**val
, const unsigned char **in
,
767 long len
, const ASN1_ITEM
*it
);
768 int ASN1_item_i2d(const ASN1_VALUE
*val
, unsigned char **out
, const ASN1_ITEM
*it
);
769 int ASN1_item_ndef_i2d(const ASN1_VALUE
*val
, unsigned char **out
,
770 const ASN1_ITEM
*it
);
772 void ASN1_add_oid_module(void);
773 void ASN1_add_stable_module(void);
775 ASN1_TYPE
*ASN1_generate_nconf(const char *str
, CONF
*nconf
);
776 ASN1_TYPE
*ASN1_generate_v3(const char *str
, X509V3_CTX
*cnf
);
777 int ASN1_str2mask(const char *str
, unsigned long *pmask
);
779 /* ASN1 Print flags */
781 /* Indicate missing OPTIONAL fields */
782 # define ASN1_PCTX_FLAGS_SHOW_ABSENT 0x001
783 /* Mark start and end of SEQUENCE */
784 # define ASN1_PCTX_FLAGS_SHOW_SEQUENCE 0x002
785 /* Mark start and end of SEQUENCE/SET OF */
786 # define ASN1_PCTX_FLAGS_SHOW_SSOF 0x004
787 /* Show the ASN1 type of primitives */
788 # define ASN1_PCTX_FLAGS_SHOW_TYPE 0x008
789 /* Don't show ASN1 type of ANY */
790 # define ASN1_PCTX_FLAGS_NO_ANY_TYPE 0x010
791 /* Don't show ASN1 type of MSTRINGs */
792 # define ASN1_PCTX_FLAGS_NO_MSTRING_TYPE 0x020
793 /* Don't show field names in SEQUENCE */
794 # define ASN1_PCTX_FLAGS_NO_FIELD_NAME 0x040
795 /* Show structure names of each SEQUENCE field */
796 # define ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME 0x080
797 /* Don't show structure name even at top level */
798 # define ASN1_PCTX_FLAGS_NO_STRUCT_NAME 0x100
800 int ASN1_item_print(BIO
*out
, const ASN1_VALUE
*ifld
, int indent
,
801 const ASN1_ITEM
*it
, const ASN1_PCTX
*pctx
);
802 ASN1_PCTX
*ASN1_PCTX_new(void);
803 void ASN1_PCTX_free(ASN1_PCTX
*p
);
804 unsigned long ASN1_PCTX_get_flags(const ASN1_PCTX
*p
);
805 void ASN1_PCTX_set_flags(ASN1_PCTX
*p
, unsigned long flags
);
806 unsigned long ASN1_PCTX_get_nm_flags(const ASN1_PCTX
*p
);
807 void ASN1_PCTX_set_nm_flags(ASN1_PCTX
*p
, unsigned long flags
);
808 unsigned long ASN1_PCTX_get_cert_flags(const ASN1_PCTX
*p
);
809 void ASN1_PCTX_set_cert_flags(ASN1_PCTX
*p
, unsigned long flags
);
810 unsigned long ASN1_PCTX_get_oid_flags(const ASN1_PCTX
*p
);
811 void ASN1_PCTX_set_oid_flags(ASN1_PCTX
*p
, unsigned long flags
);
812 unsigned long ASN1_PCTX_get_str_flags(const ASN1_PCTX
*p
);
813 void ASN1_PCTX_set_str_flags(ASN1_PCTX
*p
, unsigned long flags
);
815 ASN1_SCTX
*ASN1_SCTX_new(int (*scan_cb
) (ASN1_SCTX
*ctx
));
816 void ASN1_SCTX_free(ASN1_SCTX
*p
);
817 const ASN1_ITEM
*ASN1_SCTX_get_item(ASN1_SCTX
*p
);
818 const ASN1_TEMPLATE
*ASN1_SCTX_get_template(ASN1_SCTX
*p
);
819 unsigned long ASN1_SCTX_get_flags(ASN1_SCTX
*p
);
820 void ASN1_SCTX_set_app_data(ASN1_SCTX
*p
, void *data
);
821 void *ASN1_SCTX_get_app_data(ASN1_SCTX
*p
);
823 const BIO_METHOD
*BIO_f_asn1(void);
825 /* cannot constify val because of CMS_stream() */
826 BIO
*BIO_new_NDEF(BIO
*out
, ASN1_VALUE
*val
, const ASN1_ITEM
*it
);
828 int i2d_ASN1_bio_stream(BIO
*out
, ASN1_VALUE
*val
, BIO
*in
, int flags
,
829 const ASN1_ITEM
*it
);
830 int PEM_write_bio_ASN1_stream(BIO
*out
, ASN1_VALUE
*val
, BIO
*in
, int flags
,
831 const char *hdr
, const ASN1_ITEM
*it
);
832 /* cannot constify val because of CMS_dataFinal() */
833 int SMIME_write_ASN1(BIO
*bio
, ASN1_VALUE
*val
, BIO
*data
, int flags
,
834 int ctype_nid
, int econt_nid
,
835 STACK_OF(X509_ALGOR
) *mdalgs
, const ASN1_ITEM
*it
);
836 ASN1_VALUE
*SMIME_read_ASN1(BIO
*bio
, BIO
**bcont
, const ASN1_ITEM
*it
);
837 int SMIME_crlf_copy(BIO
*in
, BIO
*out
, int flags
);
838 int SMIME_text(BIO
*in
, BIO
*out
);
840 const ASN1_ITEM
*ASN1_ITEM_lookup(const char *name
);
841 const ASN1_ITEM
*ASN1_ITEM_get(size_t i
);
843 /* Legacy compatibility */
844 # define DECLARE_ASN1_FUNCTIONS_fname(type, itname, name) \
845 DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \
846 DECLARE_ASN1_ENCODE_FUNCTIONS(type, itname, name)
847 # define DECLARE_ASN1_FUNCTIONS_const(type) DECLARE_ASN1_FUNCTIONS(type)
848 # define DECLARE_ASN1_ENCODE_FUNCTIONS_const(type, name) \
849 DECLARE_ASN1_ENCODE_FUNCTIONS(type, name)
850 # define I2D_OF_const(type) I2D_OF(type)
851 # define ASN1_dup_of_const(type,i2d,d2i,x) ASN1_dup_of(type,i2d,d2i,x)
852 # define ASN1_i2d_fp_of_const(type,i2d,out,x) ASN1_i2d_fp_of(type,i2d,out,x)
853 # define ASN1_i2d_bio_of_const(type,i2d,out,x) ASN1_i2d_bio_of(type,i2d,out,x)