Add install feature in CMake (#29)

* Add install feature

* Add missing include

* Review code

* Add example with cmake

Author: bansan85

CMakeLists.txt

@@ -1,8 +1,9 @@
 cmake_minimum_required(VERSION 3.13)
 
-project(rlbox-cpp17
+project(rlbox-sandboxing-api
         VERSION 0.1
-        DESCRIPTION "RLBox safe sandboxing API in C++17")
+        DESCRIPTION "RLBox safe sandboxing API in C++17"
+        HOMEPAGE_URL "https://github.com/PLSysSec/rlbox_sandboxing_api")
 
 set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
 
@@ -95,12 +96,21 @@ if(NOT Catch2_FOUND)
   list(APPEND CMAKE_MODULE_PATH "${catch2_SOURCE_DIR}/contrib")
 endif()
 
+file(GLOB_RECURSE
+     RLBOX_SOURCE_FILES
+     code/include/*.[chi]pp
+     code/include/*.[chi]xx
+     code/include/*.cc
+     code/include/*.hh
+     code/include/*.ii
+     code/include/*.[CHI])
+
 # Documentation ###################
+
 find_package(Doxygen QUIET)
 
 if(DOXYGEN_FOUND)
-  # Technique from https://devblogs.microsoft.com/cppblog/clear-functional-c
-  # -documentation-with-sphinx-breathe-doxygen-cmake/
+  # Technique from https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/
   set(DOXYGEN_PROJECT_NAME "RLBox")
   set(DOXYGEN_INPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/code/include)
   set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/docs/doxygen)
@@ -111,15 +121,6 @@ if(DOXYGEN_FOUND)
   # Replace variables inside @@ with the current values
   configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
 
-  file(GLOB_RECURSE
-       RLBOX_SOURCE_FILES
-       code/include/*.[chi]pp
-       code/include/*.[chi]xx
-       code/include/*.cc
-       code/include/*.hh
-       code/include/*.ii
-       code/include/*.[CHI])
-
   file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})
   add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
                      DEPENDS ${RLBOX_SOURCE_FILES}
@@ -158,17 +159,50 @@ endif()
 
 # Targets ###################
 
+include(GNUInstallDirs)
+
 find_package(Threads REQUIRED)
-add_library(rlbox-cpp17-lib INTERFACE)
-target_include_directories(rlbox-cpp17-lib INTERFACE code/include)
-target_link_libraries(rlbox-cpp17-lib INTERFACE ${CMAKE_THREAD_LIBS_INIT})
+add_library(${PROJECT_NAME} INTERFACE)
+target_include_directories(${PROJECT_NAME} INTERFACE
+  $<BUILD_INTERFACE:${${PROJECT_NAME}_SOURCE_DIR}/code/include>
+  $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)
+target_compile_features(${PROJECT_NAME} INTERFACE cxx_std_17)
+target_link_libraries(${PROJECT_NAME} INTERFACE ${CMAKE_THREAD_LIBS_INIT})
+set_target_properties(${PROJECT_NAME} PROPERTIES PUBLIC_HEADER "${RLBOX_SOURCE_FILES}")
+
+# Install ###################
+
+include(CMakePackageConfigHelpers)
+
+write_basic_package_version_file("${PROJECT_NAME}ConfigVersion.cmake"
+                                 VERSION ${CMAKE_PROJECT_VERSION}
+                                 COMPATIBILITY SameMajorVersion)
+
+set(DATAROOT_CONFIG_DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/cmake/${PROJECT_NAME}")
+configure_package_config_file(${PROJECT_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in
+  ${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
+  INSTALL_DESTINATION ${DATAROOT_CONFIG_DESTINATION}
+  PATH_VARS CMAKE_INSTALL_INCLUDEDIR)
+install(TARGETS ${PROJECT_NAME}
+        EXPORT ${PROJECT_NAME}-targets
+        PUBLIC_HEADER DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/rlbox"
+        ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
+install(EXPORT ${PROJECT_NAME}-targets
+        FILE ${PROJECT_NAME}Targets.cmake
+        DESTINATION ${DATAROOT_CONFIG_DESTINATION})
+install(FILES "${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+              "${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
+        DESTINATION ${DATAROOT_CONFIG_DESTINATION})
 
 # Tests ###################
 
 include(CTest)
 include(Catch)
 
 # Test rlbox features
+
 add_executable(test_rlbox
                code/tests/test_main.cpp
                code/tests/rlbox/test_app_pointers.cpp
@@ -193,7 +227,7 @@ add_executable(test_rlbox
 
 target_include_directories(test_rlbox PRIVATE code/tests/rlbox)
 
-target_link_libraries(test_rlbox Catch2::Catch2 rlbox-cpp17-lib)
+target_link_libraries(test_rlbox Catch2::Catch2 ${PROJECT_NAME})
 
 catch_discover_tests(test_rlbox)
 
@@ -205,7 +239,7 @@ add_executable(test_rlbox_transition_timers
 
 target_include_directories(test_rlbox_transition_timers PRIVATE code/tests/rlbox)
 
-target_link_libraries(test_rlbox_transition_timers Catch2::Catch2 rlbox-cpp17-lib)
+target_link_libraries(test_rlbox_transition_timers Catch2::Catch2 ${PROJECT_NAME})
 
 catch_discover_tests(test_rlbox_transition_timers)
 
@@ -217,11 +251,12 @@ add_executable(test_rlbox_transition_customization
 
 target_include_directories(test_rlbox_transition_customization PRIVATE code/tests/rlbox)
 
-target_link_libraries(test_rlbox_transition_customization Catch2::Catch2 rlbox-cpp17-lib)
+target_link_libraries(test_rlbox_transition_customization Catch2::Catch2 ${PROJECT_NAME})
 
 catch_discover_tests(test_rlbox_transition_customization)
 
 # Test rlbox glue
+
 add_library(rlbox_glue_lib_static STATIC code/tests/rlbox_glue/lib/libtest.c)
 target_include_directories(rlbox_glue_lib_static
                            PUBLIC code/tests/rlbox_glue/lib)
@@ -237,7 +272,7 @@ target_include_directories(test_rlbox_glue PUBLIC code/tests/rlbox_glue)
 
 target_link_libraries(test_rlbox_glue
                       Catch2::Catch2
-                      rlbox-cpp17-lib
+                      ${PROJECT_NAME}
                       rlbox_glue_lib_static)
 
 catch_discover_tests(test_rlbox_glue)
@@ -249,7 +284,7 @@ target_include_directories(test_rlbox_glue_embedder_vars PUBLIC code/tests/rlbox
 
 target_link_libraries(test_rlbox_glue_embedder_vars
                       Catch2::Catch2
-                      rlbox-cpp17-lib
+                      ${PROJECT_NAME}
                       rlbox_glue_lib_static)
 
 catch_discover_tests(test_rlbox_glue_embedder_vars)
@@ -263,15 +298,14 @@ target_compile_definitions(test_rlbox_glue_dylib PUBLIC GLUE_LIB_PATH="$<TARGET_
 
 target_link_libraries(test_rlbox_glue_dylib
                       Catch2::Catch2
-                      rlbox-cpp17-lib
+                      ${PROJECT_NAME}
                       ${CMAKE_DL_LIBS})
 
 add_dependencies(test_rlbox_glue_dylib rlbox_glue_lib_shared)
 
 catch_discover_tests(test_rlbox_glue_dylib)
 
-
-# Shortcuts ###################
+# make check
 
 add_custom_target(
   check

cmake/rlbox-sandboxing-apiConfig.cmake.in

@@ -0,0 +1,5 @@
+@PACKAGE_INIT@
+
+include("${CMAKE_CURRENT_LIST_DIR}/@[email protected]")
+
+check_required_components("@PROJECT_NAME@")

code/include/rlbox_helpers.hpp

@@ -7,6 +7,9 @@
 #include <stdexcept>
 #include <type_traits>
 #include <utility>
+#ifndef RLBOX_USE_CUSTOM_SHARED_LOCK
+#include <mutex>
+#endif
 
 #include "rlbox_stdlib_polyfill.hpp"
 

examples/hello-world-cmake/CMakeLists.txt

@@ -0,0 +1,12 @@
+cmake_minimum_required(VERSION 3.13)
+
+project(rlbox_cmake_test
+	VERSION 0.1
+	DESCRIPTION "RLBox rlbox_cmake_test")
+
+find_package(rlbox-sandboxing-api CONFIG REQUIRED)
+
+add_library(lib mylib.c)
+
+add_executable(testt main.cpp)
+target_link_libraries(testt rlbox-sandboxing-api lib)

examples/hello-world-cmake/README.md

@@ -0,0 +1,23 @@
+This is a simple hello-world example that uses the RLBox API to call functions
+in a simple sandboxed library. This example uses the NOOP-sandbox; we will
+extend the example to use the Wasm-based sandboxed in a later example.
+
+- `mylib.{h,c}` is the simple library
+- `main.cpp` is our main program
+
+### Build  and run
+
+```
+make
+./hello
+```
+
+Running the program should produce:
+
+```
+Hello world from mylib
+Adding... 3+4 = 7
+OK? = 1
+> mylib: hi hi!
+hello_cb: hi again!
+```

examples/hello-world-cmake/main.cpp

@@ -0,0 +1,51 @@
+#define RLBOX_SINGLE_THREADED_INVOCATIONS
+#define RLBOX_USE_STATIC_CALLS() rlbox_noop_sandbox_lookup_symbol
+
+#include <stdio.h>
+#include <rlbox/rlbox.hpp>
+#include <rlbox/rlbox_noop_sandbox.hpp>
+#include "mylib.h"
+
+using namespace rlbox;
+
+void hello_cb(rlbox_sandbox<rlbox_noop_sandbox>& _,
+              tainted<const char*, rlbox_noop_sandbox> str) {
+  auto checked_string =
+    str.copy_and_verify_string([](std::unique_ptr<char[]> val) {
+        return std::strlen(val.get()) < 1024 ? std::move(val) : nullptr;
+    });
+  printf("hello_cb: %s\n", checked_string.get());
+}
+
+int main(int argc, char const *argv[]) {
+  // Create a new sandbox
+  rlbox::rlbox_sandbox<rlbox_noop_sandbox> sandbox;
+  sandbox.create_sandbox();
+
+  // call the library hello function
+  sandbox.invoke_sandbox_function(hello);
+
+  // call the add function and check the result:
+  auto ok = sandbox.invoke_sandbox_function(add, 3, 4).copy_and_verify([](unsigned ret){
+      printf("Adding... 3+4 = %d\n", ret);
+      return ret == 7;
+  });
+  printf("OK? = %d\n", ok);
+
+  // call the library echo function
+  const char* helloStr = "hi hi!";
+  size_t helloSize = strlen(helloStr) + 1;
+  auto taintedStr = sandbox.malloc_in_sandbox<char>(helloSize);
+  std::strncpy(taintedStr.unverified_safe_pointer_because(helloSize, "writing to region"), helloStr, helloSize);
+  sandbox.invoke_sandbox_function(echo, taintedStr);
+  sandbox.free_in_sandbox(taintedStr);
+
+  // register callback and call it
+  auto cb = sandbox.register_callback(hello_cb);
+  sandbox.invoke_sandbox_function(call_cb, cb);
+
+  // destroy sandbox
+  sandbox.destroy_sandbox();
+
+  return 0;
+}

examples/hello-world-cmake/mylib.c

@@ -0,0 +1,19 @@
+#include "mylib.h"
+
+#include <stdio.h>
+
+void hello() {
+  printf("Hello world from mylib\n");
+}
+
+unsigned add(unsigned a, unsigned b) {
+  return a + b;
+}
+
+void echo(const char* str) {
+  printf("> mylib: %s\n", str);
+}
+
+void call_cb(void (*cb) (const char* str)) {
+  cb("hi again!");
+}

examples/hello-world-cmake/mylib.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+    void hello();
+    unsigned add(unsigned, unsigned);
+    void echo(const char* str);
+    void call_cb(void (*cb) (const char* str));
+#ifdef __cplusplus
+}
+#endif