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 extern const std::string SMACK_USER_APP_PREFIX;
  35
  36 // support for error printing
  37 const char * CKMCErrorToString(int error);
  38 std::string CKMCReadableError(int error);
  39
  40 // RUNNER_ASSERT wrappers
  41 template <typename F, typename... Args>
  42 void assert_result(int expected, F&& func, Args... args)
  43 {
  44     int ret = func(args...);
  45     RUNNER_ASSERT_MSG(ret == expected,
  46                       "Expected: " << CKMCErrorToString(expected) << "(" << expected << ")"
  47                       " got: " << CKMCErrorToString(ret) << "(" << ret << ")");
  48 }
  49
  50 template <typename F, typename... Args>
  51 void assert_positive(F&& func, Args... args)
  52 {
  53     assert_result(CKMC_ERROR_NONE, std::move(func), args...);
  54 }
  55
  56 template <typename F, typename... Args>
  57 void assert_invalid_param(F&& func, Args... args)
  58 {
  59     assert_result(CKMC_ERROR_INVALID_PARAMETER, std::move(func), args...);
  60 }
  61
  62
  63 // list operations
  64 template <typename T>
  65 size_t list_size(const T* list)
  66 {
  67     size_t size = 0;
  68     while(list) {
  69         list = list->next;
  70         size++;
  71     }
  72     return size;
  73 }
  74
  75
  76 // service lifecycle management
  77 enum ServiceIdx {
  78     LISTENER,
  79     MANAGER
  80 };
  81 void start_service(ServiceIdx idx);
  82 void stop_service(ServiceIdx idx);
  83
  84 // scoped free
  85 typedef std::unique_ptr<char, void (*)(void *)> CharPtr;
  86
  87 // returns process owner id
  88 std::string getOwnerIdFromSelf();
  89
  90 std::string aliasWithLabel(const char *label, const char *alias);
  91
  92 // changes process label
  93 void change_label(const char* label);
  94
  95 // changes process label upon construction and restores it upon destruction
  96 class ScopedLabel
  97 {
  98 public:
  99     ScopedLabel(const char* label);
 100     ~ScopedLabel();
 101
 102 private:
 103     std::string m_original_label;
 104 };
 105
 106 void save_data(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE);
 107 void save_data(const char* alias, const char *data, size_t len, int expected_err);
 108 class ScopedSaveData
 109 {
 110 public:
 111     ScopedSaveData(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE);
 112     virtual ~ScopedSaveData();
 113
 114 private:
 115     std::string m_alias;
 116 };
 117
 118 class GarbageCollector
 119 {
 120 public:
 121     void save(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE);
 122     void save(const char* alias, const char *data, size_t len, int expected_err);
 123     void add(const char* alias);
 124     virtual ~GarbageCollector();
 125
 126 private:
 127     struct save_item {
 128         std::string item_alias;
 129         std::string owner_label;
 130         uid_t       owner_uid;
 131         gid_t       owner_gid;
 132     };
 133     std::vector<save_item>  m_garbage;
 134 };
 135
 136 class ScopedDBUnlock
 137 {
 138 public:
 139     ScopedDBUnlock(uid_t user_id, const char* passwd);
 140     virtual ~ScopedDBUnlock();
 141
 142 private:
 143     uid_t m_uid;
 144 };
 145
 146 void check_remove_allowed(const char* alias);
 147 void check_remove_denied(const char* alias);
 148 void check_remove_not_visible(const char* alias);
 149 void check_read(const char* alias,
 150                 const char *label,
 151                 const char *test_data,
 152                 size_t len,
 153                 int expected_code = CKMC_ERROR_NONE);
 154 void check_read(const char* alias,
 155                 const char *label,
 156                 const char *test_data,
 157                 int expected_code = CKMC_ERROR_NONE);
 158 void check_read_allowed(const char* alias, const char *data);
 159 void check_read_not_visible(const char* alias);
 160 void check_key(const char *alias,
 161                int expected_error = CKMC_ERROR_NONE,
 162                ckmc_key_type_e expected_type = CKMC_KEY_NONE);
 163 void check_key_allowed(const char *alias, ckmc_key_type_e expected_type = CKMC_KEY_NONE);
 164 void check_key_not_visible(const char *alias);
 165 void check_cert_allowed(const char *alias);
 166 void check_cert_not_visible(const char *alias);
 167 void allow_access(const char* alias, const char* accessor, int permissionMask);
 168 void allow_access_negative(const char* alias, const char* accessor, int permissionMask, int expectedCode);
 169 void deny_access(const char* alias, const char* accessor);
 170 void deny_access_negative(const char* alias, const char* accessor, int expectedCode);
 171
 172 void unlock_user_data(uid_t user_id, const char *passwd);
 173 void remove_user_data(uid_t user_id);
 174 void reset_user_data(uid_t user_id, const char *passwd);
 175
 176 ckmc_raw_buffer_s prepare_message_buffer(const char * input);
 177 void check_alias_list(const CKM::AliasVector& expected);
 178
 179 typedef enum {
 180     ALIAS_KEY,
 181     ALIAS_CERT,
 182     ALIAS_DATA
 183 } alias_type_;
 184 size_t count_aliases(alias_type_ type, size_t minimum_initial_element_count = 0);
 185 std::string sharedDatabase(const CKM::Alias & alias);
 186 CKM::RawBuffer createRandomBuffer(size_t random_bytes);
 187 ckmc_raw_buffer_s* createRandomBufferCAPI(size_t random_bytes);
 188
 189 ckmc_key_s *generate_AES_key(size_t lengthBits, const char *passwd);
 190 void validate_AES_key(ckmc_key_s *analyzed);
 191 void compare_AES_keys(ckmc_key_s *first, ckmc_key_s *second); // true if equal
 192
 193 // Test env class for database cleanup. Pass database uids to cleanup before and after test
 194 template <uid_t ...Args>
 195 class RemoveDataEnv;
 196
 197 template <>
 198 class RemoveDataEnv<>
 199 {
 200 public:
 201     void init(const std::string&)
 202     {}
 203     void finish()
 204     {}
 205 };
 206
 207 template <uid_t UID, uid_t ...Args>
 208 class RemoveDataEnv<UID, Args...> : public RemoveDataEnv<Args...>
 209 {
 210 public:
 211     void init(const std::string & str) {
 212         remove_user_data(UID);
 213         RemoveDataEnv<Args...>::init(str);
 214     }
 215     void finish() {
 216         RemoveDataEnv<Args...>::finish();
 217         remove_user_data(UID);
 218     }
 219 };
 220
 221 typedef std::shared_ptr<ckmc_raw_buffer_s> RawBufferPtr;
 222 typedef std::shared_ptr<struct __ckmc_param_list> ParamListPtr;
 223
 224 ParamListPtr createParamListPtr();
 225
 226 void assert_buffers_equal(const ckmc_raw_buffer_s b1, const ckmc_raw_buffer_s b2, bool equal=true);
 227
 228 RawBufferPtr create_raw_buffer(ckmc_raw_buffer_s* buffer);
 229
 230
 231 template <typename F, typename... Args>
 232 void test_no_observer(F&& func, Args... args)
 233 {
 234     CKM::ManagerAsync::ObserverPtr obs;
 235     CKM::ManagerAsync mgr;
 236
 237     try {
 238         (mgr.*func)(obs, args...);
 239         RUNNER_ASSERT_MSG(false, "function() should have thrown an exception");
 240     } catch (const std::invalid_argument& e) {
 241         RUNNER_ASSERT(true);
 242     } catch (...) {
 243         RUNNER_ASSERT_MSG(false, "Unexpected exception");
 244     }
 245 }