===== DokuWiki YubiKey Authentication Plugin =====

---- dataentry project ----
Name_              : DokuWiki Yubikey Authentication Plugin
Tags_tags          : web, dokuwiki, auth, plugin
Description_       : Plugin for DokuWiki to allow authentication via a YubiKey
Last Update_dt     : 2011-12-10
----

===== Overview =====

This project is a rewrite of the [[:projects:web:dokuwiki-auth-yubikey|DokuWiki YubiKey Auth Module]] to be implemented as a plugin and solve some of the bugs associated with being implemented as an auth module.

It is based on the [[http://h6e.net/dokuwiki/plugins/openid|OpenID]] plugin.

===== Screenshots =====

Below are some screenshots of the plugin in action.

=== Login Screen ===
{{ :projects:web:dokuwiki-plugin-yubikey:login_yubikey.png?w=500 |Login Screen}}

=== Yubikey Management ===
{{ :projects:web:dokuwiki-plugin-yubikey:manage_yubikeys.png?w=500 |Yubikey Management}}

===== Setup =====

To set up the YubiKey authentication plugin, you must first install it like any standard plugin (by downloading it and extracting it to your plugins directory).

You must also complete setup by going to the DokuWiki configuration page and setting up a Client API ID.  You can obtain a Client API ID from [[https://upgrade.yubico.com/getapikey/|Yubico's Get API Key website]].

There is also a section for specifying a secret key.  If you enter the secret key from when you signed up for your API ID, then signature verification will be enabled when performing verification to the Yubico servers.

===== Releases =====

**Version 1.1:** [[https://github.com/cvpcs/dokuwiki_plugin_yubikey/zipball/v1.1|Dokuwiki-Plugin-Yubikey-v1.1.zip]] \\
**Version 1.0:** [[https://github.com/cvpcs/dokuwiki_plugin_yubikey/zipball/v1.0|Dokuwiki-Plugin-Yubikey-v1.0.zip]]

The latest source can always be downloaded from this location:

[[https://github.com/cvpcs/dokuwiki_plugin_yubikey/zipball/master|dokuwiki_auth_yubikey-latest.zip]]

===== Source Code =====

The source is currently available at GitHub:

[[http://github.com/cvpcs/dokuwiki_plugin_yubikey]]

===== Issues ======

If you find any issues with this plugin, please report them to the [[https://github.com/cvpcs/dokuwiki_plugin_yubikey/issues|GitHub project issue tracker]].

===== Changelog =====

  * v1.1
    * added support for signature verification
    * fixed output of error messages
  * v1.0
    * initial release with base functionality