Available in stable development 1.15 1.14 1.13 1.12 1.11 1.10 1.9 1.8 1.7

Using the X509 authentication source with SimpleSAMLphp

The authX509 module provides X509 authentication with certificate validation. For now there is only one authentication source:

More validation schemes (OCSP, CRL, local list) might be added later.

1 Configuring Apache

This module assumes that the server requests a client certificate, and stores it in the environment variable SSL_CLIENT_CERT. This can be achieved with such a configuration:

SSLEngine on
SSLCertificateFile /etc/openssl/certs/server.crt
SSLCertificateKeyFile /etc/openssl/private/server.key
SSLCACertificateFile /etc/openssl/certs/ca.crt
SSLVerifyClient require
SSLVerifyDepth 2
SSLOptions +ExportCertData

Note that SSLVerifyClient can be set to optional if you want to support both certificate and plain login authentication at the same time (more on this later).

If your server or your client (or both!) have TLS renegotiation disabled as a workaround for CVE-2009-3555, then the configuration directive above must not appear in a <Directory>, <Location>, or in a name-based <VirtualHost>. You can only use them server-wide, or in <VirtualHost>s with different IP address/port combinations.

2 Setting up the authX509 module

The first thing you need to do is to enable the module:

touch modules/authX509/enable

Then you must add it as an authentication source. Here is an example authsources.php entry:

'x509' => array(
    'hostname' => 'ldaps://ldap.example.net',
    'enable_tls' => FALSE,
    'attributes' => array("cn", "uid", "mail", "ou", "sn"),
    'search.enable' => TRUE,
    'search.attributes' => array('uid', 'mail'),
    'search.base' => 'dc=example,dc=net',
    'authX509:x509attributes' => array('UID' => 'uid'),
    'authX509:ldapusercert' => array('userCertificate;binary'),

The configuration is the same as for the LDAP module, except for two options:

3 Uploading certificate in LDAP

Certificates are usually stored in LDAP as DER, in binary. Here is how to convert from PEM to DER:

openssl x509 -in cert.pem -inform PEM -outform DER -out cert.der

Here is some LDIF to upload the certificate in the directory:

dn: uid=jdoe,dc=example,dc=net
changetype: modify
add: userCertificate;binary
userCertificate;binary:< file:///path/to/cert.der

Supporting both certificate and login authentication

In your Apache configuration, set SSLVerifyClient to optional. Then you can hack your metadata/saml20-idp-hosted.php file that way:

$auth_source = empty($_SERVER['SSL_CLIENT_CERT']) ? 'ldap' : 'x509';
$metadata = array(
    '__DYNAMIC:1__' => array(
        'host'          =>      '__DEFAULT__',
        'privatekey'    =>      'server.key',
        'certificate'   =>      'server.crt',
        'auth'          =>       $auth_source,
        'authority'     =>      'login',
        'userid.attribute' =>   'uid',
        'logouttype'    =>      'iframe',
        'attributes.NameFormat' =>

Checking certificate expiry

To issue warnings to users whose certificate is about to expire, configure an authproc filter.


 10 => array(
     'class' => 'authX509:ExpiryWarning',
     'warndaysbefore' => '30',
     'renewurl' => 'https://myca.com/renew',

Parameter warndaysbefore specifies the number of days the user's certificate needs to be valid before a warning is issued. The default is 30.

Parameter renewurl specifies the URL of your Certification Authority. If specified, the user is suggested to renew the certificate immediately.