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