simplesamlphp/simplesamlphp-module-fticks

SimpleSAMLphp module to record F-Ticks statistics

v2.0.0 2024-08-21 14:48 UTC

Requires

• php: ^8.1
• ext-posix: *
• ext-sockets: *
• simplesamlphp/assert: ^1.0
• simplesamlphp/composer-module-installer: ^1.3
• simplesamlphp/saml2: ^4.6
• simplesamlphp/simplesamlphp: ^2.1

Requires (Dev)

• simplesamlphp/simplesamlphp-test-framework: ^1.5

Replaces

• safire-ac-za/simplesamlphp-module-fticks: >=1.1.1

MIT

• Guy Halse

• simplesamlphp
• fticks

README

Log statistics in the F-ticks federation log format.

Installation

Once you have installed SimpleSAMLphp, installing this module is very simple. Just execute the following command in the root of your SimpleSAMLphp installation:

vendor/bin/composer require simplesamlphp/simplesamlphp-module-fticks:dev-master

where dev-master instructs Composer to install the master (development) branch from the Git repository. See the releases available if you want to use a stable version of the module.

Configuration

Next thing you need to do is to enable the module: in config.php, search for the module.enable key and set fticks to true:

    'module.enable' => [
        'fticks' => true,
        …
    ],

For configuration of the module, see docs/authproc_fticks.md.

Acknowledgements

Some work on making SimpleSAMLphp log in F-ticks format was done by NIIF, and is available at NIIF. This module may derive ideas from their work.

Likewise, some ideas came from the Shibboleth IdP's F-ticks implementation and some of the config options should look familiar to Shibboleth users.