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