src/common/tests_common.cpp

   1 /*
   2  * Copyright (c) 2013-2015 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 /*
  18  * @file        tests_common.cpp
  19  * @author      Lukasz Kostyra (l.kostyra@partner.samsung.com)
  20  * @version     1.0
  21  * @brief       Common functions and macros used in security-tests package.
  22  */
  23
  24 #include "tests_common.h"
  25 #include <fcntl.h>
  26 #include <sys/mman.h>
  27 #include <sys/stat.h>
  28 #include <sys/types.h>
  29 #include <sys/wait.h>
  30 #include <unistd.h>
  31 #include <grp.h>
  32 #include <errno.h>
  33 #include <vector>
  34 #include <algorithm>
  35
  36 bool smack_check(void)
  37 {
  38 #ifndef WRT_SMACK_ENABLED
  39     return false;
  40 #else
  41     static int smack_present = -1;
  42     if (-1 == smack_present)
  43         smack_present = smack_smackfs_path() == nullptr ? 0 : 1;
  44     return smack_present == 1;
  45 #endif
  46 }
  47
  48 /**
  49  * Dropping root privileges
  50  * returns 0 on success, 1 on error
  51  */
  52 int drop_root_privileges(uid_t appUid, gid_t appGid)
  53 {
  54     if (getuid() == 0) {
  55         /* process is running as root, drop privileges */
  56         if (setgid(appGid) != 0)
  57             return 1;
  58         if (setuid(appUid) != 0)
  59             return 1;
  60     }
  61     uid_t uid = getuid();
  62     if (uid == appUid)
  63         return 0;
  64
  65     return 1;
  66 }
  67
  68 void setLabelForSelf(const int line, const char *label)
  69 {
  70     int ret = smack_set_label_for_self(label);
  71     RUNNER_ASSERT_MSG(ret == 0, "Error in smack_set_label_for_self(): " << ret << ", line: " << line);
  72 }
  73
  74 /*
  75  * Add a new group to the current process groups.
  76  */
  77 void add_process_group(const char* group_name)
  78 {
  79     // get group ID by group name
  80     group *gr = getgrnam(group_name);
  81     RUNNER_ASSERT_ERRNO_MSG(gr != nullptr, "getgrnam failed on '" << group_name << "' group");
  82     const gid_t new_group_id = gr->gr_gid;
  83
  84     // get number of groups that the current process belongs to
  85     int ngroups = getgroups(0, nullptr);
  86
  87     //allocate groups table + space for new group entry
  88     std::vector<gid_t> groups(ngroups + 1);
  89     getgroups(ngroups, groups.data());
  90
  91     // check if the process already belongs to the group
  92     if (std::find(groups.begin(), groups.end(), new_group_id) != groups.end()) return;
  93
  94     // add new group & apply change
  95     groups[ngroups] = new_group_id;
  96     int ret = setgroups(groups.size(), groups.data());
  97     RUNNER_ASSERT_ERRNO_MSG(ret == 0, "setgroups() failed");
  98 }
  99
 100 /*
 101  * Remove specific group from the current process groups.
 102  */
 103 void remove_process_group(const char* group_name)
 104 {
 105     // get group ID by group name
 106     group *gr = getgrnam(group_name);
 107     RUNNER_ASSERT_ERRNO_MSG(gr != nullptr, "getgrnam failed on '" << group_name << "' group");
 108     const gid_t new_group_id = gr->gr_gid;
 109
 110     int ngroups = getgroups(0, nullptr);
 111     std::vector<gid_t> groups(ngroups);
 112     getgroups(ngroups, groups.data());
 113
 114     // remove group from the list
 115     groups.erase(std::remove(groups.begin(), groups.end(), new_group_id), groups.end());
 116
 117     if (groups.size() != (size_t)ngroups) {
 118         // apply change
 119         int ret = setgroups(groups.size(), groups.data());
 120         RUNNER_ASSERT_ERRNO_MSG(ret == 0, "setgroups() failed");
 121     }
 122 }
 123
 124 std::string formatCstr(const char *cstr)
 125 {
 126     if (!cstr)
 127         return std::string("nullptr");
 128     return std::string("\"") + cstr + "\"";
 129 }
 130
 131 int files_compare(int fd1, int fd2)
 132 {
 133     //for getting files sizes
 134     struct stat fs1, fs2;
 135
 136     //handlers for mmap()
 137     void *h1 = MAP_FAILED;
 138     void *h2 = MAP_FAILED;
 139
 140     //getting files information
 141     RUNNER_ASSERT_ERRNO_MSG(fstat(fd1, &fs1) == 0, "fstat failed");
 142     RUNNER_ASSERT_ERRNO_MSG(fstat(fd2, &fs2) == 0, "fstat failed");
 143
 144     if (fs1.st_size < fs2.st_size) {
 145         return -1;
 146     }
 147
 148     if (fs1.st_size > fs2.st_size) {
 149         return 1;
 150     }
 151
 152     //since Linux 2.6.12, mmap returns EINVAL if length is 0
 153     //if both lengths are 0, files are actually the same
 154     if (0 == fs1.st_size && 0 == fs2.st_size) {
 155         return 0;
 156     }
 157
 158     //mapping files to process memory
 159     RUNNER_ASSERT_ERRNO_MSG((h1 = mmap(0, fs1.st_size, PROT_READ, MAP_SHARED, fd1, 0 )) != MAP_FAILED,
 160                                "mmap failed for fd=" << fd1);
 161
 162     if ((h2 = mmap(0, fs2.st_size, PROT_READ, MAP_SHARED, fd2, 0 )) == MAP_FAILED) {
 163         munmap(h1, fs1.st_size);
 164         RUNNER_ASSERT_MSG(h2 != MAP_FAILED, "mmap failed for fd=" << fd2
 165                                             << ". " << strerror(errno));
 166     }
 167
 168     int result = memcmp(h1, h2, fs1.st_size);
 169     munmap(h1, fs1.st_size);
 170     munmap(h2, fs2.st_size);
 171
 172     return result;
 173 }
 174
 175 void mkdirSafe(const std::string &path, mode_t mode)
 176 {
 177     RUNNER_ASSERT_ERRNO_MSG(0 == mkdir(path.c_str(), mode) || errno == EEXIST,
 178                             "mkdir for <" << path << "> with mode <" << mode << "> failed");
 179 }
 180
 181 void mktreeSafe(const std::string &path, mode_t mode)
 182 {
 183     // Create subsequent parent directories
 184     // Assume that path is absolute - i.e. starts with '/'
 185     for (size_t pos = 0; (pos = path.find("/", pos + 1)) != std::string::npos; )
 186         mkdirSafe(path.substr(0, pos).c_str(), mode);
 187
 188     mkdirSafe(path, mode);
 189 }
 190
 191 void creatSafe(const std::string &path, mode_t mode)
 192 {
 193     RUNNER_ASSERT_ERRNO_MSG(-1 != creat(path.c_str(), mode),
 194                             "creat for <" << path << "> with mode <" << mode << "> failed");
 195 }
 196
 197 void symlinkSafe(const std::string &targetPath, const std::string &linkPath)
 198 {
 199     RUNNER_ASSERT_ERRNO_MSG(0 == symlink(targetPath.c_str(), linkPath.c_str()),
 200                             "symlink for <" << linkPath << "> to <" << targetPath << "> failed");
 201 }
 202
 203 void removeDir(const std::string &path)
 204 {
 205     DIR *d = opendir(path.c_str());
 206
 207     if (nullptr == d) {
 208         RUNNER_ASSERT_ERRNO_MSG(errno == ENOENT, "opendir of <" << path << "> failed");
 209         return;
 210     }
 211
 212     struct dirent *dirEntry;
 213     while (nullptr != (dirEntry = readdir(d))) {
 214         std::string entryName(dirEntry->d_name);
 215         if (entryName == "." || entryName == "..")
 216             continue;
 217
 218         std::string entryPath(path + "/" + entryName);
 219         struct stat st;
 220
 221         RUNNER_ASSERT_ERRNO_MSG(0 == lstat(entryPath.c_str(), &st),
 222                                 "stat for <" << entryPath << "> failed");
 223         if (S_ISDIR(st.st_mode))
 224             removeDir(entryPath);
 225         else
 226             RUNNER_ASSERT_ERRNO_MSG(0 == unlink(entryPath.c_str()),
 227                                     "unlink for <" << entryPath << "> failed");
 228     }
 229
 230     closedir(d);
 231
 232     RUNNER_ASSERT_ERRNO_MSG(0 == rmdir(path.c_str()), "rmdir for <" << path << "> failed");
 233 }
 234
 235 void waitPid(pid_t pid)
 236 {
 237     int status;
 238     pid_t ret = waitpid(pid, &status, 0);
 239     RUNNER_ASSERT_MSG((ret != -1) && WIFEXITED(status) && WEXITSTATUS(status) == 0,
 240         "Child process exited abnormally" <<
 241         ": ret=" << ret << ", errno=" << errno << ", status=" << status);
 242 }
 243 // changes process label
 244 void change_label(const char* label)
 245 {
 246     int ret = smack_set_label_for_self(label);
 247     RUNNER_ASSERT_MSG(0 == ret, "Error in smack_set_label_for_self("<<label<<"). Error: " << ret);
 248 }