第 8 章:用户认证
目前为止,虽然程序的功能大部分已经实现,但还缺少一个非常重要的部分——用户认证保护。页面上的编辑和删除按钮是公开的,所有人都可以看到。假如我们现在把程序部署到网络上,那么任何人都可以执行编辑和删除条目的操作,这显然是不合理的。
这一章我们会为程序添加用户认证功能,这会把用户分成两类,一类是管理员,通过用户名和密码登入程序,可以执行数据相关的操作;另一个是访客,只能浏览页面。在此之前,我们先来看看密码应该如何安全的存储到数据库中。

安全存储密码

把密码明文存储在数据库中是极其危险的,假如攻击者窃取了你的数据库,那么用户的账号和密码就会被直接泄露。更保险的方式是对每个密码进行计算生成独一无二的密码散列值,这样即使攻击者拿到了散列值,也几乎无法逆向获取到密码。
Flask 的依赖 Werkzeug 内置了用于生成和验证密码散列值的函数,werkzeug.security.generate_password_hash() 用来为给定的密码生成密码散列值,而 werkzeug.security.check_password_hash() 则用来检查给定的散列值和密码是否对应。使用示例如下所示:
1
>>> from werkzeug.security import generate_password_hash, check_password_hash
2
>>> pw_hash = generate_password_hash('dog') # 为密码 dog 生成密码散列值
3
>>> pw_hash # 查看密码散列值
4
'pbkdf2:sha256:50000$mm9UPTRI$ee68ebc71434a4405a28d34ae3f170757fb424663dc0ca15198cb881edc0978f'
5
>>> check_password_hash(pw_hash, 'dog') # 检查散列值是否对应密码 dog
6
True
7
>>> check_password_hash(pw_hash, 'cat') # 检查散列值是否对应密码 cat
8
False
Copied!
我们在存储用户信息的 User 模型类添加 username 字段和 password_hash 字段,分别用来存储登录所需的用户名和密码散列值,同时添加两个方法来实现设置密码和验证密码的功能:
1
from werkzeug.security import generate_password_hash, check_password_hash
2
3
class User(db.Model):
4
id = db.Column(db.Integer, primary_key=True)
5
name = db.Column(db.String(20))
6
username = db.Column(db.String(20)) # 用户名
7
password_hash = db.Column(db.String(128)) # 密码散列值
8
9
def set_password(self, password): # 用来设置密码的方法,接受密码作为参数
10
self.password_hash = generate_password_hash(password) # 将生成的密码保持到对应字段
11
12
def validate_password(self, password): # 用于验证密码的方法,接受密码作为参数
13
return check_password_hash(self.password_hash, password) # 返回布尔值
Copied!
因为模型(表结构)发生变化,我们需要重新生成数据库(这会清空数据):
1
(env) $ flask initdb --drop
Copied!

生成管理员账户

因为程序只允许一个人使用,没有必要编写一个注册页面。我们可以编写一个命令来创建管理员账户,下面是实现这个功能的 admin() 函数:
1
import click
2
3
@app.cli.command()
4
@click.option('--username', prompt=True, help='The username used to login.')
5
@click.option('--password', prompt=True, hide_input=True, confirmation_prompt=True, help='The password used to login.')
6
def admin(username, password):
7
"""Create user."""
8
db.create_all()
9
10
user = User.query.first()
11
if user is not None:
12
click.echo('Updating user...')
13
user.username = username
14
user.set_password(password) # 设置密码
15
else:
16
click.echo('Creating user...')
17
user = User(username=username, name='Admin')
18
user.set_password(password) # 设置密码
19
db.session.add(user)
20
21
db.session.commit() # 提交数据库会话
22
click.echo('Done.')
Copied!
使用 click.option() 装饰器设置的两个选项分别用来接受输入用户名和密码。执行 flask admin 命令,输入用户名和密码后,即可创建管理员账户。如果执行这个命令时账户已存在,则更新相关信息:
1
(env) $ flask admin
2
Username: greyli
3
Password: 123 # hide_input=True 会让密码输入隐藏
4
Repeat for confirmation: 123 # confirmation_prompt=True 会要求二次确认输入
5
Updating user...
6
Done.
Copied!

使用 Flask-Login 实现用户认证

扩展 Flask-Login 提供了实现用户认证需要的各类功能函数,我们将使用它来实现程序的用户认证,首先来安装它:
1
(env) $ pip install flask-login
Copied!
这个扩展的初始化步骤稍微有些不同,除了实例化扩展类之外,我们还要实现一个“用户加载回调函数”,具体代码如下所示:
app.py:初始化 Flask-Login
1
from flask_login import LoginManager
2
3
login_manager = LoginManager(app) # 实例化扩展类
4
5
@login_manager.user_loader
6
def load_user(user_id): # 创建用户加载回调函数,接受用户 ID 作为参数
7
user = User.query.get(int(user_id)) # 用 ID 作为 User 模型的主键查询对应的用户
8
return user # 返回用户对象
Copied!
Flask-Login 提供了一个 current_user 变量,注册这个函数的目的是,当程序运行后,如果用户已登录, current_user 变量的值会是当前用户的用户模型类记录。
另一个步骤是让存储用户的 User 模型类继承 Flask-Login 提供的 UserMixin 类:
1
from flask_login import UserMixin
2
3
class User(db.Model, UserMixin):
4
# ...
Copied!
继承这个类会让 User 类拥有几个用于判断认证状态的属性和方法,其中最常用的是 is_authenticated 属性:如果当前用户已经登录,那么 current_user.is_authenticated 会返回 True, 否则返回 False。有了 current_user 变量和这几个验证方法和属性,我们可以很轻松的判断当前用户的认证状态。

登录

登录用户使用 Flask-Login 提供的 login_user() 函数实现,需要传入用户模型类对象作为参数。下面是用于显示登录页面和处理登录表单提交请求的视图函数:
app.py:用户登录
1
from flask_login import login_user
2
3
# ...
4
5
@app.route('/login', methods=['GET', 'POST'])
6
def login():
7
if request.method == 'POST':
8
username = request.form['username']
9
password = request.form['password']
10
11
if not username or not password:
12
flash('Invalid input.')
13
return redirect(url_for('login'))
14
15
user = User.query.first()
16
# 验证用户名和密码是否一致
17
if username == user.username and user.validate_password(password):
18
login_user(user) # 登入用户
19
flash('Login success.')
20
return redirect(url_for('index')) # 重定向到主页
21
22
flash('Invalid username or password.') # 如果验证失败,显示错误消息
23
return redirect(url_for('login')) # 重定向回登录页面
24
25
return render_template('login.html')
Copied!
下面是包含登录表单的登录页面模板:
templates/login.html:登录页面
1
{% extends 'base.html' %}
2
3
{% block content %}
4
<h3>Login</h3>
5
<form method="post">
6
Username<br>
7
<input type="text" name="username" required><br><br>
8
Password<br>
9
<!-- 密码输入框的 type 属性使用 password,会将输入值显示为圆点 -->
10
<input type="password" name="password" required><br><br>
11
<input class="btn" type="submit" name="submit" value="Submit">
12
</form>
13
{% endblock %}
Copied!

登出

和登录相对,登出操作则需要调用 logout_user() 函数,使用下面的视图函数实现:
1
from flask_login import login_required, logout_user
2
3
# ...
4
5
@app.route('/logout')
6
@login_required # 用于视图保护,后面会详细介绍
7
def logout():
8
logout_user() # 登出用户
9
flash('Goodbye.')
10
return redirect(url_for('index')) # 重定向回首页
Copied!
实现了登录和登出后,我们先来看看认证保护,最后再把对应这两个视图函数的登录/登出链接放到导航栏上。

认证保护

在 Web 程序中,有些页面或 URL 不允许未登录的用户访问,而页面上有些内容则需要对未登陆的用户隐藏,这就是认证保护。

视图保护

在视图保护层面来说,未登录用户不能执行下面的操作:
  • 访问编辑页面
  • 访问设置页面
  • 执行注销操作
  • 执行删除操作
  • 执行添加新条目操作
对于不允许未登录用户访问的视图,只需要为视图函数附加一个 login_required 装饰器就可以将未登录用户拒之门外。以删除条目视图为例:
1
@app.route('/movie/delete/<int:movie_id>', methods=['POST'])
2
@login_required # 登录保护
3
def delete(movie_id):
4
movie = Movie.query.get_or_404(movie_id)
5
db.session.delete(movie)
6
db.session.commit()
7
flash('Item deleted.')
8
return redirect(url_for('index'))
Copied!
添加了这个装饰器后,如果未登录的用户访问对应的 URL,Flask-Login 会把用户重定向到登录页面,并显示一个错误提示。为了让这个重定向操作正确执行,我们还需要把 login_manager.login_view 的值设为我们程序的登录视图端点(函数名),把下面这一行代码放到 login_manager 实例定义下面即可:
1
login_manager.login_view = 'login'
Copied!
提示 如果你需要的话,可以通过设置 login_manager.login_message 来自定义错误提示消息。
编辑视图同样需要附加这个装饰器:
1
@app.route('/movie/edit/<int:movie_id>', methods=['GET', 'POST'])
2
@login_required
3
def edit(movie_id):
4
# ...
Copied!
创建新条目的操作稍微有些不同,因为对应的视图同时处理显示页面的 GET 请求和创建新条目的 POST 请求,我们仅需要禁止未登录用户创建新条目,因此不能使用 login_required,而是在函数内部的 POST 请求处理代码前进行过滤:
1
from flask_login import login_required, current_user
2
3
# ...
4
5
@app.route('/', methods=['GET', 'POST'])
6
def index():
7
if request.method == 'POST':
8
if not current_user.is_authenticated: # 如果当前用户未认证
9
return redirect(url_for('index')) # 重定向到主页
10
# ...
Copied!
最后,我们为程序添加一个设置页面,支持修改用户的名字:
app.py:支持设置用户名字
1
from flask_login import login_required, current_user
2
3
# ...
4
5
@app.route('/settings', methods=['GET', 'POST'])
6
@login_required
7
def settings():
8
if request.method == 'POST':
9
name = request.form['name']
10
11
if not name or len(name) > 20:
12
flash('Invalid input.')
13
return redirect(url_for('settings'))
14
15
current_user.name = name
16
# current_user 会返回当前登录用户的数据库记录对象
17
# 等同于下面的用法
18
# user = User.query.first()
19
# user.name = name
20
db.session.commit()
21
flash('Settings updated.')
22
return redirect(url_for('index'))
23
24
return render_template('settings.html')
Copied!
下面是对应的模板:
templates/settings.html:设置页面模板
1
{% extends 'base.html' %}
2
3
{% block content %}
4
<h3>Settings</h3>
5
<form method="post">
6
Your Name <input type="text" name="name" autocomplete="off" required value="{{ current_user.name }}">
7
<input class="btn" type="submit" name="submit" value="Save">
8
</form>
9
{% endblock %}
Copied!

模板内容保护

认证保护的另一形式是页面模板内容的保护。比如,不能对未登录用户显示下列内容:
  • 创建新条目表单
  • 编辑按钮
  • 删除按钮
这几个元素的定义都在首页模板(index.html)中,以创建新条目表单为例,我们在表单外部添加一个 if 判断:
1
<!-- 在模板中可以直接使用 current_user 变量 -->
2
{% if current_user.is_authenticated %}
3
<form method="post">
4
Name <input type="text" name="title" autocomplete="off" required>
5
Year <input type="text" name="year" autocomplete="off" required>
6
<input class="btn" type="submit" name="submit" value="Add">
7
</form>
8
{% endif %}
Copied!
在模板渲染时,会先判断当前用户的登录状态(current_user.is_authenticated)。如果用户没有登录(current_user.is_authenticated 返回 False),就不会渲染表单部分的 HTML 代码,即上面代码块中 `
` 之间的代码。类似的还有编辑和删除按钮:
1
{% if current_user.is_authenticated %}
2
<a class="btn" href="{{ url_for('edit', movie_id=movie.id) }}">Edit</a>
3
<form class="inline-form" method="post" action="{{ url_for('.delete', movie_id=movie.id) }}">
4
<input class="btn" type="submit" name="delete" value="Delete" onclick="return confirm('Are you sure?')">
5
</form>
6
{% endif %}
Copied!
有些地方则需要根据登录状态分别显示不同的内容,比如基模板(base.html)中的导航栏。如果用户已经登录,就显示设置和登出链接,否则显示登录链接:
1
{% if current_user.is_authenticated %}
2
<li><a href="{{ url_for('settings') }}">Settings</a></li>
3
<li><a href="{{ url_for('logout') }}">Logout</a></li>
4
{% else %}
5
<li><a href="{{ url_for('login') }}">Login</a></li>
6
{% endif %}
Copied!
现在的程序中,未登录用户看到的主页如下所示:
对未登录用户显示的主页
在登录页面,输入用户名和密码登入:
登录
登录后看到的主页如下所示:
对已登录用户显示的主页

本章小结

添加用户认证后,在功能层面,我们的程序基本算是完成了。结束前,让我们提交代码:
1
$ git add .
2
$ git commit -m "User authentication with Flask-Login"
3
$ git push
Copied!
提示 你可以在 GitHub 上查看本书示例程序的对应 commit:6c60b7d

进阶提示