summaryrefslogtreecommitdiff
path: root/src/lib/libssl/bytestring.h
diff options
context:
space:
mode:
authorcvs2svn <admin@example.com>2021-08-18 16:06:57 +0000
committercvs2svn <admin@example.com>2021-08-18 16:06:57 +0000
commitd56c8fa8260d226f98b26f017b45b9c2b135f38d (patch)
tree348178b41617813cc93787187984a734ef8379ca /src/lib/libssl/bytestring.h
parent18b9c1bcab7c37d8c5bd05b8e0d14d0c59d96650 (diff)
downloadopenbsd-tb_20210818.tar.gz
openbsd-tb_20210818.tar.bz2
openbsd-tb_20210818.zip
This commit was manufactured by cvs2git to create tag 'tb_20210818'.tb_20210818
Diffstat (limited to 'src/lib/libssl/bytestring.h')
-rw-r--r--src/lib/libssl/bytestring.h518
1 files changed, 0 insertions, 518 deletions
diff --git a/src/lib/libssl/bytestring.h b/src/lib/libssl/bytestring.h
deleted file mode 100644
index 9e55dd44d6..0000000000
--- a/src/lib/libssl/bytestring.h
+++ /dev/null
@@ -1,518 +0,0 @@
1/* $OpenBSD: bytestring.h,v 1.19 2021/05/16 10:58:27 jsing Exp $ */
2/*
3 * Copyright (c) 2014, Google Inc.
4 *
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
12 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
14 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
15 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 */
17
18#ifndef OPENSSL_HEADER_BYTESTRING_H
19#define OPENSSL_HEADER_BYTESTRING_H
20
21#include <sys/types.h>
22#include <stdint.h>
23
24__BEGIN_HIDDEN_DECLS
25
26/*
27 * Bytestrings are used for parsing and building TLS and ASN.1 messages.
28 *
29 * A "CBS" (CRYPTO ByteString) represents a string of bytes in memory and
30 * provides utility functions for safely parsing length-prefixed structures
31 * like TLS and ASN.1 from it.
32 *
33 * A "CBB" (CRYPTO ByteBuilder) is a memory buffer that grows as needed and
34 * provides utility functions for building length-prefixed messages.
35 */
36
37/* CRYPTO ByteString */
38typedef struct cbs_st {
39 const uint8_t *data;
40 size_t initial_len;
41 size_t len;
42} CBS;
43
44/*
45 * CBS_init sets |cbs| to point to |data|. It does not take ownership of
46 * |data|.
47 */
48void CBS_init(CBS *cbs, const uint8_t *data, size_t len);
49
50/*
51 * CBS_skip advances |cbs| by |len| bytes. It returns one on success and zero
52 * otherwise.
53 */
54int CBS_skip(CBS *cbs, size_t len);
55
56/*
57 * CBS_data returns a pointer to the contents of |cbs|.
58 */
59const uint8_t *CBS_data(const CBS *cbs);
60
61/*
62 * CBS_len returns the number of bytes remaining in |cbs|.
63 */
64size_t CBS_len(const CBS *cbs);
65
66/*
67 * CBS_offset returns the current offset into the original data of |cbs|.
68 */
69size_t CBS_offset(const CBS *cbs);
70
71/*
72 * CBS_stow copies the current contents of |cbs| into |*out_ptr| and
73 * |*out_len|. If |*out_ptr| is not NULL, the contents are freed with
74 * free. It returns one on success and zero on allocation failure. On
75 * success, |*out_ptr| should be freed with free. If |cbs| is empty,
76 * |*out_ptr| will be NULL.
77 */
78int CBS_stow(const CBS *cbs, uint8_t **out_ptr, size_t *out_len);
79
80/*
81 * CBS_strdup copies the current contents of |cbs| into |*out_ptr| as a
82 * NUL-terminated C string. If |*out_ptr| is not NULL, the contents are freed
83 * with free. It returns one on success and zero on allocation
84 * failure. On success, |*out_ptr| should be freed with free.
85 *
86 * NOTE: If |cbs| contains NUL bytes, the string will be truncated. Call
87 * |CBS_contains_zero_byte(cbs)| to check for NUL bytes.
88 */
89int CBS_strdup(const CBS *cbs, char **out_ptr);
90
91/*
92 * CBS_write_bytes writes all of the remaining data from |cbs| into |dst|
93 * if it is at most |dst_len| bytes. If |copied| is not NULL, it will be set
94 * to the amount copied. It returns one on success and zero otherwise.
95 */
96int CBS_write_bytes(const CBS *cbs, uint8_t *dst, size_t dst_len,
97 size_t *copied);
98
99/*
100 * CBS_contains_zero_byte returns one if the current contents of |cbs| contains
101 * a NUL byte and zero otherwise.
102 */
103int CBS_contains_zero_byte(const CBS *cbs);
104
105/*
106 * CBS_mem_equal compares the current contents of |cbs| with the |len| bytes
107 * starting at |data|. If they're equal, it returns one, otherwise zero. If the
108 * lengths match, it uses a constant-time comparison.
109 */
110int CBS_mem_equal(const CBS *cbs, const uint8_t *data, size_t len);
111
112/*
113 * CBS_get_u8 sets |*out| to the next uint8_t from |cbs| and advances |cbs|. It
114 * returns one on success and zero on error.
115 */
116int CBS_get_u8(CBS *cbs, uint8_t *out);
117
118/*
119 * CBS_get_u16 sets |*out| to the next, big-endian uint16_t from |cbs| and
120 * advances |cbs|. It returns one on success and zero on error.
121 */
122int CBS_get_u16(CBS *cbs, uint16_t *out);
123
124/*
125 * CBS_get_u24 sets |*out| to the next, big-endian 24-bit value from |cbs| and
126 * advances |cbs|. It returns one on success and zero on error.
127 */
128int CBS_get_u24(CBS *cbs, uint32_t *out);
129
130/*
131 * CBS_get_u32 sets |*out| to the next, big-endian uint32_t value from |cbs|
132 * and advances |cbs|. It returns one on success and zero on error.
133 */
134int CBS_get_u32(CBS *cbs, uint32_t *out);
135
136/*
137 * CBS_get_bytes sets |*out| to the next |len| bytes from |cbs| and advances
138 * |cbs|. It returns one on success and zero on error.
139 */
140int CBS_get_bytes(CBS *cbs, CBS *out, size_t len);
141
142/*
143 * CBS_get_u8_length_prefixed sets |*out| to the contents of an 8-bit,
144 * length-prefixed value from |cbs| and advances |cbs| over it. It returns one
145 * on success and zero on error.
146 */
147int CBS_get_u8_length_prefixed(CBS *cbs, CBS *out);
148
149/*
150 * CBS_get_u16_length_prefixed sets |*out| to the contents of a 16-bit,
151 * big-endian, length-prefixed value from |cbs| and advances |cbs| over it. It
152 * returns one on success and zero on error.
153 */
154int CBS_get_u16_length_prefixed(CBS *cbs, CBS *out);
155
156/*
157 * CBS_get_u24_length_prefixed sets |*out| to the contents of a 24-bit,
158 * big-endian, length-prefixed value from |cbs| and advances |cbs| over it. It
159 * returns one on success and zero on error.
160 */
161int CBS_get_u24_length_prefixed(CBS *cbs, CBS *out);
162
163
164/* Parsing ASN.1 */
165
166/*
167 * While an identifier can be multiple octets, this library only handles the
168 * single octet variety currently. This limits support up to tag number 30
169 * since tag number 31 is a reserved value to indicate multiple octets.
170 */
171
172/* Bits 8 and 7: class tag type: See X.690 section 8.1.2.2. */
173#define CBS_ASN1_UNIVERSAL 0x00
174#define CBS_ASN1_APPLICATION 0x40
175#define CBS_ASN1_CONTEXT_SPECIFIC 0x80
176#define CBS_ASN1_PRIVATE 0xc0
177
178/* Bit 6: Primitive or constructed: See X.690 section 8.1.2.3. */
179#define CBS_ASN1_PRIMITIVE 0x00
180#define CBS_ASN1_CONSTRUCTED 0x20
181
182/*
183 * Bits 5 to 1 are the tag number. See X.680 section 8.6 for tag numbers of
184 * the universal class.
185 */
186
187/*
188 * Common universal identifier octets.
189 * See X.690 section 8.1 and X.680 section 8.6 for universal tag numbers.
190 *
191 * Note: These definitions are the cause of some of the strange behavior in
192 * CBS's bs_ber.c.
193 *
194 * In BER, it is the sender's option to use primitive or constructed for
195 * bitstring (X.690 section 8.6.1) and octetstring (X.690 section 8.7.1).
196 *
197 * In DER, bitstring and octetstring are required to be primitive
198 * (X.690 section 10.2).
199 */
200#define CBS_ASN1_BOOLEAN (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x1)
201#define CBS_ASN1_INTEGER (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x2)
202#define CBS_ASN1_BITSTRING (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x3)
203#define CBS_ASN1_OCTETSTRING (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x4)
204#define CBS_ASN1_OBJECT (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0x6)
205#define CBS_ASN1_ENUMERATED (CBS_ASN1_UNIVERSAL | CBS_ASN1_PRIMITIVE | 0xa)
206#define CBS_ASN1_SEQUENCE (CBS_ASN1_UNIVERSAL | CBS_ASN1_CONSTRUCTED | 0x10)
207#define CBS_ASN1_SET (CBS_ASN1_UNIVERSAL | CBS_ASN1_CONSTRUCTED | 0x11)
208
209/*
210 * CBS_get_asn1 sets |*out| to the contents of DER-encoded, ASN.1 element (not
211 * including tag and length bytes) and advances |cbs| over it. The ASN.1
212 * element must match |tag_value|. It returns one on success and zero
213 * on error.
214 *
215 * Tag numbers greater than 30 are not supported (i.e. short form only).
216 */
217int CBS_get_asn1(CBS *cbs, CBS *out, unsigned int tag_value);
218
219/*
220 * CBS_get_asn1_element acts like |CBS_get_asn1| but |out| will include the
221 * ASN.1 header bytes too.
222 */
223int CBS_get_asn1_element(CBS *cbs, CBS *out, unsigned int tag_value);
224
225/*
226 * CBS_peek_asn1_tag looks ahead at the next ASN.1 tag and returns one
227 * if the next ASN.1 element on |cbs| would have tag |tag_value|. If
228 * |cbs| is empty or the tag does not match, it returns zero. Note: if
229 * it returns one, CBS_get_asn1 may still fail if the rest of the
230 * element is malformed.
231 */
232int CBS_peek_asn1_tag(const CBS *cbs, unsigned int tag_value);
233
234/*
235 * CBS_get_any_asn1_element sets |*out| to contain the next ASN.1 element from
236 * |*cbs| (including header bytes) and advances |*cbs|. It sets |*out_tag| to
237 * the tag number and |*out_header_len| to the length of the ASN.1 header.
238 * Each of |out|, |out_tag|, and |out_header_len| may be NULL to ignore
239 * the value.
240 *
241 * Tag numbers greater than 30 are not supported (i.e. short form only).
242 */
243int CBS_get_any_asn1_element(CBS *cbs, CBS *out, unsigned int *out_tag,
244 size_t *out_header_len);
245
246/*
247 * CBS_get_asn1_uint64 gets an ASN.1 INTEGER from |cbs| using |CBS_get_asn1|
248 * and sets |*out| to its value. It returns one on success and zero on error,
249 * where error includes the integer being negative, or too large to represent
250 * in 64 bits.
251 */
252int CBS_get_asn1_uint64(CBS *cbs, uint64_t *out);
253
254/*
255 * CBS_get_optional_asn1 gets an optional explicitly-tagged element
256 * from |cbs| tagged with |tag| and sets |*out| to its contents. If
257 * present, it sets |*out_present| to one, otherwise zero. It returns
258 * one on success, whether or not the element was present, and zero on
259 * decode failure.
260 */
261int CBS_get_optional_asn1(CBS *cbs, CBS *out, int *out_present,
262 unsigned int tag);
263
264/*
265 * CBS_get_optional_asn1_octet_string gets an optional
266 * explicitly-tagged OCTET STRING from |cbs|. If present, it sets
267 * |*out| to the string and |*out_present| to one. Otherwise, it sets
268 * |*out| to empty and |*out_present| to zero. |out_present| may be
269 * NULL. It returns one on success, whether or not the element was
270 * present, and zero on decode failure.
271 */
272int CBS_get_optional_asn1_octet_string(CBS *cbs, CBS *out, int *out_present,
273 unsigned int tag);
274
275/*
276 * CBS_get_optional_asn1_uint64 gets an optional explicitly-tagged
277 * INTEGER from |cbs|. If present, it sets |*out| to the
278 * value. Otherwise, it sets |*out| to |default_value|. It returns one
279 * on success, whether or not the element was present, and zero on
280 * decode failure.
281 */
282int CBS_get_optional_asn1_uint64(CBS *cbs, uint64_t *out, unsigned int tag,
283 uint64_t default_value);
284
285/*
286 * CBS_get_optional_asn1_bool gets an optional, explicitly-tagged BOOLEAN from
287 * |cbs|. If present, it sets |*out| to either zero or one, based on the
288 * boolean. Otherwise, it sets |*out| to |default_value|. It returns one on
289 * success, whether or not the element was present, and zero on decode
290 * failure.
291 */
292int CBS_get_optional_asn1_bool(CBS *cbs, int *out, unsigned int tag,
293 int default_value);
294
295
296/*
297 * CRYPTO ByteBuilder.
298 *
299 * |CBB| objects allow one to build length-prefixed serialisations. A |CBB|
300 * object is associated with a buffer and new buffers are created with
301 * |CBB_init|. Several |CBB| objects can point at the same buffer when a
302 * length-prefix is pending, however only a single |CBB| can be 'current' at
303 * any one time. For example, if one calls |CBB_add_u8_length_prefixed| then
304 * the new |CBB| points at the same buffer as the original. But if the original
305 * |CBB| is used then the length prefix is written out and the new |CBB| must
306 * not be used again.
307 *
308 * If one needs to force a length prefix to be written out because a |CBB| is
309 * going out of scope, use |CBB_flush|.
310 */
311
312struct cbb_buffer_st {
313 uint8_t *buf;
314
315 /* The number of valid bytes. */
316 size_t len;
317
318 /* The size of buf. */
319 size_t cap;
320
321 /*
322 * One iff |buf| is owned by this object. If not then |buf| cannot be
323 * resized.
324 */
325 char can_resize;
326};
327
328typedef struct cbb_st {
329 struct cbb_buffer_st *base;
330
331 /*
332 * offset is the offset from the start of |base->buf| to the position of any
333 * pending length-prefix.
334 */
335 size_t offset;
336
337 /* child points to a child CBB if a length-prefix is pending. */
338 struct cbb_st *child;
339
340 /*
341 * pending_len_len contains the number of bytes in a pending length-prefix,
342 * or zero if no length-prefix is pending.
343 */
344 uint8_t pending_len_len;
345
346 char pending_is_asn1;
347
348 /*
349 * is_top_level is true iff this is a top-level |CBB| (as opposed to a child
350 * |CBB|). Top-level objects are valid arguments for |CBB_finish|.
351 */
352 char is_top_level;
353} CBB;
354
355/*
356 * CBB_init initialises |cbb| with |initial_capacity|. Since a |CBB| grows as
357 * needed, the |initial_capacity| is just a hint. It returns one on success or
358 * zero on error.
359 */
360int CBB_init(CBB *cbb, size_t initial_capacity);
361
362/*
363 * CBB_init_fixed initialises |cbb| to write to |len| bytes at |buf|. Since
364 * |buf| cannot grow, trying to write more than |len| bytes will cause CBB
365 * functions to fail. It returns one on success or zero on error.
366 */
367int CBB_init_fixed(CBB *cbb, uint8_t *buf, size_t len);
368
369/*
370 * CBB_cleanup frees all resources owned by |cbb| and other |CBB| objects
371 * writing to the same buffer. This should be used in an error case where a
372 * serialisation is abandoned.
373 */
374void CBB_cleanup(CBB *cbb);
375
376/*
377 * CBB_finish completes any pending length prefix and sets |*out_data| to a
378 * malloced buffer and |*out_len| to the length of that buffer. The caller
379 * takes ownership of the buffer and, unless the buffer was fixed with
380 * |CBB_init_fixed|, must call |free| when done.
381 *
382 * It can only be called on a "top level" |CBB|, i.e. one initialised with
383 * |CBB_init| or |CBB_init_fixed|. It returns one on success and zero on
384 * error.
385 */
386int CBB_finish(CBB *cbb, uint8_t **out_data, size_t *out_len);
387
388/*
389 * CBB_flush causes any pending length prefixes to be written out and any child
390 * |CBB| objects of |cbb| to be invalidated. It returns one on success or zero
391 * on error.
392 */
393int CBB_flush(CBB *cbb);
394
395/*
396 * CBB_discard_child discards the current unflushed child of |cbb|. Neither the
397 * child's contents nor the length prefix will be included in the output.
398 */
399void CBB_discard_child(CBB *cbb);
400
401/*
402 * CBB_add_u8_length_prefixed sets |*out_contents| to a new child of |cbb|. The
403 * data written to |*out_contents| will be prefixed in |cbb| with an 8-bit
404 * length. It returns one on success or zero on error.
405 */
406int CBB_add_u8_length_prefixed(CBB *cbb, CBB *out_contents);
407
408/*
409 * CBB_add_u16_length_prefixed sets |*out_contents| to a new child of |cbb|.
410 * The data written to |*out_contents| will be prefixed in |cbb| with a 16-bit,
411 * big-endian length. It returns one on success or zero on error.
412 */
413int CBB_add_u16_length_prefixed(CBB *cbb, CBB *out_contents);
414
415/*
416 * CBB_add_u24_length_prefixed sets |*out_contents| to a new child of |cbb|.
417 * The data written to |*out_contents| will be prefixed in |cbb| with a 24-bit,
418 * big-endian length. It returns one on success or zero on error.
419 */
420int CBB_add_u24_length_prefixed(CBB *cbb, CBB *out_contents);
421
422/*
423 * CBB_add_asn sets |*out_contents| to a |CBB| into which the contents of an
424 * ASN.1 object can be written. The |tag| argument will be used as the tag for
425 * the object. Passing in |tag| number 31 will return in an error since only
426 * single octet identifiers are supported. It returns one on success or zero
427 * on error.
428 */
429int CBB_add_asn1(CBB *cbb, CBB *out_contents, unsigned int tag);
430
431/*
432 * CBB_add_bytes appends |len| bytes from |data| to |cbb|. It returns one on
433 * success and zero otherwise.
434 */
435int CBB_add_bytes(CBB *cbb, const uint8_t *data, size_t len);
436
437/*
438 * CBB_add_space appends |len| bytes to |cbb| and sets |*out_data| to point to
439 * the beginning of that space. The caller must then write |len| bytes of
440 * actual contents to |*out_data|. It returns one on success and zero
441 * otherwise.
442 */
443int CBB_add_space(CBB *cbb, uint8_t **out_data, size_t len);
444
445/*
446 * CBB_add_u8 appends an 8-bit number from |value| to |cbb|. It returns one on
447 * success and zero otherwise.
448 */
449int CBB_add_u8(CBB *cbb, size_t value);
450
451/*
452 * CBB_add_u8 appends a 16-bit, big-endian number from |value| to |cbb|. It
453 * returns one on success and zero otherwise.
454 */
455int CBB_add_u16(CBB *cbb, size_t value);
456
457/*
458 * CBB_add_u24 appends a 24-bit, big-endian number from |value| to |cbb|. It
459 * returns one on success and zero otherwise.
460 */
461int CBB_add_u24(CBB *cbb, size_t value);
462
463/*
464 * CBB_add_u32 appends a 32-bit, big-endian number from |value| to |cbb|. It
465 * returns one on success and zero otherwise.
466 */
467int CBB_add_u32(CBB *cbb, size_t value);
468
469/*
470 * CBB_add_asn1_uint64 writes an ASN.1 INTEGER into |cbb| using |CBB_add_asn1|
471 * and writes |value| in its contents. It returns one on success and zero on
472 * error.
473 */
474int CBB_add_asn1_uint64(CBB *cbb, uint64_t value);
475
476#ifdef LIBRESSL_INTERNAL
477/*
478 * CBS_dup sets |out| to point to cbs's |data| and |len|. It results in two
479 * CBS that point to the same buffer.
480 */
481void CBS_dup(const CBS *cbs, CBS *out);
482
483/*
484 * cbs_get_any_asn1_element sets |*out| to contain the next ASN.1 element from
485 * |*cbs| (including header bytes) and advances |*cbs|. It sets |*out_tag| to
486 * the tag number and |*out_header_len| to the length of the ASN.1 header. If
487 * strict mode is disabled and the element has indefinite length then |*out|
488 * will only contain the header. Each of |out|, |out_tag|, and
489 * |out_header_len| may be NULL to ignore the value.
490 *
491 * Tag numbers greater than 30 are not supported (i.e. short form only).
492 */
493int cbs_get_any_asn1_element_internal(CBS *cbs, CBS *out, unsigned int *out_tag,
494 size_t *out_header_len, int strict);
495
496/*
497 * CBS_asn1_indefinite_to_definite reads an ASN.1 structure from |in|. If it
498 * finds indefinite-length elements that otherwise appear to be valid DER, it
499 * attempts to convert the DER-like data to DER and sets |*out| and
500 * |*out_length| to describe a malloced buffer containing the DER data.
501 * Additionally, |*in| will be advanced over the ASN.1 data.
502 *
503 * If it doesn't find any indefinite-length elements then it sets |*out| to
504 * NULL and |*in| is unmodified.
505 *
506 * This is NOT a conversion from BER to DER. There are many restrictions when
507 * dealing with DER data. This is only concerned with one: indefinite vs.
508 * definite form. However, this suffices to handle the PKCS#7 and PKCS#12 output
509 * from NSS.
510 *
511 * It returns one on success and zero otherwise.
512 */
513int CBS_asn1_indefinite_to_definite(CBS *in, uint8_t **out, size_t *out_len);
514#endif /* LIBRESSL_INTERNAL */
515
516__END_HIDDEN_DECLS
517
518#endif /* OPENSSL_HEADER_BYTESTRING_H */