forked from streamlit/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Authentication without SSO article to KB (streamlit#153)
* Add Authentication without SSO article to KB * Incorporate suggestions from PR review
- Loading branch information
1 parent
e4657d7
commit ebe4812
Showing
5 changed files
with
181 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,175 @@ | ||
--- | ||
title: Authentication without SSO | ||
slug: /knowledge-base/deploy/authentication-without-sso | ||
--- | ||
|
||
# Authentication without SSO | ||
|
||
## Introduction | ||
|
||
Want to secure your Streamlit app with passwords, but cannot implement single sign-on? We got you covered! This guide shows you two simple techniques for adding basic authentication to your Streamlit app, using [secrets management](/streamlit-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management). | ||
|
||
<Warning> | ||
|
||
While this technique adds some level of security, it is **NOT** comparable to proper authentication with an SSO provider. For enterprise use-cases, please read [Configuring Single Sign-on (SSO)](/streamlit-cloud/get-started/share-your-app/configuring-single-on-sso). | ||
|
||
</Warning> | ||
|
||
|
||
## Option 1: One global password for all users | ||
|
||
This is the easiest option! Your app will ask for a password that's shared between all users. It will be stored in the app secrets using [secrets management](/streamlit-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management). If you want to change this password or revoke a user's access, you will need to change it for everyone. If you want to have one password per user instead, jump to [Option 2 below](/knowledge-base/deploy/authentication-without-sso#option-2-individual-password-for-each-user). | ||
|
||
### Step 1: Add the password to your local app secrets | ||
|
||
Your local Streamlit app will read secrets from a file `.streamlit/secrets.toml` in your app's root dir. Create this file if it doesn't exist yet and add your password to it as shown below: | ||
|
||
```toml | ||
# .streamlit/secrets.toml | ||
|
||
password = "streamlit123" | ||
``` | ||
|
||
<Important> | ||
|
||
Be sure to add this file to your `.gitignore` so you don't commit your secrets! | ||
|
||
</Important> | ||
|
||
### Step 2: Copy your app secrets to the cloud | ||
|
||
As the `secrets.toml` file above is not committed to Github, you need to pass its content to your deployed app (on Streamlit Cloud) separately. Go to the [app dashboard](https://share.streamlit.io/) and in the app's dropdown menu, click on **Edit Secrets**. Copy the content of `secrets.toml` into the text area. More information is available at [secrets management](/streamlit-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management). | ||
|
||
 | ||
|
||
### Step 3: Ask for the password in your Streamlit app | ||
|
||
Copy the code below to your Streamlit app, insert your normal app code in the `if` statement at the bottom, and run it: | ||
|
||
```python | ||
# streamlit_app.py | ||
|
||
import streamlit as st | ||
|
||
def check_password(): | ||
"""Returns `True` if the user had the correct password.""" | ||
|
||
def password_entered(): | ||
"""Checks whether a password entered by the user is correct.""" | ||
if st.session_state["password"] == st.secrets["password"]: | ||
st.session_state["password_correct"] = True | ||
del st.session_state["password"] # don't store password | ||
else: | ||
st.session_state["password_correct"] = False | ||
|
||
if "password_correct" not in st.session_state: | ||
# First run, show input for password. | ||
st.text_input( | ||
"Password", type="password", on_change=password_entered, key="password" | ||
) | ||
return False | ||
elif not st.session_state["password_correct"]: | ||
# Password not correct, show input + error. | ||
st.text_input( | ||
"Password", type="password", on_change=password_entered, key="password" | ||
) | ||
st.error("😕 Password incorrect") | ||
return False | ||
else: | ||
# Password correct. | ||
return True | ||
|
||
if check_password(): | ||
st.write("Here goes your normal Streamlit app...") | ||
st.button("Click me") | ||
``` | ||
|
||
If everything worked out, your app should look like this: | ||
|
||
 | ||
|
||
## Option 2: Individual password for each user | ||
|
||
This option allows you to set a username and password for each user of your app. Like in [Option 1](#option-1-one-global-password-for-all-users), both values will be stored in the app secrets using [secrets management](/streamlit-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management). | ||
|
||
### Step 1: Add usernames & passwords to your local app secrets | ||
|
||
Your local Streamlit app will read secrets from a file `.streamlit/secrets.toml` in your app's root dir. Create this file if it doesn't exist yet and add the usernames & password to it as shown below: | ||
|
||
```toml | ||
# .streamlit/secrets.toml | ||
|
||
[passwords] | ||
# Follow the rule: username = "password" | ||
alice_foo = "streamlit123" | ||
bob_bar = "mycrazypw" | ||
``` | ||
|
||
<Important> | ||
|
||
Be sure to add this file to your `.gitignore` so you don't commit your secrets! | ||
|
||
</Important> | ||
|
||
Alternatively, you could set up and manage usernames & passwords via a spreadsheet or database. To use secrets to securely connect to Google Sheets, AWS, and other data providers, read our tutorials on how to [Connect Streamlit to data sources](/knowledge-base/tutorials/databases). | ||
|
||
|
||
### Step 2: Copy your app secrets to the cloud | ||
|
||
As the `secrets.toml` file above is not committed to Github, you need to pass its content to your deployed app (on Streamlit Cloud) separately. Go to the [app dashboard](https://share.streamlit.io/) and in the app's dropdown menu, click on **Edit Secrets**. Copy the content of `secrets.toml` into the text area. More information is available at [secrets management](/streamlit-cloud/get-started/deploy-an-app/connect-to-data-sources/secrets-management). | ||
|
||
 | ||
|
||
|
||
### Step 3: Ask for username & password in your Streamlit app | ||
|
||
Copy the code below to your Streamlit app, insert your normal app code in the `if` statement at the bottom, and run it: | ||
|
||
```python | ||
# streamlit_app.py | ||
|
||
import streamlit as st | ||
|
||
def check_password(): | ||
"""Returns `True` if the user had a correct password.""" | ||
|
||
def password_entered(): | ||
"""Checks whether a password entered by the user is correct.""" | ||
if ( | ||
st.session_state["username"] in st.secrets["passwords"] | ||
and st.session_state["password"] | ||
== st.secrets["passwords"][st.session_state["username"]] | ||
): | ||
st.session_state["password_correct"] = True | ||
del st.session_state["password"] # don't store username + password | ||
del st.session_state["username"] | ||
else: | ||
st.session_state["password_correct"] = False | ||
|
||
if "password_correct" not in st.session_state: | ||
# First run, show inputs for username + password. | ||
st.text_input("Username", on_change=password_entered, key="username") | ||
st.text_input( | ||
"Password", type="password", on_change=password_entered, key="password" | ||
) | ||
return False | ||
elif not st.session_state["password_correct"]: | ||
# Password not correct, show input + error. | ||
st.text_input("Username", on_change=password_entered, key="username") | ||
st.text_input( | ||
"Password", type="password", on_change=password_entered, key="password" | ||
) | ||
st.error("😕 User not known or password incorrect") | ||
return False | ||
else: | ||
# Password correct. | ||
return True | ||
|
||
if check_password(): | ||
st.write("Here goes your normal Streamlit app...") | ||
st.button("Click me") | ||
``` | ||
|
||
If everything worked out, your app should look like this: | ||
|
||
 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.