surfnet/yubikey-api-client-bundle

A Symfony bundle to integrate Yubikey OTP validation service.

Maintainers

Details

github.com/SURFnet/yubikey-api-client-bundle

Source

Issues

Installs: 13 413

Dependents: 0

Suggesters: 0

Security: 0

Stars: 10

Watchers: 10

Forks: 1

Open Issues: 0

pkg:composer/surfnet/yubikey-api-client-bundle

6.0.0 2025-11-17 08:26 UTC

Requires

Requires (Dev)

Apache-2.0 c5c869c4fe2d1f96e11f596556aa50973d5976a7

yubikeyyubico

This package is auto-updated.

Last update: 2025-11-17 08:30:17 UTC

README

A Symfony bundle to integrate Yubikey's OTP validation service.

Installation

Add the bundle to your Composer file.

composer require 'surfnet/yubikey-api-client-bundle'

Add the bundle to your AppKernel.

public function registerBundles()
{
    $bundles[] = new Surfnet\YubikeyApiClientBundle\SurfnetYubikeyApiClientBundle;
}

Usage

public function fooAction()
{
    /** @var \Surfnet\YubikeyApiClientBundle\Service\VerificationService */
    $service = $this->get('surfnet_yubikey_api_client.verification_service');
    
    if (!\Surfnet\YubikeyApiClient\Otp::isValid('user-input-otp-here')) {
        // User-entered OTP string is not valid.
    }
    
    $otp = \Surfnet\YubikeyApiClient\Otp::fromString('user-input-otp-here');
    $result = $service->verify($otp);
    
    if ($result->isSuccessful()) {
        // Yubico verified OTP.
    }
}