おつかれさまです。今日は has_secure_password について。
ログイン機能というと gem(devise など)を入れがちですが、Railsには最初から認証の仕組みが入っています。 簡単なログインなら、これで十分だったりします。
準備するもの
2つだけです。
1. bcrypt を入れる
# Gemfile
gem 'bcrypt'
2. password_digest カラムを用意する
bin/rails g model User email:string password_digest:string
bin/rails db:migrate
カラム名は password_digest で固定です。password ではありません。
モデルに1行書く
class User < ApplicationRecord
has_secure_password
validates :email, presence: true, uniqueness: true
end
これだけで、こう書けるようになります。
user = User.create!(email: 'ota@example.com', password: 'himitsu123')
user.authenticate('himitsu123') # => user オブジェクト
user.authenticate('chigau') # => false
password というカラムは無いのに password: で作れているのがポイントです。has_secure_password が password= というメソッドを用意してくれていて、受け取った文字列をハッシュ化して password_digest に入れています。
保存されるのはハッシュ
実際に中身を見てみます。
user.password_digest
# => "$2a$12$48IdwhjTdPJSyHxMhb7pkOzkBObbtmec3J4FTnxHmX5uI.QC0EFfq"
User.column_names
# => ["id", "email", "password_digest"] ← password カラムは存在しない
生のパスワードはどこにも保存されません。 DBを直接見ても、このハッシュしか出てきません。
自動で入るバリデーション
has_secure_password は、バリデーションも用意してくれます。実際に試すとこうなりました。
User.new(email: 'x@example.com').valid?
# => false ["Password can't be blank"]
User.new(email: 'y@example.com', password: 'abc', password_confirmation: 'xyz').valid?
# => false ["Password confirmation doesn't match Password"]
- パスワード必須のチェック
- 確認用(
password_confirmation)との一致チェック
password_confirmation もカラムは不要です。フォームに password_confirmation の入力欄を置けば、勝手に照合してくれます。 ※password_confirmation属性は無しで作成も可能です
ログイン処理を書く
実際のログインはこうなります。
# config/routes.rb
resource :session, only: %i[new create destroy]
# app/controllers/sessions_controller.rb
class SessionsController < ApplicationController
def new
end
def create
user = User.find_by(email: params[:email])
if user&.authenticate(params[:password])
session[:user_id] = user.id
redirect_to root_path, notice: 'ログインしました'
else
flash.now[:alert] = 'メールアドレスかパスワードが違います'
render :new, status: :unprocessable_entity
end
end
def destroy
session.delete(:user_id)
redirect_to root_path, notice: 'ログアウトしました'
end
end
肝は user&.authenticate(params[:password]) の一行です。
authenticate は成功すると user オブジェクト、失敗すると false を返すので、そのまま if に書けます。
user.authenticate('himitsu123') # => #<User id: 1, email: "ota@example.com", ...>
user.authenticate('chigau') # => false
ログイン中のユーザーは、こう取り出します。
# app/controllers/application_controller.rb
class ApplicationController < ActionController::Base
helper_method :current_user
private
def current_user
@current_user ||= User.find_by(id: session[:user_id])
end
def require_login
redirect_to new_session_path, alert: 'ログインしてください' unless current_user
end
end
||= にしているのは、1リクエストの中で何度も呼ばれてもSQLを1回で済ませるためです。
devise を使わなくていいのか
用途によります。
has_secure_password が面倒を見てくれるのはパスワードのハッシュ化と照合だけです。以下は自分で書くことになります。
- ログイン画面とセッション管理
- パスワードリセット(メール送信、トークン管理)
- メールアドレスの確認
- ログイン失敗回数の制限
このあたりが全部必要なら devise の方が早いです。逆に「ログインできればいい」なら、has_secure_password の方が中身が見えて分かりやすいと思います。
まとめ
bcryptを入れてpassword_digestカラムを作り、モデルにhas_secure_passwordと1行書くpassword=とauthenticateが使えるようになるpassword_confirmation=も使えます。必須ではない。
- 保存されるのはハッシュだけ。
authenticateは成功すると user、失敗するとfalse- パスワード必須・確認用の一致のバリデーションは自動で入る
ps: 認証まわりは自分で書くと理解が進む
6件のコメント