legacy-libs/grpc/deps/grpc/third_party/boringssl/crypto/err/err_test.cc

   1 /* Copyright (c) 2014, 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 #include <stdio.h>
  16 #include <string.h>
  17
  18 #include <gtest/gtest.h>
  19
  20 #include <openssl/crypto.h>
  21 #include <openssl/err.h>
  22 #include <openssl/mem.h>
  23
  24 #include "./internal.h"
  25
  26
  27 TEST(ErrTest, Overflow) {
  28   for (unsigned i = 0; i < ERR_NUM_ERRORS*2; i++) {
  29     ERR_put_error(1, 0 /* unused */, i+1, "test", 1);
  30   }
  31
  32   for (unsigned i = 0; i < ERR_NUM_ERRORS - 1; i++) {
  33     SCOPED_TRACE(i);
  34     uint32_t err = ERR_get_error();
  35     // Errors are returned in order they were pushed, with the least recent ones
  36     // removed, up to |ERR_NUM_ERRORS - 1| errors. So the errors returned are
  37     // |ERR_NUM_ERRORS + 2| through |ERR_NUM_ERRORS * 2|, inclusive.
  38     EXPECT_NE(0u, err);
  39     EXPECT_EQ(static_cast<int>(i + ERR_NUM_ERRORS + 2), ERR_GET_REASON(err));
  40   }
  41
  42   EXPECT_EQ(0u, ERR_get_error());
  43 }
  44
  45 TEST(ErrTest, PutError) {
  46   ASSERT_EQ(0u, ERR_get_error())
  47       << "ERR_get_error returned value before an error was added.";
  48
  49   ERR_put_error(1, 0 /* unused */, 2, "test", 4);
  50   ERR_add_error_data(1, "testing");
  51
  52   int peeked_line, line, peeked_flags, flags;
  53   const char *peeked_file, *file, *peeked_data, *data;
  54   uint32_t peeked_packed_error =
  55       ERR_peek_error_line_data(&peeked_file, &peeked_line, &peeked_data,
  56                                &peeked_flags);
  57   uint32_t packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
  58
  59   EXPECT_EQ(peeked_packed_error, packed_error);
  60   EXPECT_EQ(peeked_file, file);
  61   EXPECT_EQ(peeked_data, data);
  62   EXPECT_EQ(peeked_flags, flags);
  63
  64   EXPECT_STREQ("test", file);
  65   EXPECT_EQ(4, line);
  66   EXPECT_TRUE(flags & ERR_FLAG_STRING);
  67   EXPECT_EQ(1, ERR_GET_LIB(packed_error));
  68   EXPECT_EQ(2, ERR_GET_REASON(packed_error));
  69   EXPECT_STREQ("testing", data);
  70 }
  71
  72 TEST(ErrTest, ClearError) {
  73   ASSERT_EQ(0u, ERR_get_error())
  74       << "ERR_get_error returned value before an error was added.";
  75
  76   ERR_put_error(1, 0 /* unused */, 2, "test", 4);
  77   ERR_clear_error();
  78
  79   // The error queue should be cleared.
  80   EXPECT_EQ(0u, ERR_get_error());
  81 }
  82
  83 TEST(ErrTest, Print) {
  84   ERR_put_error(1, 0 /* unused */, 2, "test", 4);
  85   ERR_add_error_data(1, "testing");
  86   uint32_t packed_error = ERR_get_error();
  87
  88   char buf[256];
  89   for (size_t i = 0; i <= sizeof(buf); i++) {
  90     ERR_error_string_n(packed_error, buf, i);
  91   }
  92 }
  93
  94 TEST(ErrTest, Release) {
  95   ERR_put_error(1, 0 /* unused */, 2, "test", 4);
  96   ERR_remove_thread_state(NULL);
  97
  98   // The error queue should be cleared.
  99   EXPECT_EQ(0u, ERR_get_error());
 100 }
 101
 102 static bool HasSuffix(const char *str, const char *suffix) {
 103   size_t suffix_len = strlen(suffix);
 104   size_t str_len = strlen(str);
 105   if (str_len < suffix_len) {
 106     return false;
 107   }
 108   return strcmp(str + str_len - suffix_len, suffix) == 0;
 109 }
 110
 111 TEST(ErrTest, PutMacro) {
 112   int expected_line = __LINE__ + 1;
 113   OPENSSL_PUT_ERROR(USER, ERR_R_INTERNAL_ERROR);
 114
 115   int line;
 116   const char *file;
 117   uint32_t error = ERR_get_error_line(&file, &line);
 118
 119   EXPECT_PRED2(HasSuffix, file, "err_test.cc");
 120   EXPECT_EQ(expected_line, line);
 121   EXPECT_EQ(ERR_LIB_USER, ERR_GET_LIB(error));
 122   EXPECT_EQ(ERR_R_INTERNAL_ERROR, ERR_GET_REASON(error));
 123 }
 124
 125 TEST(ErrTest, SaveAndRestore) {
 126   // Restoring no state clears the error queue, including error data.
 127   ERR_put_error(1, 0 /* unused */, 1, "test1.c", 1);
 128   ERR_put_error(2, 0 /* unused */, 2, "test2.c", 2);
 129   ERR_add_error_data(1, "data1");
 130   ERR_restore_state(nullptr);
 131   EXPECT_EQ(0u, ERR_get_error());
 132
 133   // Add some entries to the error queue and save it.
 134   ERR_put_error(1, 0 /* unused */, 1, "test1.c", 1);
 135   ERR_add_error_data(1, "data1");
 136   ERR_put_error(2, 0 /* unused */, 2, "test2.c", 2);
 137   ERR_put_error(3, 0 /* unused */, 3, "test3.c", 3);
 138   ERR_add_error_data(1, "data3");
 139   bssl::UniquePtr<ERR_SAVE_STATE> saved(ERR_save_state());
 140   ASSERT_TRUE(saved);
 141
 142   // The existing error queue entries still exist.
 143   int line, flags;
 144   const char *file, *data;
 145   uint32_t packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
 146   EXPECT_EQ(ERR_GET_LIB(packed_error), 1);
 147   EXPECT_EQ(ERR_GET_REASON(packed_error), 1);
 148   EXPECT_STREQ("test1.c", file);
 149   EXPECT_EQ(line, 1);
 150   EXPECT_STREQ(data, "data1");
 151   EXPECT_EQ(flags, ERR_FLAG_STRING);
 152
 153   // The state may be restored, both over an empty and non-empty state.
 154   for (unsigned i = 0; i < 2; i++) {
 155     SCOPED_TRACE(i);
 156     ERR_restore_state(saved.get());
 157
 158     packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
 159     EXPECT_EQ(ERR_GET_LIB(packed_error), 1);
 160     EXPECT_EQ(ERR_GET_REASON(packed_error), 1);
 161     EXPECT_STREQ("test1.c", file);
 162     EXPECT_EQ(line, 1);
 163     EXPECT_STREQ(data, "data1");
 164     EXPECT_EQ(flags, ERR_FLAG_STRING);
 165
 166     packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
 167     EXPECT_EQ(ERR_GET_LIB(packed_error), 2);
 168     EXPECT_EQ(ERR_GET_REASON(packed_error), 2);
 169     EXPECT_STREQ("test2.c", file);
 170     EXPECT_EQ(line, 2);
 171     EXPECT_STREQ(data, "");  // No error data is reported as the empty string.
 172     EXPECT_EQ(flags, 0);
 173
 174     packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
 175     EXPECT_EQ(ERR_GET_LIB(packed_error), 3);
 176     EXPECT_EQ(ERR_GET_REASON(packed_error), 3);
 177     EXPECT_STREQ("test3.c", file);
 178     EXPECT_EQ(line, 3);
 179     EXPECT_STREQ(data, "data3");
 180     EXPECT_EQ(flags, ERR_FLAG_STRING);
 181
 182     // The error queue is now empty for the next iteration.
 183     EXPECT_EQ(0u, ERR_get_error());
 184   }
 185
 186   // Test a case where the error queue wraps around. The first set of errors
 187   // will all be discarded, but result in wrapping the list around.
 188   ERR_clear_error();
 189   for (unsigned i = 0; i < ERR_NUM_ERRORS / 2; i++) {
 190     ERR_put_error(0, 0 /* unused */, 0, "invalid", 0);
 191   }
 192   for (unsigned i = 1; i < ERR_NUM_ERRORS; i++) {
 193     ERR_put_error(i, 0 /* unused */, i, "test", i);
 194   }
 195   saved.reset(ERR_save_state());
 196
 197   // The state may be restored, both over an empty and non-empty state. Pop one
 198   // error off so the first iteration is tested to not be a no-op.
 199   ERR_get_error();
 200   for (int i = 0; i < 2; i++) {
 201     SCOPED_TRACE(i);
 202     ERR_restore_state(saved.get());
 203     for (int j = 1; j < ERR_NUM_ERRORS; j++) {
 204       SCOPED_TRACE(j);
 205       packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
 206       EXPECT_EQ(ERR_GET_LIB(packed_error), j);
 207       EXPECT_EQ(ERR_GET_REASON(packed_error), j);
 208       EXPECT_STREQ("test", file);
 209       EXPECT_EQ(line, j);
 210     }
 211     // The error queue is now empty for the next iteration.
 212     EXPECT_EQ(0u, ERR_get_error());
 213   }
 214 }