Change Password データベースアクションスクリプトとテンプレート

Change Password スクリプトは、管理者またはユーザーがパスワード変更ワークフローを開始すると実行されます。

Change Password スクリプトは、外部データベース内の指定したユーザーのパスワードを変更するための定義済み関数を実装します。この関数名は changePassword にすることをお勧めします。

このスクリプトは、レガシー認証シナリオでのみ使用され、外部データベース内のユーザーのパスワードを変更する場合に必要です。これは、ユーザーがパスワードリセットのワークフローを実行したとき、または Auth0 Dashboard または Auth0 Management API からパスワード変更ワークフローが開始されたときに実行されます。

​

ChangePassword function

changePassword 関数では、次の処理を行う必要があります。

• 外部データベース内のユーザーのパスワードを更新すること。
• パスワード変更に成功した場合は、true (または last_password_reset プロパティを含むオブジェクト) を返すこと。オブジェクトに last_password_reset プロパティが含まれている場合は、その値がユーザーのプロファイルに反映されます。
• パスワード変更に失敗した場合は、false を返すこと。
• 外部データベースに接続できない場合は、エラーを返すこと。

​

定義

changePassword 関数は 3 つのパラメータを受け取り、callback 関数を返します:

changePassword(email, newPassword, callback): function

パラメータ	型	説明
email	String	Auth0 および外部データベースにおけるユーザーのメールアドレス。
newPassword	String	外部データベースでユーザーの新しいパスワードとして設定する値。この値は平文で関数に送信されるため、外部データベースに送信する前に暗号化する必要があります。
callback	Function	パイプラインを通じてデータや処理結果を渡すために使用するコールバック関数。

​

例

これは、changePassword 関数の実装方法を示す擬似的なJavaScriptの例です。各言語の例については、言語別スクリプト例をご覧ください。

function changePassword(email, newPassword, callback) {
  // 指定されたパスワードをハッシュ化する 
  let hashedPassword = hash(newPassword);

  // API呼び出しを準備する
  let options = {
    url: "https://example.com/api/users",
    body: {
      email: email,
      password: hashedPassword
    }
  };

  // APIを呼び出す
  send(options, err => {
    if (err && err.id == "FAIL_CHANGE_PASSWORD") {
      // パスワード変更に失敗した場合はコールバックでfalseを返す
      return callback(null, false);
    } else if (err) {
      // その他のエラーが発生した場合はコールバックでエラーを返す
      return callback(new Error("My custom error message.");
    } else {
      // パスワード変更が成功した場合はコールバックでtrueを返す
      return callback(null, true);

      // または、パスワード変更が成功した場合は、`last_password_reset`プロパティを
      // 含むオブジェクトを返すこともできる。
      // オブジェクトに`last_password_reset`プロパティが存在する場合、
      // ユーザーのプロファイルに反映される。
      return callback(null, { "last_password_reset": Date.now() });
    }
  });
}

​

暗号化

データ漏洩のリスクを防ぐため、bcrypt などの暗号学的ハッシュライブラリを使用してパスワード値をハッシュ化します。暗号化されていないパスワード認証情報をログに記録したり、保存または転送したりしないでください。

たとえば：

bcrypt.hash(password, 10, function (err, hash) {
    if (err) {
        return callback(err);
    } else {
        // ハッシュ化されたパスワードを返す
    }
});

​

コールバック関数

callback 関数は 2 つのパラメータを受け取り、エラー情報を渡したり、処理の結果を示したりするために使用されます。

​

定義

callback(error, operationResult | resultObj): function

パラメータ	型	必須	説明
error	オブジェクト	必須	エラーデータが含まれます。
operationResult	Boolean	任意	パスワード変更処理の結果を示します。
resultObj	オブジェクト	任意	パスワード変更処理が成功したことを示します。last_password_reset プロパティが存在する場合は、ユーザーのプロファイル上で更新されます。

​

成功を返す

パスワード変更処理が成功した場合は、callback 関数を呼び出し、error パラメータに null を、operationResult パラメータに true を渡します。例：

return callback(null, true);

​

成功を返し、last_password_reset 属性を更新する

パスワード変更処理が成功した場合は、callback 関数を返し、error パラメータには null を、profile パラメータにはオブジェクトを渡します。オブジェクトに last_password_reset 属性が含まれている場合、その値はユーザーのプロファイルに更新されます。例:

return callback(null, { "last_password_reset": Date.now() });

​

失敗を返す

パスワード変更処理が失敗した場合は、callback 関数を呼び出し、error パラメータには null を、operationResult パラメータには false を渡します。例:

return callback(null, false);

​

エラーを返す

エラーが発生した場合は、callback 関数に関連するエラー情報を error パラメータとして渡します。例：

return callback(new Error("My custom error message."));

​

言語別スクリプト例

Auth0 では、以下の言語／テクノロジー向けのサンプルスクリプトを提供しています。

JavaScript

function changePassword(email, newPassword, callback) {
  // このスクリプトでは、現在のユーザーのデータベースに保存されているパスワードを変更します。
  // ユーザーがパスワードリセットのリクエスト後に確認リンクをクリックすると実行されます。
  // パスワード確認メールの内容と動作は、こちらでカスタマイズできます。
  // https://manage.auth0.com/#/emails
  // この関数の `newPassword` パラメータは平文です。データベースに保存されている値に
  // 合わせてハッシュ化し、saltを付加する必要があります。
  //
  // このスクリプトの完了方法は3通りあります。
  // 1. ユーザーのパスワードが正常に更新された場合:
  //     callback(null, true);
  // 2. ユーザーのパスワードが更新されなかった場合:
  //     callback(null, false);
  // 3. データベースへの接続中に問題が発生した場合:
  //     callback(new Error("my error message"));
  //
  // エラーが返された場合、確認リンクをクリックした後にユーザーがリダイレクトされるページの
  // クエリ文字列に渡されます。たとえば、`callback(new Error("error"))` を返して
  // https://example.com にリダイレクトすると、次のURLにリダイレクトされます。
  //     https://example.com?email=alice%40example.com&message=error&success=false
  const msg = 'Please implement the Change Password script for this database ' +
    'connection at https://manage.auth0.com/#/connections/database';
  return callback(new Error(msg));
}