Thejesh GN avatar Thejesh GN committed ff006ba

added license and readme

Comments (0)

Files changed (2)

+#===============================================================================
+# Repo: http://code.thejeshgn.com/g2fa
+# Copyright (C) 2012 Thejesh GN <i@thejeshgn.com> http://thejeshgn.com
+#
+# 
+#
+# MIT License:
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+# of the Software, and to permit persons to whom the Software is furnished to do
+# so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#===============================================================================
+===============================================================================
+      Copyright (C) 2012 Thejesh GN <i at thejeshgn dot com >, MIT License
+===============================================================================
+Welcome
+
+Welcome to g2fa. Google two factor auth for Python based apps.
+
+Repo:
+$hg clone http://code.thejeshgn.com/g2fa
+
+
+usage:
+1. Clone or download g2fa.py
+2. Change YOUR_SECRET_INITIAL_KEY, it should be at least 16, base 32 characters, keep this secret, this could be different for different app users
+3. python g2fa.py
+4. It will print the info for testing. Most important things are otp and QR code for Google Auth android app
+5. User scans this QR code on his mobile which generates OTP on his mobile which you will compare using g2fa.py on your server side
+
+
+Ponder:
+1. Clock on server and on android need to be in sync
+
+Future:
+1. Will add verify method which will allow clients clock to drift server time by +/- <defined> minutes.
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.