1ab3a1e186ecbebe7c0e2fbf55c99fb24b5ca704
[ga4php.git] / doco / readme.txt
1 The GA4PHP Project
2 ==================
3
4 GA4PHP means Google Authenticator for PHP.
5
6 The purpose of this "library" is to provde a convienient and
7 hopefully simple way of provisioning and authenticating users
8 using the Google Authenticator mechanism. For now this lib
9 will only support GA's hotp methods.
10
11
12 Why?
13 ====
14
15 Mostly cause I can. Recently i've been heavily interesting in
16 what is "out there" for FOSS based authentication projects and
17 the Google Authenticator is based on OATH - HOTP/TOTP. It also
18 has a few kewl features, like providing its secret key via QR
19 codes. But looking at the App's available for smartphones
20 (android, iphone, etc), the google auth app was the only one
21 that fullfilled some realistic criteria - easy to use, easy to
22 provision.
23
24
25 How?
26 ====
27
28 Ultimately, this is just a library with a web based example,
29 the purpose of which is to integrate into your exisint applications,
30 those that are PHP.
31
32
33 Complications
34 =============
35
36 The only real complication i've had so far is that alot of the
37 HOTP based keys out there provide the secret key as HEX where
38 google choose to use base32, of which there exist no single
39 or simple implementation. So I wrote my (rather terrible so far)
40 own as all i really want to do is convert from base32 back to
41 hex, this I do by converting to binary first... Lets how thats
42 going to work in the long run. The sad thing is is that if I
43 were writing it in C/C++/etc, bit math is easy and while im sure
44 its not too different in PHP, I've never done it, so this seeemed
45 easier.