include/openssl/asn1.h

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