はじめに
これまでの学習では、Flaskを使用してWebページの表示やフォームからのデータ送信、SQLAlchemyによるデータベース操作などを学んできました。今回の学習では、これらの知識を組み合わせて、ユーザー登録・ログイン・ログアウトができる認証システムを作成します。
Webアプリケーションでは、利用者ごとに情報を管理することが一般的です。例えば、学習記録アプリケーションであれば、誰がどの学習ログを投稿したのかを管理する必要があります。
そのためには、ユーザー情報を保存するデータベースと、ログイン状態を管理する仕組みが必要になります。
1. ユーザー情報を保存するUserモデルを作成する
Userモデルとは?
最初に、ユーザー情報をデータベースへ保存するためのモデルを作成します。これまでの学習では、学習ログを保存するためにStudyLogモデルを作成しました。同じように、ユーザーの情報を保存するためにUserモデルを作成します。
今回保存する情報は以下のとおりです。
| カラム名 | 説明 |
|---|---|
| id | ユーザーを識別する番号 |
| username | ユーザー名 |
| メールアドレス | |
| password_hash | ハッシュ化されたパスワード |
| created_at | ユーザー登録日時 |
Userクラスを定義する
application/models.pyに、以下のUserクラスを追加してください。
from datetime import datetime, timezone
from .extensions import db
class User(db.Model):
__tablename__ = "users"
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), nullable=False)
email = db.Column(db.String(255), unique=True, nullable=False)
password_hash = db.Column(db.String(255), nullable=False)
created_at = db.Column(
db.DateTime,
default=lambda: datetime.now(timezone.utc).replace(tzinfo=None)
)
ここでは、まだFlask-Loginを使用しません。まずは、これまで学んだSQLAlchemyを使って、ユーザー情報を保存するテーブルの構造を定義します。unique=Trueを設定したメールアドレスには、同じ値を重複して登録できません。password_hashにはパスワードをそのまま保存せず、後ほど説明するハッシュ化された文字列を保存します。
データベースへ反映する
Userモデルを作成したら、Flask-Migrateを使用してデータベースへ反映します。
python -m flask --app app db migrate -m "Add users table"
生成されたマイグレーションスクリプトを確認した後、次のコマンドを実行します。
python -m flask --app app db upgrade
これにより、データベースにusersテーブルが作成されます。
2. Werkzeugでパスワードをハッシュ化する
Werkzeugとは?
Werkzeug(ヴェルクツォイク)は、PythonでWebアプリケーションを開発するための機能を提供するライブラリです。FlaskはWerkzeugの機能を利用して作られています。
Werkzeugには、HTTPリクエストの処理やパスワードを安全に扱うための機能などが用意されています。今回使用するのは、パスワードのハッシュ化機能です。
Werkzeugの導入
Werkzeugは通常、Flaskをインストールした際に依存ライブラリとして自動的にインストールされます。そのため、Flaskを導入済みの環境では、追加でインストールする必要はありません。以下のコマンドで確認できます。
python -m pip show Werkzeug
Werkzeugのバージョンなどが表示されれば、インストールされています。
パスワードをそのまま保存してはいけない理由
例えば、次のようなユーザー情報を考えます。
username: tanaka
email: tanaka@example.com
password: password123
このパスワードをそのままデータベースに保存すると、データが漏えいした場合に第三者がパスワードを知ることができてしまいます。そこで、パスワードをハッシュ化して保存します。
ハッシュ化とは、元の文字列を一定の計算処理によって別の文字列に変換することです。パスワード用のハッシュ化は、一方向の処理であり、元のパスワードを復元することを前提としていません。
パスワードをハッシュ化する
Werkzeugには、generate_password_hash()という関数が用意されています。まずは対話モードに設定します。対話モードはMacのターミナルで「python3」と入力するだけです。そうするとコマンドラインが「>>>」になれば対話モードになっています。次のコードを1行づつ実行してください。
from werkzeug.security import generate_password_hash
password = "password123"
hashed_password = generate_password_hash(password)
print(hashed_password)
実行すると、元のパスワードとは異なる長い文字列が出力されます。生成される文字列は実行ごとに異なりますが、これは正常な動作です。
ハッシュ化されたパスワードを照合する
ログイン時には、入力されたパスワードが正しいかどうかを確認する必要があります。そこで使用するのがcheck_password_hash()です。
from werkzeug.security import (
generate_password_hash,
check_password_hash
)
password = "password123"
hashed_password = generate_password_hash(password)
result = check_password_hash(
hashed_password,
"password123"
)
print(result)
実行結果:
True
check_password_hash()は、入力したパスワードと保存済みのハッシュが一致するかを確認します。正しければTrue、間違っていればFalseを返します。
重要: ログイン時には保存済みのハッシュを復号するのではなく、入力したパスワードと照合します。
Userモデルにメソッドを追加する
先ほど作成したUserクラスに、パスワードを設定するメソッドと確認するメソッドを追加します。
application/models.pyのUserクラス内に以下を追加してください。
from werkzeug.security import (
generate_password_hash,
check_password_hash
)
# Userクラス内に追加
def set_password(self, password):
self.password_hash = generate_password_hash(password)
def check_password(self, password):
return check_password_hash(
self.password_hash,
password
)
これにより、次のように利用できるようになります。
user.set_password("password123")
result = user.check_password("password123")
set_password()はパスワードの登録、check_password()はログイン時の照合に使用します。
ここまでで、ユーザー情報の保存とパスワードの保護ができるようになりました。
3. Flask-Loginを導入する
Flask-Loginとは?
Flask-Loginは、Flaskアプリケーションでログイン状態を管理するための拡張ライブラリです。Werkzeugがパスワードのハッシュ化や照合を担当するのに対して、Flask-Loginはログイン中のユーザー情報を管理します。
例えば、ユーザーがログインした後に別のページへ移動しても、同じユーザーとして操作を続けられるようにします。それぞれの役割は以下のようになります。
| ライブラリ | 役割 |
|---|---|
| SQLAlchemy | ユーザー情報をDBに保存する |
| Werkzeug | パスワードのハッシュ化と照合 |
| Flask-Login | ログイン状態の管理 |
Flask-Loginをインストールする
仮想環境を有効にした状態で、次のコマンドを実行してください。
python -m pip install Flask-Login
LoginManagerを定義する
既存のapplication/extensions.pyに、Flask-LoginのLoginManagerを追加します。
from flask_sqlalchemy import SQLAlchemy
from flask_login import LoginManager
db = SQLAlchemy()
login_manager = LoginManager()
LoginManagerはFlask-Loginのログイン管理機能を提供するクラスです。ここではインスタンスを作成するだけで、まだFlaskアプリケーションとは接続していません。
Flaskアプリケーションと連携する
次にapplication/__init__.pyを編集します。既存のcreate_app()の中に以下の設定を追加してください。
from .extensions import db, login_manager
# create_app()内
db.init_app(app)
login_manager.init_app(app)
login_manager.login_view = "auth.login"
login_manager.init_app(app)は、LoginManagerをFlaskアプリケーションに関連付けます。また、login_viewは、ログインしていないユーザーをログインページへ移動させるための設定です。
今回は認証用Blueprintの名前をauth、ログイン用のビュー関数名をloginとするため、auth.loginを指定します。なお、Flask-Loginはセッションを使用するため、既存のconfig.pyでSECRET_KEYが正しく設定されている必要があります。
4. UserモデルをFlask-Loginに対応させる
先ほど作成したUserモデルは、SQLAlchemyのモデルとして定義されています。しかし、Flask-Loginで使用するには、ユーザーの認証状態やユーザーIDを取得できる仕組みが必要になります。そこで利用するのがUserMixinです。
UserMixinを追加する
UserMixinとは、Flask-Loginでユーザー認証に必要な基本機能を提供するクラスです。Userクラスに継承することで、ログイン管理に必要なメソッドやプロパティを自分で定義する必要がなくなります。application/models.pyを以下のように修正します。
from flask_login import UserMixin
class User(UserMixin, db.Model):
__tablename__ = "users"
# 既存のカラム定義
# 既存のパスワード関連メソッド
変更点は、UserMixinを継承したことです。UserMixinを継承すると、Flask-Loginが必要とする基本的な機能を利用できるようになります。例えば、次のようなプロパティやメソッドが利用できます。
| 機能 | 説明 |
|---|---|
is_authenticated | 認証されたユーザーかどうか |
is_active | 有効なユーザーかどうか |
is_anonymous | 匿名ユーザーかどうか |
get_id() | ユーザーIDを文字列として取得する |
今回は、独自にこれらを実装せず、UserMixinを使用します。
ユーザーを読み込む関数を定義する
Flask-Loginでは、ログイン情報を復元する際に、保存されたユーザーIDからユーザー情報を取得する必要があります。そこでuser_loaderを定義します。application/models.pyのUserクラス定義の後に追加してください。
from .extensions import login_manager
@login_manager.user_loader
def load_user(user_id):
return db.session.get(User, int(user_id))
@login_manager.user_loaderは、Flask-Loginにユーザー情報の取得方法を登録するためのデコレータです。db.session.get(User, int(user_id))は、指定された主キーからユーザー情報を1件取得します。これでFlask-Loginがユーザー情報を読み込めるようになりました。
5. ユーザー登録機能を作成する
ここからは、実際のWeb画面を使ってユーザーを登録する処理を作成します。
登録フォームを定義する
application/forms.pyに、新規登録用のフォームを追加します。今回は、これまでの学習で使用したFlask-WTFを引き続き使用します。
from flask_wtf import FlaskForm
from wtforms import (
StringField,
PasswordField,
SubmitField
)
from wtforms.validators import (
DataRequired,
Email,
EqualTo
)
class RegisterForm(FlaskForm):
username = StringField(
"ユーザー名",
validators=[DataRequired()]
)
email = StringField(
"メールアドレス",
validators=[DataRequired(), Email()]
)
password = PasswordField(
"パスワード",
validators=[DataRequired()]
)
confirm_password = PasswordField(
"パスワード確認",
validators=[
DataRequired(),
EqualTo("password")
]
)
submit = SubmitField("登録")
Email()バリデータを利用するため、必要に応じて次のライブラリをインストールしてください。
python -m pip install email-validator
認証用Blueprintを作成する
次にapplication/routes/auth.pyを作成します。
from flask import Blueprint
auth_bp = Blueprint(
"auth",
__name__,
url_prefix="/auth"
)
このBlueprintでは、ユーザー登録やログインなどの認証に関係するルーティングをまとめて管理します。例えば、/registerというルートを定義すると、実際のURLは/auth/registerになります。
ユーザー登録処理を実装する
auth.pyに以下の処理を追加してください。
from flask import render_template, redirect, url_for, flash
from application.extensions import db
from application.models import User
from application.forms import RegisterForm
@auth_bp.route("/register", methods=["GET", "POST"])
def register():
form = RegisterForm()
if form.validate_on_submit():
existing_user = db.session.scalar(
db.select(User).filter_by(
email=form.email.data
)
)
if existing_user:
flash("このメールアドレスは登録済みです。")
return render_template(
"auth/register.html",
form=form
)
user = User(
username=form.username.data,
email=form.email.data
)
user.set_password(form.password.data)
db.session.add(user)
db.session.commit()
flash("ユーザー登録が完了しました。")
return redirect(url_for("auth.login"))
return render_template(
"auth/register.html",
form=form
)
ここで重要な処理は次の部分です。
user = User(
username=form.username.data,
email=form.email.data
)
フォームに入力された情報からUserインスタンスを作成します。その後、次のコードでパスワードをハッシュ化します。
user.set_password(form.password.data)
最後にSQLAlchemyで保存します。
db.session.add(user)
db.session.commit()
このように、ユーザー登録処理では、これまで学んだフォーム処理とデータベース操作の知識を利用します。登録画面templates/auth/register.htmlは、既存のフォーム演習と同様にbase.htmlを継承し、form.hidden_tag()を含めて作成してください。各フィールドのエラーも表示するようにします。
6. ログイン機能を作成する
ユーザー登録機能が完成したら、登録したユーザーがログインできるようにします。ログイン処理では、以下の2つを確認します。
- 入力されたメールアドレスのユーザーが存在するか
- 入力されたパスワードが正しいか
両方の条件を満たした場合のみ、ログインを許可します。
ログインフォームを作成する
application/forms.pyに以下を追加してください。
class LoginForm(FlaskForm):
email = StringField(
"メールアドレス",
validators=[DataRequired(), Email()]
)
password = PasswordField(
"パスワード",
validators=[DataRequired()]
)
submit = SubmitField("ログイン")
login_user()とは?
Flask-Loginには、ユーザーをログイン状態にするためのlogin_user()という関数があります。基本構文は以下のとおりです。
login_user(user)
userには、データベースから取得したUserオブジェクトを指定します。この関数を実行することで、Flask-Loginがセッションを利用してログイン状態を管理します。
ログイン処理を実装する
application/routes/auth.pyにログイン処理を追加します。
from flask_login import login_user
from application.forms import LoginForm
@auth_bp.route("/login", methods=["GET", "POST"])
def login():
form = LoginForm()
if form.validate_on_submit():
user = db.session.scalar(
db.select(User).filter_by(
email=form.email.data
)
)
if user and user.check_password(
form.password.data
):
login_user(user)
return redirect(
url_for("auth.mypage")
)
flash("メールアドレスまたはパスワードが正しくありません。")
return render_template(
"auth/login.html",
form=form
)
今回のログイン処理で重要な部分は以下です。
user.check_password(form.password.data)
STEP 2で作成したメソッドを呼び出しています。パスワードが正しい場合は、次の関数を実行します。
login_user(user)
これでログイン状態になります。続いて、templates/auth/login.htmlを作成し、ログインフォームを表示できるようにしてください。ログインに成功したらマイページへ移動し、失敗した場合はエラーメッセージを表示します。
7. ログアウト機能を作成する
ログアウト処理では、Flask-Loginが提供するlogout_user()を使用します。logout_user()は現在のログイン状態を解除する関数です。auth.pyに追加してください。
from flask_login import login_required, logout_user
@auth_bp.route("/logout", methods=["POST"])
@login_required
def logout():
logout_user()
return redirect(
url_for("auth.login")
)
ログアウトのように状態を変更する操作は、GETではなくPOSTで実装します。ログアウトボタンはPOSTフォームとして作成し、CSRF対策を適用してください。
8. ログイン状態を確認する
current_userとは?
Flask-Loginでは、現在ログインしているユーザーをcurrent_userで取得できます。例えば、次のようにユーザー名を取得できます。
current_user.username
ログイン中のユーザーIDを取得する場合は以下です。
current_user.id
ログイン状態を確認する
ログインしているかどうかは、次のプロパティで確認できます。
current_user.is_authenticated
この値は、認証済みユーザーの場合はTrue、未ログインユーザーの場合はFalseとなります。
ナビゲーションの表示を変更する
application/templates/base.htmlに以下の処理を追加します。
{% if current_user.is_authenticated %}
<span>{{ current_user.username }} さん</span>
<a href="{{ url_for('auth.mypage') }}">
マイページ
</a>
{% else %}
<a href="{{ url_for('auth.login') }}">
ログイン
</a>
{% endif %}
これにより、ログイン状態に応じて画面に表示する内容を変更できます。
マイページを作成する
auth.pyに以下のルートを追加してください。
from flask_login import current_user, login_required
@auth_bp.route("/mypage")
@login_required
def mypage():
return render_template(
"auth/mypage.html",
user=current_user
)
templates/auth/mypage.htmlでは、user.usernameやuser.emailを表示します。
9. ログインしていないユーザーのアクセスを制限する
ログイン機能を実装しただけでは、すべてのページへのアクセスが自動的に制限されるわけではありません。例えば、未ログインのユーザーがURLを直接入力して学習ログを投稿できてしまうと、投稿者を特定できなくなります。
そこで、特定のページにアクセス制限を設定します。
login_requiredとは?
Flask-Loginには、ログインしているユーザーのみアクセスを許可するための@login_requiredというデコレータがあります。例えば、以下のように記述します。
@login_required
このデコレータをビュー関数に設定すると、未ログインユーザーは指定されたログインページへ誘導されます。
投稿画面にアクセス制限を追加する
application/routes/logs.pyの学習ログ登録処理に追加してください。
from flask_login import login_required
@logs_bp.route("/new", methods=["GET", "POST"])
@login_required
def new_log():
# 既存の投稿処理
...
これにより、未ログインのユーザーは/logs/newにアクセスできなくなります。一方で、トップページや学習ログ一覧など、誰でも閲覧できるページには@login_requiredを設定する必要はありません。
10. 学習ログとユーザーを紐づける
最後に、ログインしたユーザーが投稿した学習ログを、そのユーザーと関連付けます。
StudyLogモデルにuser_idを追加する
application/models.pyの既存のStudyLogクラスに、次のカラムを追加してください。
user_id = db.Column(
db.Integer,
db.ForeignKey("users.id"),
nullable=False
)
user_idは、usersテーブルのidを参照する外部キーです。これによって、どのユーザーがどの学習ログを投稿したのかを管理できます。既存の学習ログが保存されている場合は、投稿者IDをどのように設定するか決めてからマイグレーションを実行してください。
投稿時にユーザーIDを設定する
学習ログを保存する処理では、ログイン中のユーザーIDを取得します。
from flask_login import current_user
new_log = StudyLog(
title=form.title.data,
body=form.body.data,
category=form.category.data,
study_time=form.study_time.data,
user_id=current_user.id
)
db.session.add(new_log)
db.session.commit()
ここでは、current_user.idによってログイン中のユーザーIDを取得しています。そのため、利用者がフォームで投稿者IDを入力する必要はありません。
なお、上記のコードはStudyLogモデルにtitle、body、category、study_timeが定義されている場合の例です。実際のモデルとフォームに合わせて修正してください。
11. Blueprintを登録する
ここまでに作成した認証用Blueprintを、Flaskアプリケーションへ登録します。
application/__init__.pyのcreate_app()内に、以下を追加します。
from .routes.auth import auth_bp
app.register_blueprint(auth_bp)
これにより、以下のURLが利用できるようになります。
| URL | 機能 |
|---|---|
| /auth/register | ユーザー登録 |
| /auth/login | ログイン |
| /auth/logout | ログアウト(POST) |
| /auth/mypage | マイページ |
なお、auth.pyは登録済みの認証用Blueprintとして読み込まれ、既存の学習ログ用Blueprintも引き続き登録する必要があります。
まとめ
今回の学習では、Flaskにユーザー認証機能を追加しました。最初にSQLAlchemyでUserモデルを作成し、Werkzeugを使用してパスワードのハッシュ化と照合を行いました。その後、Flask-Loginを導入し、login_user()、logout_user()、current_user、@login_requiredなどを使用して、ログイン状態の管理とアクセス制限を実装しました。
利用したライブラリはそれぞれ異なる役割を担当していますが、組み合わせることでユーザー認証システムを構築できます。また、ログインしていることと、すべてのデータを操作する権限があることは別の問題です。次の学習では、ユーザーごとのアクセス権限を管理し、管理者と一般ユーザーで利用できる機能を制限する仕組みを学びます。