====== authsmartcard Plugin ======

---- plugin ----
description: Use client certificates (or smartcards) for authentication to the wiki
author     : Stephen Bowman 
email      : sbbowman@gmail.com
type       : auth
lastupdate : 2018-07-26
compatible : 2017-02-19, 2016-06-26, 2015-08-10
depends    : 
conflicts  : 
similar    : 
tags       : smartcard, authentication, certificate, cac

downloadurl: https://github.com/sbbowman/dokuwiki-authsmartcard/zipball/master
bugtracker : https://github.com/sbbowman/dokuwiki-authsmartcard/issues
sourcerepo : https://github.com/sbbowman/dokuwiki-authsmartcard/
donationurl: 

screenshot_img : 
----

This plugin authenticates users to dokuwiki by comparing the user's client certificate's CN attribute with the group field for a user in the dokuwiki user database.

This is a rewrite of an old plugin by Margus Pärt (mxrguspxrt). Much of the plugin structure and API changed with dokuwiki requiring a rewrite.

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====

For example, user John Doe needs access to the Wiki. John has a client certificate (or smartcard with a certificate on it) that as a CN attribute of 'DOE.JOHN.99999'. John Doe has is added to the dokuwiki user database by an administrator. His username is 'jdoe'. His groups are set to 'DOE.JOHN.99999, finance'.

When John Doe access the Wiki with his browser configured to use a client certificate (or smartcard), this plugin will authenticate user 'jdoe' by comparing the CN of his certificate with the groups he is a member of in the dokuwiki user database. 

===== Configuration and Settings =====

You must set authtype to authsmartcard in conf/local.php or conf/local.protected.php:

<code>$conf['authtype'] = 'authsmartcard';</code>

Other configuration parameters specific to the authsmartcard plugin are available in lib/plugins/authsmartcard/conf/default.php:

<code>
// Enable logging?
$conf['log_to_file']        = true;
// If log_to_file is enabled, where to log?  Make sure apache/php can write to this file
$conf['logfile']        = "/full/path/to/logfile/writable/by/apache";
</code>

=== Change Log ===

  * **2014-12-10**
    * Initial release

=== Known Bugs and Issues ===

None - use Issues from link above to open a new case if bugs are found.

===== FAQ =====

None yet.