== Auth_Yubico PHP class == The Yubico authentication PHP class provides an easy way to integrate the Yubikey into your existing PHP-based user authentication infrastructure. Installation is simple using PEAR. The development community is co-ordinated via https://github.com/Yubico/php-yubico[the Github project]. === Installation === Make sure your PHP installation supports curl, and that you have installed PEAR. On Debian/Ubuntu systems: $ apt-get install libapache2-mod-php5 php5-curl php-pear Install the component by invoking: $ wget https://developers.yubico.com/php-yubico/Releases/Auth_Yubico-2.5.tgz $ pear install Auth_Yubico-2.5.tgz === Usage === NOTE: Make sure that you have read https://developers.yubico.com/OTP/Libraries/Using_a_library.html[Using a YubiKey OTP library] before continuing. This is an example of how you can use the `Yubico.php` inside an HTML *.php file: [source, php] ----------- verify($otp); if (PEAR::isError($auth)) { print "

Authentication failed: " . $auth->getMessage(); print "

Debug output from server: " . $yubi->getLastResponse(); } else { print "

You are authenticated!"; } ?> ----------- ==== API demo Provided in the package is also a script https://github.com/Yubico/php-yubico/blob/master/demo.php[demo.php] that demonstrates how you may use the package. The script is deployed http://demo.yubico.com/php-yubico/demo.php[here]. ==== Example site There is also a complete example site that demonstrates one-factor and two-factor mode. It requires a database to store the username and passwords. Database schema is in https://github.com/Yubico/php-yubico/blob/master/example/db.sql[example/db.sql] and configuration for the database needs to go into https://github.com/Yubico/php-yubico/blob/master/example/config.php[example/config.php]. The example site is deployed http://demo.yubico.com/php-yubico[here]. === Modhex Calculator This package also includes https://github.com/Yubico/php-yubico/blob/master/example/Modhex_Calculator.php[Modhex_Calculator.php], a web page illustrating how to work with the modhex encoding. It is deployed http://demo.yubico.com/php-yubico/Modhex_Calculator.php[here] === License The project is licensed under a BSD license. See the file COPYING for exact wording. For any copyright year range specified as YYYY-ZZZZ in this package note that the range specifies every single year in that closed interval.