libcutils: move cutils/files.h to cutils/android_get_control_file.h

files.[h|cpp] is bound to be abused with junk, replace with
android_get_control_file.[h|cpp]. Plus some sundry cleanup.

Test: gTest libcutils-tests, logd-unit-tests, liblog-unit-tests,
      logcat-unit-tests and init_tests
Bug: 32450474
Change-Id: Ibd4a7aa4624ea19a43d1f98a3c71ac37805d36b5
This commit is contained in:
Mark Salyzyn 2016-11-07 09:39:30 -08:00
parent e631e470e0
commit 52bd37e633
16 changed files with 229 additions and 206 deletions

View file

@ -14,8 +14,8 @@
* limitations under the License.
*/
#ifndef __CUTILS_FILES_H
#define __CUTILS_FILES_H
#ifndef __CUTILS_ANDROID_GET_CONTROL_FILE_H
#define __CUTILS_ANDROID_GET_CONTROL_FILE_H
#define ANDROID_FILE_ENV_PREFIX "ANDROID_FILE_"
@ -34,4 +34,4 @@ int android_get_control_file(const char* path);
}
#endif
#endif /* __CUTILS_FILES_H */
#endif /* __CUTILS_ANDROID_GET_CONTROL_FILE_H */

View file

@ -35,6 +35,7 @@ typedef SOCKET cutils_socket_t;
#else
#include <sys/socket.h>
#include <netinet/in.h>
typedef int cutils_socket_t;
#define INVALID_SOCKET (-1)

View file

@ -23,7 +23,7 @@
#include <unistd.h>
#include <android-base/stringprintf.h>
#include <cutils/files.h>
#include <cutils/android_get_control_file.h>
#include <cutils/sockets.h>
#include "init.h"

View file

@ -16,6 +16,7 @@
#include "util.h"
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
#include <stdlib.h>
@ -23,7 +24,9 @@
#include <sys/types.h>
#include <unistd.h>
#include <cutils/files.h>
#include <android-base/stringprintf.h>
#include <android-base/test_utils.h>
#include <cutils/android_get_control_file.h>
#include <gtest/gtest.h>
#include <selinux/android.h>
@ -55,45 +58,48 @@ struct selabel_handle *sehandle;
TEST(util, create_file) {
if (!sehandle) sehandle = selinux_android_file_context_handle();
static const char path[] = "/data/local/tmp/util.create_file.test";
static const char key[] = ANDROID_FILE_ENV_PREFIX "_data_local_tmp_util_create_file_test";
EXPECT_EQ(unsetenv(key), 0);
unlink(path);
TemporaryFile tf;
close(tf.fd);
EXPECT_GE(unlink(tf.path), 0);
std::string key(ANDROID_FILE_ENV_PREFIX);
key += tf.path;
std::for_each(key.begin(), key.end(), [] (char& c) { c = isalnum(c) ? c : '_'; });
EXPECT_EQ(unsetenv(key.c_str()), 0);
int fd;
uid_t uid = decode_uid("logd");
gid_t gid = decode_uid("system");
mode_t perms = S_IRWXU | S_IWGRP | S_IRGRP | S_IROTH;
static const char context[] = "u:object_r:misc_logd_file:s0";
EXPECT_GE(fd = create_file(path, O_RDWR | O_CREAT, perms, uid, gid, context), 0);
if (fd < 0) return;
EXPECT_GE(tf.fd = create_file(tf.path, O_RDWR | O_CREAT, perms, uid, gid, context), 0);
if (tf.fd < 0) return;
static const char hello[] = "hello world\n";
static const ssize_t len = strlen(hello);
EXPECT_EQ(write(fd, hello, len), len);
char buffer[sizeof(hello)];
EXPECT_EQ(write(tf.fd, hello, len), len);
char buffer[sizeof(hello) + 1];
memset(buffer, 0, sizeof(buffer));
EXPECT_GE(lseek(fd, 0, SEEK_SET), 0);
EXPECT_EQ(read(fd, buffer, sizeof(buffer)), len);
EXPECT_EQ(strcmp(hello, buffer), 0);
char val[32];
snprintf(val, sizeof(val), "%d", fd);
EXPECT_EQ(android_get_control_file(path), -1);
setenv(key, val, true);
EXPECT_EQ(android_get_control_file(path), fd);
close(fd);
EXPECT_EQ(android_get_control_file(path), -1);
EXPECT_EQ(unsetenv(key), 0);
EXPECT_GE(lseek(tf.fd, 0, SEEK_SET), 0);
EXPECT_EQ(read(tf.fd, buffer, sizeof(buffer)), len);
EXPECT_EQ(std::string(hello), buffer);
EXPECT_EQ(android_get_control_file(tf.path), -1);
EXPECT_EQ(setenv(key.c_str(), android::base::StringPrintf("%d", tf.fd).c_str(), true), 0);
EXPECT_EQ(android_get_control_file(tf.path), tf.fd);
close(tf.fd);
EXPECT_EQ(android_get_control_file(tf.path), -1);
EXPECT_EQ(unsetenv(key.c_str()), 0);
struct stat st;
EXPECT_EQ(stat(path, &st), 0);
EXPECT_EQ(stat(tf.path, &st), 0);
EXPECT_EQ(st.st_mode & (S_IRWXU | S_IRWXG | S_IRWXO), perms);
EXPECT_EQ(st.st_uid, uid);
EXPECT_EQ(st.st_gid, gid);
security_context_t con;
EXPECT_GE(getfilecon(path, &con), 0);
EXPECT_GE(getfilecon(tf.path, &con), 0);
EXPECT_NE(con, static_cast<security_context_t>(NULL));
if (con) {
EXPECT_EQ(context, std::string(con));
}
freecon(con);
EXPECT_EQ(unlink(path), 0);
EXPECT_EQ(unlink(tf.path), 0);
}

View file

@ -18,6 +18,7 @@
// they correspond to features not used by our host development tools
// which are also hard or even impossible to port to native Win32
libcutils_nonwindows_sources = [
"android_get_control_file.cpp",
"fs.c",
"multiuser.c",
"socket_inaddr_any_server_unix.c",
@ -34,7 +35,6 @@ cc_library {
host_supported: true,
srcs: [
"config_utils.c",
"files.cpp",
"fs_config.c",
"canned_fs_config.c",
"hashmap.c",

View file

@ -0,0 +1,33 @@
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __CUTILS_ANDROID_GET_CONTROL_ENV_H
#define __CUTILS_ANDROID_GET_CONTROL_ENV_H
/* To declare library function hidden and internal */
#define LIBCUTILS_HIDDEN __attribute__((visibility("hidden")))
#ifdef __cplusplus
extern "C" {
#endif
LIBCUTILS_HIDDEN int __android_get_control_from_env(const char* prefix,
const char* name);
#ifdef __cplusplus
}
#endif
#endif /* __CUTILS_ANDROID_GET_CONTROL_ENV_H */

View file

@ -25,11 +25,6 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
// This file contains files implementation that can be shared between
// platforms as long as the correct headers are included.
#define _GNU_SOURCE 1 // for asprintf
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
@ -41,17 +36,16 @@
#include <sys/types.h>
#include <unistd.h>
#include <cutils/files.h>
#include <cutils/android_get_control_file.h>
#ifndef TEMP_FAILURE_RETRY // _WIN32 does not define
#define TEMP_FAILURE_RETRY(exp) (exp)
#endif
#include "android_get_control_env.h"
int android_get_control_file(const char* path) {
if (!path) return -1;
LIBCUTILS_HIDDEN int __android_get_control_from_env(const char* prefix,
const char* name) {
if (!prefix || !name) return -1;
char *key = NULL;
if (asprintf(&key, ANDROID_FILE_ENV_PREFIX "%s", path) < 0) return -1;
if (asprintf(&key, "%s%s", prefix, name) < 0) return -1;
if (!key) return -1;
char *cp = key;
@ -70,29 +64,33 @@ int android_get_control_file(const char* path) {
// validity checking
if ((fd < 0) || (fd > INT_MAX)) return -1;
#if defined(_SC_OPEN_MAX)
if (fd >= sysconf(_SC_OPEN_MAX)) return -1;
#elif defined(OPEN_MAX)
if (fd >= OPEN_MAX) return -1;
#elif defined(_POSIX_OPEN_MAX)
if (fd >= _POSIX_OPEN_MAX) return -1;
// Since we are inheriting an fd, it could legitimately exceed _SC_OPEN_MAX
// Still open?
#if defined(F_GETFD) // Linux lowest overhead
if (TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD)) < 0) return -1;
#elif defined(F_GETFL) // Mac host lowest overhead
if (fcntl(fd, F_GETFL) < 0) return -1;
#else // Hail Mary pass
struct stat s;
if (fstat(fd, &s) < 0) return -1;
#endif
#if defined(F_GETFD)
if (TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD)) < 0) return -1;
#elif defined(F_GETFL)
if (TEMP_FAILURE_RETRY(fcntl(fd, F_GETFL)) < 0) return -1;
#else
struct stat s;
if (TEMP_FAILURE_RETRY(fstat(fd, &s)) < 0) return -1;
#endif
return static_cast<int>(fd);
}
int android_get_control_file(const char* path) {
int fd = __android_get_control_from_env(ANDROID_FILE_ENV_PREFIX, path);
#if defined(__linux__)
// Find file path from /proc and make sure it is correct
char *proc = NULL;
if (asprintf(&proc, "/proc/self/fd/%ld", fd) < 0) return -1;
if (asprintf(&proc, "/proc/self/fd/%d", fd) < 0) return -1;
if (!proc) return -1;
size_t len = strlen(path);
// readlink() does not guarantee a nul byte, len+2 so we catch truncation.
char *buf = static_cast<char *>(calloc(1, len + 2));
if (!buf) {
free(proc);
@ -104,8 +102,8 @@ int android_get_control_file(const char* path) {
free(buf);
if (ret < 0) return -1;
if (cmp != 0) return -1;
// It is what we think it is
#endif
// It is what we think it is
return static_cast<int>(fd);
return fd;
}

View file

@ -24,7 +24,7 @@
#include <sys/types.h>
#include <unistd.h>
#include <cutils/files.h>
#include <cutils/android_get_control_file.h>
#include <cutils/klog.h>
static int klog_level = KLOG_DEFAULT_LEVEL;

View file

@ -28,33 +28,9 @@
// This file contains socket implementation that can be shared between
// platforms as long as the correct headers are included.
#define _GNU_SOURCE 1 // For asprintf
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
#include <limits.h>
#if !defined(_WIN32)
#include <netinet/in.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#if !defined(_WIN32)
#include <sys/un.h>
#endif
#include <unistd.h>
#include <string>
#include <cutils/sockets.h>
#ifndef TEMP_FAILURE_RETRY // _WIN32 does not define
#define TEMP_FAILURE_RETRY(exp) (exp)
#endif
int socket_get_local_port(cutils_socket_t sock) {
sockaddr_storage addr;
socklen_t addr_size = sizeof(addr);
@ -65,58 +41,3 @@ int socket_get_local_port(cutils_socket_t sock) {
}
return -1;
}
int android_get_control_socket(const char* name) {
char *key = NULL;
if (asprintf(&key, ANDROID_SOCKET_ENV_PREFIX "%s", name) < 0) return -1;
if (!key) return -1;
char *cp = key;
while (*cp) {
if (!isalnum(*cp)) *cp = '_';
++cp;
}
const char* val = getenv(key);
free(key);
if (!val) return -1;
errno = 0;
long fd = strtol(val, NULL, 10);
if (errno) return -1;
// validity checking
if ((fd < 0) || (fd > INT_MAX)) return -1;
#if defined(_SC_OPEN_MAX)
if (fd >= sysconf(_SC_OPEN_MAX)) return -1;
#elif defined(OPEN_MAX)
if (fd >= OPEN_MAX) return -1;
#elif defined(_POSIX_OPEN_MAX)
if (fd >= _POSIX_OPEN_MAX) return -1;
#endif
#if defined(F_GETFD)
if (TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD)) < 0) return -1;
#elif defined(F_GETFL)
if (TEMP_FAILURE_RETRY(fcntl(fd, F_GETFL)) < 0) return -1;
#else
struct stat s;
if (TEMP_FAILURE_RETRY(fstat(fd, &s)) < 0) return -1;
#endif
#if !defined(_WIN32)
struct sockaddr_un addr;
socklen_t addrlen = sizeof(addr);
int ret = TEMP_FAILURE_RETRY(getsockname(fd, (struct sockaddr *)&addr, &addrlen));
if (ret < 0) return -1;
char *path = NULL;
if (asprintf(&path, ANDROID_SOCKET_DIR"/%s", name) < 0) return -1;
if (!path) return -1;
int cmp = strcmp(addr.sun_path, path);
free(path);
if (cmp != 0) return -1;
#endif
// It is what we think it is
return static_cast<int>(fd);
}

View file

@ -16,13 +16,21 @@
#define LOG_TAG "socket-unix"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/socket.h>
#include <sys/uio.h>
#include <sys/un.h>
#include <time.h>
#include <unistd.h>
#include <android/log.h>
#include <cutils/android_get_control_file.h>
#include <cutils/sockets.h>
#include "android_get_control_env.h"
#if defined(__ANDROID__)
/* For the socket trust (credentials) check */
#include <private/android_filesystem_config.h>
@ -80,3 +88,24 @@ ssize_t socket_send_buffers(cutils_socket_t sock,
return writev(sock, iovec_buffers, num_buffers);
}
int android_get_control_socket(const char* name) {
int fd = __android_get_control_from_env(ANDROID_SOCKET_ENV_PREFIX, name);
if (fd < 0) return fd;
// Compare to UNIX domain socket name, must match!
struct sockaddr_un addr;
socklen_t addrlen = sizeof(addr);
int ret = TEMP_FAILURE_RETRY(getsockname(fd, (struct sockaddr *)&addr, &addrlen));
if (ret < 0) return -1;
char *path = NULL;
if (asprintf(&path, ANDROID_SOCKET_DIR "/%s", name) < 0) return -1;
if (!path) return -1;
int cmp = strcmp(addr.sun_path, path);
free(path);
if (cmp != 0) return -1;
// It is what we think it is
return fd;
}

View file

@ -84,3 +84,7 @@ ssize_t socket_send_buffers(cutils_socket_t sock,
return -1;
}
int android_get_control_socket(const char* name) {
return -1;
}

View file

@ -14,7 +14,7 @@
cc_defaults {
name: "libcutils_test_default",
srcs: ["sockets_test.cpp", "files_test.cpp"],
srcs: ["sockets_test.cpp"],
target: {
android: {
@ -28,7 +28,11 @@ cc_defaults {
},
not_windows: {
srcs: ["test_str_parms.cpp"],
srcs: [
"test_str_parms.cpp",
"android_get_control_socket_test.cpp",
"android_get_control_file_test.cpp"
],
},
},

View file

@ -14,33 +14,37 @@
* limitations under the License.
*/
#include <ctype.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <time.h>
#include <cutils/files.h>
#include <string>
#include <android-base/stringprintf.h>
#include <android-base/test_utils.h>
#include <cutils/android_get_control_file.h>
#include <gtest/gtest.h>
TEST(FilesTest, android_get_control_file) {
static const char key[] = ANDROID_FILE_ENV_PREFIX "_dev_kmsg";
static const char name[] = "/dev/kmsg";
TemporaryFile tf;
ASSERT_GE(tf.fd, 0);
EXPECT_EQ(unsetenv(key), 0);
EXPECT_EQ(android_get_control_file(name), -1);
std::string key(ANDROID_FILE_ENV_PREFIX);
key += tf.path;
int fd;
ASSERT_GE(fd = open(name, O_RDONLY | O_CLOEXEC), 0);
EXPECT_EQ(android_get_control_file(name), -1);
std::for_each(key.begin(), key.end(), [] (char& c) { c = isalnum(c) ? c : '_'; });
char val[32];
snprintf(val, sizeof(val), "%d", fd);
EXPECT_EQ(setenv(key, val, true), 0);
EXPECT_EQ(unsetenv(key.c_str()), 0);
EXPECT_EQ(android_get_control_file(tf.path), -1);
EXPECT_EQ(android_get_control_file(name), fd);
close(fd);
EXPECT_EQ(android_get_control_file(name), -1);
EXPECT_EQ(unsetenv(key), 0);
EXPECT_EQ(android_get_control_file(name), -1);
EXPECT_EQ(setenv(key.c_str(), android::base::StringPrintf("%d", tf.fd).c_str(), true), 0);
EXPECT_EQ(android_get_control_file(tf.path), tf.fd);
close(tf.fd);
EXPECT_EQ(android_get_control_file(tf.path), -1);
EXPECT_EQ(unsetenv(key.c_str()), 0);
EXPECT_EQ(android_get_control_file(tf.path), -1);
}

View file

@ -0,0 +1,71 @@
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <stdio.h>
#include <stdlib.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <sys/un.h>
#include <time.h>
#include <cutils/sockets.h>
#include <gtest/gtest.h>
#ifndef SOCK_NONBLOCK
#define SOCK_NONBLOCK 0
#endif
#ifndef SOCK_CLOEXEC
#define SOCK_CLOEXEC 0
#endif
TEST(SocketsTest, android_get_control_socket) {
static const char key[] = ANDROID_SOCKET_ENV_PREFIX "SocketsTest_android_get_control_socket";
static const char* name = key + strlen(ANDROID_SOCKET_ENV_PREFIX);
EXPECT_EQ(unsetenv(key), 0);
EXPECT_EQ(android_get_control_socket(name), -1);
int fd;
ASSERT_GE(fd = socket(PF_UNIX, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0), 0);
#ifdef F_GETFL
int flags;
ASSERT_GE(flags = fcntl(fd, F_GETFL), 0);
ASSERT_GE(fcntl(fd, F_SETFL, flags | O_NONBLOCK), 0);
#endif
EXPECT_EQ(android_get_control_socket(name), -1);
struct sockaddr_un addr;
memset(&addr, 0, sizeof(addr));
addr.sun_family = AF_UNIX;
snprintf(addr.sun_path, sizeof(addr.sun_path), ANDROID_SOCKET_DIR"/%s", name);
unlink(addr.sun_path);
EXPECT_EQ(bind(fd, (struct sockaddr*)&addr, sizeof(addr)), 0);
EXPECT_EQ(android_get_control_socket(name), -1);
char val[32];
snprintf(val, sizeof(val), "%d", fd);
EXPECT_EQ(setenv(key, val, true), 0);
EXPECT_EQ(android_get_control_socket(name), fd);
socket_close(fd);
EXPECT_EQ(android_get_control_socket(name), -1);
EXPECT_EQ(unlink(addr.sun_path), 0);
EXPECT_EQ(android_get_control_socket(name), -1);
EXPECT_EQ(unsetenv(key), 0);
EXPECT_EQ(android_get_control_socket(name), -1);
}

View file

@ -18,11 +18,9 @@
// IPv6 capabilities. These tests assume that no UDP packets are lost, which
// should be the case for loopback communication, but is not guaranteed.
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <sys/un.h>
#include <time.h>
#include <cutils/sockets.h>
@ -189,49 +187,3 @@ TEST(SocketsTest, TestTcpReceiveTimeout) {
TEST(SocketsTest, TestSocketSendBuffersFailure) {
EXPECT_EQ(-1, socket_send_buffers(INVALID_SOCKET, nullptr, 0));
}
#ifndef SOCK_NONBLOCK
#define SOCK_NONBLOCK 0
#endif
#ifndef SOCK_CLOEXEC
#define SOCK_CLOEXEC 0
#endif
TEST(SocketsTest, android_get_control_socket) {
static const char key[] = ANDROID_SOCKET_ENV_PREFIX "SocketsTest_android_get_control_socket";
static const char* name = key + strlen(ANDROID_SOCKET_ENV_PREFIX);
EXPECT_EQ(unsetenv(key), 0);
EXPECT_EQ(android_get_control_socket(name), -1);
int fd;
ASSERT_GE(fd = socket(PF_UNIX, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0), 0);
#ifdef F_GETFL
int flags;
ASSERT_GE(flags = fcntl(fd, F_GETFL), 0);
ASSERT_GE(fcntl(fd, F_SETFL, flags | O_NONBLOCK), 0);
#endif
EXPECT_EQ(android_get_control_socket(name), -1);
struct sockaddr_un addr;
memset(&addr, 0, sizeof(addr));
addr.sun_family = AF_UNIX;
snprintf(addr.sun_path, sizeof(addr.sun_path), ANDROID_SOCKET_DIR"/%s", name);
unlink(addr.sun_path);
EXPECT_EQ(bind(fd, (struct sockaddr*)&addr, sizeof(addr)), 0);
EXPECT_EQ(android_get_control_socket(name), -1);
char val[32];
snprintf(val, sizeof(val), "%d", fd);
EXPECT_EQ(setenv(key, val, true), 0);
EXPECT_EQ(android_get_control_socket(name), fd);
socket_close(fd);
EXPECT_EQ(android_get_control_socket(name), -1);
EXPECT_EQ(unlink(addr.sun_path), 0);
EXPECT_EQ(android_get_control_socket(name), -1);
EXPECT_EQ(unsetenv(key), 0);
EXPECT_EQ(android_get_control_socket(name), -1);
}

View file

@ -37,9 +37,9 @@
#include <memory>
#include <android-base/macros.h>
#include <cutils/android_get_control_file.h>
#include <cutils/properties.h>
#include <cutils/sched_policy.h>
#include <cutils/files.h>
#include <cutils/sockets.h>
#include <log/event_tag_map.h>
#include <packagelistparser/packagelistparser.h>