Authenticatron

A simple PHP script to create TOTP secrets and corresponding QR codes,
then verify the entered response over a given time variance.
homepage   documentation   glossary   server   source    

Get ready to use Authenticatron.

$auth = Authenticatron(
		string $issuerDefault = 'Example Site',
		string $phpQrCode = __DIR__ . '/_libs/phpqrcode_2010100721_1.1.4.php'
	): class

$issuerDefault is a string containing the default name you with to use to identify your app.

$phpQrCode is an optional string containing the location of the PHP QR Code Library, if diferent from the default.

Create a new Secret and get the QR Code all in one.

$auth->new(string $accountName): array

$accountName is a string containing the data your member will identify with.

Outputs an array, where Secret is the Secret for the member, URL is an OTPAuth URL, and QR is the Data64 URI for the QR code.

array(3) {
  ["Secret"]=>
  string(16) "WE3IUA7VIZN7MA45"
  ["URL"]=>
  string(126) "otpauth://totp/Authenticatron Documentation Page: Member Name?secret=WE3IUA7VIZN7MA45&issuer=Authenticatron+Documentation+Page"
  ["QR"]=>
  string(926) "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMQAAADEAQMAAAD6aBwoAAAABlBMVEUAAAD///+l2Z/dAAAACXBIWXMAAA7EAAAOxAGVKw4bAAACRUlEQVRYhbWY0W0kMQxD1YH671IdKOKjBwfcN3eDJDN+BmzZtERvVVX37v2tuX8z99L1PkGih/uZnUPqNPt1zRLeBKZu9LmW6Wv8BVHjXsOFp6Hv+UdEA+v35nDLuj8hbNQe0Mr2TYAV3jRBIf9//mknRhTYRXgSLI3cr+nizhJeTn10KMTRWt9Kkx4NflOod74kTSYUJtqrG3mYyymEuDtNSofqhryJXAepcaWaTZP2WIXKT+46YM08wkTiuNGXlNc3PimpJkzIQSSLVYzVnKnZNLnxxgJEf2RyuqSJU6r2ap2ZEI26R8m1jFAXwXkjtchhQq1QC1mPMBFohckiENJQtXX+DnKWNPmux6l2rEN2Lksoepa6daFt7PJZDpKm1vXrpZrugpEmrgxSyUVcFNl26FlClKquCrGwQ+gyTqqdIJAipaK+rUwS605FiXT7nETFiVcT2eOCiHNY6ShRidAJVtFrn+R6BiJKlJLktwR0jLVpa58XJc3o5FcWc8euKE30iOoVp104k8gT5wdlWjwDJtwWMkkWy/XZBirg4FfCBJOvtIf5ttUrXFeWEKPCQyMsJ4mwwuQVWC1moXsuLGuFBAlqXxsGOwcqVZzgrXzjQn724f25rhwp3451rDDFeDsSepTowZcIKuBaMWxdlHBR9XZhUnFfFI4swZisDZ69PULsNPlWsp2WfKVAomFC2ety4cOezPMucUKWoEiR/qaei8yT5SR9p4uLUpr4GyYtohLt+NsfV5EkqZdh8afPz7mURMkfLeVmoU9XH+4AAAAASUVORK5CYII="
}

This returns a simple boolean value to prevent data-leakage and zero-equivalent values from codes or keys.

$auth->checkCode(string $code, string $secret, int $variance = 2): bool

$code is what the user enters to authenticate. A 6 digit string, usually numeric, but not necessarily an integer.

$secret is the first result from Authenticatron_Check, that you securely stored for later.

$variance is an integer indicating the adjustment of codes with a 30 second value. Defaults to 2 either side, or 1 minute.

Outputs a boolean value, true or false.

bool(true)

Warning: The functions below are for advanced users only.

You should only need the two functions above this point to implement two-factor authentication.

Functions listed below this point should not need to be used in most production-ready environments.

Generates a 16-digit secret, never to be shared with anyone except via internal non-cachable QR code.

Generated using RandomBytes if it is available, falling back to OpenSSL if it is secure.

RandomBytes is available.

OpenSSL is installed, and secure.

Your installation will use RandomBytes.

$auth->makeSecret(int $length = 16): ?string

$length should be an integer, longer than 16. Usually left to default.

Returns a $length long string with 32bit only Characters, or null on failure (usually due to a lack of security).

Click the link to keep the secret the same when you refresh the page.

PUYGBXU4RCQVPDGL

Generates the URL for launching and adding the Secret we made earlier.

This link won't do anything unless you have a Authentication program on your computer.

$auth->getUrl(string $accountName, string $secret, string $issuer = null): string

All parameters should be strings, with the optional issuer defaulting to the configured value if not passed.

Outputs an OTPAuth URL that gives people their Secret along with a passed Member Name and an optional Issuer.

otpauth://totp/Authenticatron Documentation Page: Member Name?secret=PUYGBXU4RCQVPDGL&issuer=Authenticatron+Documentation+Page

Outputs a QR Code in Data64 for direct embedding from a given URL.

The GD functions are loaded.

generateQrCode(string $URL, int $Size = 4, int $Margin = 0, string $Level = 'M'): ?string

$URL is a valid OTPAuth URL in string form.

$Size is a non-zero integer, defaults to 4.

$Margin is an integer, defaults to 0.

$Level is a string, defaults to 'M'. It defines the error correction level.

• Level L (Low) — 7% of codewords can be restored.
• Level M (Medium) — 15% of codewords can be restored.
• Level Q (Quartile) — 25% of codewords can be restored.
• Level H (High) — 30% of codewords can be restored.

Outputs a QR Code image in 64bit data-URI form.

Try scanning this QR code with your phone.

This should open an app like Google Authenticator.

This is the current authentication code.

Check the Acceptable list to see the two either side.

getCode(string $secret, int $timestamp = null, int $codeLength = 6): string

$secret is a valid Base32 Secret in string form.

$timestamp is a unix timestamp, defaults to false to use the current timestamp.

$codeLength is a non-zero integer, the desired length of the generated code. Defaults to 6.

Outputs the calculated code for the current or provided timestamp.

string(6) "721138"

This is the array Authenticatron_Check uses to check for valid codes.

$auth->getCodesInRange(string $secret, int $variance = 2): array

$secret is a valid Base32 Secret in string form.

$variance is an integer indicating the adjustment of codes with a 30 second value. Defaults to 2, or 1 minute.

Outputs the calculated code for the current or provided timestamp.

Note the indexes, which can be used to determine the time difference, and perhaps warn users on the outer bounds.

Code generation is expensive, so avoid generating any you don't want to check against later.

array(5) {
  [-2]=>
  string(6) "527065"
  [-1]=>
  string(6) "529950"
  [0]=>
  string(6) "721138"
  [1]=>
  string(6) "808613"
  [2]=>
  string(6) "936418"
}

Your phone should produce one of these from the QR code above.

These are only valid for 30 seconds, so click the Secret link to get a new list.

Glossary

Base32 is an encoding, effectively an alphabet, that computers use made up of 32 characters.

Base32 Characters are A to Z (upper-case only), and 2 to 7.

HOTP is HMAC-based one-time password algorithm. HOTP Algorithms generate passwords from a given secret that do not expose the secret over time.

OATH is the short name for the Initiative for Open Authentication, an organisation dedicated to keeping secure authentication free.

OTP Auth stands for one-time password authentication.

QR Code (Quick Response Code) is a type of 2D matrix barcodes with built in redundancy, commonly used to scan links into mobile phones through cameras.

TOTP abbreviates Time-based One-time Password Algorithm. TOTP Algorithms generate passwords from a given secret that are only valid over a very specific time period.