PHPackages firesphere/yubiauth - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Authentication & Authorization](/categories/authentication) 4. / 5. firesphere/yubiauth ActiveSilverstripe-vendormodule[Authentication & Authorization](/categories/authentication) firesphere/yubiauth =================== Enable authentication with a Yubikey 2.2.0(8y ago)51312[1 issues](https://github.com/Firesphere/silverstripe-yubiauth/issues)BSD-3-ClausePHP Since Nov 12Pushed 7y ago3 watchersCompare [ Source](https://github.com/Firesphere/silverstripe-yubiauth)[ Packagist](https://packagist.org/packages/firesphere/yubiauth)[ RSS](/packages/firesphere-yubiauth/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (4)Dependencies (3)Versions (21)Used By (0) status ====== [](#status) [![Scrutinizer Status](https://camo.githubusercontent.com/37814baabd7dd25463d6d6a9d98f2bd1e3a6d58feb0a772648c042972adfbd1a/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f466972657370686572652f73696c7665727374726970652d79756269617574682f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/Firesphere/silverstripe-yubiauth)[![License](https://camo.githubusercontent.com/da99ff0534432b829ec0f11293d137588a3c47904667565d5baf522df2a228ad/68747470733a2f2f706f7365722e707567782e6f72672f666972657370686572652f79756269617574682f6c6963656e73653f666f726d61743d666c617453)](https://packagist.org/packages/firesphere/yubiauth)[![CircleCI](https://camo.githubusercontent.com/c9a48e5310a8fe76d7f5812f350d0f7d897d482a31647b4a0c6c56e4f810c522/68747470733a2f2f636972636c6563692e636f6d2f67682f466972657370686572652f73696c7665727374726970652d79756269617574682f747265652f6d61737465722e7376673f7374796c653d737667)](https://circleci.com/gh/Firesphere/silverstripe-yubiauth/tree/master)[![codecov](https://camo.githubusercontent.com/75097c543026efea2c4ad0ef68a002e7091ec76c1658e4d12cc770b5b789d397/68747470733a2f2f636f6465636f762e696f2f67682f466972657370686572652f73696c7665727374726970652d79756269617574682f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/Firesphere/silverstripe-yubiauth)[![Maintainability](https://camo.githubusercontent.com/0c1d88a63d47e7d75ebd37ef3a4b74281538e37ca9c7defd1ead9352d286e29a/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f36613730613439363661366236373064363739392f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/Firesphere/silverstripe-yubiauth/maintainability) WARNING ======= [](#warning) Current SS4 branch is broken, based on the refactoring of authentication inside the core. Until that refactor is completed, the SS4 version of this module will not work properly. Usage ===== [](#usage) Install the module using composer: ``` composer require firesphere\yubiauth ``` Configuration ------------- [](#configuration) Configure your ClientID and API key in your environment file. ``` define('YUBIAUTH_CLIENTID', '1234'); define('YUBIAUTH_APIKEY', 'apikeyfromyubico'); // https://upgrade.yubico.com/getapikey'); ``` Options ------- [](#options) Optionally, configure your own URL endpoint in your YML file: ``` YubikeyAuthenticator: AuthURL: 'https://my-auth-url.com' ``` ### Note of caution [](#note-of-caution) If you use your own Yubikey Authentication server, any One Time Password sent to that will *not* be invalid on the public Yubico API's To disable the existing MemberAuthenticator, add the following to your `_config.php`: ``` Authenticator::unregister_authenticator('MemberAuthenticator'); ``` This is *not* a good idea to do on a dev environment ;) Configuration ============= [](#configuration-1) The amount of days, or total amount of logins without Yubikey, are set in the config.yml. You can override it in your mysite config with the following setting: ``` Firesphere\YubiAuth\YubikeyAuthenticator: MaxNoYubiLogin: 25 MaxNoYubiLoginDays: 5 ``` Requirements: ============= [](#requirements) - SilverStripe CMS 3.2 or higher - SilverStripe Framework 3.2 or higher - `enygma/yubikey` master Test your yubikey ----------------- [](#test-your-yubikey) Actual license ============== [](#actual-license) This module is published under BSD 3-clause license, although these are not in the actual classes, the license does apply: Copyright (c) 2012-NOW(), Simon "Sphere" Erkelens All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: ``` Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. ``` THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Did you read this entire readme? You rock! ========================================== [](#did-you-read-this-entire-readme-you-rock) Pictured below is a cow, just for you. ``` /( ,,,,, )\ _\,;;;;;;;,/_ .-"; ;;;;;;;;; ;"-. '.__/`_ / \ _`\__.' | (')| |(') | | .--' '--. | |/ o o \| | | / \ _..=.._ / \ /:. '._____.' \ ;::' / \ .; | _|_ _|_ ::| .-| '==o==' '|-. / | . / \ | \ | | ::| | | .| | ( ') (. )::| |: | |; U U ;|:: | `| |' | | \ U U / |' | | ##V| |_/`"""`\_| |V## ##V## ##V## ``` ### Health Score 32 — LowBetter than 72% of packages Maintenance16 Infrequent updates — may be unmaintained Popularity16 Limited adoption so far Community10 Small or concentrated contributor base Maturity72 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~36 days Recently: every ~90 days Total 11 Last Release 3102d ago Major Versions 1.1.4 → 2.02017-06-20 ### Community Maintainers ![](https://www.gravatar.com/avatar/8497c885d84e4bf94b8e6136292aa602124a50bbbb4a14ab00e1423f232e7663?d=identicon)[Firesphere](/maintainers/Firesphere) --- Top Contributors [![Firesphere](https://avatars.githubusercontent.com/u/680570?v=4)](https://github.com/Firesphere "Firesphere (4 commits)") --- Tags hacktoberfestsecurityAuthenticationsilverstripemoduleyubikey ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/firesphere-yubiauth/health.svg) ``` [![Health](https://phpackages.com/badges/firesphere-yubiauth/health.svg)](https://phpackages.com/packages/firesphere-yubiauth) ``` ### Alternatives [lusitanian/oauth PHP 7.2 oAuth 1/2 Library 1.1k23.2M121](/packages/lusitanian-oauth)[silverstripe/mfa Enable multi-factor authentication with fallback codes 10346.1k8](/packages/silverstripe-mfa) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)