Debian Codegraph @

external/boringssl/crypto/bytestring/internal.h

raw
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 and sets |*out| and |*out_length| to describe a malloced buffer
28 * containing the DER data. Additionally, |*in| will be advanced over the BER
29 * element.
30 *
31 * If it doesn't find any indefinite-length elements or constructed strings then
32 * it sets |*out| to NULL and |*in| is unmodified.
33 *
34 * This function should successfully process any valid BER input, however it
35 * will not convert all of BER's deviations from DER. BER is ambiguous between
36 * implicitly-tagged SEQUENCEs of strings and implicitly-tagged constructed
37 * strings. Implicitly-tagged strings must be parsed with
38 * |CBS_get_ber_implicitly_tagged_string| instead of |CBS_get_asn1|. The caller
39 * must also account for BER variations in the contents of a primitive.
40 *
41 * It returns one on success and zero otherwise. */
42 OPENSSL_EXPORT int CBS_asn1_ber_to_der(CBS *in, uint8_t **out, size_t *out_len);
43
44 /* CBS_get_asn1_implicit_string parses a BER string of primitive type
45 * |inner_tag| implicitly-tagged with |outer_tag|. It sets |out| to the
46 * contents. If concatenation was needed, it sets |*out_storage| to a buffer
47 * which the caller must release with |OPENSSL_free|. Otherwise, it sets
48 * |*out_storage| to NULL.
49 *
50 * This function does not parse all of BER. It requires the string be
51 * definite-length. Constructed strings are allowed, but all children of the
52 * outermost element must be primitive. The caller should use
53 * |CBS_asn1_ber_to_der| before running this function.
54 *
55 * It returns one on success and zero otherwise. */
56 OPENSSL_EXPORT int CBS_get_asn1_implicit_string(CBS *in, CBS *out,
57 uint8_t **out_storage,
58 unsigned outer_tag,
59 unsigned inner_tag);
60
61 /* CBB_finish_i2d calls |CBB_finish| on |cbb| which must have been initialized
62 * with |CBB_init|. If |outp| is not NULL then the result is written to |*outp|
63 * and |*outp| is advanced just past the output. It returns the number of bytes
64 * in the result, whether written or not, or a negative value on error. On
65 * error, it calls |CBB_cleanup| on |cbb|.
66 *
67 * This function may be used to help implement legacy i2d ASN.1 functions. */
68 int CBB_finish_i2d(CBB *cbb, uint8_t **outp);
69
70
71 #if defined(__cplusplus)
72 } /* extern C */
73 #endif
74
75 #endif /* OPENSSL_HEADER_BYTESTRING_INTERNAL_H */