ref: 98c1cd7ae022efe276123898af6b892eade0732c
dir: /third_party/boringssl/src/crypto/err/err_test.cc/
/* Copyright (c) 2014, Google Inc.
*
* Permission to use, copy, modify, and/or 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 <stdio.h>
#include <string.h>
#include <gtest/gtest.h>
#include <openssl/crypto.h>
#include <openssl/err.h>
#include <openssl/mem.h>
#include "./internal.h"
#if defined(OPENSSL_WINDOWS)
OPENSSL_MSVC_PRAGMA(warning(push, 3))
#include <windows.h>
OPENSSL_MSVC_PRAGMA(warning(pop))
#else
#include <errno.h>
#endif
TEST(ErrTest, Overflow) {
for (unsigned i = 0; i < ERR_NUM_ERRORS*2; i++) {
ERR_put_error(1, 0 /* unused */, i+1, "test", 1);
}
for (unsigned i = 0; i < ERR_NUM_ERRORS - 1; i++) {
SCOPED_TRACE(i);
uint32_t err = ERR_get_error();
// Errors are returned in order they were pushed, with the least recent ones
// removed, up to |ERR_NUM_ERRORS - 1| errors. So the errors returned are
// |ERR_NUM_ERRORS + 2| through |ERR_NUM_ERRORS * 2|, inclusive.
EXPECT_NE(0u, err);
EXPECT_EQ(static_cast<int>(i + ERR_NUM_ERRORS + 2), ERR_GET_REASON(err));
}
EXPECT_EQ(0u, ERR_get_error());
}
TEST(ErrTest, PutError) {
ASSERT_EQ(0u, ERR_get_error())
<< "ERR_get_error returned value before an error was added.";
ERR_put_error(1, 0 /* unused */, 2, "test", 4);
ERR_add_error_data(1, "testing");
int peeked_line, line, peeked_flags, flags;
const char *peeked_file, *file, *peeked_data, *data;
uint32_t peeked_packed_error =
ERR_peek_error_line_data(&peeked_file, &peeked_line, &peeked_data,
&peeked_flags);
uint32_t packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
EXPECT_EQ(peeked_packed_error, packed_error);
EXPECT_EQ(peeked_file, file);
EXPECT_EQ(peeked_data, data);
EXPECT_EQ(peeked_flags, flags);
EXPECT_STREQ("test", file);
EXPECT_EQ(4, line);
EXPECT_TRUE(flags & ERR_FLAG_STRING);
EXPECT_EQ(1, ERR_GET_LIB(packed_error));
EXPECT_EQ(2, ERR_GET_REASON(packed_error));
EXPECT_STREQ("testing", data);
}
TEST(ErrTest, ClearError) {
ASSERT_EQ(0u, ERR_get_error())
<< "ERR_get_error returned value before an error was added.";
ERR_put_error(1, 0 /* unused */, 2, "test", 4);
ERR_clear_error();
// The error queue should be cleared.
EXPECT_EQ(0u, ERR_get_error());
}
TEST(ErrTest, Print) {
ERR_put_error(1, 0 /* unused */, 2, "test", 4);
ERR_add_error_data(1, "testing");
uint32_t packed_error = ERR_get_error();
char buf[256];
for (size_t i = 0; i <= sizeof(buf); i++) {
ERR_error_string_n(packed_error, buf, i);
}
}
TEST(ErrTest, Release) {
ERR_put_error(1, 0 /* unused */, 2, "test", 4);
ERR_remove_thread_state(NULL);
// The error queue should be cleared.
EXPECT_EQ(0u, ERR_get_error());
}
static bool HasSuffix(const char *str, const char *suffix) {
size_t suffix_len = strlen(suffix);
size_t str_len = strlen(str);
if (str_len < suffix_len) {
return false;
}
return strcmp(str + str_len - suffix_len, suffix) == 0;
}
TEST(ErrTest, PutMacro) {
int expected_line = __LINE__ + 1;
OPENSSL_PUT_ERROR(USER, ERR_R_INTERNAL_ERROR);
int line;
const char *file;
uint32_t error = ERR_get_error_line(&file, &line);
EXPECT_PRED2(HasSuffix, file, "err_test.cc");
EXPECT_EQ(expected_line, line);
EXPECT_EQ(ERR_LIB_USER, ERR_GET_LIB(error));
EXPECT_EQ(ERR_R_INTERNAL_ERROR, ERR_GET_REASON(error));
}
TEST(ErrTest, SaveAndRestore) {
// Restoring no state clears the error queue, including error data.
ERR_put_error(1, 0 /* unused */, 1, "test1.c", 1);
ERR_put_error(2, 0 /* unused */, 2, "test2.c", 2);
ERR_add_error_data(1, "data1");
ERR_restore_state(nullptr);
EXPECT_EQ(0u, ERR_get_error());
// Add some entries to the error queue and save it.
ERR_put_error(1, 0 /* unused */, 1, "test1.c", 1);
ERR_add_error_data(1, "data1");
ERR_put_error(2, 0 /* unused */, 2, "test2.c", 2);
ERR_put_error(3, 0 /* unused */, 3, "test3.c", 3);
ERR_add_error_data(1, "data3");
bssl::UniquePtr<ERR_SAVE_STATE> saved(ERR_save_state());
ASSERT_TRUE(saved);
// The existing error queue entries still exist.
int line, flags;
const char *file, *data;
uint32_t packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
EXPECT_EQ(ERR_GET_LIB(packed_error), 1);
EXPECT_EQ(ERR_GET_REASON(packed_error), 1);
EXPECT_STREQ("test1.c", file);
EXPECT_EQ(line, 1);
EXPECT_STREQ(data, "data1");
EXPECT_EQ(flags, ERR_FLAG_STRING);
// The state may be restored, both over an empty and non-empty state.
for (unsigned i = 0; i < 2; i++) {
SCOPED_TRACE(i);
ERR_restore_state(saved.get());
packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
EXPECT_EQ(ERR_GET_LIB(packed_error), 1);
EXPECT_EQ(ERR_GET_REASON(packed_error), 1);
EXPECT_STREQ("test1.c", file);
EXPECT_EQ(line, 1);
EXPECT_STREQ(data, "data1");
EXPECT_EQ(flags, ERR_FLAG_STRING);
packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
EXPECT_EQ(ERR_GET_LIB(packed_error), 2);
EXPECT_EQ(ERR_GET_REASON(packed_error), 2);
EXPECT_STREQ("test2.c", file);
EXPECT_EQ(line, 2);
EXPECT_STREQ(data, ""); // No error data is reported as the empty string.
EXPECT_EQ(flags, 0);
packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
EXPECT_EQ(ERR_GET_LIB(packed_error), 3);
EXPECT_EQ(ERR_GET_REASON(packed_error), 3);
EXPECT_STREQ("test3.c", file);
EXPECT_EQ(line, 3);
EXPECT_STREQ(data, "data3");
EXPECT_EQ(flags, ERR_FLAG_STRING);
// The error queue is now empty for the next iteration.
EXPECT_EQ(0u, ERR_get_error());
}
// Test a case where the error queue wraps around. The first set of errors
// will all be discarded, but result in wrapping the list around.
ERR_clear_error();
for (unsigned i = 0; i < ERR_NUM_ERRORS / 2; i++) {
ERR_put_error(0, 0 /* unused */, 0, "invalid", 0);
}
for (unsigned i = 1; i < ERR_NUM_ERRORS; i++) {
ERR_put_error(i, 0 /* unused */, i, "test", i);
}
saved.reset(ERR_save_state());
// The state may be restored, both over an empty and non-empty state. Pop one
// error off so the first iteration is tested to not be a no-op.
ERR_get_error();
for (int i = 0; i < 2; i++) {
SCOPED_TRACE(i);
ERR_restore_state(saved.get());
for (int j = 1; j < ERR_NUM_ERRORS; j++) {
SCOPED_TRACE(j);
packed_error = ERR_get_error_line_data(&file, &line, &data, &flags);
EXPECT_EQ(ERR_GET_LIB(packed_error), j);
EXPECT_EQ(ERR_GET_REASON(packed_error), j);
EXPECT_STREQ("test", file);
EXPECT_EQ(line, j);
}
// The error queue is now empty for the next iteration.
EXPECT_EQ(0u, ERR_get_error());
}
}
// Querying the error queue should not affect the OS error.
#if defined(OPENSSL_WINDOWS)
TEST(ErrTest, PreservesLastError) {
SetLastError(ERROR_INVALID_FUNCTION);
ERR_get_error();
EXPECT_EQ(static_cast<DWORD>(ERROR_INVALID_FUNCTION), GetLastError());
}
#else
TEST(ErrTest, PreservesErrno) {
errno = EINVAL;
ERR_get_error();
EXPECT_EQ(EINVAL, errno);
}
#endif
TEST(ErrTest, String) {
char buf[128];
const uint32_t err = ERR_PACK(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR);
EXPECT_STREQ(
"error:0e000044:common libcrypto routines:OPENSSL_internal:internal "
"error",
ERR_error_string_n(err, buf, sizeof(buf)));
// The buffer is exactly the right size.
EXPECT_STREQ(
"error:0e000044:common libcrypto routines:OPENSSL_internal:internal "
"error",
ERR_error_string_n(err, buf, 73));
// If the buffer is too short, the string is truncated.
EXPECT_STREQ(
"error:0e000044:common libcrypto routines:OPENSSL_internal:internal "
"erro",
ERR_error_string_n(err, buf, 72));
EXPECT_STREQ("error:0e000044:common libcrypto routines:OPENSSL_internal:",
ERR_error_string_n(err, buf, 59));
// Truncated log lines always have the right number of colons.
EXPECT_STREQ("error:0e000044:common libcrypto routines:OPENSSL_interna:",
ERR_error_string_n(err, buf, 58));
EXPECT_STREQ("error:0e000044:common libcrypto routines:OPENSSL_intern:",
ERR_error_string_n(err, buf, 57));
EXPECT_STREQ("error:0e000044:common libcryp::",
ERR_error_string_n(err, buf, 32));
EXPECT_STREQ("error:0e0000:::",
ERR_error_string_n(err, buf, 16));
EXPECT_STREQ("err::::",
ERR_error_string_n(err, buf, 8));
EXPECT_STREQ("::::",
ERR_error_string_n(err, buf, 5));
// If the buffer is too short for even four colons, |ERR_error_string_n| does
// not bother trying to preserve the format.
EXPECT_STREQ("err", ERR_error_string_n(err, buf, 4));
EXPECT_STREQ("er", ERR_error_string_n(err, buf, 3));
EXPECT_STREQ("e", ERR_error_string_n(err, buf, 2));
EXPECT_STREQ("", ERR_error_string_n(err, buf, 1));
// A buffer length of zero should not touch the buffer.
ERR_error_string_n(err, nullptr, 0);
}
// Error-printing functions should return something with unknown errors.
TEST(ErrTest, UnknownError) {
uint32_t err = ERR_PACK(0xff, 0xfff);
EXPECT_TRUE(ERR_lib_error_string(err));
EXPECT_TRUE(ERR_reason_error_string(err));
char buf[128];
ERR_error_string_n(err, buf, sizeof(buf));
EXPECT_NE(0u, strlen(buf));
}