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

ユーザーがログインしようとすると、Login スクリプトが実行されます。

Login スクリプトは、ユーザーの認証が必要になるたびに実行される関数を実装します。この関数名は login にすることをお勧めします。

このスクリプトは、レガシー認証と自動移行の両方で必要です。接続で自動移行が設定されている場合、ユーザーが初めて正常にログインした後に移行プロセスがトリガーされます。重複ユーザーの作成を避けるため、Auth0 では返されるユーザープロファイルに永続的な user_id を設定することを推奨しています。

​

Login 関数

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

• 指定されたユーザーの資格情報を外部データベースの API に送信する。
• 認証に成功した場合は、ユーザーのプロファイルデータを返す。
• 認証に失敗した場合は、エラーを返す。

​

定義

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

login(userNameOrEmail, password, callback): function

パラメータ	型	説明
userNameOrEmail	String	ユーザーのユーザー名またはメールアドレス。
password	String	ユーザーのパスワード (プレーンテキスト) 。
callback	Function	エラーまたはプロファイルデータをパイプライン経由で渡すために使用します。

以下は、login 関数の実装方法を示す擬似JavaScriptの例です：

function login(userNameOrEmail, password, callback) {
  // 外部データベースAPIに資格情報を送信する
  let hashedPassword = hash(password);

  let options = {
    url: "https://example.com/api/authenticate",
    body: {
      email: userNameOrEmail,
      password: hashedPassword
    }
  };

  send(options, (err, profileData) => {
    // 認証が失敗した場合はコールバックでエラーを返す
    if (err) {
      return callback(new WrongUsernameOrPasswordError(userNameOrEmail, "My custom error message."));
    } else {
      // 認証が成功した場合はコールバックでプロファイルデータを返す
      let profile = {
        username: profileData.username,
        email: profileData.emailAddress,
        user_id: profileData.userId
      };

      return callback(null, profile);
    }
  });
}

​

暗号化

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

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

​

コールバック関数

callback 関数は、ユーザープロファイルデータまたはエラーデータをパイプライン内で受け渡すために使用されます。

​

定義

callback 関数は、最大 2 つのパラメータを受け取り、関数を返します。

callback(error[, profile]): function

パラメータ	型	必須	説明
error	Object	必須	エラーに関するデータが含まれます。
profile	Object	任意	ユーザーのプロファイルデータが含まれます。

​

ユーザープロファイルを返す

ユーザーに対して Login スクリプトが返すプロファイルデータは、Get User スクリプトが返すプロファイルデータと一致している必要があります。

ユーザーの認証に成功した場合は、正規化形式 の profile オブジェクトでそのプロファイルデータを返す必要があります。例:

return callback(null, {
    username: "username",
    user_id: "my-custom-db|[e-mail]",
    email: "[e-mail]",
    email_verified: false,
    user_metadata: {
        language: "en"
    },
    app_metadata: {
        plan: "full"
    },
    mfa_factors: [
      {
        phone: {
          value: "[phone]"
        }
      },
    ]
});

​

WrongUsernameOrPasswordError 型オブジェクト

WrongUsernameOrPasswordError カスタムエラー型オブジェクトを使用すると、テナントログに表示されるデータを渡すことができます。

WrongUsernameOrPasswordError のコンストラクタは、最大2つのパラメータを受け取ります。

new WrongUsernameOrPasswordError(userNameOrEmail[, message]): WrongUsernameOrPasswordError

パラメータ	型	必須	説明
userNameOrEmail	String	必須	ユーザーのユーザー名またはメールアドレス、もしくは null が含まれます。
message	String	任意	エラーに関する情報が含まれます。

標準フィールドに加えて、user_metadata、app_metadata、mfa_factors フィールドを含めることができます。

​

エラーを返す

エラーが発生した場合、error パラメータには原因に関する情報を含める必要があります。

たとえば、userNameOrEmail フィールドに値を指定してエラーを返すことができます。

return callback(new WrongUsernameOrPasswordError(userNameOrEmail, "My custom error message"));

この場合、Auth0 は fp テナントログイベントを記録します。

テナントログイベントフィールド	値
コード	fp
イベント	ログイン失敗 (パスワードが正しくありません)
説明	My custom error message

userNameOrEmail フィールドに null を指定してエラーを返すこともできます。

return callback(new WrongUsernameOrPasswordError(null, "My custom error message"));

この場合、Auth0 は fu テナントログイベントを記録します。

テナントログイベントフィールド	値
コード	fu
イベント	ログイン失敗 (無効なメールアドレス／ユーザー名)
説明	My custom error message

​

ログインのたびにユーザープロファイル属性を同期する

ログインのたびに外部データベースから返される値で Auth0 が name、nickname、given_name、family_name、picture フィールドを更新するようにするには、Sync user profile attributes at each login 設定を有効にします。

この設定を有効にしない場合、ユーザーが初回ログイン時に外部データベースから返された値は、その後のログイン時にも保持され、外部データベース側で変更されていても反映されません。

​

言語別のスクリプト例

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

JavaScript

function login(email, password, callback) {
  // このスクリプトでは、データベースに保存されている資格情報を使用してユーザーを認証します。
  // ユーザーがログインを試みたとき、またはサインアップ直後（ユーザーが正常にサインアップされたことを確認するため）に実行されます。
  //
  // このスクリプトが返すすべての内容はユーザープロファイルの一部として設定され、
  // すべてのテナント管理者が閲覧できます。パスワード、キー、シークレットなどの値を持つ属性は追加しないでください。
  //
  // この関数の `password` パラメータは平文です。データベースに保存されている値と一致させるためにハッシュ化／ソルト化する必要があります。例:
  //
  //     var bcrypt = require('bcrypt@0.8.5');
  //     bcrypt.compare(password, dbPasswordHash, function(err, res)) { ... }
  //
  // このスクリプトは次の3通りの方法で終了できます:
  // 1. ユーザーの資格情報が有効な場合。返されるユーザープロファイルは次の形式である必要があります:
  //     https://auth0.com/docs/users/normalized/auth0/normalized-user-profile-schema
  //     var profile = {
  //       user_id: ..., // user_id は必須です
  //       email: ...,
  //       [...]
  //     };
  //     callback(null, profile);
  // 2. ユーザーの資格情報が無効な場合
  //     callback(new WrongUsernameOrPasswordError(email, "my error message"));
  // 3. データベースへ接続する際に何か問題が発生した場合
  //     callback(new Error("my error message"));
  //
  // 参照可能な Node.js モジュールの一覧は以下を参照してください:
  //
  //    https://tehsis.github.io/webtaskio-canirequire/
  const msg = 'Please implement the Login script for this database connection ' +
    'at https://manage.auth0.com/#/connections/database';
  return callback(new Error(msg));
}