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