diff --git a/LICENCE.google-authenticator b/LICENCE.google-authenticator new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENCE.google-authenticator @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/mysql/sql/init.sql b/mysql/sql/init.sql index b8d4a0d..480cfd1 100755 --- a/mysql/sql/init.sql +++ b/mysql/sql/init.sql @@ -16,6 +16,7 @@ CREATE TABLE users ( last_login_attempt INT UNSIGNED DEFAULT 0, verified BOOLEAN DEFAULT 0, token VARCHAR(50) NOT NULL DEFAULT "", + authenticator_secret VARCHAR(20) NOT NULL DEFAULT "", PRIMARY KEY (userid) ); diff --git a/src/app/models/user.py b/src/app/models/user.py index f021149..a8c84b2 100755 --- a/src/app/models/user.py +++ b/src/app/models/user.py @@ -96,6 +96,25 @@ def set_password(userid, password): db.close() +def set_authenticator_secret(userid, secret): + """ + Set the password for a user + """ + db.connect() + cursor = db.cursor() + query = ("UPDATE users SET authenticator_secret = %s WHERE userid = %s") + try: + cursor.execute(query, (secret, userid)) + db.commit() + except mysql.connector.Error as err: + logger.error("Failed executing query: %s", err) + cursor.fetchall() + exit(1) + finally: + cursor.close() + db.close() + + def set_login_attempts(userid, num, timestamp): """ Set the number and timestamp of the failed login attempts for the given user. diff --git a/src/app/templates/verify.html b/src/app/templates/verify.html index 6234b27..ff776f5 100644 --- a/src/app/templates/verify.html +++ b/src/app/templates/verify.html @@ -1,4 +1,4 @@ -$def with (nav, message) +$def with (nav, success, secret, message)
We require two-factor authentication on this site.
+Please enter the following code into your authenticator: $secret
+This code will only be displayed once.
diff --git a/src/app/views/app.py b/src/app/views/app.py index 837227f..9bb9b3a 100755 --- a/src/app/views/app.py +++ b/src/app/views/app.py @@ -11,7 +11,7 @@ from views.index import Index from views.apply import Apply # Disable the debug error page -web.config.debug = False +web.config.debug = True # Define application routes urls = ( diff --git a/src/app/views/forms.py b/src/app/views/forms.py index 41d25a2..3b0332c 100755 --- a/src/app/views/forms.py +++ b/src/app/views/forms.py @@ -13,6 +13,7 @@ not_empty = form.regexp(r".+", "- This field is required") login_form = form.Form( form.Textbox("username", description="Username"), form.Password("password", description="Password"), + form.Textbox("authenticator_secret", description="Authenticator code"), form.Checkbox("remember", description= "Remember me", checked=True, value=False), form.Button("Log In", type="submit", description="Login"), ) diff --git a/src/app/views/login.py b/src/app/views/login.py index 8634808..825ebf3 100755 --- a/src/app/views/login.py +++ b/src/app/views/login.py @@ -57,7 +57,9 @@ class Login(): if user["login_attempts"] > login_attempts_threshold and user["last_login_attempt"] + login_timeout > time.time(): return render.login(nav, login_form, "- There have been too many incorrect login attempts for your account. You have to wait a minute before you can log in.") - if check_password(data.password, user["password"]): + two_factor = get_totp_token(user["authenticator_secret"]) == data.authenticator_secret + + if two_factor and check_password(data.password, user["password"]): if user["login_attempts"] > login_attempts_threshold: logger.info("User %s logged in succesfully after %s attempts", user["username"], user["login_attempts"]) @@ -71,7 +73,7 @@ class Login(): models.user.set_login_attempts(user["userid"], 0, time.time()) self.login(user["username"], user["userid"], data.remember) raise web.seeother("/") - elif check_password(data.password, user["temporary_password"]): + elif two_factor and check_password(data.password, user["temporary_password"]): session.temporary_userid = user["userid"] raise web.seeother("/reset") else: diff --git a/src/app/views/register.py b/src/app/views/register.py index 0f22574..0303c4b 100755 --- a/src/app/views/register.py +++ b/src/app/views/register.py @@ -1,7 +1,7 @@ import web from views.forms import register_form from views.utils import (get_nav_bar, csrf_protected, password_weakness, get_render, - sendmail, hash_password) + sendmail, hash_password, generate_authenticator_secret) from uuid import uuid4 import models.register import models.user @@ -97,8 +97,11 @@ class Verify: token = web.input(token='').token userid = models.user.get_userid_from_token(token) + if token and userid is not None: models.user.verify_user(userid) - return render.verify(nav, "Your email has been verified. You can log in now.") + secret = generate_authenticator_secret() + models.user.set_authenticator_secret(userid, secret) + return render.verify(nav, True, secret, "Your email has been verified.") else: - return render.verify(nav, "Invalid token. Please try again.") + return render.verify(nav, True, secret, "Invalid token. Please try again.") diff --git a/src/app/views/utils.py b/src/app/views/utils.py index e3612fc..941d61e 100755 --- a/src/app/views/utils.py +++ b/src/app/views/utils.py @@ -1,5 +1,12 @@ import web import os +import hmac +import base64 +import struct +import hashlib +import random +import string +import time import bcrypt import logging import smtplib @@ -200,3 +207,46 @@ def check_password(password, password_hash): :return: True if the password matches, or False if it doesn't """ return password and password_hash and bcrypt.checkpw(password.encode('UTF-8'), password_hash.encode('UTF-8')) + + +# Authenticator code copied from https://github.com/jakobsn/google-authenticator. +# The license for this code can be found in the file LICENSE.google-authenticator + +def get_hotp_token(secret, intervals_no): + """This is where the magic happens.""" + key = base64.b32decode(normalize(secret), True) # True is to fold lower into uppercase + msg = struct.pack(">Q", intervals_no) + h = bytearray(hmac.new(key, msg, hashlib.sha1).digest()) + o = h[19] & 15 + h = str((struct.unpack(">I", h[o:o+4])[0] & 0x7fffffff) % 1000000) + return prefix0(h) + + +def get_totp_token(secret): + """The TOTP token is just a HOTP token seeded with every 30 seconds.""" + return get_hotp_token(secret, intervals_no=int(time.time())//30) + + +def normalize(key): + """Normalizes secret by removing spaces and padding with = to a multiple of 8""" + k2 = key.strip().replace(' ', '') + # k2 = k2.upper() # skipped b/c b32decode has a foldcase argument + if len(k2) % 8 != 0: + k2 += '=' * (8 - len(k2) % 8) + return k2 + + +def prefix0(h): + """Prefixes code with leading zeros if missing.""" + if len(h) < 6: + h = '0'*(6-len(h)) + h + return h + +# End of code copied from https://github.com/jakobsn/google-authenticator. + + +def generate_authenticator_secret(): + length = 16 + alphabet = string.ascii_uppercase + + return ''.join(random.SystemRandom().choice(alphabet) for _ in range(length))