1 /* Copyright (c) 2014, Google Inc. 2 * 3 * Permission to use, copy, modify, and/or distribute this software for any 4 * purpose with or without fee is hereby granted, provided that the above 5 * copyright notice and this permission notice appear in all copies. 6 * 7 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 8 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 9 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 10 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 11 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION 12 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 13 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ 14 15 #ifndef OPENSSL_HEADER_BYTESTRING_INTERNAL_H 16 #define OPENSSL_HEADER_BYTESTRING_INTERNAL_H 17 18 #include <openssl/base.h> 19 20 #if defined(__cplusplus) 21 extern "C" { 22 #endif 23 24 25 // CBS_asn1_ber_to_der reads a BER element from |in|. If it finds 26 // indefinite-length elements or constructed strings then it converts the BER 27 // data to DER, sets |out| to the converted contents and |*out_storage| to a 28 // buffer which the caller must release with |OPENSSL_free|. Otherwise, it sets 29 // |out| to the original BER element in |in| and |*out_storage| to NULL. 30 // Additionally, |*in| will be advanced over the BER element. 31 // 32 // This function should successfully process any valid BER input, however it 33 // will not convert all of BER's deviations from DER. BER is ambiguous between 34 // implicitly-tagged SEQUENCEs of strings and implicitly-tagged constructed 35 // strings. Implicitly-tagged strings must be parsed with 36 // |CBS_get_ber_implicitly_tagged_string| instead of |CBS_get_asn1|. The caller 37 // must also account for BER variations in the contents of a primitive. 38 // 39 // It returns one on success and zero otherwise. 40 OPENSSL_EXPORT int CBS_asn1_ber_to_der(CBS *in, CBS *out, 41 uint8_t **out_storage); 42 43 // CBS_get_asn1_implicit_string parses a BER string of primitive type 44 // |inner_tag| implicitly-tagged with |outer_tag|. It sets |out| to the 45 // contents. If concatenation was needed, it sets |*out_storage| to a buffer 46 // which the caller must release with |OPENSSL_free|. Otherwise, it sets 47 // |*out_storage| to NULL. 48 // 49 // This function does not parse all of BER. It requires the string be 50 // definite-length. Constructed strings are allowed, but all children of the 51 // outermost element must be primitive. The caller should use 52 // |CBS_asn1_ber_to_der| before running this function. 53 // 54 // It returns one on success and zero otherwise. 55 OPENSSL_EXPORT int CBS_get_asn1_implicit_string(CBS *in, CBS *out, 56 uint8_t **out_storage, 57 unsigned outer_tag, 58 unsigned inner_tag); 59 60 // CBB_finish_i2d calls |CBB_finish| on |cbb| which must have been initialized 61 // with |CBB_init|. If |outp| is not NULL then the result is written to |*outp| 62 // and |*outp| is advanced just past the output. It returns the number of bytes 63 // in the result, whether written or not, or a negative value on error. On 64 // error, it calls |CBB_cleanup| on |cbb|. 65 // 66 // This function may be used to help implement legacy i2d ASN.1 functions. 67 int CBB_finish_i2d(CBB *cbb, uint8_t **outp); 68 69 70 // Unicode utilities. 71 72 // The following functions read one Unicode code point from |cbs| with the 73 // corresponding encoding and store it in |*out|. They return one on success and 74 // zero on error. 75 OPENSSL_EXPORT int cbs_get_utf8(CBS *cbs, uint32_t *out); 76 OPENSSL_EXPORT int cbs_get_latin1(CBS *cbs, uint32_t *out); 77 OPENSSL_EXPORT int cbs_get_ucs2_be(CBS *cbs, uint32_t *out); 78 OPENSSL_EXPORT int cbs_get_utf32_be(CBS *cbs, uint32_t *out); 79 80 // cbb_get_utf8_len returns the number of bytes needed to represent |u| in 81 // UTF-8. 82 OPENSSL_EXPORT size_t cbb_get_utf8_len(uint32_t u); 83 84 // The following functions encode |u| to |cbb| with the corresponding 85 // encoding. They return one on success and zero on error. 86 OPENSSL_EXPORT int cbb_add_utf8(CBB *cbb, uint32_t u); 87 OPENSSL_EXPORT int cbb_add_latin1(CBB *cbb, uint32_t u); 88 OPENSSL_EXPORT int cbb_add_ucs2_be(CBB *cbb, uint32_t u); 89 OPENSSL_EXPORT int cbb_add_utf32_be(CBB *cbb, uint32_t u); 90 91 92 #if defined(__cplusplus) 93 } // extern C 94 #endif 95 96 #endif // OPENSSL_HEADER_BYTESTRING_INTERNAL_H 97