include/openssl/asn1.h

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