--- /dev/null
+/* $OpenBSD: bn_convert.c,v 1.1 2023/04/22 14:03:03 jsing Exp $ */
+/*
+ * Copyright (c) 2023 Joel Sing <jsing@openbsd.org>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include <err.h>
+#include <string.h>
+
+#include <openssl/bn.h>
+
+/*
+ * Additional test coverage is needed for:
+ *
+ * - BN_bn2binpad()
+ * - BN_bn2lebinpad()
+ * - BN_lebin2bn()
+ * - BN_bn2mpi()/BN_mpi2bn()
+ * - BN_print()/BN_print_fp()
+ *
+ * - Invalid inputs to {asc,dec,hex,mpi}2bn
+ * - Zero padded inputs
+ */
+
+static void
+hexdump(const unsigned char *buf, size_t len)
+{
+ size_t i;
+
+ for (i = 1; i <= len; i++)
+ fprintf(stderr, " 0x%02hhx,%s", buf[i - 1], i % 8 ? "" : "\n");
+
+ fprintf(stderr, "\n");
+}
+
+static int
+check_bin_output(size_t test_no, const char *label, const uint8_t *bin,
+ size_t bin_len, const BIGNUM *bn)
+{
+ uint8_t *out = NULL;
+ int out_len;
+ int ret;
+ int failed = 1;
+
+ out_len = BN_num_bytes(bn);
+ if (out_len != (int)bin_len) {
+ fprintf(stderr, "FAIL: Test %zu - BN_num_bytes() = %d, "
+ "want %zu\n", test_no, out_len, bin_len);
+ goto failure;
+ }
+ if ((out = malloc(out_len)) == NULL)
+ err(1, "malloc");
+ if ((ret = BN_bn2bin(bn, out)) != out_len) {
+ fprintf(stderr, "FAIL: BN_bn2bin() returned %d, "
+ "want %d\n", ret, out_len);
+ goto failure;
+ }
+ if (memcmp(out, bin, bin_len) != 0) {
+ fprintf(stderr, "FAIL: Test %zu - output from "
+ "BN_bn2bin() differs\n", test_no);
+ fprintf(stderr, "Got:\n");
+ hexdump(out, out_len);
+ fprintf(stderr, "Want:\n");
+ hexdump(bin, bin_len);
+ goto failure;
+ }
+
+ failed = 0;
+
+ failure:
+ free(out);
+
+ return failed;
+}
+
+struct bn_asc2bn_test {
+ const char *in;
+ const uint8_t bin[64];
+ size_t bin_len;
+ int neg;
+ int want_error;
+};
+
+static const struct bn_asc2bn_test bn_asc2bn_tests[] = {
+ {
+ .in = "",
+ .want_error = 1,
+ },
+ {
+ .in = "-",
+ .want_error = 1,
+ },
+ {
+ .in = "0",
+ .bin = { 0x00, },
+ .bin_len = 0,
+ .neg = 0,
+ },
+ {
+ .in = "0x0",
+ .bin = { 0x00, },
+ .bin_len = 0,
+ .neg = 0,
+ },
+ {
+ .in = "-0",
+ .bin = { 0x00, },
+ .bin_len = 0,
+ .neg = 0,
+ },
+ {
+ .in = "-0x0",
+ .bin = { 0x00, },
+ .bin_len = 0,
+ .neg = 0,
+ },
+ {
+ .in = "123456789",
+ .bin = { 0x07, 0x5b, 0xcd, 0x15, },
+ .bin_len = 4,
+ .neg = 0,
+ },
+ {
+ .in = "0123456789",
+ .bin = { 0x07, 0x5b, 0xcd, 0x15, },
+ .bin_len = 4,
+ .neg = 0,
+ },
+ {
+ .in = "-123456789",
+ .bin = { 0x07, 0x5b, 0xcd, 0x15, },
+ .bin_len = 4,
+ .neg = 1,
+ },
+ {
+ .in = "0X123456789",
+ .bin = { 0x01, 0x23, 0x45, 0x67, 0x89, },
+ .bin_len = 5,
+ .neg = 0,
+ },
+ {
+ .in = "0x123456789",
+ .bin = { 0x01, 0x23, 0x45, 0x67, 0x89, },
+ .bin_len = 5,
+ .neg = 0,
+ },
+ {
+ .in = "-0x123456789",
+ .bin = { 0x01, 0x23, 0x45, 0x67, 0x89, },
+ .bin_len = 5,
+ .neg = 1,
+ },
+ {
+ .in = "abcdef123456789",
+ .want_error = 1,
+ },
+ {
+ .in = "0x000123456789abCdEf",
+ .bin = { 0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef },
+ .bin_len = 8,
+ .neg = 0,
+ },
+};
+
+#define N_BN_ASC2BN_TESTS \
+ (sizeof(bn_asc2bn_tests) / sizeof(*bn_asc2bn_tests))
+
+static int
+test_bn_asc2bn(void)
+{
+ const struct bn_asc2bn_test *bat;
+ BIGNUM *bn = NULL;
+ size_t i;
+ int failed = 1;
+
+ for (i = 0; i < N_BN_ASC2BN_TESTS; i++) {
+ bat = &bn_asc2bn_tests[i];
+
+ BN_free(bn);
+ bn = NULL;
+
+ if (!BN_asc2bn(&bn, bat->in)) {
+ if (bat->want_error)
+ continue;
+ fprintf(stderr, "FAIL: Test %zu - BN_asc2bn() failed\n", i);
+ goto failure;
+ }
+ if (bat->want_error) {
+ fprintf(stderr, "FAIL: Test %zu - BN_asc2bn() succeeded "
+ "when it should have failed\n", i);
+ goto failure;
+ }
+
+ if (check_bin_output(i, "BN_asc2bn()", bat->bin, bat->bin_len,
+ bn) != 0)
+ goto failure;
+
+ if (BN_is_negative(bn) != bat->neg) {
+ fprintf(stderr, "FAIL: Test %zu - BN_asc2bn() resulted "
+ "in negative %d, want %d", i, BN_is_negative(bn),
+ bat->neg);
+ goto failure;
+ }
+ }
+
+ failed = 0;
+
+ failure:
+ BN_free(bn);
+
+ return failed;
+}
+
+struct bn_convert_test {
+ const uint8_t bin[64];
+ size_t bin_len;
+ int neg;
+ const char *dec;
+ const char *hex;
+};
+
+static const struct bn_convert_test bn_convert_tests[] = {
+ {
+ .bin = { 0x0, },
+ .bin_len = 0,
+ .neg = 0,
+ .dec = "0",
+ .hex = "0",
+ },
+ {
+ .bin = { 0x1, },
+ .bin_len = 1,
+ .neg = 0,
+ .dec = "1",
+ .hex = "01",
+ },
+ {
+ .bin = { 0x7f, 0xff, 0xff, },
+ .bin_len = 3,
+ .neg = 0,
+ .dec = "8388607",
+ .hex = "7FFFFF",
+ },
+ {
+ .bin = { 0x7f, 0xff, 0xff, },
+ .bin_len = 3,
+ .neg = 1,
+ .dec = "-8388607",
+ .hex = "-7FFFFF",
+ },
+ {
+ .bin = { 0xff, 0xff, 0xff, 0xff, },
+ .bin_len = 4,
+ .neg = 0,
+ .dec = "4294967295",
+ .hex = "FFFFFFFF",
+ },
+ {
+ .bin = { 0xff, 0xff, 0xff, 0xff, },
+ .bin_len = 4,
+ .neg = 1,
+ .dec = "-4294967295",
+ .hex = "-FFFFFFFF",
+ },
+ {
+ .bin = { 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, },
+ .bin_len = 8,
+ .neg = 0,
+ .dec = "18446744069414584320",
+ .hex = "FFFFFFFF00000000",
+ },
+ {
+ .bin = { 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, },
+ .bin_len = 8,
+ .neg = 1,
+ .dec = "-18446744069414584320",
+ .hex = "-FFFFFFFF00000000",
+ },
+ {
+ .bin = { 0x80, 0x01, 0x80, 0x01, 0x80, 0x01, 0x80, 0x01, },
+ .bin_len = 8,
+ .neg = 0,
+ .dec = "9223794255762391041",
+ .hex = "8001800180018001",
+ },
+ {
+ .bin = { 0x80, 0x01, 0x80, 0x01, 0x80, 0x01, 0x80, 0x01, },
+ .bin_len = 8,
+ .neg = 1,
+ .dec = "-9223794255762391041",
+ .hex = "-8001800180018001",
+ },
+ {
+ .bin = { 0x01, 0x80, 0x01, 0x80, 0x01, 0x80, 0x01, 0x80, 0x01, },
+ .bin_len = 9,
+ .neg = 0,
+ .dec = "27670538329471942657",
+ .hex = "018001800180018001",
+ },
+ {
+ .bin = { 0x01, 0x80, 0x01, 0x80, 0x01, 0x80, 0x01, 0x80, 0x01, },
+ .bin_len = 9,
+ .neg = 1,
+ .dec = "-27670538329471942657",
+ .hex = "-018001800180018001",
+ },
+ {
+ .bin = {
+ 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff,
+ 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff,
+ 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff,
+ 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff,
+ },
+ .bin_len = 32,
+ .neg = 0,
+ .dec = "57895161181645529494837117048595051142566530671229791132691030063130991362047",
+ .hex = "7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF",
+ },
+ {
+ .bin = {
+ 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff,
+ 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff,
+ 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff,
+ 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff, 0x7f, 0xff,
+ },
+ .bin_len = 32,
+ .neg = 1,
+ .dec = "-57895161181645529494837117048595051142566530671229791132691030063130991362047",
+ .hex = "-7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF7FFF",
+ },
+};
+
+#define N_BN_CONVERT_TESTS \
+ (sizeof(bn_convert_tests) / sizeof(*bn_convert_tests))
+
+static int
+test_bn_convert(void)
+{
+ const struct bn_convert_test *bct;
+ char *out_str = NULL;
+ BIGNUM *bn = NULL;
+ size_t i;
+ int failed = 1;
+
+ for (i = 0; i < N_BN_CONVERT_TESTS; i++) {
+ bct = &bn_convert_tests[i];
+
+ BN_free(bn);
+ if ((bn = BN_bin2bn(bct->bin, bct->bin_len, NULL)) == NULL) {
+ fprintf(stderr, "FAIL: BN_bin2bn() failed\n");
+ goto failure;
+ }
+ BN_set_negative(bn, bct->neg);
+
+ if (check_bin_output(i, "BN_bin2bn()", bct->bin, bct->bin_len,
+ bn) != 0)
+ goto failure;
+
+ free(out_str);
+ if ((out_str = BN_bn2dec(bn)) == NULL) {
+ fprintf(stderr, "FAIL: BN_bn2dec() failed\n");
+ goto failure;
+ }
+ if (strcmp(out_str, bct->dec) != 0) {
+ fprintf(stderr, "FAIL: Test %zu - BN_bn2dec() returned "
+ "'%s', want '%s'", i, out_str, bct->dec);
+ goto failure;
+ }
+
+ free(out_str);
+ if ((out_str = BN_bn2hex(bn)) == NULL) {
+ fprintf(stderr, "FAIL: BN_bn2hex() failed\n");
+ goto failure;
+ }
+ if (strcmp(out_str, bct->hex) != 0) {
+ fprintf(stderr, "FAIL: Test %zu - BN_bn2hex() returned "
+ "'%s', want '%s'", i, out_str, bct->hex);
+ goto failure;
+ }
+
+ if (BN_dec2bn(&bn, bct->dec) != (int)strlen(bct->dec)) {
+ fprintf(stderr, "FAIL: BN_dec2bn() failed\n");
+ goto failure;
+ }
+ if (BN_is_negative(bn) != bct->neg) {
+ fprintf(stderr, "FAIL: Test %zu - BN_dec2bn() resulted "
+ "in negative %d, want %d", i, BN_is_negative(bn),
+ bct->neg);
+ goto failure;
+ }
+
+ if (check_bin_output(i, "BN_dec2bn()", bct->bin, bct->bin_len,
+ bn) != 0)
+ goto failure;
+
+ if (BN_hex2bn(&bn, bct->hex) != (int)strlen(bct->hex)) {
+ fprintf(stderr, "FAIL: BN_hex2bn() failed\n");
+ goto failure;
+ }
+ if (BN_is_negative(bn) != bct->neg) {
+ fprintf(stderr, "FAIL: Test %zu - BN_hex2bn() resulted "
+ "in negative %d, want %d", i, BN_is_negative(bn),
+ bct->neg);
+ goto failure;
+ }
+
+ if (check_bin_output(i, "BN_hex2bn()", bct->bin, bct->bin_len,
+ bn) != 0)
+ goto failure;
+ }
+
+ failed = 0;
+
+ failure:
+ free(out_str);
+ BN_free(bn);
+
+ return failed;
+}
+
+static int
+test_bn_dec2bn(void)
+{
+ BIGNUM *bn = NULL;
+ BN_ULONG w;
+ int ret;
+ int failed = 1;
+
+ /* An empty string fails to parse. */
+ if (BN_dec2bn(&bn, "") != 0) {
+ fprintf(stderr, "FAIL: BN_dec2bn(_, \"\") succeeded\n");
+ goto failure;
+ }
+ if (bn != NULL) {
+ fprintf(stderr, "FAIL: BN_dec2bn(_, \"\") succeeded\n");
+ goto failure;
+ }
+
+ /* A minus sign parses as 0. */
+ if (BN_dec2bn(&bn, "-") != 1) {
+ fprintf(stderr, "FAIL: BN_dec2bn(_, \"-\") failed\n");
+ goto failure;
+ }
+ if (bn == NULL) {
+ fprintf(stderr, "FAIL: BN_dec2bn(_, \"-\") failed\n");
+ goto failure;
+ }
+ if (!BN_is_zero(bn)) {
+ fprintf(stderr, "FAIL: BN_dec2bn(_, \"-\") is non-zero\n");
+ goto failure;
+ }
+ if (BN_is_negative(bn)) {
+ fprintf(stderr, "FAIL: BN_dec2bn(_, \"-\") resulted in "
+ "negative zero\n");
+ goto failure;
+ }
+
+ /* Ensure that -0 results in 0. */
+ if (BN_dec2bn(&bn, "-0") != 2) {
+ fprintf(stderr, "FAIL: BN_dec2bn(_, \"-0\") failed\n");
+ goto failure;
+ }
+ if (!BN_is_zero(bn)) {
+ fprintf(stderr, "FAIL: BN_dec2bn(_, \"-0\") is non-zero\n");
+ goto failure;
+ }
+ if (BN_is_negative(bn)) {
+ fprintf(stderr, "FAIL: BN_dec2bn(_, \"-0\") resulted in "
+ "negative zero\n");
+ goto failure;
+ }
+
+ /* BN_dec2bn() is the new atoi()... */
+ if ((ret = BN_dec2bn(&bn, "0123456789abcdef")) != 10) {
+ fprintf(stderr, "FAIL: BN_dec2bn() returned %d, want 10\n", ret);
+ goto failure;
+ }
+ if ((w = BN_get_word(bn)) != 0x75bcd15) {
+ fprintf(stderr, "FAIL: BN_dec2bn() resulted in %llx, want %llx\n",
+ (unsigned long long)w, 0x75bcd15ULL);
+ goto failure;
+ }
+
+ failed = 0;
+
+ failure:
+ BN_free(bn);
+
+ return failed;
+}
+
+static int
+test_bn_hex2bn(void)
+{
+ BIGNUM *bn = NULL;
+ BN_ULONG w;
+ int ret;
+ int failed = 1;
+
+ /* An empty string fails to parse. */
+ if (BN_hex2bn(&bn, "") != 0) {
+ fprintf(stderr, "FAIL: BN_hex2bn(_, \"\") succeeded\n");
+ goto failure;
+ }
+ if (bn != NULL) {
+ fprintf(stderr, "FAIL: BN_hex2bn(_, \"\") succeeded\n");
+ goto failure;
+ }
+
+ /* A minus sign parses as 0. */
+ if (BN_hex2bn(&bn, "-") != 1) {
+ fprintf(stderr, "FAIL: BN_hex2bn(_, \"-\") failed\n");
+ goto failure;
+ }
+ if (bn == NULL) {
+ fprintf(stderr, "FAIL: BN_hex2bn(_, \"-\") failed\n");
+ goto failure;
+ }
+ if (!BN_is_zero(bn)) {
+ fprintf(stderr, "FAIL: BN_hex2bn(_, \"-\") returned non-zero\n");
+ goto failure;
+ }
+ if (BN_is_negative(bn)) {
+ fprintf(stderr, "FAIL: BN_hex2bn(_, \"-\") returned negative zero\n");
+ goto failure;
+ }
+
+ /* Ensure that -0 results in 0. */
+ if (BN_hex2bn(&bn, "-0") != 2) {
+ fprintf(stderr, "FAIL: BN_hex2bn(_, \"-0\") failed\n");
+ goto failure;
+ }
+ if (!BN_is_zero(bn)) {
+ fprintf(stderr, "FAIL: BN_hex2bn(_, \"-0\") is non-zero\n");
+ goto failure;
+ }
+ if (BN_is_negative(bn)) {
+ fprintf(stderr, "FAIL: BN_hex2bn(_, \"-0\") resulted in "
+ "negative zero\n");
+ goto failure;
+ }
+
+ /* BN_hex2bn() is the new atoi()... */
+ if ((ret = BN_hex2bn(&bn, "9abcdefz")) != 7) {
+ fprintf(stderr, "FAIL: BN_hex2bn() returned %d, want 7\n", ret);
+ goto failure;
+ }
+ if ((w = BN_get_word(bn)) != 0x9abcdef) {
+ fprintf(stderr, "FAIL: BN_hex2bn() resulted in %llx, want %llx\n",
+ (unsigned long long)w, 0x9abcdefULL);
+ goto failure;
+ }
+
+ /* A 0x prefix fails to parse without BN_asc2bn() (instead we get 0!). */
+ if (BN_hex2bn(&bn, "0x1") != 1) {
+ fprintf(stderr, "FAIL: BN_hex2bn() parsed a 0x prefix\n");
+ goto failure;
+ }
+
+ failed = 0;
+
+ failure:
+ BN_free(bn);
+
+ return failed;
+}
+
+int
+main(int argc, char **argv)
+{
+ int failed = 0;
+
+ failed |= test_bn_asc2bn();
+ failed |= test_bn_convert();
+ failed |= test_bn_dec2bn();
+ failed |= test_bn_hex2bn();
+
+ return failed;
+}
projects / openbsd / commitdiff