PHP OTP Library compatible with Google Authenticator

Installs: 3 431

Dependents: 1

Stars: 66

Watchers: 8

Forks: 36

Language: PHP


README

Scrutinizer Quality Score Code Coverage

Build Status HHVM Status PHP 7 ready

SensioLabsInsight

Latest Stable Version Total Downloads Latest Unstable Version License

A php library for generating one time passwords according to RFC 4226 (HOTP Algorithm) and the RFC 6238 (TOTP Algorithm)

This library is compatible with Google Authenticator apps available for Android and iPhone. It is also compatible with other applications such as FreeOTP for example.

This is a fork of https://github.com/lelag/otphp with the following changes:

  • Continuous unit and functional tests using Travis-CI
  • 100% test coverage
  • Code Quality improvement
  • Better namespace usage
  • Issuer support
  • Window support
  • Completely abstract objects

The Release Process

The release process is described here.

Prerequisites

This library needs at least PHP 5.3. It has been successfully tested using PHP 5.3 to PHP 5.6, PHP 7 and HHVM

Installation

The preferred way to install this library is to rely on Composer:

composer require "spomky-labs/otphp" "~5.0.0"

Extend the library

This library only contains the logic. You must extend all classes to define setters and getters.

Look at Extend classes for more information and examples.

How to use

Your classes are ready to use? Have a look at How to use to generate your first OTP.

Contributing

Requests for new features, bug fixed and all other ideas to make this library useful are welcome. Please follow these best practices.

Licence

This software is release under MIT licence.