1 /* Copyright (c) 2015, 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_CRYPTO_TEST_TEST_UTIL_H
16 #define OPENSSL_HEADER_CRYPTO_TEST_TEST_UTIL_H
17 
18 #include <stddef.h>
19 #include <stdint.h>
20 #include <stdio.h>
21 #include <string.h>
22 
23 #include <iosfwd>
24 #include <string>
25 #include <vector>
26 
27 #include <openssl/span.h>
28 
29 #include "../internal.h"
30 
31 
32 // hexdump writes |msg| to |fp| followed by the hex encoding of |len| bytes
33 // from |in|.
34 void hexdump(FILE *fp, const char *msg, const void *in, size_t len);
35 
36 // Bytes is a wrapper over a byte slice which may be compared for equality. This
37 // allows it to be used in EXPECT_EQ macros.
38 struct Bytes {
BytesBytes39   Bytes(const uint8_t *data_arg, size_t len_arg)
40       : span_(data_arg, len_arg) {}
BytesBytes41   Bytes(const char *data_arg, size_t len_arg)
42       : span_(reinterpret_cast<const uint8_t *>(data_arg), len_arg) {}
43 
BytesBytes44   explicit Bytes(const char *str)
45       : span_(reinterpret_cast<const uint8_t *>(str), strlen(str)) {}
BytesBytes46   explicit Bytes(const std::string &str)
47       : span_(reinterpret_cast<const uint8_t *>(str.data()), str.size()) {}
BytesBytes48   explicit Bytes(bssl::Span<const uint8_t> span)
49       : span_(span) {}
50 
51   bssl::Span<const uint8_t> span_;
52 };
53 
54 inline bool operator==(const Bytes &a, const Bytes &b) {
55   return a.span_ == b.span_;
56 }
57 
58 inline bool operator!=(const Bytes &a, const Bytes &b) { return !(a == b); }
59 
60 std::ostream &operator<<(std::ostream &os, const Bytes &in);
61 
62 // DecodeHex decodes |in| from hexadecimal and writes the output to |out|. It
63 // returns true on success and false if |in| is not a valid hexadecimal byte
64 // string.
65 bool DecodeHex(std::vector<uint8_t> *out, const std::string &in);
66 
67 // EncodeHex returns |in| encoded in hexadecimal.
68 std::string EncodeHex(bssl::Span<const uint8_t> in);
69 
70 
71 #endif  // OPENSSL_HEADER_CRYPTO_TEST_TEST_UTIL_H
72