Better handling of openlog weirdness

Author: ghalse

docs/authproc_fticks.md

@@ -44,6 +44,10 @@ The filter supports the following configuration options:
 > * `host` - the hostname of the remote syslog server, defaulting to `localhost`. _[remote]_
 > * `port` - the port of the remote syslog server, defaulting to `514`. _[remote]_
 
+Note that if `logdest` is `local` and you set either `processname` or `facility` to a value that's different to what is
+in SimpleSAMLphp's global config, you may end up with inconsistent output from SimpleSAMLphp's own logging. This is
+because PHP's [openlog](http://php.net/manual/en/function.openlog.php) function does not return a handle.
+
 Examples
 --------
 

lib/Auth/Process/Fticks.php

@@ -220,6 +220,16 @@ public function __construct($config, $reserved)
             }
         }
 
+        if (array_key_exists('logdest', $config)) {
+            if (is_string($config['logdest']) and
+                in_array($config['logdest'], array('local', 'syslog', 'remote', 'stdout', 'errorlog', 'simplesamlphp'))
+            ) {
+                $this->logdest = $config['logdest'];
+            } else {
+                throw new \SimpleSAML\Error\Exception('F-ticks log destination must be one of [local, remote, stdout, errorlog, simplesamlphp]');
+            }
+        }
+
         /* match SSP config or we risk mucking up the openlog call */
         $globalConfig = \SimpleSAML_Configuration::getInstance();
         $defaultFacility = $globalConfig->getInteger('logging.facility', defined('LOG_LOCAL5') ? constant('LOG_LOCAL5') : LOG_USER);
@@ -234,20 +244,13 @@ public function __construct($config, $reserved)
             $this->logconfig['facility'] = $defaultFacility;
             $this->logconfig['processname'] = $defaultProcessName;
         }
-        if (array_key_exists('facility', $this->logconfig) and $this->logconfig['facility'] !== $defaultFacility) {
-            \SimpleSAML\Logger::warning('F-ticks syslog facility differs from global config');
-        }
-        if (array_key_exists('processname', $this->logconfig) and $this->logconfig['processname'] !== $defaultProcessName) {
-            \SimpleSAML\Logger::warning('F-ticks syslog processname differs from global config');
-        }
-
-        if (array_key_exists('logdest', $config)) {
-            if (is_string($config['logdest']) and
-                in_array($config['logdest'], array('local', 'remote', 'stdout', 'errorlog', 'simplesamlphp'))
-            ) {
-                $this->logdest = $config['logdest'];
-            } else {
-                throw new \SimpleSAML\Error\Exception('F-ticks log destination must be one of [local, remote, stdout, errorlog, simplesamlphp]');
+        /* warn if we risk mucking up the openlog call (doesn't matter for remote syslog) */
+        if (in_array($this->logdest, array('local', 'syslog'))) {
+            if (array_key_exists('facility', $this->logconfig) and $this->logconfig['facility'] !== $defaultFacility) {
+                \SimpleSAML\Logger::warning('F-ticks syslog facility differs from global config which may cause SimpleSAMLphp\'s logging to behave inconsistently');
+            }
+            if (array_key_exists('processname', $this->logconfig) and $this->logconfig['processname'] !== $defaultProcessName) {
+                \SimpleSAML\Logger::warning('F-ticks syslog processname differs from global config which may cause SimpleSAMLphp\'s logging to behave inconsistently');
             }
         }
     }