Merge pull request #120 from jhiemstrawisc/cache-location-config

Cache location config

Author: djw8605

src/scitokens.cpp

@@ -1,17 +1,23 @@
 #include <atomic>
 #include <exception>
 #include <string.h>
-
+#include <sys/stat.h>
 
 #include "scitokens.h"
 #include "scitokens_internal.h"
 
 /**
  * GLOBALS
  */
+
+// Cache timeout config
 std::atomic_int configurer::Configuration::m_next_update_delta{600};
 std::atomic_int configurer::Configuration::m_expiry_delta{4 * 24 * 3600};
 
+// SciTokens cache home config
+std::shared_ptr<std::string> configurer::Configuration::m_cache_home =
+    std::make_shared<std::string>("");
+
 SciTokenKey scitoken_key_create(const char *key_id, const char *alg,
                                 const char *public_contents,
                                 const char *private_contents, char **err_msg) {
@@ -950,6 +956,10 @@ int keycache_set_jwks(const char *issuer, const char *jwks, char **err_msg) {
 }
 
 int config_set_int(const char *key, int value, char **err_msg) {
+    return scitoken_config_set_int(key, value, err_msg);
+}
+
+int scitoken_config_set_int(const char *key, int value, char **err_msg) {
     if (!key) {
         if (err_msg) {
             *err_msg = strdup("A key must be provided.");
@@ -958,7 +968,6 @@ int config_set_int(const char *key, int value, char **err_msg) {
     }
 
     std::string _key = key;
-
     if (_key == "keycache.update_interval_s") {
         if (value < 0) {
             if (err_msg) {
@@ -970,8 +979,8 @@ int config_set_int(const char *key, int value, char **err_msg) {
         return 0;
     }
 
-    if (_key == "keycache.expiration_interval_s") {
-        if (value < 0 ) {
+    else if (_key == "keycache.expiration_interval_s") {
+        if (value < 0) {
             if (err_msg) {
                 *err_msg = strdup("Expiry interval must be positive.");
             }
@@ -990,6 +999,10 @@ int config_set_int(const char *key, int value, char **err_msg) {
 }
 
 int config_get_int(const char *key, char **err_msg) {
+    return scitoken_config_get_int(key, err_msg);
+}
+
+int scitoken_config_get_int(const char *key, char **err_msg) {
     if (!key) {
         if (err_msg) {
             *err_msg = strdup("A key must be provided.");
@@ -998,12 +1011,11 @@ int config_get_int(const char *key, char **err_msg) {
     }
 
     std::string _key = key;
-
     if (_key == "keycache.update_interval_s") {
         return configurer::Configuration::get_next_update_delta();
     }
 
-    if (_key == "keycache.expiration_interval_s") {
+    else if (_key == "keycache.expiration_interval_s") {
         return configurer::Configuration::get_expiry_delta();
     }
 
@@ -1013,4 +1025,55 @@ int config_get_int(const char *key, char **err_msg) {
         }
         return -1;
     }
-}
+}
+
+int scitoken_config_set_str(const char *key, const char *value,
+                            char **err_msg) {
+    if (!key) {
+        if (err_msg) {
+            *err_msg = strdup("A key must be provided.");
+        }
+        return -1;
+    }
+
+    std::string _key = key;
+    if (_key == "keycache.cache_home") {
+        auto rp = configurer::Configuration::set_cache_home(value);
+        if (!rp.first) { // There was an error, pass rp.second to err_msg
+            if (err_msg) {
+                *err_msg = strdup(rp.second.c_str());
+            }
+            return -1;
+        }
+    }
+
+    else {
+        if (err_msg) {
+            *err_msg = strdup("Key not recognized.");
+        }
+        return -1;
+    }
+    return 0;
+}
+
+int scitoken_config_get_str(const char *key, char **output, char **err_msg) {
+    if (!key) {
+        if (err_msg) {
+            *err_msg = strdup("A key must be provided.");
+        }
+        return -1;
+    }
+
+    std::string _key = key;
+    if (_key == "keycache.cache_home") {
+        *output = strdup(configurer::Configuration::get_cache_home().c_str());
+    }
+
+    else {
+        if (err_msg) {
+            *err_msg = strdup("Key not recognized.");
+        }
+        return -1;
+    }
+    return 0;
+}

src/scitokens.h

@@ -291,24 +291,43 @@ int keycache_get_cached_jwks(const char *issuer, char **jwks, char **err_msg);
 int keycache_set_jwks(const char *issuer, const char *jwks, char **err_msg);
 
 /**
- * API for managing scitokens configuration parameters.
+ * APIs for managing scitokens configuration parameters.
  */
 
+// On its way to deprecation
+int config_set_int(const char *key, int value, char **err_msg);
+
 /**
- * Update scitokens parameters.
+ * Update scitokens int parameters.
  * Takes in key/value pairs and assigns the input value to whatever
  * configuration variable is indicated by the key.
  * Returns 0 on success, and non-zero for invalid keys or values.
  */
-int config_set_int(const char *key, int value, char **err_msg);
+int scitoken_config_set_int(const char *key, int value, char **err_msg);
+
+// on its way to deprecation
+int config_get_int(const char *key, char **err_msg);
 
 /**
- * Get current scitokens parameters.
+ * Get current scitokens int parameters.
  * Returns the value associated with the supplied input key on success, and -1
- * on failure This assumes there are no keys for which a negative return value
+ * on failure. This assumes there are no keys for which a negative return value
  * is permissible.
  */
-int config_get_int(const char *key, char **err_msg);
+int scitoken_config_get_int(const char *key, char **err_msg);
+
+/**
+ * Set current scitokens str parameters.
+ * Returns 0 on success, nonzero on failure
+ */
+int scitoken_config_set_str(const char *key, const char *value, char **err_msg);
+
+/**
+ * Get current scitokens str parameters.
+ * Returns 0 on success, nonzero on failure, and populates the value associated
+ * with the input key to output.
+ */
+int scitoken_config_get_str(const char *key, char **output, char **err_msg);
 
 #ifdef __cplusplus
 }

src/scitokens_cache.cpp

@@ -42,9 +42,9 @@ void initialize_cachedb(const std::string &keycache_file) {
 
 /**
  * Get the Cache file location
- *
- *  1. $XDG_CACHE_HOME
- *  2. .cache subdirectory of home directory as returned by the password
+ *  1. User-defined through config api
+ *  2. $XDG_CACHE_HOME
+ *  3. .cache subdirectory of home directory as returned by the password
  * database
  */
 std::string get_cache_file() {
@@ -64,7 +64,16 @@ std::string get_cache_file() {
         home_dir += "/.cache";
     }
 
-    std::string cache_dir(xdg_cache_home ? xdg_cache_home : home_dir.c_str());
+    // Figure out where to plop the cache based on priority
+    std::string cache_dir;
+    std::string configured_cache_dir =
+        configurer::Configuration::get_cache_home();
+    if (configured_cache_dir.length() > 0) { // The variable has been configured
+        cache_dir = configured_cache_dir;
+    } else {
+        cache_dir = xdg_cache_home ? xdg_cache_home : home_dir.c_str();
+    }
+
     if (cache_dir.size() == 0) {
         return "";
     }

src/scitokens_internal.cpp

@@ -2,6 +2,7 @@
 #include <functional>
 #include <memory>
 #include <sstream>
+#include <sys/stat.h>
 
 #include <jwt-cpp/base.h>
 #include <jwt-cpp/jwt.h>
@@ -1064,3 +1065,89 @@ bool scitokens::Enforcer::scope_validator(const jwt::claim &claim,
 
     return me->m_test_authz.empty();
 }
+
+// Configuration class functions
+std::pair<bool, std::string>
+configurer::Configuration::set_cache_home(const std::string dir_path) {
+    // If setting to "", then we should treat as though it is unsetting the
+    // config
+    if (dir_path.length() == 0) { // User is configuring to empty string
+        m_cache_home = std::make_shared<std::string>(dir_path);
+        return std::make_pair(true, "");
+    }
+
+    std::vector<std::string> path_components =
+        path_split(dir_path); // cleans any extraneous /'s
+    std::string cleaned_dir_path;
+    for (const auto &component :
+         path_components) { // add the / back to the path components
+        cleaned_dir_path += "/" + component;
+    }
+
+    // Check that the cache_home exists, and if not try to create it
+    auto rp = mkdir_and_parents_if_needed(
+        cleaned_dir_path); // Structured bindings not introduced until cpp 17
+    if (!rp.first) {       //
+        std::string err_prefix{
+            "An issue was encountered with the provided cache home path: "};
+        return std::make_pair(false, err_prefix + rp.second);
+    }
+
+    // Now it exists and we can write to it, set the value and let
+    // scitokens_cache handle the rest
+    m_cache_home = std::make_shared<std::string>(cleaned_dir_path);
+    return std::make_pair(true, "");
+}
+
+std::string configurer::Configuration::get_cache_home() {
+    return *m_cache_home;
+}
+
+// bool configurer::Configuration::check_dir(const std::string dir_path) {
+//     struct stat info;
+//     return stat(dir_path.c_str(), &info) == 0 && (info.st_mode & S_IFDIR);
+// }
+
+std::pair<bool, std::string>
+configurer::Configuration::mkdir_and_parents_if_needed(
+    const std::string dir_path) {
+    // SciTokens-cpp already makes assumptions about using Linux file paths,
+    // so making that assumption here as well.
+
+    // Using these perms because that's what the actual cache file uses in
+    // scitokens_cache
+    mode_t mode = 0700; // Maybe these permissions should be configurable?
+
+    int result;
+    std::string currentLevel;
+    std::vector<std::string> path_components = path_split(dir_path);
+    for (const auto &component : path_components) {
+        currentLevel += "/" + component;
+        result = mkdir(currentLevel.c_str(), mode);
+        if ((result < 0) && errno != EEXIST) {
+            std::string err_prefix{"There was an error while creating/checking "
+                                   "the directory: mkdir error: "};
+            return std::make_pair(false, err_prefix + strerror(errno));
+        }
+    }
+
+    return std::make_pair(true, "");
+}
+
+std::vector<std::string>
+configurer::Configuration::path_split(std::string path) {
+    std::vector<std::string> path_components;
+    std::stringstream ss(path);
+    std::string component;
+
+    while (std::getline(ss, component, '/')) {
+        if (!component.empty()) {
+            path_components.push_back(component);
+        }
+    }
+
+    if (path_components[0] == "") {
+        path_components.erase(path_components.begin());
+    }
+    return path_components;
+}

src/scitokens_internal.h

@@ -42,9 +42,17 @@ class Configuration {
         m_expiry_delta = _expiry_delta;
     }
     static int get_expiry_delta() { return m_expiry_delta; }
+    static std::pair<bool, std::string> set_cache_home(const std::string cache_home);
+    static std::string get_cache_home();
+
   private:
     static std::atomic_int m_next_update_delta;
     static std::atomic_int m_expiry_delta;
+    static std::shared_ptr<std::string> m_cache_home;
+    // static bool check_dir(const std::string dir_path);
+    static std::pair<bool, std::string>
+    mkdir_and_parents_if_needed(const std::string dir_path);
+    static std::vector<std::string> path_split(const std::string dir_path);
 };
 } // namespace configurer