From 99f2f1dc3e5c95961f57ca41e9fbb76863e69e46 Mon Sep 17 00:00:00 2001
From: "Dr. Stephen Henson" <steve@openssl.org>
Date: Sat, 10 Dec 2016 19:21:01 +0000
Subject: [PATCH] Add function and reason checking to evp_test

Add options to check the function and reason code matches expected values.

Reviewed-by: Richard Levitte <levitte@openssl.org>
---
 test/evp_test.c   | 62 ++++++++++++++++++++++++++++++++++++++++++++---
 test/evptests.txt |  8 ++++++
 2 files changed, 66 insertions(+), 4 deletions(-)

diff --git a/test/evp_test.c b/test/evp_test.c
index 9dfd4a1719..e52ff0c947 100644
--- a/test/evp_test.c
+++ b/test/evp_test.c
@@ -210,6 +210,10 @@ struct evp_test {
     const char *err, *aux_err;
     /* Expected error value of test */
     char *expected_err;
+    /* Expected error function string */
+    char *func;
+    /* Expected error reason string */
+    char *reason;
     /* Number of tests */
     int ntests;
     /* Error count */
@@ -296,6 +300,10 @@ static void free_expected(struct evp_test *t)
 {
     OPENSSL_free(t->expected_err);
     t->expected_err = NULL;
+    OPENSSL_free(t->func);
+    t->func = NULL;
+    OPENSSL_free(t->reason);
+    t->reason = NULL;
     OPENSSL_free(t->out_expected);
     OPENSSL_free(t->out_received);
     t->out_expected = NULL;
@@ -317,6 +325,9 @@ static void print_expected(struct evp_test *t)
 
 static int check_test_error(struct evp_test *t)
 {
+    unsigned long err;
+    const char *func;
+    const char *reason;
     if (!t->err && !t->expected_err)
         return 1;
     if (t->err && !t->expected_err) {
@@ -335,11 +346,38 @@ static int check_test_error(struct evp_test *t)
                 t->start_line, t->expected_err);
         return 0;
     }
-    if (strcmp(t->err, t->expected_err) == 0)
+
+    if (strcmp(t->err, t->expected_err) != 0) {
+        fprintf(stderr, "Test line %d: expecting %s got %s\n",
+                t->start_line, t->expected_err, t->err);
+        return 0;
+    }
+
+    if (t->func == NULL && t->reason == NULL)
         return 1;
 
-    fprintf(stderr, "Test line %d: expecting %s got %s\n",
-            t->start_line, t->expected_err, t->err);
+    if (t->func == NULL || t->reason == NULL) {
+        fprintf(stderr, "Test line %d: missing function or reason code\n",
+                t->start_line);
+        return 0;
+    }
+
+    err = ERR_peek_error();
+    if (err == 0) {
+        fprintf(stderr, "Test line %d, expected error \"%s:%s\" not set\n",
+                t->start_line, t->func, t->reason);
+        return 0;
+    }
+
+    func = ERR_func_error_string(err);
+    reason = ERR_reason_error_string(err);
+
+    if (strcmp(func, t->func) == 0 && strcmp(reason, t->reason) == 0)
+        return 1;
+
+    fprintf(stderr, "Test line %d: expected error \"%s:%s\", got \"%s:%s\"\n",
+            t->start_line, t->func, t->reason, func, reason);
+
     return 0;
 }
 
@@ -494,7 +532,23 @@ static int process_test(struct evp_test *t, char *buf, int verbose)
             return 0;
         }
         t->expected_err = OPENSSL_strdup(value);
-        if (!t->expected_err)
+        if (t->expected_err == NULL)
+            return 0;
+    } else if (strcmp(keyword, "Function") == 0) {
+        if (t->func != NULL) {
+            fprintf(stderr, "Line %d: multiple function lines\n", t->line);
+            return 0;
+        }
+        t->func = OPENSSL_strdup(value);
+        if (t->func == NULL)
+            return 0;
+    } else if (strcmp(keyword, "Reason") == 0) {
+        if (t->reason != NULL) {
+            fprintf(stderr, "Line %d: multiple reason lines\n", t->line);
+            return 0;
+        }
+        t->reason = OPENSSL_strdup(value);
+        if (t->reason == NULL)
             return 0;
     } else {
         /* Must be test specific line: try to parse it */
diff --git a/test/evptests.txt b/test/evptests.txt
index 2813b4f783..e480d7cf94 100644
--- a/test/evptests.txt
+++ b/test/evptests.txt
@@ -2773,11 +2773,15 @@ Output = c09d402423cbf233d26cae21f954547bc43fe80fd41360a0336cfdbe9aedad05bef6fd2
 # Illegal RSA key derivation
 Derive = RSA-2048
 Result = KEYOP_INIT_ERROR
+Function = EVP_PKEY_derive_init
+Reason = operation not supported for this keytype
 
 # Invalid ctrl
 Sign = RSA-2048
 Ctrl = rsa_mgf1_md:sha1
 Result = PKEY_CTRL_INVALID
+Function = pkey_rsa_ctrl
+Reason = invalid mgf1 md
 
 # EC tests
 
@@ -3733,6 +3737,10 @@ SharedSecret=4A5D9D5BA4CE2DE1728E3BF480350F25E07E21C947D19E3376F09B3C1E161742
 
 Sign=Alice-25519
 Result = KEYOP_INIT_ERROR
+Function = EVP_PKEY_sign_init
+Reason = operation not supported for this keytype
 
 Verify=Alice-25519
 Result = KEYOP_INIT_ERROR
+Function = EVP_PKEY_verify_init
+Reason = operation not supported for this keytype
-- 
2.25.1