在线版的内容可能落后于电子书,如果想及时获得更新,请购买电子书

第 12 章 重设密码

完成账户激活功能后(从而确认了用户的电子邮件地址可用),我们可以实现密码重设功能了,以防用户忘记密码。我们将看到,密码重设的很多步骤和账户激活类似,所以这里会用到第 11 章学到的知识。不过,开头不一样,与账户激活功能不同的是,密码重设要修改一个视图,还要创建两个新表单(用于提交电子邮件地址和设定新密码)。

编写代码之前,我们先构思要实现的重设密码步骤。首先,我们要在演示应用的登录表单中添加“forgot password”(忘记密码)链接,如图 12.1 所示。

login forgot password mockup
图 12.1:“forgot password”链接的构思图

点击“forgot password”链接后打开一个页面,这个页面中有一个表单,要求输入电子邮件地址,用户提交之后,应用向这个地址发送一封包含密码重设链接的邮件,如图 12.2 所示。

forgot password form mockup
图 12.2:“Forgot password”表单的构思图

点击密码重设链接会打开一个表单,用户在这个表单中重设密码(还要填写密码确认),如图 12.3 所示。

reset password form mockup
图 12.3:“Reset password”表单的构思图

如果你读完了第 11 章,已经有了密码重设邮件程序(代码清单 11.6)。本节将完成剩下的工作,为密码重设功能添加资源和数据模型。重设密码功能在 12.3 节实现。

与账户激活功能一样,我们要把“密码重设”看做一个资源,每个重设密码操作都有一个重设令牌和对应的摘要。主要的步骤如下:

  1. 用户请求重设密码时,使用提交的电子邮件地址查找用户;

  2. 如果数据库中有这个电子邮件地址,生成一个重设令牌和对应的摘要;

  3. 把重设摘要保存在数据库中,然后给用户发送一封邮件,其中有一个包含重设令牌和用户电子邮件地址的链接;

  4. 用户点击链接后,使用电子邮件地址查找用户,然后对比令牌和摘要;

  5. 如果通过身份验证,显示重设密码表单。

12.1 PasswordResets 资源

与会话(8.1 节)和账户激活(第 11 章)一样,我们要把“密码重设”看做一个资源(PasswordResets),不过这个资源不对应 Active Record 模型,相关的数据(包括重设令牌)存储在 User 模型中。

我们将把“密码重设”看做一个资源,因此要使用标准的 REST URL 与之交互。处理激活链接只需 edit 一个动作,而这里要渲染 newedit 表单,处理密码重设请求,还要创建和更新密码,因此最终共计要使用四个 REST 式路由。

与之前一样,我们要在主题分支中实现这个新功能:

$ git checkout -b password-reset

12.1.1 PasswordResets 控制器

首先,生成 PasswordResets 控制器,并且根据上述讨论,指定 newedit 两个动作:

$ rails generate controller PasswordResets new edit --no-test-framework

注意,我们指定了一个旗标,不让 Rails 生成测试。这是因为我们不需要控制器测试,而将继续使用 11.3.3 节编写的集成测试。

我们需要两个表单,一个请求重设密码(图 12.2),一个修改 User 模型中的密码(图 12.3),所以需要为 newcreateeditupdate 四个动作定义路由——通过代码清单 12.1 中高亮显示的那条 resources 规则实现。

代码清单 12.1:添加 PasswordResets 资源的路由
config/routes.rb
Rails.application.routes.draw do
  root   'static_pages#home'
  get    '/help',    to: 'static_pages#help'
  get    '/about',   to: 'static_pages#about'
  get    '/contact', to: 'static_pages#contact'
  get    '/signup',  to: 'users#new'
  get    '/login',   to: 'sessions#new'
  post   '/login',   to: 'sessions#create'
  delete '/logout',  to: 'sessions#destroy'
  resources :users
  resources :account_activations, only: [:edit]
  resources :password_resets,     only: [:new, :create, :edit, :update]
end

添加这个规则后,得到了表 12.1 中的 REST 式路由。

表 12.1:在代码清单 12.1 中添加那条规则后得到的 REST 式路由
HTTP 请求 URL 动作 具名路由

GET

/password_resets/new

new

new_password_reset_path

POST

/password_resets

create

password_resets_path

GET

/password_resets/<token>/edit

edit

edit_password_reset_url(token)

PATCH

/password_resets/<token>

update

password_reset_path(token)

通过表中第一个路由可以得到指向“Forgot password”表单的链接:

new_password_reset_path

把这个链接添加到登录表单,如代码清单 12.2 所示。添加后的效果如图 12.4 所示。

代码清单 12.2:添加打开忘记密码表单的链接
app/views/sessions/new.html.erb
<% provide(:title, "Log in") %>
<h1>Log in</h1>

<div class="row">
  <div class="col-md-6 col-md-offset-3">
    <%= form_for(:session, url: login_path) do |f| %>

      <%= f.label :email %>
      <%= f.email_field :email, class: 'form-control' %>

      <%= f.label :password %>
      <%= link_to "(forgot password)", new_password_reset_path %>
      <%= f.password_field :password, class: 'form-control' %>

      <%= f.label :remember_me, class: "checkbox inline" do %>
        <%= f.check_box :remember_me %>
        <span>Remember me on this computer</span>
      <% end %>

      <%= f.submit "Log in", class: "btn btn-primary" %>
    <% end %>

    <p>New user? <%= link_to "Sign up now!", signup_path %></p>
  </div>
</div>
练习
  1. 确认测试组件仍能通过。

  2. 表 12.1 为什么列出具名路由的 _url 形式,而不是 _path 形式?提示:我们将在电子邮件中使用链接。

12.1.2 请求重设密码

请求重设密码之前,我们要定义数据模型。密码重设所需的数据模型与账户激活的类似(图 11.1)。参照“记住我”功能(9.1 节)和账户激活功能(第 11 章),密码重设需要一个虚拟的重设令牌属性,在重设密码的邮件中使用,以及对应的重设摘要,用于检索用户。如果存储未哈希的令牌,能访问数据库的攻击者就能发送一封重设密码邮件给用户,然后使用令牌和邮件地址访问对应的密码重设链接,从而获得账户控制权。因此,必须存储令牌的摘要。为了进一步保障安全,我们还计划过几个小时后让重设链接失效,所以要记录重设邮件发送的时间。据此,我们要添加两个属性:reset_digestreset_sent_at,如图 12.5 所示。

user model password reset
图 12.5:添加密码重设相关属性后的 User 模型

执行下面的命令,创建添加这两个属性的迁移:

$ rails generate migration add_reset_to_users reset_digest:string \
> reset_sent_at:datetime

(前面说过,第二行开头的 > 是“行接续”符号,是 shell 自动插入的,无需输入。)

然后像之前一样执行迁移:

$ rails db:migrate

我们要参照前面为没有模型的资源编写表单的方式,即创建新会话的登录表单(代码清单 8.4),编写请求重设密码的表单。为了便于参考,我们再把那个表单列出来,如代码清单 12.3 所示。

代码清单 12.3:登录表单的代码
app/views/sessions/new.html.erb
<% provide(:title, "Log in") %>
<h1>Log in</h1>

<div class="row">
  <div class="col-md-6 col-md-offset-3">
    <%= form_for(:session, url: login_path) do |f| %>

      <%= f.label :email %>
      <%= f.email_field :email, class: 'form-control' %>

      <%= f.label :password %>
      <%= f.password_field :password, class: 'form-control' %>

      <%= f.label :remember_me, class: "checkbox inline" do %>
        <%= f.check_box :remember_me %>
        <span>Remember me on this computer</span>
      <% end %>

      <%= f.submit "Log in", class: "btn btn-primary" %>
    <% end %>

    <p>New user? <%= link_to "Sign up now!", signup_path %></p>
  </div>
</div>

请求重设密码的表单和代码清单 12.3 有很多共通之处,二者之间最大的区别是,form_for 中的资源和地址不一样,而且也没有密码字段。请求重设密码的表单如代码清单 12.4 所示,渲染的结果如图 12.6 所示。

代码清单 12.4:请求重设密码页面的视图
app/views/password_resets/new.html.erb
<% provide(:title, "Forgot password") %>
<h1>Forgot password</h1>

<div class="row">
  <div class="col-md-6 col-md-offset-3">
    <%= form_for(:password_reset, url: password_resets_path) do |f| %>
      <%= f.label :email %>
      <%= f.email_field :email, class: 'form-control' %>

      <%= f.submit "Submit", class: "btn btn-primary" %>
    <% end %>
  </div>
</div>
forgot password form
图 12.6:“Forgot Password”表单
练习
  1. 代码清单 12.4 中,传给 form_for 的为什么是 :password_reset,而不是 @password_reset

12.1.3 PasswordResets 控制器的 create 动作

提交图 12.6 中的表单后,我们要通过电子邮件地址查找用户,更新这个用户的 reset_tokenreset_digestreset_sent_at 属性,然后重定向到根地址,并显示一个闪现消息。与登录一样(代码清单 8.11),如果提交的数据无效,我们要重新渲染页面,并且使用 flash.now 显示一个闪现消息。[1]据此写出的 create 动作如代码清单 12.5 所示。

代码清单 12.5PasswordResets 控制器的 create 动作
app/controllers/password_resets_controller.rb
class PasswordResetsController < ApplicationController

  def new
  end

  def create
    @user = User.find_by(email: params[:password_reset][:email].downcase)
    if @user
      @user.create_reset_digest
      @user.send_password_reset_email
      flash[:info] = "Email sent with password reset instructions"
      redirect_to root_url
    else
      flash.now[:danger] = "Email address not found"
      render 'new'
    end
  end

  def edit
  end
end

User 模型中的代码与 before_create 回调中使用的 create_activation_digest 方法(代码清单 11.3)类似,如代码清单 12.6 所示。

代码清单 12.6:在 User 模型中添加重设密码所需的方法
app/models/user.rb
class User < ApplicationRecord
  attr_accessor :remember_token, :activation_token, :reset_token
  before_save   :downcase_email
  before_create :create_activation_digest
  .
  .
  .
  # 激活账户
  def activate
    update_attribute(:activated,    true)
    update_attribute(:activated_at, Time.zone.now)
  end

  # 发送激活邮件
  def send_activation_email
    UserMailer.account_activation(self).deliver_now
  end

  # 设置密码重设相关的属性
  def create_reset_digest
    self.reset_token = User.new_token
    update_attribute(:reset_digest,  User.digest(reset_token))
    update_attribute(:reset_sent_at, Time.zone.now)
  end

  # 发送密码重设邮件
  def send_password_reset_email
    UserMailer.password_reset(self).deliver_now
  end

  private
      .
      .
      .
end

图 12.7 所示,提交无效的电子邮件地址时,应用的表现正常。为了让提交有效地址时应用也能正常运行,我们要定义发送密码重设邮件的方法。

invalid email password reset
图 12.7:提交无效电子邮件地址后显示的“Forgot Password”表单
练习
  1. 图 12.6 所示的表单中提交有效的电子邮件地址,会看到什么错误消息?

  2. 在 Rails 控制台中确认,虽然前一题有错误,但是 reset_digestreset_sent_at 属性有值了。这两个属性的值是什么?

12.2 密码重设邮件

前一节在 PasswordResets 控制器中定义的 create 动作基本可用,但是发送密码重设邮件的方法还没有。

如果你跟着 11.1 节做了,app/mailers/user_mailer.rb 文件中应该有一个默认生成的 password_reset 方法,这是代码清单 11.6 生成 User 邮件程序时生成的。如果你跳过了第 11 章,可以直接复制下面的代码(不含 account_activation 及相关的方法),并且创建缺少的文件。

12.2.1 密码重设邮件程序和模板

代码清单 12.6 中我们用到了 11.3.3 节重构的成果,直接在 User 模型中使用 User 邮件程序:

UserMailer.password_reset(self).deliver_now

让这个邮件程序运作起来所需的代码几乎与 11.2 节的账户激活邮件程序一样。我们首先在 UserMailer 中定义 password_reset 方法(代码清单 12.7),然后编写邮件的纯文本视图(代码清单 12.8)和 HTML 视图(代码清单 12.9)。

代码清单 12.7:发送密码重设链接
app/mailers/user_mailer.rb
class UserMailer < ApplicationMailer

  def account_activation(user)
    @user = user
    mail to: user.email, subject: "Account activation"
  end

  def password_reset(user)
    @user = user
    mail to: user.email, subject: "Password reset"
  end
end
代码清单 12.8:密码重设邮件的纯文本视图
app/views/user_mailer/password_reset.text.erb
To reset your password click the link below:

<%= edit_password_reset_url(@user.reset_token, email: @user.email) %>

This link will expire in two hours.

If you did not request your password to be reset, please ignore this email and
your password will stay as it is.
代码清单 12.9:密码重设邮件的 HTML 视图
app/views/user_mailer/password_reset.html.erb
<h1>Password reset</h1>

<p>To reset your password click the link below:</p>

<%= link_to "Reset password", edit_password_reset_url(@user.reset_token,
                                                      email: @user.email) %>

<p>This link will expire in two hours.</p>

<p>
If you did not request your password to be reset, please ignore this email and
your password will stay as it is.
</p>

与账户激活邮件一样(11.2 节),我们可以使用 Rails 提供的邮件预览程序预览密码重设邮件。参照代码清单 11.18,密码重设邮件的预览程序如代码清单 12.10 所示。

代码清单 12.10:预览密码重设邮件所需的方法
test/mailers/previews/user_mailer_preview.rb
# Preview all emails at http://localhost:3000/rails/mailers/user_mailer
class UserMailerPreview < ActionMailer::Preview

  # Preview this email at
  # http://localhost:3000/rails/mailers/user_mailer/account_activation
  def account_activation
    user = User.first
    user.activation_token = User.new_token
    UserMailer.account_activation(user)
  end

  # Preview this email at
  # http://localhost:3000/rails/mailers/user_mailer/password_reset
  def password_reset
    user = User.first
    user.reset_token = User.new_token
    UserMailer.password_reset(user)
  end
end

然后就可以预览密码重设邮件了,HTML 格式和纯文本格式分别如图 12.8图 12.9 所示。

password reset html preview 4th ed
图 12.8:预览 HTML 格式的密码重设邮件

现在,提交有效的电子邮件地址后会看到如图 12.10 所示的页面。服务器日志中会显示相应的邮件,如代码清单 12.11 所示。

password reset text preview 4th ed
图 12.9:预览纯文本格式的密码重设邮件
valid email password reset
图 12.10:提交有效电子邮件地址后看到的页面
代码清单 12.11:服务器日志中看到的密码重设邮件
Sent mail to michael@michaelhartl.com (66.8ms)
Date: Mon, 06 Jun 2016 22:00:41 +0000
From: noreply@example.com
To: michael@michaelhartl.com
Message-ID: <5407babbee139_8722b257d04576a@mhartl-rails-tutorial-953753.mail>
Subject: Password reset
Mime-Version: 1.0
Content-Type: multipart/alternative;
 boundary="--==_mimepart_5407babbe3505_8722b257d045617";
 charset=UTF-8
Content-Transfer-Encoding: 7bit


----==_mimepart_5407babbe3505_8722b257d045617
Content-Type: text/plain;
 charset=UTF-8
Content-Transfer-Encoding: 7bit

To reset your password click the link below:

https://rails-tutorial-mhartl.c9users.io/password_resets/3BdBrXeQZSWqFIDRN8cxHA/
edit?email=michael%40michaelhartl.com

This link will expire in two hours.

If you did not request your password to be reset, please ignore this email and
your password will stay as it is.
----==_mimepart_5407babbe3505_8722b257d045617
Content-Type: text/html;
 charset=UTF-8
Content-Transfer-Encoding: 7bit

<h1>Password reset</h1>

<p>To reset your password click the link below:</p>

<a href="https://rails-tutorial-mhartl.c9users.io/
password_resets/3BdBrXeQZSWqFIDRN8cxHA/
edit?email=michael%40michaelhartl.com">Reset password</a>

<p>This link will expire in two hours.</p>

<p>
If you did not request your password to be reset, please ignore this email and
your password will stay as it is.
</p>
----==_mimepart_5407babbe3505_8722b257d045617--
练习
  1. 在浏览器中预览电子邮件模板。你看到的发送日期是什么?

  2. 在请求重设密码表单中提交有效的电子邮件地址,在服务器日志中会看到什么?

  3. 在 Rails 控制台中查找前一题中那个电子邮件地址对应的用户对象,确认它有 reset_digestreset_sent_at 属性。

12.2.2 测试电子邮件

参照账户激活邮件程序的测试(代码清单 11.20),下面为密码重设邮件程序编写一个测试,如代码清单 12.12 所示。

代码清单 12.12:添加密码重设邮件程序的测试 GREEN
test/mailers/user_mailer_test.rb
require 'test_helper'

class UserMailerTest < ActionMailer::TestCase

  test "account_activation" do
    user = users(:michael)
    user.activation_token = User.new_token
    mail = UserMailer.account_activation(user)
    assert_equal "Account activation", mail.subject
    assert_equal [user.email], mail.to
    assert_equal ["noreply@example.com"], mail.from
    assert_match user.name,               mail.body.encoded
    assert_match user.activation_token,   mail.body.encoded
    assert_match CGI.escape(user.email), mail.body.encoded
  end

  test "password_reset" do
    user = users(:michael)
    user.reset_token = User.new_token
    mail = UserMailer.password_reset(user)
    assert_equal "Password reset", mail.subject
    assert_equal [user.email], mail.to
    assert_equal ["noreply@example.com"], mail.from
    assert_match user.reset_token,        mail.body.encoded
    assert_match CGI.escape(user.email), mail.body.encoded
  end
end

现在,测试组件应该能通过:

代码清单 12.13GREEN
$ rails test
练习
  1. 只运行邮件程序的测试,能通过吗?

  2. 代码清单 12.12 中第二个测试里的 CGI.escape 去掉,确认测试会失败。

12.3 重设密码

现在能正确生成邮件了(代码清单 12.11),接下来我们要编写 PasswordResets 控制器的 edit 动作,重设用户的密码。与 11.3.3 节一样,我们将编写完整的集成测试。

12.3.1 PasswordResets 控制器的 edit 动作

密码重设邮件中有类似下面这种形式的链接:

https://example.com/password_resets/3BdBrXeQZSWqFIDRN8cxHA/edit?email=foo%40bar.com

为了让这种形式的链接生效,我们要编写一个表单,重设密码。这个表单的目的与编辑用户资料的表单(代码清单 10.2)类似,不过现在只需更新密码和密码确认两个字段。

不过,这一次处理起来有点复杂,因为我们希望通过电子邮件地址查找用户。也就是说,在 edit 动作和 update 动作中都需要使用邮件地址。在 edit 动作中可以轻易地获取邮件地址,因为链接中有。可是提交表单后,邮件地址就没有了。为了解决这个问题,我们可以使用一个隐藏字段,把它的值设为邮件地址(不会显示),和表单中的其他数据一起提交给 update 动作,如代码清单 12.14 所示。

代码清单 12.14:重设密码的表单
app/views/password_resets/edit.html.erb
<% provide(:title, 'Reset password') %>
<h1>Reset password</h1>

<div class="row">
  <div class="col-md-6 col-md-offset-3">
    <%= form_for(@user, url: password_reset_path(params[:id])) do |f| %>
      <%= render 'shared/error_messages' %>

      <%= hidden_field_tag :email, @user.email %>

      <%= f.label :password %>
      <%= f.password_field :password, class: 'form-control' %>

      <%= f.label :password_confirmation, "Confirmation" %>
      <%= f.password_field :password_confirmation, class: 'form-control' %>

      <%= f.submit "Update password", class: "btn btn-primary" %>
    <% end %>
  </div>
</div>

注意,在代码清单 12.14 中,使用的表单标签辅助方法是

hidden_field_tag :email, @user.email

而不是

f.hidden_field :email, @user.email

因为在重设密码的链接中,邮件地址在 params[:email] 中,如果使用后者,会把邮件地址放入 params[:user][:email] 中。

为了正确渲染这个表单,我们要在 PasswordResets 控制器的 edit 动作中定义 @user 变量。与账户激活一样(代码清单 11.31),我们要找到 params[:email] 中电子邮件地址对应的用户,确认这个用户已经激活,然后使用代码清单 11.26 中定义的通用版 authenticated? 方法验证 params[:id] 中的重设令牌。因为在 editupdate 动作中都要使用 @user,所以我们要把查找用户和验证令牌的代码写入一个前置过滤器中,如代码清单 12.15 所示。

代码清单 12.15PasswordResets 控制器的 edit 动作
app/controllers/password_resets_controller.rb
class PasswordResetsController < ApplicationController
  before_action :get_user,   only: [:edit, :update]
  before_action :valid_user, only: [:edit, :update]
  .
  .
  .
  def edit
  end

  private

    def get_user
      @user = User.find_by(email: params[:email])
    end

    # 确保是有效用户
    def valid_user
      unless (@user && @user.activated? &&
              @user.authenticated?(:reset, params[:id]))
        redirect_to root_url
      end
    end
end

代码清单 12.15 中的 authenticated?(:reset, params[:id])代码清单 11.28 中的 authenticated?(:remember, cookies[:remember_token]),以及代码清单 11.31 中的 authenticated?(:activation, params[:id]),就是表 11.1authenticated? 方法的三个用例。

现在,点击代码清单 12.11 中的链接后,会显示密码重设表单,如图 12.11 所示。

password reset form
图 12.11:密码重设表单
练习
  1. 点击服务器日志中的密码重设链接,看能不能正确渲染如图 12.11 所示的表单。

  2. 提交前一题看到的表单会发生什么?

12.3.2 更新密码

AccountActivations 控制器的 edit 动作只需把用户的状态由“未激活”改成“激活”,而 PasswordResets 控制器的 edit 动作处理的是表单,因此提交后要交给 update 动作处理。为了定义 update 动作,我们要考虑四种情况:

  1. 密码重设请求已过期

  2. 填写的新密码无效,更新失败

  3. 没有填写密码和密码确认,更新失败(看起来像是成功了)

  4. 成功更新密码

第一第二和第四种情况非常简单,第三种情况不是那么直观,下面会详述。

第一种情况在 editupdate 动作中都要考虑,因此可以使用前置过滤器:

before_action :check_expiration, only: [:edit, :update]    # 第一种情况

为此,我们要定义私有的 check_expiration 方法:

# 检查重设令牌是否过期
def check_expiration
  if @user.password_reset_expired?
    flash[:danger] = "Password reset has expired."
    redirect_to new_password_reset_url
  end
end

check_expiration 方法中,我们把过期检查交给实例方法 password_reset_expired? 去做。这个方法有点难定义,稍后再讲。

代码清单 12.16 给出了这两个过滤器的实现,还给出了涵盖第二第三和第四种情况的 update 动作。第二种情况会导致更新失败,然后重新渲染 edit 视图,显示错误消息(使用代码清单 12.14 中共用的局部视图)。第四种情况是成功更新密码,处理方式与成功登录类似(代码清单 8.25)。

第二种情况没有处理密码为空(即第三种情况),而现在 User 模型允许密码为空(代码清单 10.13),所以我们要捕获这个问题,然后单独处理。[2]为了处理这种情况,我们使用 errors.add 方法直接为 @user 对象添加错误消息:

@user.errors.add(:password, :blank)

密码为空时,上述代码使用没有内容时的默认消息。[3]

综上,处理四种情况的 update 动作如代码清单 12.16 所示。

代码清单 12.16:重设密码的 update 动作
app/controllers/password_resets_controller.rb
class PasswordResetsController < ApplicationController
  before_action :get_user,         only: [:edit, :update]
  before_action :valid_user,       only: [:edit, :update]
  before_action :check_expiration, only: [:edit, :update]    # 第一种情况

  def new
  end

  def create
    @user = User.find_by(email: params[:password_reset][:email].downcase)
    if @user
      @user.create_reset_digest
      @user.send_password_reset_email
      flash[:info] = "Email sent with password reset instructions"
      redirect_to root_url
    else
      flash.now[:danger] = "Email address not found"
      render 'new'
    end
  end

  def edit
  end

  def update
    if params[:user][:password].empty?                  # 第三种情况
      @user.errors.add(:password, "can't be empty")
      render 'edit'
    elsif @user.update_attributes(user_params)          # 第四种情况
      log_in @user
      flash[:success] = "Password has been reset."
      redirect_to @user
    else
      render 'edit'                                     # 第二种情况
    end
  end

  private

    def user_params
      params.require(:user).permit(:password, :password_confirmation)
    end

    # 前置过滤器

    def get_user
      @user = User.find_by(email: params[:email])
    end

    # 确保是有效用户
    def valid_user
      unless (@user && @user.activated? &&
              @user.authenticated?(:reset, params[:id]))
        redirect_to root_url
      end
    end

    # 检查重设令牌是否过期
    def check_expiration
      if @user.password_reset_expired?
        flash[:danger] = "Password reset has expired."
        redirect_to new_password_reset_url
      end
    end
end

注意,我们在 user_params 方法中指定允许修改 passwordpassword_confirmation 两个属性。

前面说过,我们把密码重设超时检查交给 User 模型去做:

@user.password_reset_expired?

所以,我们要定义 password_reset_expired? 方法。如 12.2.1 节的邮件模板所示,如果邮件发出后两个小时内没重设密码,就认为此次请求超时了。这个限制可以通过下面的 Ruby 代码实现:

reset_sent_at < 2.hours.ago

如果你把 < 当成小于号,读成“密码重设邮件发出少于两小时”就错了,这和想表达的意思正好相反。这里,最好把 < 理解成“超过”,读成“密码重设邮件已经发出超过两小时”,这才是我们想表达的意思。password_reset_expired? 方法的定义如代码清单 12.17 所示。(对这个比较算式的证明参见 12.6 节。)

代码清单 12.17:在 User 模型中定义 password_reset_expired? 方法
app/models/user.rb
class User < ApplicationRecord
  .
  .
  .
  # 如果密码重设请求超时了,返回 true
  def password_reset_expired?
    reset_sent_at < 2.hours.ago
  end

  private
    .
    .
    .
end

现在,代码清单 12.16 中的 update 动作可以使用了。密码重设失败和成功后显示的页面分别如图 12.12图 12.13 所示。(你可能不想等两个小时再确认效果,本节的练习中有一题,为第三个分支编写测试。)

练习
  1. 打开邮件中的链接,在页面中填写不一致的密码,会看到什么错误消息?

  2. 在 Rails 控制台中找到邮件中链接对应的用户,获取 password_digest 属性的值。然后在如图 12.12 所示的表单中填写匹配的密码,提交后有什么效果?对 password_digest 属性的值有什么影响?提示:使用 user.reload 方法加载新值。

password reset failure 4th ed
图 12.12:密码重设失败
password reset success 4th ed
图 12.13:密码重设成功

12.3.3 测试密码重设功能

本节,我们要编写一个集成测试,覆盖代码清单 12.16 中的两个分支:重设失败和重设成功。(前面说过,第三个分支的测试留作练习。)首先,为重设密码功能生成一个测试文件:

$ rails generate integration_test password_resets
      invoke  test_unit
      create    test/integration/password_resets_test.rb

这个测试的步骤大致与代码清单 11.33 中的账户激活测试差不多,不过开头有点不同。首先访问“Forgot password”表单,分别提交有效和无效的电子邮件地址,电子邮件地址有效时要创建密码重设令牌,并且发送重设邮件。然后,访问邮件中的链接,分别提交无效和有效的密码,验证各自的行为是否正确。最终写出的测试如代码清单 12.18 所示。这是一个不错的练习,可以锻炼阅读代码的能力。

代码清单 12.18:密码重设功能的集成测试
test/integration/password_resets_test.rb
require 'test_helper'

class PasswordResetsTest < ActionDispatch::IntegrationTest

  def setup
    ActionMailer::Base.deliveries.clear
    @user = users(:michael)
  end

  test "password resets" do
    get new_password_reset_path
    assert_template 'password_resets/new'
    # 电子邮件地址无效
    post password_resets_path, params: { password_reset: { email: "" } }
    assert_not flash.empty?
    assert_template 'password_resets/new'
    # 电子邮件地址有效
    post password_resets_path,
         params: { password_reset: { email: @user.email } }
    assert_not_equal @user.reset_digest, @user.reload.reset_digest
    assert_equal 1, ActionMailer::Base.deliveries.size
    assert_not flash.empty?
    assert_redirected_to root_url
    # 密码重设表单
    user = assigns(:user)
    # 电子邮件地址错误
    get edit_password_reset_path(user.reset_token, email: "")
    assert_redirected_to root_url
    # 用户未激活
    user.toggle!(:activated)
    get edit_password_reset_path(user.reset_token, email: user.email)
    assert_redirected_to root_url
    user.toggle!(:activated)
    # 电子邮件地址正确,令牌不对
    get edit_password_reset_path('wrong token', email: user.email)
    assert_redirected_to root_url
    # 电子邮件地址正确,令牌也对
    get edit_password_reset_path(user.reset_token, email: user.email)
    assert_template 'password_resets/edit'
    assert_select "input[name=email][type=hidden][value=?]", user.email
    # 密码和密码确认不匹配
    patch password_reset_path(user.reset_token),
          params: { email: user.email,
                    user: { password:              "foobaz",
                            password_confirmation: "barquux" } }
    assert_select 'div#error_explanation'
    # 密码为空值
    patch password_reset_path(user.reset_token),
          params: { email: user.email,
                    user: { password:              "",
                            password_confirmation: "" } }
    assert_select 'div#error_explanation'
    # 密码和密码确认有效
    patch password_reset_path(user.reset_token),
          params: { email: user.email,
                    user: { password:              "foobaz",
                            password_confirmation: "foobaz" } }
    assert is_logged_in?
    assert_not flash.empty?
    assert_redirected_to user
  end
end

代码清单 12.18 中的大多数用法前面都见过,但是针对 input 标签的测试有点陌生:

assert_select "input[name=email][type=hidden][value=?]", user.email

这行代码的意思是,页面中有 name 属性、类型(隐藏)和电子邮件地址都正确的 input 标签:

<input id="email" name="email" type="hidden" value="michael@example.com" />

现在,测试组件应该能通过:

代码清单 12.19GREEN
$ rails test
练习
  1. 代码清单 12.6 中,create_reset_digest 方法调用了两次 update_attribute 方法,每一次调用都要单独执行一个数据库事务。填写代码清单 12.20 中缺少的代码,把两个 update_attribute 调用换成一个 update_columns 调用,这样修改后只会与数据库交互一次。改完后运行测试组件,确保仍能通过。(代码清单 12.20 中包含代码清单 11.39 的解答。)

  2. 填写代码清单 12.21 中缺少的代码,为代码清单 12.16 中的密码重设请求超时分支编写集成测试。(这里使用的 response.body 用于获取返回页面中的 HTML。)检查是否过期有很多方法,这里使用的方法是,检查响应主体中是否包含单词“expired”(不区分大小写)。

  3. 几小时后让密码重设请求过期是个不错的安全防护措施,可是对使用公共电脑的用户来说,安全隐患更大。这是因为密码重设链接的有效期是 2 小时,而在这段时间内,即便用户已经退出,重设链接仍能使用。如果用户在公共电脑上重设密码,任何人都能点击后退按钮,然后再次重设密码(从而使用新密码登录)。为了避免这个问题,添加代码清单 12.22 中的代码,在用户成功修改密码后清除重设摘要。[4]

  4. 代码清单 12.18 中添加一行代码,测试前一题实现的重设摘要清除功能。提示:使用 assert_niluser.reload 直接测试 reset_digest 属性。

代码清单 12.20:使用 update_columns 的代码模板
app/models/user.rb
class User < ApplicationRecord
  attr_accessor :remember_token, :activation_token
  before_save   :downcase_email
  before_create :create_activation_digest
  .
  .
  .
  # 激活账户
  def activate
    update_columns(activated: true, activated_at: Time.zone.now)
  end

  # 发送激活邮件
  def send_activation_email
    UserMailer.account_activation(self).deliver_now
  end

  # 设置密码重设相关的属性
  def create_reset_digest
    self.reset_token = User.new_token
    update_columns(reset_digest:  FILL_IN, reset_sent_at: FILL_IN)
  end
  .
  .
  .
end
代码清单 12.21:测试密码重设请求超时 GREEN
test/integration/password_resets_test.rb
require 'test_helper'

class PasswordResetsTest < ActionDispatch::IntegrationTest

  def setup
    ActionMailer::Base.deliveries.clear
    @user = users(:michael)
  end
  .
  .
  .
  test "expired token" do
    get new_password_reset_path
    post password_resets_path,
         params: { password_reset: { email: @user.email } }

    @user = assigns(:user)
    @user.update_attribute(:reset_sent_at, 3.hours.ago)
    patch password_reset_path(@user.reset_token),
          params: { email: @user.email,
                    user: { password:              "foobar",
                            password_confirmation: "foobar" } }
    assert_response :redirect
    follow_redirect!
    assert_match /FILL_IN/i, response.body
  end
end
代码清单 12.22:成功重设密码后清除重设摘要
app/controllers/password_resets_controller.rb
class PasswordResetsController < ApplicationController
  .
  .
  .
  def update
    if params[:user][:password].empty?
      @user.errors.add(:password, "can't be empty")
      render 'edit'
    elsif @user.update_attributes(user_params)
      log_in @user
      @user.update_attribute(:reset_digest, nil)
      flash[:success] = "Password has been reset."
      redirect_to @user
    else
      render 'edit'
    end
  end
  .
  .
  .
end

12.4 在生产环境中发送邮件(再谈)

我们已经在开发环境实现了密码重设功能,本节要配置应用,让它在生产环境中能真正地发送邮件。相关的步骤与实现账户激活功能时一样,如果你已经按照 11.4 节所讲的做了,可以直接跳到代码清单 12.24

我们要在生产环境中使用 SendGrid 服务发送邮件。这个服务是 Heroku 的扩展,只有通过认证的账户才能使用。(要在 Heroku 的账户中填写信用卡信息,不过认证不收费。)对我们的应用来说,入门套餐就够了(免费,写作本书时限制每天最多发送 400 封邮件)。我们可以使用下面的命令添加这个扩展:

$ heroku addons:create sendgrid:starter

(如果你使用的是 Heroku 的旧版命令行接口,这个命令可能无法执行。这个问题有两种解决方法:其一,升级到最新的 Heroku 工具包;其二,使用旧句法 heroku addons:add sendgrid:starter。)

为了让应用使用 SendGrid 发送邮件,我们要在生产环境中配置 SMTP,还要定义一个 host 变量,设置生产环境中网站的地址,如代码清单 12.23 所示。

代码清单 12.23:配置应用,在生产环境中使用 SendGrid
config/environments/production.rb
Rails.application.configure do
  .
  .
  .
  config.action_mailer.raise_delivery_errors = true
  config.action_mailer.delivery_method = :smtp
  host = '<your heroku app>.herokuapp.com'
  config.action_mailer.default_url_options = { host: host }
  ActionMailer::Base.smtp_settings = {
    :address        => 'smtp.sendgrid.net',
    :port           => '587',
    :authentication => :plain,
    :user_name      => ENV['SENDGRID_USERNAME'],
    :password       => ENV['SENDGRID_PASSWORD'],
    :domain         => 'heroku.com',
    :enable_starttls_auto => true
  }
  .
  .
  .
end

代码清单 12.23 中设置了 SendGrid 账户的用户名(user_name)和密码(password),但是注意,这两个值是从 ENV 环境变量中获取的,而没有直接写入代码。这是生产环境应用的最佳实践,为了安全,绝不能在源码中写入敏感信息,例如原始密码。这两个值由 SendGrid 扩展自动设置,13.4.4 节会介绍如何自己定义。

现在,应该把主题分支合并到主分支中:

代码清单 12.24:把 password-reset 分支合并到 master 分支
$ rails test
$ git add -A
$ git commit -m "Add password reset"
$ git checkout master
$ git merge password-reset

然后,推送到远程仓库,再部署到 Heroku:

$ rails test
$ git push
$ git push heroku
$ heroku run rails db:migrate

部署到 Heroku 中之后,可以点击“forgot password”链接(图 12.4)重设密码。你会收到一封重设邮件,如图 12.14 所示。点击邮件中的链接,输入有效密码或无效密码,效果应该同生产环境中一样(图 12.12图 12.13)。

reset email production 4th ed
图 12.14:生产环境中的应用发送的密码重设邮件
练习
  1. 在生产环境中重设密码。能收到电子邮件吗?

  2. 点击密码重设邮件中的链接,然后重设密码。在服务器的日志中能看到什么?提示:在命令行中执行 heroku logs 命令。

  3. 你能成功更新密码吗?

12.5 小结

实现密码重设功能后,我们的演示应用已经完整实现了“注册-登录-退出”机制,而且是专业级的。本书剩下的章节将以此为基础,实现类似 Twitter 的微博(第 13 章)和所关注用户的微博动态流(第 14 章)。在实现的过程中,我们会学到一些 Rails 提供的强大功能,例如使用 has_manyhas_many :through 实现的高级数据模型。

12.5.1 本章所学

  • 与会话和账户激活一样,密码重设虽然没有对应的 Active Record 对象,但也可以看做一个资源;

  • Rails 可以生成 Action Mailer 动作和视图,用于发送邮件;

  • Action Mailer 支持纯文本邮件和 HTML 邮件;

  • 与普通的动作和视图一样,在邮件程序的视图中也可以使用邮件程序动作中的实例变量;

  • 使用生成的令牌创建唯一的 URL,用于重设密码;

  • 使用哈希摘要安全识别有效的密码重设请求;

  • 邮件程序的测试和集成测试对确认邮件程序的行为都有用;

  • 在生产环境可以使用 SendGrid 发送电子邮件。

12.6 证明超时比较算式

我们在 12.3 节讲过,确定密码重设请求是否超时的比较算式是:

reset_sent_at < 2.hours.ago

乍一看容易理解成“密码重设邮件发出少于两小时”,这和想表达的意思正好相反。本节我们要证明这个比较算式是正确的。

我们先来定义两个时间间隔: 表示发送密码重设邮件后经过的时间, 表示限制的失效时长(例如两个小时)。如果邮件发出后经过的时间比限制的失效时长长,说明此次密码重设请求已经失效,即:

如果用 表示现在的时间, 表示发送邮件的时间, 表示失效的时间(例如两个小时以前),那么:

把这两个等式代入第一个算式:

在这个不等式的两边乘于 -1 后得到:

= 2.hours.ago 代入这个不等式后就能得到代码清单 12.17 中的 password_reset_expired? 方法:

def password_reset_expired?
  reset_sent_at < 2.hours.ago
end

12.3 节说过,如果把 < 理解成“超过”而不是“小于”的话,就能得到一个符合人类逻辑的句子:“密码重设邮件已经发出超过两小时”。

  1. 不要觉得显示电子邮件地址不安全。网上随处可见不允许使用已经被用过的电子邮件地址注册的网站,在密码重设过程中指明电子邮件不可用不会给攻击者留下可利用的信息。
  2. 我们只需处理密码为空的情况,因为密码确认为空时会被二次确认验证捕获(密码为空时不会做这个验证),然后显示一个相关的错误消息。
  3. 细心的读者 Khaled Teilab 发现,使用 errors.add(:password, :blank) 的好处是,使用 rails-i18n gem 时得到的消息自动使用正确的语言渲染。
  4. 感谢读者 Tristan Ludowyk 提出这个建议,并且提供详细说明和实现方式。