wildwolf/yubico-otp

PHP 7-friendly alternative to the official php-yubico client

Maintainers

Details

github.com/sjinks/yubico-otp

Source

Issues

Fund package maintenance!
www.paypal.com/donate/?hosted_button_id=SAG6877JDJ3KU
send.monobank.ua/jar/7rosVfiwKM

Installs: 19 546

Dependents: 1

Suggesters: 0

Security: 0

Stars: 5

Watchers: 3

Forks: 1

Open Issues: 2

3.0.3 2024-02-19 23:37 UTC

Requires

Requires (Dev)

MIT b20251f900bd040db6c1f25375a120c495de5245

securityAuthenticationotpyubico2fa

This package is auto-updated.

Last update: 2024-12-23 00:32:34 UTC

README

CI Static Code Analysis Quality Gate Status

PHP 7/8-friendly alternative to the official php-yubico client.

Installation

composer require wildwolf/yubico-otp

Usage

$otp      = new WildWolf\Yubico\OTP($id, $secret);
$response = null;
$result   = $otp->verify($code, null, &$response);

Where:

  • $id, $secret are the Client ID and the secret key; you will need to sign up for them;
  • $code is the OTP code to verify (it will look something like ccccccjknjjnfffttntuknrfnkednknkfjegcrhhkuut; see OTP::parsePasswordOTP() for its format);
  • $result is the verification result (true for success, false for failure);
  • $response is the raw response from Yubico (details).

verify() can throw OTPBadResponseException if the response fails the basic sanity checks, OTPTamperedResponseException if the response signature fails to validate, OTPTransportException in case of the issues talking to the OTP server.