blob: 4229cee4648d7172d539f25c68dad9764ecfbb05 [file] [log] [blame]
// Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Contains the implementation of class Platform
#include "platform.h"
#include <errno.h>
#include <grp.h>
#include <limits.h>
#include <pwd.h>
#include <signal.h>
#include <stdint.h>
#include <sys/mount.h>
#include <sys/stat.h>
#include <sys/statvfs.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <base/file_util.h>
#include <base/string_util.h>
#include <chromeos/utility.h>
// Included last to avoid redefinition problems
extern "C" {
#include <keyutils.h>
}
using std::string;
namespace cryptohome {
const int kDefaultMountOptions = MS_NOEXEC | MS_NOSUID | MS_NODEV;
const int kDefaultPwnameLength = 1024;
const int kDefaultUmask = S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH
| S_IXOTH;
const std::string kMtab = "/etc/mtab";
const std::string kProcDir = "/proc";
Platform::Platform()
: mount_options_(kDefaultMountOptions),
umask_(kDefaultUmask),
mtab_file_(kMtab),
proc_dir_(kProcDir) {
}
Platform::~Platform() {
}
bool Platform::IsDirectoryMounted(const std::string& directory) {
// Trivial string match from /etc/mtab to see if the cryptohome mount point is
// listed. This works because Chrome OS is a controlled environment and the
// only way /home/chronos/user should be mounted is if cryptohome mounted it.
string contents;
if (file_util::ReadFileToString(FilePath(mtab_file_), &contents)) {
if (contents.find(StringPrintf(" %s ", directory.c_str()))
!= string::npos) {
return true;
}
}
return false;
}
bool Platform::IsDirectoryMountedWith(const std::string& directory,
const std::string& from) {
// Trivial string match from /etc/mtab to see if the cryptohome mount point
// and the user's vault path are present. Assumes this user is mounted if it
// finds both. This will need to change if simultaneous login is implemented.
string contents;
if (file_util::ReadFileToString(FilePath(mtab_file_), &contents)) {
if ((contents.find(StringPrintf(" %s ", directory.c_str()))
!= string::npos)
&& (contents.find(StringPrintf("%s ",
from.c_str()).c_str())
!= string::npos)) {
return true;
}
}
return false;
}
bool Platform::Mount(const std::string& from, const std::string& to,
const std::string& type,
const std::string& mount_options) {
if (mount(from.c_str(), to.c_str(), type.c_str(), mount_options_,
mount_options.c_str())) {
return false;
}
return true;
}
bool Platform::Unmount(const std::string& path, bool lazy, bool* was_busy) {
if (lazy) {
if (umount2(path.c_str(), MNT_DETACH)) {
if (was_busy) {
*was_busy = (errno == EBUSY);
}
return false;
}
} else {
if (umount(path.c_str())) {
if (was_busy) {
*was_busy = (errno == EBUSY);
}
return false;
}
}
if (was_busy) {
*was_busy = false;
}
return true;
}
bool Platform::TerminatePidsWithOpenFiles(const std::string& path, bool hard) {
std::vector<pid_t> pids;
LookForOpenFiles(path, &pids);
for (std::vector<pid_t>::iterator it = pids.begin(); it != pids.end(); it++) {
pid_t pid = static_cast<pid_t>(*it);
if (pid != getpid()) {
if (hard) {
kill(pid, SIGTERM);
} else {
kill(pid, SIGKILL);
}
}
}
return (pids.size() != 0);
}
void Platform::GetProcessesWithOpenFiles(
const std::string& path,
std::vector<ProcessInformation>* processes) {
std::vector<pid_t> pids;
LookForOpenFiles(path, &pids);
for (std::vector<pid_t>::iterator it = pids.begin(); it != pids.end(); it++) {
pid_t pid = static_cast<pid_t>(*it);
processes->push_back(ProcessInformation());
GetProcessOpenFileInformation(pid, path,
&processes->at(processes->size() - 1));
}
}
std::string Platform::ReadLink(const std::string& link_path) {
char link_buf[PATH_MAX];
ssize_t link_length = readlink(link_path.c_str(), link_buf, sizeof(link_buf));
if (link_length > 0) {
return std::string(link_buf, link_length);
}
return std::string();
}
void Platform::GetProcessOpenFileInformation(pid_t pid,
const std::string& path_in,
ProcessInformation* process_info) {
process_info->set_process_id(pid);
FilePath pid_path(StringPrintf("/proc/%d", pid));
FilePath cmdline_file = pid_path.Append("cmdline");
string contents;
std::vector<std::string> cmd_line;
if (file_util::ReadFileToString(cmdline_file, &contents)) {
SplitString(contents, '\0', &cmd_line);
}
process_info->set_cmd_line(&cmd_line);
// Make sure that if we get a directory, it has a trailing separator
FilePath file_path(path_in);
file_util::EnsureEndsWithSeparator(&file_path);
std::string path = file_path.value();
FilePath cwd_path = pid_path.Append("cwd");
std::string link_val = ReadLink(cwd_path.value());
if (IsPathChild(path, link_val)) {
process_info->set_cwd(&link_val);
} else {
link_val.clear();
process_info->set_cwd(&link_val);
}
// Open /proc/<pid>/fd
FilePath fd_dirpath = pid_path.Append("fd");
file_util::FileEnumerator fd_dir_enum(fd_dirpath, false,
file_util::FileEnumerator::FILES);
std::set<std::string> open_files;
// List open file descriptors
for (FilePath fd_path = fd_dir_enum.Next();
!fd_path.empty();
fd_path = fd_dir_enum.Next()) {
link_val = ReadLink(fd_path.value());
if (IsPathChild(path, link_val)) {
open_files.insert(link_val);
}
}
process_info->set_open_files(&open_files);
}
void Platform::LookForOpenFiles(const std::string& path_in,
std::vector<pid_t>* pids) {
// Make sure that if we get a directory, it has a trailing separator
FilePath file_path(path_in);
file_util::EnsureEndsWithSeparator(&file_path);
std::string path = file_path.value();
// Open /proc
file_util::FileEnumerator proc_dir_enum(FilePath(proc_dir_), false,
file_util::FileEnumerator::DIRECTORIES);
int linkbuf_length = path.length();
std::vector<char> linkbuf(linkbuf_length);
// List PIDs in /proc
for (FilePath pid_path = proc_dir_enum.Next();
!pid_path.empty();
pid_path = proc_dir_enum.Next()) {
pid_t pid = static_cast<pid_t>(atoi(pid_path.BaseName().value().c_str()));
// Ignore PID 1 and errors
if (pid <= 1) {
continue;
}
FilePath cwd_path = pid_path.Append("cwd");
ssize_t link_length = readlink(cwd_path.value().c_str(),
&linkbuf[0],
linkbuf.size());
if (link_length > 0) {
std::string open_file(&linkbuf[0], link_length);
if (IsPathChild(path, open_file)) {
pids->push_back(pid);
continue;
}
}
// Open /proc/<pid>/fd
FilePath fd_dirpath = pid_path.Append("fd");
file_util::FileEnumerator fd_dir_enum(fd_dirpath, false,
file_util::FileEnumerator::FILES);
// List open file descriptors
for (FilePath fd_path = fd_dir_enum.Next();
!fd_path.empty();
fd_path = fd_dir_enum.Next()) {
link_length = readlink(fd_path.value().c_str(), &linkbuf[0],
linkbuf.size());
if (link_length > 0) {
std::string open_file(&linkbuf[0], link_length);
if (IsPathChild(path, open_file)) {
pids->push_back(pid);
break;
}
}
}
}
}
bool Platform::IsPathChild(const std::string& parent,
const std::string& child) {
if (parent.length() == 0 || child.length() == 0) {
return false;
}
if (child.length() >= parent.length()) {
if (child.compare(0, parent.length(), parent, 0, parent.length()) == 0) {
return true;
}
} else if ((parent[parent.length() - 1] == '/') &&
(child.length() == (parent.length() - 1))) {
if (child.compare(0, child.length(), parent, 0, parent.length() - 1) == 0) {
return true;
}
}
return false;
}
bool Platform::TerminatePidsForUser(const uid_t uid, bool hard) {
std::vector<pid_t> pids;
GetPidsForUser(uid, &pids);
for (std::vector<pid_t>::iterator it = pids.begin(); it != pids.end(); it++) {
pid_t pid = static_cast<pid_t>(*it);
if (pid != getpid()) {
if (hard) {
kill(pid, SIGTERM);
} else {
kill(pid, SIGKILL);
}
}
}
return (pids.size() != 0);
}
void Platform::GetPidsForUser(uid_t uid, std::vector<pid_t>* pids) {
// Open /proc
file_util::FileEnumerator proc_dir_enum(FilePath(proc_dir_), false,
file_util::FileEnumerator::DIRECTORIES);
// List PIDs in /proc
FilePath pid_path;
while (!(pid_path = proc_dir_enum.Next()).empty()) {
pid_t pid = static_cast<pid_t>(atoi(pid_path.BaseName().value().c_str()));
if (pid <= 1) {
continue;
}
// Open /proc/<pid>/status
FilePath status_path = pid_path.Append("status");
string contents;
if (!file_util::ReadFileToString(status_path, &contents)) {
continue;
}
size_t uid_loc = contents.find("Uid:");
if (!uid_loc) {
continue;
}
uid_loc += 4;
size_t uid_end = contents.find("\n", uid_loc);
if (!uid_end) {
continue;
}
contents = contents.substr(uid_loc, uid_end - uid_loc);
std::vector<std::string> tokens;
Tokenize(contents, " \t", &tokens);
for (std::vector<std::string>::iterator it = tokens.begin();
it != tokens.end(); it++) {
std::string& value = *it;
if (value.length() == 0) {
continue;
}
uid_t check_uid = static_cast<uid_t>(atoi(value.c_str()));
if (check_uid == uid) {
pids->push_back(pid);
break;
}
}
}
}
bool Platform::SetOwnership(const std::string& path, uid_t user_id,
gid_t group_id) {
if (chown(path.c_str(), user_id, group_id)) {
PLOG(ERROR) << "chown() of " << path.c_str() << " to (" << user_id
<< "," << group_id << ") failed.";
return false;
}
return true;
}
bool Platform::SetOwnershipRecursive(const std::string& directory,
uid_t user_id,
gid_t group_id) {
std::vector<std::string> to_recurse;
to_recurse.push_back(directory);
while (to_recurse.size()) {
std::string current_dir = to_recurse.back();
to_recurse.pop_back();
FilePath next_path;
// Push the subdirectories to the back of the vector
file_util::FileEnumerator dir_enumerator(
FilePath(current_dir),
false, // do not recurse into subdirectories.
file_util::FileEnumerator::DIRECTORIES);
while (!(next_path = dir_enumerator.Next()).empty()) {
to_recurse.push_back(next_path.value());
}
// Handle the files
file_util::FileEnumerator file_enumerator(FilePath(current_dir), false,
file_util::FileEnumerator::FILES);
while (!(next_path = file_enumerator.Next()).empty()) {
if (!SetOwnership(next_path.value(), user_id, group_id))
return false;
}
// Set permissions on the directory itself
if (!SetOwnership(current_dir, user_id, group_id))
return false;
}
return true;
}
int Platform::SetMask(int new_mask) {
return umask(new_mask);
}
bool Platform::GetUserId(const std::string& user, uid_t* user_id,
gid_t* group_id) {
// Load the passwd entry
long user_name_length = sysconf(_SC_GETPW_R_SIZE_MAX);
if (user_name_length == -1) {
user_name_length = kDefaultPwnameLength;
}
struct passwd user_info, *user_infop;
std::vector<char> user_name_buf(user_name_length);
if (getpwnam_r(user.c_str(), &user_info, &user_name_buf[0],
user_name_length, &user_infop)) {
return false;
}
*user_id = user_info.pw_uid;
*group_id = user_info.pw_gid;
return true;
}
bool Platform::GetGroupId(const std::string& group, gid_t* group_id) {
// Load the group entry
long group_name_length = sysconf(_SC_GETGR_R_SIZE_MAX);
if (group_name_length == -1) {
group_name_length = kDefaultPwnameLength;
}
struct group group_info, *group_infop;
std::vector<char> group_name_buf(group_name_length);
if (getgrnam_r(group.c_str(), &group_info, &group_name_buf[0],
group_name_length, &group_infop)) {
return false;
}
*group_id = group_info.gr_gid;
return true;
}
int64 Platform::AmountOfFreeDiskSpace(const string& path) const {
struct statvfs stats;
if (statvfs(path.c_str(), &stats) != 0) {
return -1;
}
return static_cast<int64>(stats.f_bavail) * stats.f_frsize;
}
void Platform::ClearUserKeyring() {
keyctl(KEYCTL_CLEAR, KEY_SPEC_USER_KEYRING);
}
bool Platform::Symlink(const std::string& oldpath, const std::string& newpath) {
int rc = symlink(oldpath.c_str(), newpath.c_str());
if (rc && errno != EEXIST) {
PLOG(ERROR) << "Error creating symbolic link from " << newpath << " to "
<< oldpath << ".";
return false;
}
return true;
}
bool Platform::Exec(const std::string& command,
const std::vector<std::string>& args,
uid_t uid,
gid_t gid) {
pid_t child_pid = -1;
child_pid = fork();
if (child_pid == 0) {
if (gid != static_cast<gid_t>(-1)) {
if (setresgid(gid, gid, gid)) {
_exit(2);
}
}
if (uid != static_cast<uid_t>(-1)) {
if (setresuid(uid, uid, uid)) {
_exit(1);
}
}
const char** local_args = (const char**) calloc(args.size() + 1,
sizeof(char*));
int index = 0;
std::vector<std::string>::const_iterator it;
for (it = args.begin(); it != args.end(); ++it, ++index) {
local_args[index] = const_cast<char*>(it->c_str());
}
execve(command.c_str(), const_cast<char* const*>(local_args), NULL);
PLOG(ERROR) << "Couldn't start the command subprocess.";
_exit(3);
} else if (child_pid != -1) {
int status = 0;
do {
pid_t term_pid = waitpid(child_pid, &status, WUNTRACED | WCONTINUED);
if (term_pid == -1) {
return false;
}
} while (!WIFEXITED(status) && !WIFSIGNALED(status));
if (WIFEXITED(status) && WEXITSTATUS(status) == 0) {
return true;
}
LOG(ERROR) << "Command subprocess (" << command
<< ") exited with a non-zero status. ("
<< "status = " << WEXITSTATUS(status) << " )";
}
else {
PLOG(ERROR) << "Couldn't spawn a subprocess for command execution.";
}
return false;
}
bool Platform::FileExists(const std::string& path) {
return file_util::PathExists(FilePath(path));
}
bool Platform::DirectoryExists(const std::string& path) {
return file_util::DirectoryExists(FilePath(path));
}
bool Platform::WriteFile(const std::string& path,
const chromeos::Blob& blob) {
FilePath file_path(path);
if (!file_util::DirectoryExists(file_path.DirName())) {
if (!file_util::CreateDirectory(file_path.DirName())) {
LOG(ERROR) << "Cannot create directory: " << file_path.DirName().value();
return false;
}
}
// chromeos::Blob::size_type is std::vector::size_type and is unsigned.
if (blob.size() > static_cast<chromeos::Blob::size_type>(INT_MAX)) {
LOG(ERROR) << "Cannot write to " << path
<< ". Blob is too large: " << blob.size() << " bytes.";
return false;
}
int data_written = file_util::WriteFile(
file_path,
reinterpret_cast<const char*>(&blob[0]),
blob.size());
return data_written == static_cast<int>(blob.size());
}
bool Platform::ReadFile(const std::string& path, chromeos::Blob* blob) {
int64 file_size;
FilePath file_path(path);
if (!file_util::PathExists(file_path)) {
return false;
}
if (!file_util::GetFileSize(file_path, &file_size)) {
LOG(ERROR) << "Could not get size of " << path;
return false;
}
// Compare to the max of a signed integer.
if (file_size > static_cast<int64>(INT_MAX)) {
LOG(ERROR) << "File " << path << " is too large: "
<< file_size << " bytes.";
return false;
}
chromeos::Blob buf(file_size);
int data_read = file_util::ReadFile(file_path,
reinterpret_cast<char*>(&buf[0]),
file_size);
// Cast is okay because of comparison to INT_MAX above.
if (data_read != static_cast<int>(file_size)) {
LOG(ERROR) << "Only read " << data_read << " of " << file_size << " bytes.";
return false;
}
blob->swap(buf);
return true;
}
bool Platform::CreateDirectory(const std::string& path) {
return file_util::CreateDirectory(FilePath(path));
}
bool Platform::DeleteFile(const std::string& path, bool is_recursive) {
return file_util::Delete(FilePath(path), is_recursive);
}
bool Platform::EnumerateFiles(const std::string& path,
bool recursive,
std::vector<std::string>* file_list) {
file_util::FileEnumerator dir_enum(FilePath(path), recursive,
file_util::FileEnumerator::FILES);
for (FilePath path = dir_enum.Next(); !path.empty(); path = dir_enum.Next())
file_list->push_back(path.value());
return true;
}
} // namespace cryptohome