1*42fa457bSdoug /* $OpenBSD: bytestring.h,v 1.14 2015/06/19 00:23:36 doug Exp $ */ 2c4905cd3Sdoug /* 3c4905cd3Sdoug * Copyright (c) 2014, Google Inc. 4c4905cd3Sdoug * 5c4905cd3Sdoug * Permission to use, copy, modify, and/or distribute this software for any 6c4905cd3Sdoug * purpose with or without fee is hereby granted, provided that the above 7c4905cd3Sdoug * copyright notice and this permission notice appear in all copies. 8c4905cd3Sdoug * 9c4905cd3Sdoug * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10c4905cd3Sdoug * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11c4905cd3Sdoug * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 12c4905cd3Sdoug * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13c4905cd3Sdoug * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION 14c4905cd3Sdoug * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 15c4905cd3Sdoug * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ 16c4905cd3Sdoug 17c4905cd3Sdoug #ifndef OPENSSL_HEADER_BYTESTRING_H 18c4905cd3Sdoug #define OPENSSL_HEADER_BYTESTRING_H 19c4905cd3Sdoug 20c4905cd3Sdoug #if defined(__cplusplus) 21c4905cd3Sdoug extern "C" { 22c4905cd3Sdoug #endif 23c4905cd3Sdoug 24c4905cd3Sdoug #include <sys/types.h> 25c4905cd3Sdoug #include <stdint.h> 26c4905cd3Sdoug 27c4905cd3Sdoug #include <openssl/opensslconf.h> 28c4905cd3Sdoug 29732f1cb2Sdoug /* 30732f1cb2Sdoug * Bytestrings are used for parsing and building TLS and ASN.1 messages. 31c4905cd3Sdoug * 32c4905cd3Sdoug * A "CBS" (CRYPTO ByteString) represents a string of bytes in memory and 33c4905cd3Sdoug * provides utility functions for safely parsing length-prefixed structures 34c4905cd3Sdoug * like TLS and ASN.1 from it. 35c4905cd3Sdoug * 36c4905cd3Sdoug * A "CBB" (CRYPTO ByteBuilder) is a memory buffer that grows as needed and 37732f1cb2Sdoug * provides utility functions for building length-prefixed messages. 38732f1cb2Sdoug */ 39c4905cd3Sdoug 40c4905cd3Sdoug /* CRYPTO ByteString */ 41c4905cd3Sdoug typedef struct cbs_st { 42c4905cd3Sdoug const uint8_t *data; 4334e475baSdoug size_t initial_len; 44c4905cd3Sdoug size_t len; 45c4905cd3Sdoug } CBS; 46c4905cd3Sdoug 47732f1cb2Sdoug /* 48732f1cb2Sdoug * CBS_init sets |cbs| to point to |data|. It does not take ownership of 49732f1cb2Sdoug * |data|. 50732f1cb2Sdoug */ 51c4905cd3Sdoug void CBS_init(CBS *cbs, const uint8_t *data, size_t len); 52c4905cd3Sdoug 53732f1cb2Sdoug /* 54732f1cb2Sdoug * CBS_skip advances |cbs| by |len| bytes. It returns one on success and zero 55732f1cb2Sdoug * otherwise. 56732f1cb2Sdoug */ 57c4905cd3Sdoug int CBS_skip(CBS *cbs, size_t len); 58c4905cd3Sdoug 59732f1cb2Sdoug /* 603b087d0eSdoug * CBS_data returns a pointer to the contents of |cbs|. 61732f1cb2Sdoug */ 62c4905cd3Sdoug const uint8_t *CBS_data(const CBS *cbs); 63c4905cd3Sdoug 64732f1cb2Sdoug /* 65732f1cb2Sdoug * CBS_len returns the number of bytes remaining in |cbs|. 66732f1cb2Sdoug */ 67c4905cd3Sdoug size_t CBS_len(const CBS *cbs); 68c4905cd3Sdoug 69732f1cb2Sdoug /* 7034e475baSdoug * CBS_offset returns the current offset into the original data of |cbs|. 7134e475baSdoug */ 7234e475baSdoug size_t CBS_offset(const CBS *cbs); 7334e475baSdoug 7434e475baSdoug /* 75732f1cb2Sdoug * CBS_stow copies the current contents of |cbs| into |*out_ptr| and 76c4905cd3Sdoug * |*out_len|. If |*out_ptr| is not NULL, the contents are freed with 771f70f88bSdoug * free. It returns one on success and zero on allocation failure. On 781f70f88bSdoug * success, |*out_ptr| should be freed with free. If |cbs| is empty, 79732f1cb2Sdoug * |*out_ptr| will be NULL. 80732f1cb2Sdoug */ 81c4905cd3Sdoug int CBS_stow(const CBS *cbs, uint8_t **out_ptr, size_t *out_len); 82c4905cd3Sdoug 83732f1cb2Sdoug /* 84732f1cb2Sdoug * CBS_strdup copies the current contents of |cbs| into |*out_ptr| as a 85c4905cd3Sdoug * NUL-terminated C string. If |*out_ptr| is not NULL, the contents are freed 861f70f88bSdoug * with free. It returns one on success and zero on allocation 871f70f88bSdoug * failure. On success, |*out_ptr| should be freed with free. 88c4905cd3Sdoug * 89c4905cd3Sdoug * NOTE: If |cbs| contains NUL bytes, the string will be truncated. Call 90732f1cb2Sdoug * |CBS_contains_zero_byte(cbs)| to check for NUL bytes. 91732f1cb2Sdoug */ 92c4905cd3Sdoug int CBS_strdup(const CBS *cbs, char **out_ptr); 93c4905cd3Sdoug 94732f1cb2Sdoug /* 95df129122Sdoug * CBS_write_bytes writes all of the remaining data from |cbs| into |dst| 96df129122Sdoug * if it is at most |dst_len| bytes. If |copied| is not NULL, it will be set 97df129122Sdoug * to the amount copied. It returns one on success and zero otherwise. 98df129122Sdoug */ 99df129122Sdoug int CBS_write_bytes(const CBS *cbs, uint8_t *dst, size_t dst_len, 100df129122Sdoug size_t *copied); 101df129122Sdoug 102df129122Sdoug /* 103732f1cb2Sdoug * CBS_contains_zero_byte returns one if the current contents of |cbs| contains 104732f1cb2Sdoug * a NUL byte and zero otherwise. 105732f1cb2Sdoug */ 106c4905cd3Sdoug int CBS_contains_zero_byte(const CBS *cbs); 107c4905cd3Sdoug 108732f1cb2Sdoug /* 109732f1cb2Sdoug * CBS_mem_equal compares the current contents of |cbs| with the |len| bytes 110c4905cd3Sdoug * starting at |data|. If they're equal, it returns one, otherwise zero. If the 111732f1cb2Sdoug * lengths match, it uses a constant-time comparison. 112732f1cb2Sdoug */ 113732f1cb2Sdoug int CBS_mem_equal(const CBS *cbs, const uint8_t *data, size_t len); 114c4905cd3Sdoug 115732f1cb2Sdoug /* 116732f1cb2Sdoug * CBS_get_u8 sets |*out| to the next uint8_t from |cbs| and advances |cbs|. It 117732f1cb2Sdoug * returns one on success and zero on error. 118732f1cb2Sdoug */ 119c4905cd3Sdoug int CBS_get_u8(CBS *cbs, uint8_t *out); 120c4905cd3Sdoug 121732f1cb2Sdoug /* 122732f1cb2Sdoug * CBS_get_u16 sets |*out| to the next, big-endian uint16_t from |cbs| and 123732f1cb2Sdoug * advances |cbs|. It returns one on success and zero on error. 124732f1cb2Sdoug */ 125c4905cd3Sdoug int CBS_get_u16(CBS *cbs, uint16_t *out); 126c4905cd3Sdoug 127732f1cb2Sdoug /* 128732f1cb2Sdoug * CBS_get_u24 sets |*out| to the next, big-endian 24-bit value from |cbs| and 129732f1cb2Sdoug * advances |cbs|. It returns one on success and zero on error. 130732f1cb2Sdoug */ 131c4905cd3Sdoug int CBS_get_u24(CBS *cbs, uint32_t *out); 132c4905cd3Sdoug 133732f1cb2Sdoug /* 134732f1cb2Sdoug * CBS_get_u32 sets |*out| to the next, big-endian uint32_t value from |cbs| 135732f1cb2Sdoug * and advances |cbs|. It returns one on success and zero on error. 136732f1cb2Sdoug */ 137c4905cd3Sdoug int CBS_get_u32(CBS *cbs, uint32_t *out); 138c4905cd3Sdoug 139732f1cb2Sdoug /* 140732f1cb2Sdoug * CBS_get_bytes sets |*out| to the next |len| bytes from |cbs| and advances 141732f1cb2Sdoug * |cbs|. It returns one on success and zero on error. 142732f1cb2Sdoug */ 143c4905cd3Sdoug int CBS_get_bytes(CBS *cbs, CBS *out, size_t len); 144c4905cd3Sdoug 145732f1cb2Sdoug /* 146732f1cb2Sdoug * CBS_get_u8_length_prefixed sets |*out| to the contents of an 8-bit, 147c4905cd3Sdoug * length-prefixed value from |cbs| and advances |cbs| over it. It returns one 148732f1cb2Sdoug * on success and zero on error. 149732f1cb2Sdoug */ 150c4905cd3Sdoug int CBS_get_u8_length_prefixed(CBS *cbs, CBS *out); 151c4905cd3Sdoug 152732f1cb2Sdoug /* 153732f1cb2Sdoug * CBS_get_u16_length_prefixed sets |*out| to the contents of a 16-bit, 154c4905cd3Sdoug * big-endian, length-prefixed value from |cbs| and advances |cbs| over it. It 155732f1cb2Sdoug * returns one on success and zero on error. 156732f1cb2Sdoug */ 157c4905cd3Sdoug int CBS_get_u16_length_prefixed(CBS *cbs, CBS *out); 158c4905cd3Sdoug 159732f1cb2Sdoug /* 160732f1cb2Sdoug * CBS_get_u24_length_prefixed sets |*out| to the contents of a 24-bit, 161c4905cd3Sdoug * big-endian, length-prefixed value from |cbs| and advances |cbs| over it. It 162732f1cb2Sdoug * returns one on success and zero on error. 163732f1cb2Sdoug */ 164c4905cd3Sdoug int CBS_get_u24_length_prefixed(CBS *cbs, CBS *out); 165c4905cd3Sdoug 166c4905cd3Sdoug 167c4905cd3Sdoug /* Parsing ASN.1 */ 168c4905cd3Sdoug 169844e66cbSdoug /* 170844e66cbSdoug * While an identifier can be multiple octets, this library only handles the 171844e66cbSdoug * single octet variety currently. This limits support up to tag number 30 172844e66cbSdoug * since tag number 31 is a reserved value to indicate multiple octets. 173844e66cbSdoug */ 174c4905cd3Sdoug 175844e66cbSdoug /* Bits 8 and 7: class tag type: See X.690 section 8.1.2.2. */ 176844e66cbSdoug #define CBS_ASN1_UNIVERSAL 0x00 177844e66cbSdoug #define CBS_ASN1_APPLICATION 0x40 178c4905cd3Sdoug #define CBS_ASN1_CONTEXT_SPECIFIC 0x80 179844e66cbSdoug #define CBS_ASN1_PRIVATE 0xc0 180844e66cbSdoug 181844e66cbSdoug /* Bit 6: Primitive or constructed: See X.690 section 8.1.2.3. */ 182844e66cbSdoug #define CBS_ASN1_PRIMITIVE 0x00 183844e66cbSdoug #define CBS_ASN1_CONSTRUCTED 0x20 184844e66cbSdoug 185844e66cbSdoug /* 186844e66cbSdoug * Bits 5 to 1 are the tag number. See X.680 section 8.6 for tag numbers of 187844e66cbSdoug * the universal class. 188844e66cbSdoug */ 189844e66cbSdoug 190844e66cbSdoug /* 191844e66cbSdoug * Common universal identifier octets. 192844e66cbSdoug * See X.690 section 8.1 and X.680 section 8.6 for universal tag numbers. 193844e66cbSdoug * 194844e66cbSdoug * Note: These definitions are the cause of some of the strange behavior in 195844e66cbSdoug * CBS's bs_ber.c. 196844e66cbSdoug * 197844e66cbSdoug * In BER, it is the sender's option to use primitive or constructed for 198844e66cbSdoug * bitstring (X.690 section 8.6.1) and octetstring (X.690 section 8.7.1). 199844e66cbSdoug * 200844e66cbSdoug * In DER, bitstring and octetstring are required to be primitive 201844e66cbSdoug * (X.690 section 10.2). 202844e66cbSdoug */ 203844e66cbSdoug #define CBS_ASN1_BOOLEAN (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x1) 204844e66cbSdoug #define CBS_ASN1_INTEGER (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x2) 205844e66cbSdoug #define CBS_ASN1_BITSTRING (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x3) 206844e66cbSdoug #define CBS_ASN1_OCTETSTRING (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x4) 207844e66cbSdoug #define CBS_ASN1_OBJECT (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x6) 208844e66cbSdoug #define CBS_ASN1_ENUMERATED (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0xa) 209844e66cbSdoug #define CBS_ASN1_SEQUENCE (CBS_ASN1_UNIVERSAL | CBS_ASN1_CONSTRUCTED | 0x10) 210844e66cbSdoug #define CBS_ASN1_SET (CBS_ASN1_UNIVERSAL | CBS_ASN1_CONSTRUCTED | 0x11) 211c4905cd3Sdoug 212732f1cb2Sdoug /* 213732f1cb2Sdoug * CBS_get_asn1 sets |*out| to the contents of DER-encoded, ASN.1 element (not 214c4905cd3Sdoug * including tag and length bytes) and advances |cbs| over it. The ASN.1 215c4905cd3Sdoug * element must match |tag_value|. It returns one on success and zero 216c4905cd3Sdoug * on error. 217c4905cd3Sdoug * 2183b087d0eSdoug * Tag numbers greater than 30 are not supported (i.e. short form only). 219732f1cb2Sdoug */ 2200ad3dcfdSdoug int CBS_get_asn1(CBS *cbs, CBS *out, unsigned int tag_value); 221c4905cd3Sdoug 222732f1cb2Sdoug /* 223732f1cb2Sdoug * CBS_get_asn1_element acts like |CBS_get_asn1| but |out| will include the 224732f1cb2Sdoug * ASN.1 header bytes too. 225732f1cb2Sdoug */ 2260ad3dcfdSdoug int CBS_get_asn1_element(CBS *cbs, CBS *out, unsigned int tag_value); 227c4905cd3Sdoug 228732f1cb2Sdoug /* 229732f1cb2Sdoug * CBS_peek_asn1_tag looks ahead at the next ASN.1 tag and returns one 230c4905cd3Sdoug * if the next ASN.1 element on |cbs| would have tag |tag_value|. If 231c4905cd3Sdoug * |cbs| is empty or the tag does not match, it returns zero. Note: if 232c4905cd3Sdoug * it returns one, CBS_get_asn1 may still fail if the rest of the 233732f1cb2Sdoug * element is malformed. 234732f1cb2Sdoug */ 2350ad3dcfdSdoug int CBS_peek_asn1_tag(const CBS *cbs, unsigned int tag_value); 236c4905cd3Sdoug 237732f1cb2Sdoug /* 238732f1cb2Sdoug * CBS_get_any_asn1_element sets |*out| to contain the next ASN.1 element from 239c4905cd3Sdoug * |*cbs| (including header bytes) and advances |*cbs|. It sets |*out_tag| to 2400870ee34Sdoug * the tag number and |*out_header_len| to the length of the ASN.1 header. 2410870ee34Sdoug * Each of |out|, |out_tag|, and |out_header_len| may be NULL to ignore 242c4905cd3Sdoug * the value. 243c4905cd3Sdoug * 2443b087d0eSdoug * Tag numbers greater than 30 are not supported (i.e. short form only). 245732f1cb2Sdoug */ 2460ad3dcfdSdoug int CBS_get_any_asn1_element(CBS *cbs, CBS *out, unsigned int *out_tag, 247c4905cd3Sdoug size_t *out_header_len); 248c4905cd3Sdoug 249732f1cb2Sdoug /* 250732f1cb2Sdoug * CBS_get_asn1_uint64 gets an ASN.1 INTEGER from |cbs| using |CBS_get_asn1| 251c4905cd3Sdoug * and sets |*out| to its value. It returns one on success and zero on error, 252c4905cd3Sdoug * where error includes the integer being negative, or too large to represent 253732f1cb2Sdoug * in 64 bits. 254732f1cb2Sdoug */ 255c4905cd3Sdoug int CBS_get_asn1_uint64(CBS *cbs, uint64_t *out); 256c4905cd3Sdoug 257732f1cb2Sdoug /* 258732f1cb2Sdoug * CBS_get_optional_asn1 gets an optional explicitly-tagged element 259c4905cd3Sdoug * from |cbs| tagged with |tag| and sets |*out| to its contents. If 260c4905cd3Sdoug * present, it sets |*out_present| to one, otherwise zero. It returns 261c4905cd3Sdoug * one on success, whether or not the element was present, and zero on 262732f1cb2Sdoug * decode failure. 263732f1cb2Sdoug */ 2640ad3dcfdSdoug int CBS_get_optional_asn1(CBS *cbs, CBS *out, int *out_present, 2650ad3dcfdSdoug unsigned int tag); 266c4905cd3Sdoug 267732f1cb2Sdoug /* 268732f1cb2Sdoug * CBS_get_optional_asn1_octet_string gets an optional 269c4905cd3Sdoug * explicitly-tagged OCTET STRING from |cbs|. If present, it sets 270c4905cd3Sdoug * |*out| to the string and |*out_present| to one. Otherwise, it sets 271c4905cd3Sdoug * |*out| to empty and |*out_present| to zero. |out_present| may be 272c4905cd3Sdoug * NULL. It returns one on success, whether or not the element was 273732f1cb2Sdoug * present, and zero on decode failure. 274732f1cb2Sdoug */ 275732f1cb2Sdoug int CBS_get_optional_asn1_octet_string(CBS *cbs, CBS *out, int *out_present, 2760ad3dcfdSdoug unsigned int tag); 277c4905cd3Sdoug 278732f1cb2Sdoug /* 279732f1cb2Sdoug * CBS_get_optional_asn1_uint64 gets an optional explicitly-tagged 280c4905cd3Sdoug * INTEGER from |cbs|. If present, it sets |*out| to the 281c4905cd3Sdoug * value. Otherwise, it sets |*out| to |default_value|. It returns one 282c4905cd3Sdoug * on success, whether or not the element was present, and zero on 283732f1cb2Sdoug * decode failure. 284732f1cb2Sdoug */ 2850ad3dcfdSdoug int CBS_get_optional_asn1_uint64(CBS *cbs, uint64_t *out, unsigned int tag, 286c4905cd3Sdoug uint64_t default_value); 287c4905cd3Sdoug 288732f1cb2Sdoug /* 289732f1cb2Sdoug * CBS_get_optional_asn1_bool gets an optional, explicitly-tagged BOOLEAN from 290c4905cd3Sdoug * |cbs|. If present, it sets |*out| to either zero or one, based on the 291c4905cd3Sdoug * boolean. Otherwise, it sets |*out| to |default_value|. It returns one on 292c4905cd3Sdoug * success, whether or not the element was present, and zero on decode 293732f1cb2Sdoug * failure. 294732f1cb2Sdoug */ 2950ad3dcfdSdoug int CBS_get_optional_asn1_bool(CBS *cbs, int *out, unsigned int tag, 296c4905cd3Sdoug int default_value); 297c4905cd3Sdoug 298c4905cd3Sdoug 299732f1cb2Sdoug /* 300732f1cb2Sdoug * CRYPTO ByteBuilder. 301c4905cd3Sdoug * 302c4905cd3Sdoug * |CBB| objects allow one to build length-prefixed serialisations. A |CBB| 303c4905cd3Sdoug * object is associated with a buffer and new buffers are created with 304c4905cd3Sdoug * |CBB_init|. Several |CBB| objects can point at the same buffer when a 305c4905cd3Sdoug * length-prefix is pending, however only a single |CBB| can be 'current' at 306c4905cd3Sdoug * any one time. For example, if one calls |CBB_add_u8_length_prefixed| then 307c4905cd3Sdoug * the new |CBB| points at the same buffer as the original. But if the original 308c4905cd3Sdoug * |CBB| is used then the length prefix is written out and the new |CBB| must 309c4905cd3Sdoug * not be used again. 310c4905cd3Sdoug * 311c4905cd3Sdoug * If one needs to force a length prefix to be written out because a |CBB| is 312732f1cb2Sdoug * going out of scope, use |CBB_flush|. 313732f1cb2Sdoug */ 314c4905cd3Sdoug 315c4905cd3Sdoug struct cbb_buffer_st { 316c4905cd3Sdoug uint8_t *buf; 317732f1cb2Sdoug 318732f1cb2Sdoug /* The number of valid bytes. */ 319732f1cb2Sdoug size_t len; 320732f1cb2Sdoug 321732f1cb2Sdoug /* The size of buf. */ 322732f1cb2Sdoug size_t cap; 323732f1cb2Sdoug 324732f1cb2Sdoug /* 325732f1cb2Sdoug * One iff |buf| is owned by this object. If not then |buf| cannot be 326732f1cb2Sdoug * resized. 327732f1cb2Sdoug */ 328732f1cb2Sdoug char can_resize; 329c4905cd3Sdoug }; 330c4905cd3Sdoug 331c4905cd3Sdoug typedef struct cbb_st { 332c4905cd3Sdoug struct cbb_buffer_st *base; 333732f1cb2Sdoug 334732f1cb2Sdoug /* 335732f1cb2Sdoug * offset is the offset from the start of |base->buf| to the position of any 336732f1cb2Sdoug * pending length-prefix. 337732f1cb2Sdoug */ 338c4905cd3Sdoug size_t offset; 339732f1cb2Sdoug 340c4905cd3Sdoug /* child points to a child CBB if a length-prefix is pending. */ 341c4905cd3Sdoug struct cbb_st *child; 342732f1cb2Sdoug 343732f1cb2Sdoug /* 344732f1cb2Sdoug * pending_len_len contains the number of bytes in a pending length-prefix, 345732f1cb2Sdoug * or zero if no length-prefix is pending. 346732f1cb2Sdoug */ 347c4905cd3Sdoug uint8_t pending_len_len; 348732f1cb2Sdoug 349c4905cd3Sdoug char pending_is_asn1; 350732f1cb2Sdoug 351732f1cb2Sdoug /* 352732f1cb2Sdoug * is_top_level is true iff this is a top-level |CBB| (as opposed to a child 353732f1cb2Sdoug * |CBB|). Top-level objects are valid arguments for |CBB_finish|. 354732f1cb2Sdoug */ 355c4905cd3Sdoug char is_top_level; 356c4905cd3Sdoug } CBB; 357c4905cd3Sdoug 358732f1cb2Sdoug /* 359732f1cb2Sdoug * CBB_init initialises |cbb| with |initial_capacity|. Since a |CBB| grows as 360c4905cd3Sdoug * needed, the |initial_capacity| is just a hint. It returns one on success or 361732f1cb2Sdoug * zero on error. 362732f1cb2Sdoug */ 363c4905cd3Sdoug int CBB_init(CBB *cbb, size_t initial_capacity); 364c4905cd3Sdoug 365732f1cb2Sdoug /* 366732f1cb2Sdoug * CBB_init_fixed initialises |cbb| to write to |len| bytes at |buf|. Since 367c4905cd3Sdoug * |buf| cannot grow, trying to write more than |len| bytes will cause CBB 368732f1cb2Sdoug * functions to fail. It returns one on success or zero on error. 369732f1cb2Sdoug */ 370c4905cd3Sdoug int CBB_init_fixed(CBB *cbb, uint8_t *buf, size_t len); 371c4905cd3Sdoug 372732f1cb2Sdoug /* 373732f1cb2Sdoug * CBB_cleanup frees all resources owned by |cbb| and other |CBB| objects 374c4905cd3Sdoug * writing to the same buffer. This should be used in an error case where a 375732f1cb2Sdoug * serialisation is abandoned. 376732f1cb2Sdoug */ 377c4905cd3Sdoug void CBB_cleanup(CBB *cbb); 378c4905cd3Sdoug 379732f1cb2Sdoug /* 380732f1cb2Sdoug * CBB_finish completes any pending length prefix and sets |*out_data| to a 381c4905cd3Sdoug * malloced buffer and |*out_len| to the length of that buffer. The caller 382c4905cd3Sdoug * takes ownership of the buffer and, unless the buffer was fixed with 3831f70f88bSdoug * |CBB_init_fixed|, must call |free| when done. 384c4905cd3Sdoug * 385c4905cd3Sdoug * It can only be called on a "top level" |CBB|, i.e. one initialised with 386c4905cd3Sdoug * |CBB_init| or |CBB_init_fixed|. It returns one on success and zero on 387732f1cb2Sdoug * error. 388732f1cb2Sdoug */ 389c4905cd3Sdoug int CBB_finish(CBB *cbb, uint8_t **out_data, size_t *out_len); 390c4905cd3Sdoug 391732f1cb2Sdoug /* 392732f1cb2Sdoug * CBB_flush causes any pending length prefixes to be written out and any child 393c4905cd3Sdoug * |CBB| objects of |cbb| to be invalidated. It returns one on success or zero 394732f1cb2Sdoug * on error. 395732f1cb2Sdoug */ 396c4905cd3Sdoug int CBB_flush(CBB *cbb); 397c4905cd3Sdoug 398732f1cb2Sdoug /* 399732f1cb2Sdoug * CBB_add_u8_length_prefixed sets |*out_contents| to a new child of |cbb|. The 400c4905cd3Sdoug * data written to |*out_contents| will be prefixed in |cbb| with an 8-bit 401732f1cb2Sdoug * length. It returns one on success or zero on error. 402732f1cb2Sdoug */ 403c4905cd3Sdoug int CBB_add_u8_length_prefixed(CBB *cbb, CBB *out_contents); 404c4905cd3Sdoug 405732f1cb2Sdoug /* 406732f1cb2Sdoug * CBB_add_u16_length_prefixed sets |*out_contents| to a new child of |cbb|. 407c4905cd3Sdoug * The data written to |*out_contents| will be prefixed in |cbb| with a 16-bit, 408732f1cb2Sdoug * big-endian length. It returns one on success or zero on error. 409732f1cb2Sdoug */ 410c4905cd3Sdoug int CBB_add_u16_length_prefixed(CBB *cbb, CBB *out_contents); 411c4905cd3Sdoug 412732f1cb2Sdoug /* 413732f1cb2Sdoug * CBB_add_u24_length_prefixed sets |*out_contents| to a new child of |cbb|. 414c4905cd3Sdoug * The data written to |*out_contents| will be prefixed in |cbb| with a 24-bit, 415732f1cb2Sdoug * big-endian length. It returns one on success or zero on error. 416732f1cb2Sdoug */ 417c4905cd3Sdoug int CBB_add_u24_length_prefixed(CBB *cbb, CBB *out_contents); 418c4905cd3Sdoug 419732f1cb2Sdoug /* 420732f1cb2Sdoug * CBB_add_asn sets |*out_contents| to a |CBB| into which the contents of an 421c4905cd3Sdoug * ASN.1 object can be written. The |tag| argument will be used as the tag for 422d7a08d8fSdoug * the object. Passing in |tag| number 31 will return in an error since only 423d7a08d8fSdoug * single octet identifiers are supported. It returns one on success or zero 424d7a08d8fSdoug * on error. 425732f1cb2Sdoug */ 4269d4b5ca7Sdoug int CBB_add_asn1(CBB *cbb, CBB *out_contents, unsigned int tag); 427c4905cd3Sdoug 428732f1cb2Sdoug /* 429732f1cb2Sdoug * CBB_add_bytes appends |len| bytes from |data| to |cbb|. It returns one on 430732f1cb2Sdoug * success and zero otherwise. 431732f1cb2Sdoug */ 432c4905cd3Sdoug int CBB_add_bytes(CBB *cbb, const uint8_t *data, size_t len); 433c4905cd3Sdoug 434732f1cb2Sdoug /* 435732f1cb2Sdoug * CBB_add_space appends |len| bytes to |cbb| and sets |*out_data| to point to 436c4905cd3Sdoug * the beginning of that space. The caller must then write |len| bytes of 437c4905cd3Sdoug * actual contents to |*out_data|. It returns one on success and zero 438732f1cb2Sdoug * otherwise. 439732f1cb2Sdoug */ 440c4905cd3Sdoug int CBB_add_space(CBB *cbb, uint8_t **out_data, size_t len); 441c4905cd3Sdoug 442732f1cb2Sdoug /* 443732f1cb2Sdoug * CBB_add_u8 appends an 8-bit number from |value| to |cbb|. It returns one on 444732f1cb2Sdoug * success and zero otherwise. 445732f1cb2Sdoug */ 4469d4b5ca7Sdoug int CBB_add_u8(CBB *cbb, size_t value); 447c4905cd3Sdoug 448732f1cb2Sdoug /* 449732f1cb2Sdoug * CBB_add_u8 appends a 16-bit, big-endian number from |value| to |cbb|. It 450732f1cb2Sdoug * returns one on success and zero otherwise. 451732f1cb2Sdoug */ 4529d4b5ca7Sdoug int CBB_add_u16(CBB *cbb, size_t value); 453c4905cd3Sdoug 454732f1cb2Sdoug /* 455732f1cb2Sdoug * CBB_add_u24 appends a 24-bit, big-endian number from |value| to |cbb|. It 456732f1cb2Sdoug * returns one on success and zero otherwise. 457732f1cb2Sdoug */ 4589d4b5ca7Sdoug int CBB_add_u24(CBB *cbb, size_t value); 459c4905cd3Sdoug 460732f1cb2Sdoug /* 461732f1cb2Sdoug * CBB_add_asn1_uint64 writes an ASN.1 INTEGER into |cbb| using |CBB_add_asn1| 462c4905cd3Sdoug * and writes |value| in its contents. It returns one on success and zero on 463732f1cb2Sdoug * error. 464732f1cb2Sdoug */ 465c4905cd3Sdoug int CBB_add_asn1_uint64(CBB *cbb, uint64_t value); 466c4905cd3Sdoug 467c4905cd3Sdoug #ifdef LIBRESSL_INTERNAL 468732f1cb2Sdoug /* 469*42fa457bSdoug * CBS_dup sets |out| to point to cbs's |data| and |len|. It results in two 470*42fa457bSdoug * CBS that point to the same buffer. 471*42fa457bSdoug */ 472*42fa457bSdoug void CBS_dup(const CBS *cbs, CBS *out); 473*42fa457bSdoug 474*42fa457bSdoug /* 4752b93cbaaSdoug * cbs_get_any_asn1_element sets |*out| to contain the next ASN.1 element from 4760870ee34Sdoug * |*cbs| (including header bytes) and advances |*cbs|. It sets |*out_tag| to 4770870ee34Sdoug * the tag number and |*out_header_len| to the length of the ASN.1 header. If 4780870ee34Sdoug * strict mode is disabled and the element has indefinite length then |*out| 4790870ee34Sdoug * will only contain the header. Each of |out|, |out_tag|, and 4800870ee34Sdoug * |out_header_len| may be NULL to ignore the value. 4810870ee34Sdoug * 4820870ee34Sdoug * Tag numbers greater than 30 are not supported (i.e. short form only). 4830870ee34Sdoug */ 4840ad3dcfdSdoug int cbs_get_any_asn1_element_internal(CBS *cbs, CBS *out, unsigned int *out_tag, 4850870ee34Sdoug size_t *out_header_len, int strict); 4860870ee34Sdoug 4870870ee34Sdoug /* 48850933c7bSdoug * CBS_asn1_indefinite_to_definite reads an ASN.1 structure from |in|. If it 48950933c7bSdoug * finds indefinite-length elements that otherwise appear to be valid DER, it 49050933c7bSdoug * attempts to convert the DER-like data to DER and sets |*out| and 49150933c7bSdoug * |*out_length| to describe a malloced buffer containing the DER data. 49250933c7bSdoug * Additionally, |*in| will be advanced over the ASN.1 data. 493c4905cd3Sdoug * 494c4905cd3Sdoug * If it doesn't find any indefinite-length elements then it sets |*out| to 495c4905cd3Sdoug * NULL and |*in| is unmodified. 496c4905cd3Sdoug * 49750933c7bSdoug * This is NOT a conversion from BER to DER. There are many restrictions when 49850933c7bSdoug * dealing with DER data. This is only concerned with one: indefinite vs. 49950933c7bSdoug * definite form. However, this suffices to handle the PKCS#7 and PKCS#12 output 500c4905cd3Sdoug * from NSS. 501c4905cd3Sdoug * 502732f1cb2Sdoug * It returns one on success and zero otherwise. 503732f1cb2Sdoug */ 50450933c7bSdoug int CBS_asn1_indefinite_to_definite(CBS *in, uint8_t **out, size_t *out_len); 505c4905cd3Sdoug #endif /* LIBRESSL_INTERNAL */ 506c4905cd3Sdoug 507c4905cd3Sdoug #if defined(__cplusplus) 508c4905cd3Sdoug } /* extern C */ 509c4905cd3Sdoug #endif 510c4905cd3Sdoug 511c4905cd3Sdoug #endif /* OPENSSL_HEADER_BYTESTRING_H */ 512