test/params_test.c: Add "real world" parameter testing
authorRichard Levitte <levitte@openssl.org>
Mon, 4 Mar 2019 16:22:45 +0000 (17:22 +0100)
committerRichard Levitte <levitte@openssl.org>
Wed, 13 Mar 2019 10:32:17 +0000 (11:32 +0100)
test/params_test.c is a program that tries to mimic how a provider and
an application would or could handle OSSL_PARAM arrays.

For the moment, this program tests a very raw way of handling
OSSL_PARAM arrays.  It is, however, written in a way that will
hopefully make it possible to extend with other methods as APIs arise,
and to set up test cases where a "provider" handles the array one way
while the "application" handles it another way.

Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/8396)

test/build.info
test/params_test.c [new file with mode: 0644]
test/recipes/04-test_params.t [new file with mode: 0644]

index 914e5bf..13d6630 100644 (file)
@@ -50,7 +50,7 @@ IF[{- !$disabled{tests} -}]
           time_offset_test pemtest ssl_cert_table_internal_test ciphername_test \
           servername_test ocspapitest rsa_mp_test fatalerrtest tls13ccstest \
           sysdefaulttest errtest gosttest \
-          context_internal_test aesgcmtest
+          context_internal_test aesgcmtest params_test
 
   SOURCE[versions]=versions.c
   INCLUDE[versions]=../include ../apps/include
@@ -615,6 +615,11 @@ IF[{- !$disabled{tests} -}]
     DEFINE[provider_test]=OPENSSL_NO_SHARED
     DEFINE[provider_internal_test]=OPENSSL_NO_SHARED
   ENDIF
+
+  PROGRAMS{noinst}=params_test
+  SOURCE[params_test]=params_test.c
+  INCLUDE[params_test]=.. ../include ../apps/include
+  DEPEND[params_test]=../libcrypto.a libtestutil.a
 ENDIF
 
 {-
diff --git a/test/params_test.c b/test/params_test.c
new file mode 100644 (file)
index 0000000..f2474d5
--- /dev/null
@@ -0,0 +1,385 @@
+/*
+ * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * https://www.openssl.org/source/license.html
+ * or in the file LICENSE in the source distribution.
+ */
+
+/*
+ * This program tests the use of OSSL_PARAM, currently in raw form.
+ */
+
+#include <string.h>
+#include <openssl/bn.h>
+#include <openssl/core.h>
+#include "internal/nelem.h"
+#include "testutil.h"
+
+/*-
+ * PROVIDER SECTION
+ * ================
+ *
+ * Even though it's not necessarily ONLY providers doing this part,
+ * they are naturally going to be the most common users of
+ * set_params and get_params functions.
+ */
+
+/*
+ * In real use cases, setters and getters would take an object with
+ * which the parameters are associated.  This structure is a cheap
+ * simulation.
+ */
+struct object_st {
+    /*
+     * Documented as a native integer, of the size given by sizeof(int).
+     * Assumed data type OSSL_PARAM_INTEGER
+     */
+    int p1;
+    /*
+     * Documented as a native double, of the size given by sizeof(double).
+     * Assumed data type OSSL_PARAM_REAL
+     */
+    double p2;
+    /*
+     * Documented as an arbitrarly large unsigned integer.
+     * The data size must be large enough to accomodate.
+     * Assumed data type OSSL_PARAM_UNSIGNED_INTEGER
+     */
+    BIGNUM *p3;
+    /*
+     * Documented as a C string.
+     * The data size must be large enough to accomodate.
+     * Assumed data type OSSL_PARAM_UTF8_STRING
+     */
+    char *p4;
+    /*
+     * Documented as a pointer to a constant C string.
+     * Assumed data type OSSL_PARAM_UTF8_STRING_PTR
+     */
+    const char *p5;
+};
+
+#define p1_init 42                              /* The ultimate answer */
+#define p2_init 6.283                           /* Magic number */
+/* Stolen from evp_data, BLAKE2s256 test */
+#define p3_init                                 \
+    "4142434445464748494a4b4c4d4e4f50"          \
+    "5152535455565758595a616263646566"          \
+    "6768696a6b6c6d6e6f70717273747576"          \
+    "7778797a30313233343536373839"
+#define p4_init "BLAKE2s256"                    /* Random string */
+#define p5_init OPENSSL_FULL_VERSION_STR        /* Static string */
+
+static void cleanup_object(void *vobj)
+{
+    struct object_st *obj = vobj;
+
+    BN_free(obj->p3);
+    obj->p3 = NULL;
+    OPENSSL_free(obj->p4);
+    obj->p4 = NULL;
+    OPENSSL_free(obj);
+}
+
+static void *init_object(void)
+{
+    struct object_st *obj = OPENSSL_zalloc(sizeof(*obj));
+
+    obj->p1 = p1_init;
+    obj->p2 = p2_init;
+    if (!TEST_true(BN_hex2bn(&obj->p3, p3_init)))
+        goto fail;
+    if (!TEST_ptr(obj->p4 = OPENSSL_strdup(p4_init)))
+        goto fail;
+    obj->p5 = p5_init;
+
+    return obj;
+ fail:
+    cleanup_object(obj);
+    obj = NULL;
+
+    return NULL;
+}
+
+/*
+ * RAW provider, which handles the parameters in a very raw manner,
+ * with no fancy API and very minimal checking.  The application that
+ * calls these to set or request parameters MUST get its OSSL_PARAM
+ * array right.
+ */
+
+static int raw_set_params(void *vobj, const OSSL_PARAM *params)
+{
+    struct object_st *obj = vobj;
+
+    for (; params->key != NULL; params++)
+        if (strcmp(params->key, "p1") == 0) {
+            obj->p1 = *(int *)params->data;
+        } else if (strcmp(params->key, "p2") == 0) {
+            obj->p2 = *(double *)params->data;
+        } else if (strcmp(params->key, "p3") == 0) {
+            BN_free(obj->p3);
+            if (!TEST_ptr(obj->p3 = BN_native2bn(params->data,
+                                                 params->data_size, NULL)))
+                return 0;
+        } else if (strcmp(params->key, "p4") == 0) {
+            OPENSSL_free(obj->p4);
+            if (!TEST_ptr(obj->p4 = OPENSSL_strndup(params->data,
+                                                    params->data_size)))
+                return 0;
+        } else if (strcmp(params->key, "p5") == 0) {
+            obj->p5 = *(const char **)params->data;
+        }
+
+    return 1;
+}
+
+static int raw_get_params(void *vobj, const OSSL_PARAM *params)
+{
+    struct object_st *obj = vobj;
+
+    for (; params->key != NULL; params++)
+        if (strcmp(params->key, "p1") == 0) {
+            if (params->return_size != NULL)
+                *params->return_size = sizeof(obj->p1);
+            *(int *)params->data = obj->p1;
+        } else if (strcmp(params->key, "p2") == 0) {
+            if (params->return_size != NULL)
+                *params->return_size = sizeof(obj->p2);
+            *(double *)params->data = obj->p2;
+        } else if (strcmp(params->key, "p3") == 0) {
+            size_t bytes = BN_num_bytes(obj->p3);
+
+            if (params->return_size != NULL)
+                *params->return_size = bytes;
+            if (!TEST_size_t_ge(params->data_size, bytes))
+                return 0;
+            BN_bn2nativepad(obj->p3, params->data, bytes);
+        } else if (strcmp(params->key, "p4") == 0) {
+            size_t bytes = strlen(obj->p4) + 1;
+
+            if (params->return_size != NULL)
+                *params->return_size = bytes;
+            if (!TEST_size_t_ge(params->data_size, bytes))
+                return 0;
+            strcpy(params->data, obj->p4);
+        } else if (strcmp(params->key, "p5") == 0) {
+            /*
+             * We COULD also use OPENSSL_FULL_VERSION_STR directly and
+             * use sizeof(OPENSSL_FULL_VERSION_STR) instead of calling
+             * strlen().
+             * The caller wouldn't know the difference.
+             */
+            size_t bytes = strlen(obj->p5) + 1;
+
+            if (params->return_size != NULL)
+                *params->return_size = bytes;
+            *(const char **)params->data = obj->p5;
+        }
+
+    return 1;
+}
+
+/*
+ * This structure only simulates a provider dispatch, the real deal is
+ * a bit more code that's not necessary in these tests.
+ */
+struct provider_dispatch_st {
+    int (*set_params)(void *obj, const OSSL_PARAM *params);
+    int (*get_params)(void *obj, const OSSL_PARAM *params);
+};
+
+/* "raw" provider */
+static const struct provider_dispatch_st provider_raw = {
+    raw_set_params, raw_get_params
+};
+
+/*-
+ * APPLICATION SECTION
+ * ===================
+ */
+
+/* In all our tests, these are variables that get manipulated as parameters
+ *
+ * These arrays consistenly do nothing with the "p2" parameter, and
+ * always include a "foo" parameter.  This is to check that the
+ * set_params and get_params calls ignore the lack of parameters that
+ * the application isn't interested in, as well as ignore parameters
+ * they don't understand (the application may have one big bag of
+ * parameters).
+ */
+static int app_p1;                    /* "p1" */
+static double app_p2;                 /* "p2" is ignored */
+static BIGNUM *app_p3 = NULL;         /* "p3" */
+static unsigned char bignumbin[4096]; /* "p3" */
+static size_t bignumbin_l;            /* "p3" */
+static char app_p4[256];              /* "p4" */
+static size_t app_p4_l;               /* "p4" */
+static const char *app_p5 = NULL;     /* "p5" */
+static size_t app_p5_l;               /* "p5" */
+static unsigned char foo[1];          /* "foo" */
+static size_t foo_l;                  /* "foo" */
+
+#define app_p1_init 17           /* A random number */
+#define app_p2_init 47.11        /* Another random number */
+#define app_p3_init "deadbeef"   /* Classic */
+#define app_p4_init "Hello"
+#define app_p5_init "World"
+#define app_foo_init 'z'
+
+static int cleanup_app_variables(void)
+{
+    BN_free(app_p3);
+    app_p3 = NULL;
+    return 1;
+}
+
+static int init_app_variables(void)
+{
+    int l = 0;
+
+    cleanup_app_variables();
+
+    app_p1 = app_p1_init;
+    app_p2 = app_p2_init;
+    if (!BN_hex2bn(&app_p3, app_p3_init)
+        || (l = BN_bn2nativepad(app_p3, bignumbin, sizeof(bignumbin))) < 0)
+        return 0;
+    bignumbin_l = (size_t)l;
+    strcpy(app_p4, app_p4_init);
+    app_p4_l = sizeof(app_p4_init);
+    app_p5 = app_p5_init;
+    app_p5_l = sizeof(app_p5_init);
+    foo[0] = app_foo_init;
+    foo_l = sizeof(app_foo_init);
+
+    return 1;
+}
+
+/*
+ * Here, we define test OSSL_PARAM arrays
+ */
+
+/* An array of OSSL_PARAM, specific in the most raw manner possible */
+static const OSSL_PARAM raw_params[] = {
+    { "p1", OSSL_PARAM_INTEGER, &app_p1, sizeof(app_p1), NULL },
+    { "p3", OSSL_PARAM_UNSIGNED_INTEGER, &bignumbin, sizeof(bignumbin),
+      &bignumbin_l },
+    { "p4", OSSL_PARAM_UTF8_STRING, &app_p4, sizeof(app_p4), &app_p4_l },
+    { "p5", OSSL_PARAM_UTF8_STRING_PTR, &app_p5, sizeof(app_p5), &app_p5_l },
+    { "foo", OSSL_PARAM_OCTET_STRING, &foo, sizeof(foo), &foo_l },
+    { NULL, 0, NULL, 0, NULL }
+};
+
+/*-
+ * TESTING
+ * =======
+ */
+
+/*
+ * Test cases to combine parameters with "provider side" functions
+ */
+static struct {
+    const struct provider_dispatch_st *prov;
+    const OSSL_PARAM *params;
+    const char *desc;
+} test_cases[] = {
+    { &provider_raw, raw_params, "raw provider vs raw params" }
+};
+
+/* Generic tester of combinations of "providers" and params */
+static int test_case(int i)
+{
+    const struct provider_dispatch_st *prov = test_cases[i].prov;
+    const OSSL_PARAM *params = test_cases[i].params;
+    BIGNUM *verify_p3 = NULL;
+    void *obj = NULL;
+    int errcnt = 0;
+
+    TEST_info("Case: %s", test_cases[i].desc);
+
+    /*
+     * Initialize
+     */
+    if (!TEST_ptr(obj = init_object())
+        || !TEST_true(BN_hex2bn(&verify_p3, p3_init))) {
+        errcnt++;
+        goto fin;
+    }
+
+    /*
+     * Get parameters a first time, just to see that getting works and
+     * gets us the values we expect.
+     */
+    init_app_variables();
+
+    if (!TEST_true(prov->get_params(obj, params))
+        || !TEST_int_eq(app_p1, p1_init)        /* "provider" value */
+        || !TEST_ulong_eq(app_p2, app_p2_init)  /* Should remain untouched */
+        || !TEST_ptr(BN_native2bn(bignumbin, bignumbin_l, app_p3))
+        || !TEST_BN_eq(app_p3, verify_p3)       /* "provider" value */
+        || !TEST_str_eq(app_p4, p4_init)        /* "provider" value */
+        || !TEST_str_eq(app_p5, p5_init)        /* "provider" value */
+        || !TEST_char_eq(foo[0], app_foo_init)  /* Should remain untouched */
+        || !TEST_int_eq(foo_l, sizeof(app_foo_init)))
+        errcnt++;
+
+    /*
+     * Set parameters, then sneak into the object itself and check
+     * that its attributes got set (or ignored) properly.
+     */
+    init_app_variables();
+
+    if (!TEST_true(prov->set_params(obj, params))) {
+        errcnt++;
+    } else {
+        struct object_st *sneakpeek = obj;
+
+        if (!TEST_int_eq(sneakpeek->p1, app_p1)         /* app value set */
+            || !TEST_ulong_eq(sneakpeek->p2, p2_init) /* Should remain untouched */
+            || !TEST_BN_eq(sneakpeek->p3, app_p3)       /* app value set */
+            || !TEST_str_eq(sneakpeek->p4, app_p4)      /* app value set */
+            || !TEST_str_eq(sneakpeek->p5, app_p5))     /* app value set */
+            errcnt++;
+    }
+
+    /*
+     * Get parameters again, checking that we get different values
+     * than earlier where relevant.
+     */
+    BN_free(verify_p3);
+    verify_p3 = NULL;
+
+    if (!TEST_true(BN_hex2bn(&verify_p3, app_p3_init))) {
+        errcnt++;
+        goto fin;
+    }
+
+    if (!TEST_true(prov->get_params(obj, params))
+        || !TEST_int_eq(app_p1, app_p1_init)    /* app value */
+        || !TEST_ulong_eq(app_p2, app_p2_init)  /* Should remain untouched */
+        || !TEST_ptr(BN_native2bn(bignumbin, bignumbin_l, app_p3))
+        || !TEST_BN_eq(app_p3, verify_p3)       /* app value */
+        || !TEST_str_eq(app_p4, app_p4_init)    /* app value */
+        || !TEST_str_eq(app_p5, app_p5_init)    /* app value */
+        || !TEST_char_eq(foo[0], app_foo_init)  /* Should remain untouched */
+        || !TEST_int_eq(foo_l, sizeof(app_foo_init)))
+        errcnt++;
+
+ fin:
+    BN_free(verify_p3);
+    verify_p3 = NULL;
+    cleanup_app_variables();
+    cleanup_object(obj);
+
+    return errcnt == 0;
+}
+
+int setup_tests(void)
+{
+    ADD_ALL_TESTS(test_case, OSSL_NELEM(test_cases));
+    return 1;
+}
diff --git a/test/recipes/04-test_params.t b/test/recipes/04-test_params.t
new file mode 100644 (file)
index 0000000..ae83d4f
--- /dev/null
@@ -0,0 +1,15 @@
+#! /usr/bin/env perl
+# Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
+#
+# Licensed under the Apache License 2.0 (the "License").  You may not use
+# this file except in compliance with the License.  You can obtain a copy
+# in the file LICENSE in the source distribution or at
+# https://www.openssl.org/source/license.html
+
+use strict;
+use OpenSSL::Test;
+use OpenSSL::Test::Simple;
+
+setup("test_params");
+
+simple_test("test_params", "params_test");