Allow empty configuration

jvoisin · Aug 11, 2020 · 3d76763 · 3d76763
1 parent f3360c4
commit 3d76763
Show file tree

Hide file tree

Showing 9 changed files with 70 additions and 47 deletions.
diff --git a/src/php_snuffleupagus.h b/src/php_snuffleupagus.h
@@ -62,6 +62,10 @@ typedef void (*zif_handler)(INTERNAL_FUNCTION_PARAMETERS);
 #define TSRMLS_C
 #endif
 
+#define SP_CONFIG_VALID 1
+#define SP_CONFIG_INVALID 0
+#define SP_CONFIG_NONE -1
+
 #include "sp_pcre_compat.h"
 #include "sp_list.h"
 #include "sp_tree.h"
@@ -101,7 +105,7 @@ extern zend_module_entry snuffleupagus_module_entry;
 ZEND_BEGIN_MODULE_GLOBALS(snuffleupagus)
 size_t in_eval;
 sp_config config;
-bool is_config_valid;
+int is_config_valid;  // 1 = valid, 0 = invalid, -1 = empty
 bool allow_broken_configuration;
 HashTable *disabled_functions_hook;
 HashTable *sp_internal_functions_hook;

diff --git a/src/snuffleupagus.c b/src/snuffleupagus.c
@@ -68,6 +68,7 @@ ZEND_DLEXPORT zend_extension zend_extension_entry = {
     STANDARD_ZEND_EXTENSION_PROPERTIES};
 
 PHP_GINIT_FUNCTION(snuffleupagus) {
+	snuffleupagus_globals->is_config_valid = SP_CONFIG_NONE;
   snuffleupagus_globals->in_eval = 0;
 
 #define SP_INIT_HT(F) snuffleupagus_globals->F = \
@@ -186,8 +187,12 @@ PHP_RINIT_FUNCTION(snuffleupagus) {
   ZEND_TSRMLS_CACHE_UPDATE();
 #endif
 
-  if (!SNUFFLEUPAGUS_G(allow_broken_configuration) && !SNUFFLEUPAGUS_G(is_config_valid)) {
-    sp_log_err("config", "Invalid configuration file");
+  if (!SNUFFLEUPAGUS_G(allow_broken_configuration)) {
+    if (SNUFFLEUPAGUS_G(is_config_valid) == SP_CONFIG_INVALID ) {
+      sp_log_err("config", "Invalid configuration file");
+    } else if (SNUFFLEUPAGUS_G(is_config_valid) == SP_CONFIG_NONE) {
+      sp_log_warn("config", "No configuration specificed via sp.configuration_file");
+    }
   }
 
   // We need to disable wrappers loaded by extensions loaded after SNUFFLEUPAGUS.
@@ -209,12 +214,22 @@ PHP_RINIT_FUNCTION(snuffleupagus) {
 PHP_RSHUTDOWN_FUNCTION(snuffleupagus) { return SUCCESS; }
 
 PHP_MINFO_FUNCTION(snuffleupagus) {
+  const char *valid_config;
+  switch(SNUFFLEUPAGUS_G(is_config_valid)) {
+    case SP_CONFIG_VALID:
+      valid_config = "yes";
+      break;
+    case SP_CONFIG_INVALID:
+      valid_config = "empty";
+      break;
+    default:
+      valid_config = "no";
+  }
   php_info_print_table_start();
-  php_info_print_table_row(2, "snuffleupagus support", "enabled");
+  php_info_print_table_row(2, "snuffleupagus support",
+      SNUFFLEUPAGUS_G(is_config_valid)?"enabled":"disabled");
   php_info_print_table_row(2, "Version", PHP_SNUFFLEUPAGUS_VERSION);
-  php_info_print_table_row(
-      2, "Valid config",
-      (SNUFFLEUPAGUS_G(is_config_valid) == true) ? "yes" : "no");
+  php_info_print_table_row( 2, "Valid config", valid_config);
   php_info_print_table_end();
   DISPLAY_INI_ENTRIES();
 }
@@ -223,8 +238,8 @@ static PHP_INI_MH(OnUpdateConfiguration) {
   TSRMLS_FETCH();
 
   if (!new_value || !new_value->len) {
-    return FAILURE;
-  }
+    return SUCCESS;
+  } 
 
   glob_t globbuf;
   char *config_file;
@@ -234,22 +249,22 @@ static PHP_INI_MH(OnUpdateConfiguration) {
     int ret = glob(config_file, GLOB_NOCHECK, NULL, &globbuf);
 
     if (ret != 0) {
-      SNUFFLEUPAGUS_G(is_config_valid) = false;
+      SNUFFLEUPAGUS_G(is_config_valid) = SP_CONFIG_INVALID;
       globfree(&globbuf);
       return FAILURE;
     }
 
     for (size_t i = 0; globbuf.gl_pathv[i]; i++) {
       if (sp_parse_config(globbuf.gl_pathv[i]) != SUCCESS) {
-        SNUFFLEUPAGUS_G(is_config_valid) = false;
+        SNUFFLEUPAGUS_G(is_config_valid) = SP_CONFIG_INVALID;
         globfree(&globbuf);
         return FAILURE;
       }
     }
     globfree(&globbuf);
   }
 
-  SNUFFLEUPAGUS_G(is_config_valid) = true;
+  SNUFFLEUPAGUS_G(is_config_valid) = SP_CONFIG_VALID;
 
   if ((SNUFFLEUPAGUS_G(config).config_sloppy->enable)) {
     hook_sloppy();

diff --git a/src/sp_crypt.c b/src/sp_crypt.c
@@ -108,8 +108,8 @@ int decrypt_zval(zval *pDest, bool simulation, zend_hash_key *hash_key) {
       return ZEND_HASH_APPLY_KEEP;
     } else {
       sp_log_warn("cookie_encryption",
-                 "Something went wrong with the decryption of %s",
-                 hash_key ? ZSTR_VAL(hash_key->key) : "the session");
+                  "Something went wrong with the decryption of %s",
+                  hash_key ? ZSTR_VAL(hash_key->key) : "the session");
       efree(backup);
       return ZEND_HASH_APPLY_REMOVE;
     }

diff --git a/src/sp_disabled_functions.c b/src/sp_disabled_functions.c
@@ -575,12 +575,12 @@ ZEND_FUNCTION(eval_blacklist_callback) {
     }
     if (config_eval->simulation) {
       sp_log_simulation("eval",
-                 "A call to %s was tried in eval, in %s:%d, logging it.",
-                 current_function_name, ZSTR_VAL(filename), line_number);
+                        "A call to %s was tried in eval, in %s:%d, logging it.",
+                        current_function_name, ZSTR_VAL(filename), line_number);
     } else {
       sp_log_drop("eval",
-                 "A call to %s was tried in eval, in %s:%d, dropping it.",
-                 current_function_name, ZSTR_VAL(filename), line_number);
+                  "A call to %s was tried in eval, in %s:%d, dropping it.",
+                  current_function_name, ZSTR_VAL(filename), line_number);
     }
     efree(filename);
   }

diff --git a/src/sp_execute.c b/src/sp_execute.c
@@ -19,10 +19,11 @@ ZEND_COLD static inline void terminate_if_writable(const char *filename) {
     }
     if (true == config_ro_exec->simulation) {
       sp_log_simulation("readonly_exec",
-                 "Attempted execution of a writable file (%s).", filename);
+                        "Attempted execution of a writable file (%s).",
+                        filename);
     } else {
       sp_log_drop("readonly_exec",
-                 "Attempted execution of a writable file (%s).", filename);
+                  "Attempted execution of a writable file (%s).", filename);
       zend_bailout();
     }
   } else {

diff --git a/src/sp_upload_validation.c b/src/sp_upload_validation.c
@@ -13,10 +13,11 @@ int sp_rfc1867_callback(unsigned int event, void *event_data, void **extra);
 
 int sp_rfc1867_callback_win(unsigned int event, void *event_data,
                             void **extra) {
-  sp_log_simulation("upload_validation",
-             "The upload validation doesn't work for now on Windows yet, "
-             "see https://github.com/jvoisin/snuffleupagus/issues/248 for "
-             "details.");
+  sp_log_simulation(
+      "upload_validation",
+      "The upload validation doesn't work for now on Windows yet, "
+      "see https://github.com/jvoisin/snuffleupagus/issues/248 for "
+      "details.");
   return SUCCESS;
 }
 
@@ -91,8 +92,8 @@ int sp_rfc1867_callback(unsigned int event, void *event_data, void **extra) {
         char *uri = getenv("REQUEST_URI");
         int sim = config_upload->simulation;
         sp_log_auto("upload_validation", sim,
-            "The upload of %s on %s was rejected.",
-            filename, uri ? uri : "?");
+                    "The upload of %s on %s was rejected.", filename,
+                    uri ? uri : "?");
       }
     }
     ZEND_HASH_FOREACH_END();

diff --git a/src/sp_utils.c b/src/sp_utils.c
@@ -41,7 +41,7 @@ const char* get_ipaddr() {
 }
 
 void sp_log_msgf(char const* restrict feature, int level, int type,
-                const char* restrict fmt, ...) {
+                 const char* restrict fmt, ...) {
   char* msg;
   va_list args;
 
@@ -51,7 +51,7 @@ void sp_log_msgf(char const* restrict feature, int level, int type,
 
   const char* client_ip = get_ipaddr();
   const char* logtype = NULL;
-  switch(type) {
+  switch (type) {
     case SP_TYPE_SIMULATION:
       logtype = "simulation";
       break;
@@ -80,7 +80,8 @@ void sp_log_msgf(char const* restrict feature, int level, int type,
     }
     case SP_ZEND:
     default:
-      zend_error(level, "[snuffleupagus][%s][%s][%s] %s", client_ip, feature, logtype, msg);
+      zend_error(level, "[snuffleupagus][%s][%s][%s] %s", client_ip, feature,
+                 logtype, msg);
       break;
   }
 }
@@ -280,26 +281,27 @@ void sp_log_disable(const char* restrict path, const char* restrict arg_name,
       char_repr = zend_string_to_char(arg_value);
     }
     if (alias) {
-      sp_log_auto("disabled_function", sim,
-                 "Aborted execution on call of the function '%s', "
-                 "because its argument '%s' content (%s) matched the rule '%s'",
-                 path, arg_name, char_repr ? char_repr : "?", ZSTR_VAL(alias));
+      sp_log_auto(
+          "disabled_function", sim,
+          "Aborted execution on call of the function '%s', "
+          "because its argument '%s' content (%s) matched the rule '%s'",
+          path, arg_name, char_repr ? char_repr : "?", ZSTR_VAL(alias));
     } else {
       sp_log_auto("disabled_function", sim,
-                 "Aborted execution on call of the function '%s', "
-                 "because its argument '%s' content (%s) matched a rule",
-                 path, arg_name, char_repr ? char_repr : "?");
+                  "Aborted execution on call of the function '%s', "
+                  "because its argument '%s' content (%s) matched a rule",
+                  path, arg_name, char_repr ? char_repr : "?");
     }
     efree(char_repr);
   } else {
     if (alias) {
       sp_log_auto("disabled_function", sim,
-                 "Aborted execution on call of the function '%s', "
-                 "because of the the rule '%s'",
-                 path, ZSTR_VAL(alias));
+                  "Aborted execution on call of the function '%s', "
+                  "because of the the rule '%s'",
+                  path, ZSTR_VAL(alias));
     } else {
       sp_log_auto("disabled_function", sim,
-                 "Aborted execution on call of the function '%s'", path);
+                  "Aborted execution on call of the function '%s'", path);
     }
   }
 }
@@ -327,9 +329,9 @@ void sp_log_disable_ret(const char* restrict path,
         path, char_repr ? char_repr : "?", ZSTR_VAL(alias));
   } else {
     sp_log_auto("disabled_function", sim,
-               "Aborted execution on return of the function '%s', "
-               "because the function returned '%s', which matched a rule",
-               path, char_repr ? char_repr : "?");
+                "Aborted execution on return of the function '%s', "
+                "because the function returned '%s', which matched a rule",
+                path, char_repr ? char_repr : "?");
   }
   efree(char_repr);
 }

diff --git a/src/tests/broken_configuration/broken_conf_no_file_specified.phpt b/src/tests/broken_configuration/broken_conf_no_file_specified.phpt
@@ -6,5 +6,5 @@ Broken configuration - No configuration file specified
 --FILE--
 <?php echo "1\n"; ?>
 --EXPECT--
-Fatal error: [snuffleupagus][0.0.0.0][config][log] Invalid configuration file in Unknown on line 0
-Could not startup.
+Warning: [snuffleupagus][0.0.0.0][config][log] No configuration specificed via sp.configuration_file in Unknown on line 0
+1
diff --git a/src/tests/loading.phpt b/src/tests/loading.phpt
@@ -7,5 +7,5 @@ Check for snuffleupagus presence
 echo "snuffleupagus extension is available";
 ?>
 --EXPECT--
-Fatal error: [snuffleupagus][0.0.0.0][config][log] Invalid configuration file in Unknown on line 0
-Could not startup.
+Warning: [snuffleupagus][0.0.0.0][config][log] No configuration specificed via sp.configuration_file in Unknown on line 0
+snuffleupagus extension is available