Coverage Report

Created: 2023-10-07 03:40

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