diff options
| -rw-r--r-- | .travis.yml | 8 | ||||
| -rw-r--r-- | CMakeLists.txt | 43 | ||||
| -rw-r--r-- | NitrokeyManager.cc | 3 | ||||
| -rw-r--r-- | unittest/test2.cc | 42 | ||||
| -rw-r--r-- | unittest/test3.cc | 8 | ||||
| -rw-r--r-- | unittest/test_offline.cc | 141 |
6 files changed, 180 insertions, 65 deletions
diff --git a/.travis.yml b/.travis.yml index ba4465b..cd1c489 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,7 +13,7 @@ matrix: - osx_image: xcode8.2 - os: linux dist: trusty - env: COMPILER_NAME=gcc CXX=g++-5 CC=gcc-5 CF=-DCOMPILE_TESTS=ON + env: COMPILER_NAME=gcc CXX=g++-5 CC=gcc-5 addons: apt: packages: @@ -24,7 +24,7 @@ matrix: - ubuntu-toolchain-r-test - os: linux dist: trusty - env: COMPILER_NAME=gcc CXX=g++-6 CC=gcc-6 CF=-DCOMPILE_TESTS=ON + env: COMPILER_NAME=gcc CXX=g++-6 CC=gcc-6 addons: apt: packages: @@ -34,7 +34,7 @@ matrix: sources: *sources - os: linux dist: trusty - env: COMPILER_NAME=clang CXX=clang++-3.8 CC=clang-3.8 CF=-DCOMPILE_TESTS=ON + env: COMPILER_NAME=clang CXX=clang++-3.8 CC=clang-3.8 addons: apt: packages: @@ -55,4 +55,4 @@ install: script: - make -j2 -# - make test # TODO add library device-less tests
\ No newline at end of file + - ctest -VV
\ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index 6e5ed53..8cb0fdc 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -31,7 +31,15 @@ project(libnitrokey) SET(PROJECT_VERSION "3.0-alpha") set(CMAKE_CXX_STANDARD 14) -OPTION(LIBNITROKEY_STATIC "Build libnitrokey statically" TRUE) +set(LIBNK_VERSION_MAJOR 3) # reminder: incompatible API changes +set(LIBNK_VERSION_MINOR 0) # add functionality in a backwards-compatible manner +set(LIBNK_VERSION_PATCH 0) # make backwards-compatible bug fixes +set(LIBNK_VERSION ${LIBNK_VERSION_MAJOR}.${LIBNK_VERSION_MINOR}.${LIBNK_VERSION_PATCH} ) + + +include(GNUInstallDirs) + +OPTION(LIBNITROKEY_STATIC "Build libnitrokey statically" FALSE) OPTION(COMPILE_TESTS "Compile tests" FALSE) @@ -83,8 +91,8 @@ ENDIF() IF (NOT LIBNITROKEY_STATIC) add_library(nitrokey SHARED ${SOURCE_FILES}) - install (TARGETS nitrokey DESTINATION "lib") - SET(LIBNAME nitrokey) + add_library(nitrokey-log SHARED ${SOURCE_FILES}) + SET(LIBNAME nitrokey) ELSE() add_library(nitrokey-static STATIC ${SOURCE_FILES}) SET(LIBNAME nitrokey-static) @@ -93,6 +101,11 @@ ENDIF() target_link_libraries(${LIBNAME} hidapi-libusb) +set_target_properties(${LIBNAME} PROPERTIES VERSION ${LIBNK_VERSION} + SOVERSION ${LIBNK_VERSION_MAJOR} ) +set_target_properties(${LIBNAME}-log PROPERTIES VERSION ${LIBNK_VERSION} + SOVERSION ${LIBNK_VERSION_MAJOR} ) + OPTION(ERROR_ON_WARNING "Stop compilation on warning found (not supported for MSVC)" ON) if (NOT MSVC) set(COMPILE_FLAGS "-Wall -Wno-unused-function -Wcast-qual -Woverloaded-virtual") @@ -110,14 +123,23 @@ IF (NO_LOG) ENDIF() -file(GLOB LIB_INCLUDES "include/libnitrokey/*.h") -install (FILES ${LIB_INCLUDES} DESTINATION "include") +file(GLOB LIB_INCLUDES "include/*.h") +install (FILES ${LIB_INCLUDES} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/libnitrokey) +install (TARGETS ${LIBNAME} DESTINATION ${CMAKE_INSTALL_LIBDIR}) +install (TARGETS ${LIBNAME}-log DESTINATION ${CMAKE_INSTALL_LIBDIR}) -IF (COMPILE_TESTS) - include_directories(unittest/Catch/include) - add_library(catch STATIC unittest/catch_main.cpp ) +include_directories(unittest/Catch/include) +add_library(catch STATIC unittest/catch_main.cpp ) +add_executable (test_offline unittest/test_offline.cc) +target_link_libraries (test_offline ${EXTRA_LIBS} ${LIBNAME}-log catch) +#run with 'make test' or 'ctest' +include (CTest) +add_test (runs test_offline) +IF (COMPILE_TESTS) + #needs connected PRO device for success + #warning: it may delete data on the device add_executable (test_C_API unittest/test_C_API.cpp) target_link_libraries (test_C_API ${EXTRA_LIBS} ${LIBNAME} catch) @@ -136,11 +158,6 @@ IF (COMPILE_TESTS) add_executable (test_issues unittest/test_issues.cc) target_link_libraries (test_issues ${EXTRA_LIBS} ${LIBNAME} catch) - #run with 'make test' or 'ctest' - #needs connected PRO device for success - #warning: it may delete data on the device - include (CTest) - add_test (runs test_C_API) ENDIF() diff --git a/NitrokeyManager.cc b/NitrokeyManager.cc index 9ff146d..b29b27d 100644 --- a/NitrokeyManager.cc +++ b/NitrokeyManager.cc @@ -724,9 +724,8 @@ using nitrokey::misc::strcpyT; } DeviceModel NitrokeyManager::get_connected_device_model() const{ - //FIXME throw if no device is connected or return unknown/unconnected value if (device == nullptr){ - throw std::runtime_error("device not connected"); + throw DeviceNotConnected("device not connected"); } return device->get_device_model(); } diff --git a/unittest/test2.cc b/unittest/test2.cc index 31dbce8..bbe5b07 100644 --- a/unittest/test2.cc +++ b/unittest/test2.cc @@ -80,48 +80,6 @@ TEST_CASE("long operation test", "[test_long]") { } -#include "test_command_ids_header.h" - -TEST_CASE("test device commands ids", "[fast]") { - -// REQUIRE(STICK20_CMD_START_VALUE == static_cast<uint8_t>(CommandID::START_VALUE)); - REQUIRE(STICK20_CMD_ENABLE_CRYPTED_PARI == static_cast<uint8_t>(CommandID::ENABLE_CRYPTED_PARI)); - REQUIRE(STICK20_CMD_DISABLE_CRYPTED_PARI == static_cast<uint8_t>(CommandID::DISABLE_CRYPTED_PARI)); - REQUIRE(STICK20_CMD_ENABLE_HIDDEN_CRYPTED_PARI == static_cast<uint8_t>(CommandID::ENABLE_HIDDEN_CRYPTED_PARI)); - REQUIRE(STICK20_CMD_DISABLE_HIDDEN_CRYPTED_PARI == static_cast<uint8_t>(CommandID::DISABLE_HIDDEN_CRYPTED_PARI)); - REQUIRE(STICK20_CMD_ENABLE_FIRMWARE_UPDATE == static_cast<uint8_t>(CommandID::ENABLE_FIRMWARE_UPDATE)); - REQUIRE(STICK20_CMD_EXPORT_FIRMWARE_TO_FILE == static_cast<uint8_t>(CommandID::EXPORT_FIRMWARE_TO_FILE)); - REQUIRE(STICK20_CMD_GENERATE_NEW_KEYS == static_cast<uint8_t>(CommandID::GENERATE_NEW_KEYS)); - REQUIRE(STICK20_CMD_FILL_SD_CARD_WITH_RANDOM_CHARS == static_cast<uint8_t>(CommandID::FILL_SD_CARD_WITH_RANDOM_CHARS)); - - REQUIRE(STICK20_CMD_WRITE_STATUS_DATA == static_cast<uint8_t>(CommandID::WRITE_STATUS_DATA)); - REQUIRE(STICK20_CMD_ENABLE_READONLY_UNCRYPTED_LUN == static_cast<uint8_t>(CommandID::ENABLE_READONLY_UNCRYPTED_LUN)); - REQUIRE(STICK20_CMD_ENABLE_READWRITE_UNCRYPTED_LUN == static_cast<uint8_t>(CommandID::ENABLE_READWRITE_UNCRYPTED_LUN)); - - REQUIRE(STICK20_CMD_SEND_PASSWORD_MATRIX == static_cast<uint8_t>(CommandID::SEND_PASSWORD_MATRIX)); - REQUIRE(STICK20_CMD_SEND_PASSWORD_MATRIX_PINDATA == static_cast<uint8_t>(CommandID::SEND_PASSWORD_MATRIX_PINDATA)); - REQUIRE(STICK20_CMD_SEND_PASSWORD_MATRIX_SETUP == static_cast<uint8_t>(CommandID::SEND_PASSWORD_MATRIX_SETUP)); - - REQUIRE(STICK20_CMD_GET_DEVICE_STATUS == static_cast<uint8_t>(CommandID::GET_DEVICE_STATUS)); - REQUIRE(STICK20_CMD_SEND_DEVICE_STATUS == static_cast<uint8_t>(CommandID::SEND_DEVICE_STATUS)); - - REQUIRE(STICK20_CMD_SEND_HIDDEN_VOLUME_PASSWORD == static_cast<uint8_t>(CommandID::SEND_HIDDEN_VOLUME_PASSWORD)); - REQUIRE(STICK20_CMD_SEND_HIDDEN_VOLUME_SETUP == static_cast<uint8_t>(CommandID::SEND_HIDDEN_VOLUME_SETUP)); - REQUIRE(STICK20_CMD_SEND_PASSWORD == static_cast<uint8_t>(CommandID::SEND_PASSWORD)); - REQUIRE(STICK20_CMD_SEND_NEW_PASSWORD == static_cast<uint8_t>(CommandID::SEND_NEW_PASSWORD)); - REQUIRE(STICK20_CMD_CLEAR_NEW_SD_CARD_FOUND == static_cast<uint8_t>(CommandID::CLEAR_NEW_SD_CARD_FOUND)); - - REQUIRE(STICK20_CMD_SEND_STARTUP == static_cast<uint8_t>(CommandID::SEND_STARTUP)); - REQUIRE(STICK20_CMD_SEND_CLEAR_STICK_KEYS_NOT_INITIATED == static_cast<uint8_t>(CommandID::SEND_CLEAR_STICK_KEYS_NOT_INITIATED)); - REQUIRE(STICK20_CMD_SEND_LOCK_STICK_HARDWARE == static_cast<uint8_t>(CommandID::SEND_LOCK_STICK_HARDWARE)); - - REQUIRE(STICK20_CMD_PRODUCTION_TEST == static_cast<uint8_t>(CommandID::PRODUCTION_TEST)); - REQUIRE(STICK20_CMD_SEND_DEBUG_DATA == static_cast<uint8_t>(CommandID::SEND_DEBUG_DATA)); - - REQUIRE(STICK20_CMD_CHANGE_UPDATE_PIN == static_cast<uint8_t>(CommandID::CHANGE_UPDATE_PIN)); - -} - TEST_CASE("test device internal status with various commands", "[fast]") { auto stick = make_shared<Stick20>(); bool connected = stick->connect(); diff --git a/unittest/test3.cc b/unittest/test3.cc index 9e0ef11..b5289f7 100644 --- a/unittest/test3.cc +++ b/unittest/test3.cc @@ -113,7 +113,7 @@ TEST_CASE("write general config", "[pronew]") { auto p = get_payload<WriteGeneralConfig>(); p.enable_user_password = 1; REQUIRE_THROWS( - WriteGeneralConfig::CommandTransaction::run(stick, p); + WriteGeneralConfig::CommandTransaction::run(stick, p) ); strcpyT(p.temporary_admin_password, temporary_password); WriteGeneralConfig::CommandTransaction::run(stick, p); @@ -154,7 +154,7 @@ TEST_CASE("authorize user HOTP", "[pronew]") { auto p3 = get_payload<GetHOTP>(); p3.slot_number = 0 + 0x10; REQUIRE_THROWS( - GetHOTP::CommandTransaction::run(stick, p3); + GetHOTP::CommandTransaction::run(stick, p3) ); strcpyT(p3.temporary_user_password, temporary_password); auto code_response = GetHOTP::CommandTransaction::run(stick, p3); @@ -205,7 +205,7 @@ TEST_CASE("authorize user TOTP", "[pronew]") { p_get_totp.slot_number = 0 + 0x20; REQUIRE_THROWS( - GetTOTP::CommandTransaction::run(stick, p_get_totp); + GetTOTP::CommandTransaction::run(stick, p_get_totp) ); strcpyT(p_get_totp.temporary_user_password, temporary_password); @@ -216,4 +216,4 @@ TEST_CASE("authorize user TOTP", "[pronew]") { auto code = GetTOTP::CommandTransaction::run(stick, p_get_totp); REQUIRE(code.data().code == 94287082); -}
\ No newline at end of file +} diff --git a/unittest/test_offline.cc b/unittest/test_offline.cc new file mode 100644 index 0000000..58c7555 --- /dev/null +++ b/unittest/test_offline.cc @@ -0,0 +1,141 @@ +#include "catch.hpp" +#include <NitrokeyManager.h> +#include <memory> +#include "../NK_C_API.h" + +using namespace nitrokey::proto; +using namespace nitrokey::device; + +using namespace std; +using namespace nitrokey; + +//This test suite assumes no Pro or Storage devices are connected + +TEST_CASE("Return false on no device connected", "[fast]") { + INFO("This test case assumes no Pro or Storage devices are connected"); + auto stick = make_shared<Stick20>(); + bool connected = true; + REQUIRE_NOTHROW(connected = stick->connect()); + REQUIRE_FALSE(connected); + + auto stick_pro = make_shared<Stick10>(); + REQUIRE_NOTHROW(connected = stick_pro->connect()); + REQUIRE_FALSE(connected); + + + auto i = NitrokeyManager::instance(); + REQUIRE_NOTHROW(connected = i->connect()); + REQUIRE_FALSE(connected); + REQUIRE_FALSE(i->is_connected()); + REQUIRE_FALSE(i->disconnect()); + REQUIRE_FALSE(i->could_current_device_be_enumerated()); + + + int C_connected = 1; + REQUIRE_NOTHROW(C_connected = NK_login_auto()); + REQUIRE(0 == C_connected); +} + +TEST_CASE("Test C++ side behaviour in offline", "[fast]") { + auto i = NitrokeyManager::instance(); + + string serial_number; + REQUIRE_NOTHROW (serial_number = i->get_serial_number()); + REQUIRE(serial_number.empty()); + + REQUIRE_THROWS_AS( + i->get_status(), DeviceNotConnected + ); + + REQUIRE_THROWS_AS( + i->get_HOTP_code(0xFF, ""), InvalidSlotException + ); + + REQUIRE_THROWS_AS( + i->get_TOTP_code(0xFF, ""), InvalidSlotException + ); + + REQUIRE_THROWS_AS( + i->erase_hotp_slot(0xFF, ""), InvalidSlotException + ); + + REQUIRE_THROWS_AS( + i->erase_totp_slot(0xFF, ""), InvalidSlotException + ); + + REQUIRE_THROWS_AS( + i->get_totp_slot_name(0xFF), InvalidSlotException + ); + + REQUIRE_THROWS_AS( + i->get_hotp_slot_name(0xFF), InvalidSlotException + ); + + REQUIRE_THROWS_AS( + i->first_authenticate("123123", "123123"), DeviceNotConnected + ); + + REQUIRE_THROWS_AS( + i->get_connected_device_model(), DeviceNotConnected + ); + + REQUIRE_THROWS_AS( + i->clear_new_sd_card_warning("123123"), DeviceNotConnected + ); + +} + + +TEST_CASE("Test helper function - hex_string_to_byte", "[fast]") { + using namespace nitrokey::misc; + std::vector<uint8_t> v; + REQUIRE_NOTHROW(v = hex_string_to_byte("00112233445566")); + const uint8_t test_data[] = {0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66}; + REQUIRE(v.size() == sizeof(test_data)); + for (int i = 0; i < v.size(); ++i) { + INFO("Position i: " << i); + REQUIRE(v.data()[i] == test_data[i]); + } +} + +#include "test_command_ids_header.h" +TEST_CASE("Test device commands ids", "[fast]") { +// Make sure CommandID values are in sync with firmware's header + +// REQUIRE(STICK20_CMD_START_VALUE == static_cast<uint8_t>(CommandID::START_VALUE)); + REQUIRE(STICK20_CMD_ENABLE_CRYPTED_PARI == static_cast<uint8_t>(CommandID::ENABLE_CRYPTED_PARI)); + REQUIRE(STICK20_CMD_DISABLE_CRYPTED_PARI == static_cast<uint8_t>(CommandID::DISABLE_CRYPTED_PARI)); + REQUIRE(STICK20_CMD_ENABLE_HIDDEN_CRYPTED_PARI == static_cast<uint8_t>(CommandID::ENABLE_HIDDEN_CRYPTED_PARI)); + REQUIRE(STICK20_CMD_DISABLE_HIDDEN_CRYPTED_PARI == static_cast<uint8_t>(CommandID::DISABLE_HIDDEN_CRYPTED_PARI)); + REQUIRE(STICK20_CMD_ENABLE_FIRMWARE_UPDATE == static_cast<uint8_t>(CommandID::ENABLE_FIRMWARE_UPDATE)); + REQUIRE(STICK20_CMD_EXPORT_FIRMWARE_TO_FILE == static_cast<uint8_t>(CommandID::EXPORT_FIRMWARE_TO_FILE)); + REQUIRE(STICK20_CMD_GENERATE_NEW_KEYS == static_cast<uint8_t>(CommandID::GENERATE_NEW_KEYS)); + REQUIRE(STICK20_CMD_FILL_SD_CARD_WITH_RANDOM_CHARS == static_cast<uint8_t>(CommandID::FILL_SD_CARD_WITH_RANDOM_CHARS)); + + REQUIRE(STICK20_CMD_WRITE_STATUS_DATA == static_cast<uint8_t>(CommandID::WRITE_STATUS_DATA)); + REQUIRE(STICK20_CMD_ENABLE_READONLY_UNCRYPTED_LUN == static_cast<uint8_t>(CommandID::ENABLE_READONLY_UNCRYPTED_LUN)); + REQUIRE(STICK20_CMD_ENABLE_READWRITE_UNCRYPTED_LUN == static_cast<uint8_t>(CommandID::ENABLE_READWRITE_UNCRYPTED_LUN)); + + REQUIRE(STICK20_CMD_SEND_PASSWORD_MATRIX == static_cast<uint8_t>(CommandID::SEND_PASSWORD_MATRIX)); + REQUIRE(STICK20_CMD_SEND_PASSWORD_MATRIX_PINDATA == static_cast<uint8_t>(CommandID::SEND_PASSWORD_MATRIX_PINDATA)); + REQUIRE(STICK20_CMD_SEND_PASSWORD_MATRIX_SETUP == static_cast<uint8_t>(CommandID::SEND_PASSWORD_MATRIX_SETUP)); + + REQUIRE(STICK20_CMD_GET_DEVICE_STATUS == static_cast<uint8_t>(CommandID::GET_DEVICE_STATUS)); + REQUIRE(STICK20_CMD_SEND_DEVICE_STATUS == static_cast<uint8_t>(CommandID::SEND_DEVICE_STATUS)); + + REQUIRE(STICK20_CMD_SEND_HIDDEN_VOLUME_PASSWORD == static_cast<uint8_t>(CommandID::SEND_HIDDEN_VOLUME_PASSWORD)); + REQUIRE(STICK20_CMD_SEND_HIDDEN_VOLUME_SETUP == static_cast<uint8_t>(CommandID::SEND_HIDDEN_VOLUME_SETUP)); + REQUIRE(STICK20_CMD_SEND_PASSWORD == static_cast<uint8_t>(CommandID::SEND_PASSWORD)); + REQUIRE(STICK20_CMD_SEND_NEW_PASSWORD == static_cast<uint8_t>(CommandID::SEND_NEW_PASSWORD)); + REQUIRE(STICK20_CMD_CLEAR_NEW_SD_CARD_FOUND == static_cast<uint8_t>(CommandID::CLEAR_NEW_SD_CARD_FOUND)); + + REQUIRE(STICK20_CMD_SEND_STARTUP == static_cast<uint8_t>(CommandID::SEND_STARTUP)); + REQUIRE(STICK20_CMD_SEND_CLEAR_STICK_KEYS_NOT_INITIATED == static_cast<uint8_t>(CommandID::SEND_CLEAR_STICK_KEYS_NOT_INITIATED)); + REQUIRE(STICK20_CMD_SEND_LOCK_STICK_HARDWARE == static_cast<uint8_t>(CommandID::SEND_LOCK_STICK_HARDWARE)); + + REQUIRE(STICK20_CMD_PRODUCTION_TEST == static_cast<uint8_t>(CommandID::PRODUCTION_TEST)); + REQUIRE(STICK20_CMD_SEND_DEBUG_DATA == static_cast<uint8_t>(CommandID::SEND_DEBUG_DATA)); + + REQUIRE(STICK20_CMD_CHANGE_UPDATE_PIN == static_cast<uint8_t>(CommandID::CHANGE_UPDATE_PIN)); + +} |