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 a25a17b..480cfd1 100755 --- a/mysql/sql/init.sql +++ b/mysql/sql/init.sql @@ -3,6 +3,7 @@ CREATE TABLE users ( userid INT UNSIGNED AUTO_INCREMENT, username VARCHAR(45) UNIQUE NOT NULL, password VARCHAR(60) NOT NULL, + temporary_password VARCHAR(60) NOT NULL DEFAULT "", full_name VARCHAR(200) NOT NULL, company VARCHAR(50), email VARCHAR(50) NOT NULL, @@ -11,8 +12,11 @@ CREATE TABLE users ( state VARCHAR(50), postal_code VARCHAR(50), country VARCHAR(50), - login_attempts INT UNSIGNED, - last_login_attempt INT UNSIGNED, + login_attempts INT UNSIGNED DEFAULT 0, + 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/register.py b/src/app/models/register.py index 2be8e1f..9782fde 100755 --- a/src/app/models/register.py +++ b/src/app/models/register.py @@ -6,7 +6,7 @@ logger = logging.getLogger(__name__) def set_user(username, password, full_name, company, email, - street_address, city, state, postal_code, country): + street_address, city, state, postal_code, country, token): """ Register a new user in the database :param username: The users unique user name @@ -19,6 +19,7 @@ def set_user(username, password, full_name, company, email, :param state: The state where the user lives :param postal_code: The corresponding postal code :param country: The users country + :param token: The account verification token :type username: str :type password: str :type full_name: str @@ -29,13 +30,19 @@ def set_user(username, password, full_name, company, email, :type state: str :type postal_code: str :type country: str + :type token: str """ db.connect() cursor = db.cursor() - query = ("INSERT INTO users VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, 0, 0)") + query = (""" + INSERT INTO users (userid, username, password, full_name, company, + email, street_address, city, state, postal_code, + country, token) + VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s) + """) try: - cursor.execute(query, (username, password, full_name, company, email, street_address, - city, state, postal_code, country)) + cursor.execute(query, (username, password, full_name, company, email, + street_address, city, state, postal_code, country, token)) db.commit() except mysql.connector.Error as err: logger.error("Failed executing query: %s", err) diff --git a/src/app/models/user.py b/src/app/models/user.py index 24dd567..a8c84b2 100755 --- a/src/app/models/user.py +++ b/src/app/models/user.py @@ -11,17 +11,20 @@ def get_user(username): :param username: The username :type username: str - :return: user + :return: A dictionary of user attributes """ db.connect() cursor = db.cursor() - query = ("SELECT userid, username, password, login_attempts, last_login_attempt from users where username = %s") - user = None + fields = [ + 'userid', 'username', 'email', 'password', 'temporary_password', + 'login_attempts', 'last_login_attempt', 'authenticator_secret', + ] + query = ("SELECT {} from users where username = %s".format(', '.join(fields))) try: cursor.execute(query, (username,)) users = cursor.fetchall() if len(users): - user = users[0] + return {fields[i]: users[0][i] for i in range(len(fields))} except mysql.connector.Error as err: logger.error("Failed executing query: %s", err) cursor.fetchall() @@ -29,7 +32,8 @@ def get_user(username): finally: cursor.close() db.close() - return user + + return None def get_users(): @@ -54,6 +58,63 @@ def get_users(): return users +def set_temporary_password(userid, password): + """ + Set a temporary password for a user + """ + db.connect() + cursor = db.cursor() + query = ("UPDATE users SET temporary_password = %s WHERE userid = %s") + try: + cursor.execute(query, (password, 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_password(userid, password): + """ + Set the password for a user + """ + db.connect() + cursor = db.cursor() + query = ("UPDATE users SET password = %s WHERE userid = %s") + try: + cursor.execute(query, (password, 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_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. @@ -122,3 +183,83 @@ def get_user_name_by_id(userid): cursor.close() db.close() return username + + +def set_token(userid, token): + """Set the given token for the given user.""" + db.connect() + cursor = db.cursor() + query = ("UPDATE users SET token=%s WHERE userid=%s") + try: + cursor.execute(query, (token, userid)) + db.commit() + except mysql.connector.Error as err: + print("Failed executing query: {}".format(err)) + cursor.fetchall() + exit(1) + finally: + cursor.close() + db.close() + + +def get_userid_from_token(token): + """Get the user with the given verify token.""" + db.connect() + cursor = db.cursor() + query = ("SELECT userid FROM users WHERE token=%s") + try: + cursor.execute(query, (token,)) + tokens = cursor.fetchall() + if tokens: + return tokens[0][0] + except mysql.connector.Error as err: + print("Failed executing query: {}".format(err)) + cursor.fetchall() + exit(1) + finally: + cursor.close() + db.close() + + return None + + +def verify_user(userid): + """ + Mark the user as verified. + """ + db.connect() + cursor = db.cursor() + query = ("UPDATE users SET verified=1 WHERE userid=%s AND verified=0") + try: + cursor.execute(query, (userid,)) + db.commit() + except mysql.connector.Error as err: + print("Failed executing query: {}".format(err)) + cursor.fetchall() + exit(1) + finally: + cursor.close() + db.close() + + +def is_verified(userid): + """ + Check whether the user has verified + """ + db.connect() + cursor = db.cursor() + query = ("SELECT userid FROM users WHERE verified=1 AND userid=%s") + try: + cursor.execute(query, (userid,)) + users = cursor.fetchall() + if users: + return True + except mysql.connector.Error as err: + print("Failed executing query: {}".format(err)) + cursor.fetchall() + exit(1) + finally: + cursor.close() + db.close() + + return False diff --git a/src/app/requirements.txt b/src/app/requirements.txt index 172cf6d..9b130fc 100755 --- a/src/app/requirements.txt +++ b/src/app/requirements.txt @@ -1,4 +1,5 @@ web.py==0.40 -mysql-connector-python==8.0.* +mysql-connector-python==8.0.5 python-dotenv bcrypt +qrcode[pil] diff --git a/src/app/templates/login.html b/src/app/templates/login.html index c98949a..d6e1199 100755 --- a/src/app/templates/login.html +++ b/src/app/templates/login.html @@ -17,6 +17,7 @@ $def with (nav, login_form, message)
$else: diff --git a/src/app/templates/reset.html b/src/app/templates/reset.html new file mode 100644 index 0000000..108f17c --- /dev/null +++ b/src/app/templates/reset.html @@ -0,0 +1,25 @@ +$def with (nav, reset_form, message) + + +$message
+ + + diff --git a/src/app/templates/reset_request.html b/src/app/templates/reset_request.html new file mode 100644 index 0000000..0445b2a --- /dev/null +++ b/src/app/templates/reset_request.html @@ -0,0 +1,25 @@ +$def with (nav, reset_request_form, message) + + +$message
+ + + diff --git a/src/app/templates/verify.html b/src/app/templates/verify.html new file mode 100644 index 0000000..b11b32c --- /dev/null +++ b/src/app/templates/verify.html @@ -0,0 +1,24 @@ +$def with (nav, success, secret, qr, message) + + +We require two-factor authentication on this site.
+Please scan the QR code, or enter the following code into your authenticator: $secret
+This code will only be displayed once.
+