src/ckm/ckm-common.h

   1 /*
   2  *  Copyright (c) 2000 - 2014 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *  Licensed under the Apache License, Version 2.0 (the "License");
   5  *  you may not use this file except in compliance with the License.
   6  *  You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License
  15  */
  16 /*
  17  * @file       ckm-common.h
  18  * @author     Krzysztof Jackiewicz (k.jackiewicz@samsung.com)
  19  * @version    1.0
  20  */
  21
  22 #pragma once
  23
  24 #include <string>
  25 #include <memory>
  26 #include <stdexcept>
  27 #include <ckm/ckm-type.h>
  28 #include <ckm/ckm-manager-async.h>
  29 #include <ckmc/ckmc-type.h>
  30 #include <ckmc/ckmc-error.h>
  31 #include <tests_common.h>
  32 #include <sys/types.h>
  33
  34 // support for error printing
  35 const char * CKMCErrorToString(int error);
  36 std::string CKMCReadableError(int error);
  37
  38 // RUNNER_ASSERT wrappers
  39 template <typename F, typename... Args>
  40 void assert_result(int expected, F&& func, Args... args)
  41 {
  42     int ret = func(args...);
  43     RUNNER_ASSERT_MSG(ret == expected,
  44                       "Expected: " << CKMCErrorToString(expected) << "(" << expected << ")"
  45                       " got: " << CKMCErrorToString(ret) << "(" << ret << ")");
  46 }
  47
  48 template <typename F, typename... Args>
  49 void assert_positive(F&& func, Args... args)
  50 {
  51     assert_result(CKMC_ERROR_NONE, std::move(func), args...);
  52 }
  53
  54 template <typename F, typename... Args>
  55 void assert_invalid_param(F&& func, Args... args)
  56 {
  57     assert_result(CKMC_ERROR_INVALID_PARAMETER, std::move(func), args...);
  58 }
  59
  60
  61 // list operations
  62 template <typename T>
  63 size_t list_size(const T* list)
  64 {
  65     size_t size = 0;
  66     while(list) {
  67         list = list->next;
  68         size++;
  69     }
  70     return size;
  71 }
  72
  73
  74 // service lifecycle management
  75 enum ServiceIdx {
  76     LISTENER,
  77     MANAGER
  78 };
  79 void start_service(ServiceIdx idx);
  80 void stop_service(ServiceIdx idx);
  81
  82
  83 // scoped free
  84 typedef std::unique_ptr<char, void (*)(void *)> CharPtr;
  85
  86 // returns process label
  87 CharPtr get_label();
  88
  89 std::string aliasWithLabel(const char *label, const char *alias);
  90
  91 // changes process label
  92 void change_label(const char* label);
  93
  94 // changes process label upon construction and restores it upon destruction
  95 class ScopedLabel
  96 {
  97 public:
  98     ScopedLabel(const char* label);
  99     ~ScopedLabel();
 100
 101 private:
 102     CharPtr m_original_label;
 103 };
 104
 105 void save_data(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE);
 106 void save_data(const char* alias, const char *data, size_t len, int expected_err);
 107 class ScopedSaveData
 108 {
 109 public:
 110     ScopedSaveData(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE);
 111     virtual ~ScopedSaveData();
 112
 113 private:
 114     std::string m_alias;
 115 };
 116
 117 class GarbageCollector
 118 {
 119 public:
 120     void save(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE);
 121     void save(const char* alias, const char *data, size_t len, int expected_err);
 122     void add(const char* alias);
 123     virtual ~GarbageCollector();
 124
 125 private:
 126     struct save_item {
 127         std::string item_alias;
 128         std::string owner_label;
 129         uid_t       owner_uid;
 130         gid_t       owner_gid;
 131     };
 132     std::vector<save_item>  m_garbage;
 133 };
 134
 135 class ScopedDBUnlock
 136 {
 137 public:
 138     ScopedDBUnlock(uid_t user_id, const char* passwd);
 139     virtual ~ScopedDBUnlock();
 140
 141 private:
 142     uid_t m_uid;
 143 };
 144
 145 void check_remove_allowed(const char* alias);
 146 void check_remove_denied(const char* alias);
 147 void check_remove_not_visible(const char* alias);
 148 void check_read(const char* alias,
 149                 const char *label,
 150                 const char *test_data,
 151                 size_t len,
 152                 int expected_code = CKMC_ERROR_NONE);
 153 void check_read(const char* alias,
 154                 const char *label,
 155                 const char *test_data,
 156                 int expected_code = CKMC_ERROR_NONE);
 157 void check_read_allowed(const char* alias, const char *data);
 158 void check_read_not_visible(const char* alias);
 159 void check_key(const char *alias,
 160                int expected_error = CKMC_ERROR_NONE,
 161                ckmc_key_type_e expected_type = CKMC_KEY_NONE);
 162 void check_key_allowed(const char *alias, ckmc_key_type_e expected_type = CKMC_KEY_NONE);
 163 void check_key_not_visible(const char *alias);
 164 void check_cert_allowed(const char *alias);
 165 void check_cert_not_visible(const char *alias);
 166 void allow_access(const char* alias, const char* accessor, int permissionMask);
 167 void allow_access_negative(const char* alias, const char* accessor, int permissionMask, int expectedCode);
 168 void deny_access(const char* alias, const char* accessor);
 169 void deny_access_negative(const char* alias, const char* accessor, int expectedCode);
 170
 171 void unlock_user_data(uid_t user_id, const char *passwd);
 172 void remove_user_data(uid_t user_id);
 173 void reset_user_data(uid_t user_id, const char *passwd);
 174
 175 ckmc_raw_buffer_s prepare_message_buffer(const char * input);
 176 void check_alias_list(const CKM::AliasVector& expected);
 177
 178 typedef enum {
 179     ALIAS_KEY,
 180     ALIAS_CERT,
 181     ALIAS_DATA
 182 } alias_type_;
 183 size_t count_aliases(alias_type_ type, size_t minimum_initial_element_count = 0);
 184 std::string sharedDatabase(const CKM::Alias & alias);
 185 CKM::RawBuffer createRandomBuffer(size_t random_bytes);
 186 ckmc_raw_buffer_s* createRandomBufferCAPI(size_t random_bytes);
 187
 188 ckmc_key_s *generate_AES_key(size_t lengthBits, const char *passwd);
 189 void validate_AES_key(ckmc_key_s *analyzed);
 190 void compare_AES_keys(ckmc_key_s *first, ckmc_key_s *second); // true if equal
 191
 192 // Test env class for database cleanup. Pass database uids to cleanup before and after test
 193 template <uid_t ...Args>
 194 class RemoveDataEnv;
 195
 196 template <>
 197 class RemoveDataEnv<>
 198 {
 199 public:
 200     void init(const std::string&)
 201     {}
 202     void finish()
 203     {}
 204 };
 205
 206 template <uid_t UID, uid_t ...Args>
 207 class RemoveDataEnv<UID, Args...> : public RemoveDataEnv<Args...>
 208 {
 209 public:
 210     void init(const std::string & str) {
 211         remove_user_data(UID);
 212         RemoveDataEnv<Args...>::init(str);
 213     }
 214     void finish() {
 215         RemoveDataEnv<Args...>::finish();
 216         remove_user_data(UID);
 217     }
 218 };
 219
 220 typedef std::shared_ptr<ckmc_raw_buffer_s> RawBufferPtr;
 221 typedef std::shared_ptr<ckmc_param_list_s> ParamListPtr;
 222
 223 ParamListPtr createParamListPtr();
 224
 225 void assert_buffers_equal(const ckmc_raw_buffer_s b1, const ckmc_raw_buffer_s b2, bool equal=true);
 226
 227 RawBufferPtr create_raw_buffer(ckmc_raw_buffer_s* buffer);
 228
 229
 230 template <typename F, typename... Args>
 231 void test_no_observer(F&& func, Args... args)
 232 {
 233     CKM::ManagerAsync::ObserverPtr obs;
 234     CKM::ManagerAsync mgr;
 235
 236     try {
 237         (mgr.*func)(obs, args...);
 238         RUNNER_ASSERT_MSG(false, "function() should have thrown an exception");
 239     } catch (const std::invalid_argument& e) {
 240         RUNNER_ASSERT(true);
 241     } catch (...) {
 242         RUNNER_ASSERT_MSG(false, "Unexpected exception");
 243     }
 244 }