include/openssl/asn1.h

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