Source for file totp.php

Documentation is available at totp.php

  1. <?php
  2. /**
  3.  * @package    FrameworkOnFramework
  4.  * @subpackage encrypt
  5.  * @copyright  Copyright (C) 2010 - 2012 Akeeba Ltd. All rights reserved.
  6.  * @license    GNU General Public License version 2 or later; see LICENSE.txt
  7.  */
  8. defined('_JEXEC') or die;
  9.  
  10. /**
  11.  * This class provides an RFC6238-compliant Time-based One Time Passwords,
  12.  * compatible with Google Authenticator (with PassCodeLength = 6 and TimePeriod = 30).
  13.  *
  14.  * @package  FrameworkOnFramework
  15.  * @since    1.0
  16.  */
  17. class FOFEncryptTotp
  18. {
  19.     private $_passCodeLength = 6;
  20.  
  21.     private $_pinModulo;
  22.  
  23.     private $_secretLength = 10;
  24.  
  25.     private $_timeStep = 30;
  26.  
  27.     /**
  28.      * Initialises an RFC6238-compatible TOTP generator. Please note that this
  29.      * class does not implement the constraint in the last paragraph of ยง5.2
  30.      * of RFC6238. It's up to you to ensure that the same user/device does not
  31.      * retry validation within the same Time Step.
  32.      *
  33.      * @param   int  $timeStep        The Time Step (in seconds). Use 30 to be compatible with Google Authenticator.
  34.      * @param   int  $passCodeLength  The generated passcode length. Default: 6 digits.
  35.      * @param   int  $secretLength    The length of the secret key. Default: 10 bytes (80 bits).
  36.      */
  37.     public function __construct($timeStep = 30, $passCodeLength = 6, $secretLength = 10)
  38.     {
  39.         $this->_timeStep       = $timeStep;
  40.         $this->_passCodeLength = $passCodeLength;
  41.         $this->_secretLength   = $secretLength;
  42.         $this->_pinModulo      = pow(10, $this->_passCodeLength);
  43.     }
  44.  
  45.     /**
  46.      * Get the time period based on the $time timestamp and the Time Step
  47.      * defined. If $time is skipped or set to null the current timestamp will
  48.      * be used.
  49.      *
  50.      * @param   int|null $time  Timestamp
  51.      *
  52.      * @return  int  The time period since the UNIX Epoch
  53.      */
  54.     public function getPeriod($time = null)
  55.     {
  56.         if (is_null($time))
  57.         {
  58.             $time = time();
  59.         }
  60.  
  61.         $period = floor($time / $this->_timeStep);
  62.  
  63.         return $period;
  64.     }
  65.  
  66.     /**
  67.      * Check is the given passcode $code is a valid TOTP generated using secret
  68.      * key $secret
  69.      *
  70.      * @param   string  $secret  The Base32-encoded secret key
  71.      * @param   string  $code    The passcode to check
  72.      *
  73.      * @return boolean True if the code is valid
  74.      */
  75.     public function checkCode($secret, $code)
  76.     {
  77.         $time = $this->getPeriod();
  78.  
  79.         for ($i = -1; $i <= 1; $i++)
  80.         {
  81.             if ($this->getCode($secret, $time + $i) == $code)
  82.             {
  83.                 return true;
  84.             }
  85.         }
  86.  
  87.         return false;
  88.     }
  89.  
  90.     /**
  91.      * Gets the TOTP passcode for a given secret key $secret and a given UNIX
  92.      * timestamp $time
  93.      *
  94.      * @param   string  $secret  The Base32-encoded secret key
  95.      * @param   int     $time    UNIX timestamp
  96.      *
  97.      * @return string 
  98.      */
  99.     public function getCode($secret, $time = null)
  100.     {
  101.         $period = $this->getPeriod($time);
  102.         $base32 = new FOFEncryptBase32;
  103.         $secret = $base32->decode($secret);
  104.  
  105.         $time = pack("N", $period);
  106.         $time = str_pad($time, 8, chr(0), STR_PAD_LEFT);
  107.  
  108.         $hash = hash_hmac('sha1', $time, $secret, true);
  109.         $offset = ord(substr($hash, -1));
  110.         $offset = $offset & 0xF;
  111.  
  112.         $truncatedHash = $this->hashToInt($hash, $offset) & 0x7FFFFFFF;
  113.         $pinValue = str_pad($truncatedHash % $this->_pinModulo, $this->_passCodeLength, "0", STR_PAD_LEFT);
  114.  
  115.         return $pinValue;
  116.     }
  117.  
  118.     /**
  119.      * Extracts a part of a hash as an integer
  120.      *
  121.      * @param   string  $bytes  The hash
  122.      * @param   string  $start  The char to start from (0 = first char)
  123.      *
  124.      * @return  string 
  125.      */
  126.     protected function hashToInt($bytes, $start)
  127.     {
  128.         $input = substr($bytes, $start, strlen($bytes) - $start);
  129.         $val2 = unpack("N", substr($input, 0, 4));
  130.  
  131.         return $val2[1];
  132.     }
  133.  
  134.     /**
  135.      * Returns a QR code URL for easy setup of TOTP apps like Google Authenticator
  136.      *
  137.      * @param   string  $user      User
  138.      * @param   string  $hostname  Hostname
  139.      * @param   string  $secret    Secret string
  140.      *
  141.      * @return  string 
  142.      */
  143.     public function getUrl($user, $hostname, $secret)
  144.     {
  145.         $url = sprintf("otpauth://totp/%s@%s?secret=%s", $user, $hostname, $secret);
  146.         $encoder = "https://chart.googleapis.com/chart?chs=200x200&chld=Q|2&cht=qr&chl=";
  147.         $encoderURL = $encoder . urlencode($url);
  148.  
  149.         return $encoderURL;
  150.     }
  151.  
  152.     /**
  153.      * Generates a (semi-)random Secret Key for TOTP generation
  154.      *
  155.      * @return  string 
  156.      */
  157.     public function generateSecret()
  158.     {
  159.         $secret = "";
  160.  
  161.         for ($i = 1; $i <= $this->_secretLength; $i++)
  162.         {
  163.             $c = rand(0, 255);
  164.             $secret .= pack("c", $c);
  165.         }
  166.  
  167.         $base32 = new FOFEncryptBase32;
  168.  
  169.         return $base32->encode($secret);
  170.     }
  171. }

Documentation generated on Tue, 19 Nov 2013 15:15:56 +0100 by phpDocumentor 1.4.3