streamlit-test / authenticator.py
IsaacKerson
add self.check_username to auth
7cbab12 unverified
raw history blame
No virus
9.12 kB
import jwt
import yaml
import bcrypt
import sqlite3
import os.path
import streamlit as st
from datetime import datetime, timedelta
import extra_streamlit_components as stx
class Hasher:
def __init__(self, password):
"""Create a new instance of "Hasher".
Parameters
----------
password: str
Plain text password to be hashed.
Returns
-------
str
Plain text password to be hashed.
"""
self.password = password
def hash(self, password):
"""
Parameters
----------
password: str
The plain text password to be hashed.
Returns
-------
str
The hashed password.
"""
return bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
def generate(self):
"""
Returns
-------
str
The hashed password.
"""
return self.hash(self.password)
class Authenticate:
def __init__(self, dbname, tablename, cookie_name, key, cookie_expiry_days=30):
"""Create a new instance of "Authenticate".
Parameters
----------
dbname: str
First name of user from database
dbusername: str
Username of user from database
dbpassword: str
Hashed password from database
cookie_name: str
The name of the JWT cookie stored on the client's browser for passwordless reauthentication.
key: str
The key to be used for hashing the signature of the JWT cookie.
cookie_expiry_days: int
The number of days before the cookiFe expires on the client's browser.
Returns
-------
str
Name of authenticated user.
boolean
The status of authentication, None: no credentials entered, False: incorrect credentials, True: correct credentials.
str
Username of authenticated user.
"""
self.dbname = dbname
self.dbtable = tablename
self.cookie_name = cookie_name
self.key = key
self.cookie_expiry_days = cookie_expiry_days
self.cookie_manager = stx.CookieManager()
if 'name' not in st.session_state:
st.session_state['name'] = None
if 'authentication_status' not in st.session_state:
st.session_state['authentication_status'] = None
if 'username' not in st.session_state:
st.session_state['username'] = None
if 'logout' not in st.session_state:
st.session_state['logout'] = None
def get_path(self):
dir = os.path.dirname(os.path.abspath(__file__))
return os.path.join(dir, self.dbname)
def get_connection(self):
return sqlite3.connect(self.get_path())
def check_connection(self):
try:
self.get_connection().cursor()
return True
except Exception as ex:
return False
def get_cursor(self):
return self.get_connection().cursor()
def check_username(self):
usernames = []
query = f"SELECT username FROM {self.dbtable}"
c = self.get_cursor()
for item in c.execute(query):
usernames.append(item[0])
if self.username in usernames:
return True
else:
return False
def get_hashed_password(self):
query = f'''SELECT hashed_password FROM {self.dbtable} WHERE username = ?'''
c = self.get_cursor()
c.execute(query, (self.username, ))
return c.fetchone()[0]
def token_encode(self):
"""
Returns
-------
str
The JWT cookie for passwordless reauthentication.
"""
return jwt.encode({'name':st.session_state['name'],
'username':st.session_state['username'],
'exp_date':self.exp_date}, self.key, algorithm='HS256')
def token_decode(self):
"""
Returns
-------
str
The decoded JWT cookie for passwordless reauthentication.
"""
try:
return jwt.decode(self.token, self.key, algorithms=['HS256'])
except:
return False
def exp_date(self):
"""
Returns
-------
str
The JWT cookie's expiry timestamp in Unix epoch.
"""
return (datetime.utcnow() + timedelta(days=self.cookie_expiry_days)).timestamp()
def check_pw(self):
"""
Returns
-------
boolean
The validation state for the input password by comparing it to the hashed password on disk.
"""
return bcrypt.checkpw(self.password.encode(), self.get_hashed_password().encode())
def login(self, form_name, location='main'):
"""Create a new instance of "authenticate".
Parameters
----------
form_name: str
The rendered name of the login form.
location: str
The location of the login form i.e. main or sidebar.
Returns
-------
str
Name of authenticated user.
boolean
The status of authentication, None: no credentials entered, False: incorrect credentials, True: correct credentials.
str
Username of authenticated user.
"""
if location not in ['main', 'sidebar']:
raise ValueError("Location must be one of 'main' or 'sidebar'")
if not st.session_state['authentication_status']:
self.token = self.cookie_manager.get(self.cookie_name)
if self.token is not None:
self.token = self.token_decode()
if self.token is not False:
if not st.session_state['logout']:
if self.token['exp_date'] > datetime.utcnow().timestamp():
st.session_state['name'] = self.token['name']
st.session_state['authentication_status'] = True
st.session_state['username'] = self.token['username']
if st.session_state['authentication_status'] != True:
if location == 'main':
login_form = st.form('Login')
elif location == 'sidebar':
login_form = st.sidebar.form('Login')
login_form.subheader(form_name)
self.username = login_form.text_input('Username')
st.session_state['username'] = self.username
self.password = login_form.text_input('Password', type='password')
if login_form.form_submit_button('Login'):
if self.check_username() is not None:
try:
if self.check_pw():
st.session_state['name'] = self.dbname
self.exp_date = self.exp_date()
self.token = self.token_encode()
self.cookie_manager.set(self.cookie_name, self.token,
expires_at=datetime.now() + timedelta(days=self.cookie_expiry_days))
st.session_state['authentication_status'] = True
else:
st.session_state['authentication_status'] = False
except Exception as e:
print(e)
else:
st.session_state['authentication_status'] = False
return st.session_state['name'], st.session_state['authentication_status'], st.session_state['username']
def logout(self, button_name, location='main'):
"""Creates a logout button.
Parameters
----------
button_name: str
The rendered name of the logout button.
location: str
The location of the logout button i.e. main or sidebar.
"""
if location not in ['main', 'sidebar']:
raise ValueError("Location must be one of 'main' or 'sidebar'")
if location == 'main':
if st.button(button_name):
self.cookie_manager.delete(self.cookie_name)
st.session_state['logout'] = True
st.session_state['name'] = None
st.session_state['username'] = None
st.session_state['authentication_status'] = None
elif location == 'sidebar':
if st.sidebar.button(button_name):
self.cookie_manager.delete(self.cookie_name)
st.session_state['logout'] = True
st.session_state['name'] = None
st.session_state['username'] = None
st.session_state['authentication_status'] = None