『玩转Streamlit』--登录认证机制

如果你的Streamlit App中使用的数据的比较敏感，那么，保护这个App及其背后的数据免受未授权访问变得至关重要。

无论是出于商业机密的保护、用户隐私的维护，还是为了满足日益严格的合规要求，确保只有经过验证的用户才能访问特定的数据和功能，已成为大部分应用的一个基本需求。

登录认证，作为访问控制的基础，是保护Streamlit App安全的第一道防线。

通过实施登录认证机制，我们可以确保只有合法的用户才能访问敏感数据、执行关键操作或查看特定页面。

本文将探讨如何在Streamlit多页应用中添加登录认证功能。

从为什么需要登录认证，到如何实现这一功能，最后再构建一个示例来演示如何在自己的Streamlit App中添加登录认证功能。

1. 为什么需要登录认证

在构建Streamlit多页应用时，添加登录认证功能并不是多余的步骤，而是确保应用安全、高效和用户友好的重要一环。

一般来说，我们会在以下一些场景时需要登录认证功能。

1.1. 有数据安全性要求

如果我们的Streamlit App所处理的数据包含敏感或机密信息，比如客户数据、财务数据或研究数据。

那么，未授权的访问可能会导致数据泄露，带来不必要的麻烦。

这时，通过登录认证，至少可以确保只有经过验证的用户才能访问这些数据，能有效降低了数据泄露的风险。

另外，许多行业（如金融、医疗、教育）都有严格的数据保护规定，要求对个人信息和敏感数据进行加密存储和访问控制。登录认证是实现这些合规要求的关键组成部分。

1.2. 有用户管理需求

如果你的应用有不同角色的用户（比如分了管理员，编辑者和查看者等等），每种角色有不同的权限。

那么，首先就要实现登录认证的功能，才能进一步将你的Streamlit App和RBAC(Role Based Access Control)系统对接，实现基于角色的访问控制。

1.3. 提高用户体验

当用户看到Streamlit App采取了登录认证等安全措施时，他们会更加信任该应用，更愿意分享个人信息或使用敏感功能。

此外，登录认证允许Streamlit App识别并记住用户，从而提供个性化的体验。

例如，可以根据用户的偏好设置界面主题、保存用户的工作进度等等。

2. 如何实现登录认证

实现一个登录认证功能，主要包含以下4个部分：

1. 认证方法：常见有用户名+密码；邮箱或手机接受验证码；基于第三方的认证(OAuth/OpenID)等等
2. 用户信息数据库：一般用关系数据库来保存用户信息，用户信息一般包含用户ID、用户名、密码哈希、角色/权限等字段
3. 登录页面：根据选择的认证方法，用Streamlit实现一个页面来处理用户的输入和登录请求
4. 后端逻辑：根据选择的认证方法，后端实现对用户输入信息是否合法的判断

后端逻辑中，除了判断用户输入信息的合法性之外，有时候为了更高的安全性要求，还会加入一些密码策略（比如要求密码长度、包含特殊字符、定期更换密码等），防暴力破解的机制（比如限制登录频率，登录失败过多锁定账户等），以及其他一些攻击手段的预防。

3. 登录认证示例

最后，通过一个简化的示例演示如何在Streamlit App加入登录认证机制。

本示例主要演示Streamlit是如何限制未登录认证的用户访问具体功能页面的，不包含数据库和安全性的部分。

首先，构建一个多页应用，先不加登录功能。

工程目录结构如下：

$ tree /A /F .
登录认证
|   app.py
|
\---func_pages
        page1.py
        page2.py
        __init__.py

app.py

import streamlit as st

page1 = st.Page("pages/page1.py", title="查看数据集")
page2 = st.Page("pages/page2.py", title="绘制折线图")

pg = st.navigation({"主要功能": [page1, page2]})
pg.run()

page1.py和page2.py分别模拟了不同的功能页面。

运行效果如下：

接下来添加登录认证的功能，为了简化，登录的用户名和密码固定写死，登录状态放在session中。

将app.py改造如下

# 初始化会话状态
if "logged_in" not in st.session_state:
    st.session_state.logged_in = False


# 默认用户
USERNAME = "admin"
PASSWORD = "adminadmin"


# 登录页面
def login():
    st.header("登录")
    st.divider()

    username = st.text_input("用户名")
    password = st.text_input("密码", type="password")

    if st.button("Login"):
        if username == USERNAME and password == PASSWORD:
            st.session_state.logged_in = True
            st.success("登录成功!")
            time.sleep(0.5)
            st.rerun()
        else:
            st.error("用户名或密码错误")


page1 = st.Page("func_pages/page1.py", title="查看数据集")
page2 = st.Page("func_pages/page2.py", title="绘制折线图")
login_page = st.Page(login, title="登录")

# 默认只有login页面
pg = st.navigation([login_page])

if st.session_state.logged_in:
    pg = st.navigation({"主要功能": [page1, page2]})

pg.run()

通过状态st.session_state.logged_in来判断用户是否已经登录，

登录成功后进入【主要功能】页面，否则停留在【登录】页面。

再添加一个退出登录的函数，基于上面的代码修改如下：

def logout():
    if st.button("Logout"):
        st.session_state.logged_in = False
        st.rerun()

logout_page = st.Page(logout, title="退出登录")

if st.session_state.logged_in:
    pg = st.navigation(
        {
            "账户管理": [logout_page],
            "主要功能": [page1, page2],
        }
    )

运行效果如下：

4. 总结

本文只提供了一个基本的登录认证实现示例，实际应用中可能需要根据具体需求进行定制和扩展。

例如，可以考虑添加多因素认证、用户注册和找回密码功能、以及与第三方身份提供者（如OAuth）的集成等。