パスワード変更スクリプトテンプレート

Change Password スクリプトは、指定したユーザーのパスワードを外部データベースで変更するための関数を実装します。この関数名は changePassword とすることを推奨します。このスクリプトは、レガシー認証シナリオでのみ使用され、外部データベース内のユーザーのパスワードを変更する場合に必要です。ユーザーがパスワードリセットワークフローを実行したとき、またはもしくは Auth0 からパスワード変更ワークフローが開始されたときに実行されます。

ChangePassword 関数

changePassword 関数は、次の要件を満たす必要があります。

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

定義

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

changePassword(email, newPassword, callback): function

Parameter	Type	説明
`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`	Object	必須	エラーデータが含まれます。
`operationResult`	Boolean	任意	パスワード変更処理の結果を示します。
`resultObj`	Object	任意	パスワード変更処理が成功したことを示します。`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
ASP.NET Membership Provider (MVC3 - Universal Providers)
ASP.NET Membership Provider (MVC4 - Simple Membership)
MongoDB
MySQL
PostgreSQL
SQL Server
Windows Azure SQL Database

JavaScript

function changePassword(email, newPassword, callback) {
  // このスクリプトは、データベースに保存されている現在のユーザーのパスワードを変更します。
  // パスワードリセットリクエスト後、ユーザーが確認リンクをクリックしたときに実行されます。
  // パスワード確認メールの内容と動作は、こちらでカスタマイズできます:
  // https://manage.auth0.com/#/emails
  // この関数の `newPassword` パラメーターは平文です。データベースに保存されている形式に
  // 合わせてハッシュ化/ソルト化する必要があります。
  //
  // このスクリプトの終了パターンは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));
}

ASP.NET Membership プロバイダー (MVC3 - Universal Providers)

function changePassword(email, newPassword, callback) {
  var crypto = require('crypto');
  var Connection = require('tedious').Connection;
  var Request = require('tedious').Request;
  var TYPES = require('tedious').TYPES
  var connection = new Connection({
    userName:  'the username',
    password:  'the password',
    server:    'the server',
    options: {
      database:  'the db name',
      // encrypt: true   for Windows Azure enable this
    }
  });
  /**
   * hashPassword
   *
   * この関数は、データベースに保存するためのパスワードのハッシュ値を生成します。
   *
   * @password  {[string]}      ユーザーが入力したパスワード
   * @return    {[string]}      ハッシュ化されたパスワード
   */
  function hashPassword(password, salt) {
    // the default implementation uses HMACSHA256 and since Key length is 64
    // and default salt is 16 bytes, Membership will fill the buffer repeating the salt
    var key = Buffer.concat([salt, salt, salt, salt]);
    var hmac = crypto.createHmac('sha256', key);
    hmac.update(Buffer.from(password, 'ucs2'));
    var hashed = hmac.digest('base64');
    return hashed;
  }
  connection.on('debug', function(text) {
      // if you have connection issues, uncomment this to get more detailed info
      //console.log(text);
  }).on('errorMessage', function(text) {
      // this will show any errors when connecting to the SQL database or with the SQL statements
    console.log(JSON.stringify(text));
  });
  connection.on('connect', function (err) {
    if (err) {
      return callback(err);
    }
    updateMembershipUser(email, newPassword, function(err, wasUpdated) {
      if (err) {
        return callback(err); // this will return a 500
      }
      callback(null, wasUpdated);
    });
  });
  function updateMembershipUser(email, newPassword, callback) {
    var salt            = crypto.randomBytes(16);
    var hashedPassword  = hashPassword(newPassword, salt);
    var updateMembership =
      'UPDATE Memberships '+
      'SET Password=@NewPassword, PasswordSalt=@NewSalt, LastPasswordChangedDate=GETDATE() '+
      'WHERE Email=@Email';
    var updateMembershipQuery = new Request(updateMembership, function (membershipErr, membershipCount) {
      if (membershipErr) {
        return callback(membershipErr);
      }
      callback(null, membershipCount > 0);
    });
    updateMembershipQuery.addParameter('NewPassword', TYPES.VarChar, hashedPassword);
    updateMembershipQuery.addParameter('NewSalt',     TYPES.VarChar, salt.toString('base64'));
    updateMembershipQuery.addParameter('Email',       TYPES.VarChar, email);
    connection.execSql(updateMembershipQuery);
  }
}

ASP.NET Membership Provider (MVC4 - Simple Membership)

function changePassword(email, newPassword, callback) {
  var crypto = require('crypto');
  var Connection = require('tedious').Connection;
  var Request = require('tedious').Request;
  var TYPES = require('tedious').TYPES
  var connection = new Connection({
    userName:  'the username',
    password:  'the password',
    server:    'the server',
    options: {
      database:  'the db name',
      // Windows Azure の場合は encrypt: true を有効にしてください
    }
  });
  /**
   * hashPassword
   *
   * この関数は HMAC SHA256 アルゴリズムを使用してパスワードをハッシュ化します。
   *
   * @password    {[string]}    ハッシュ化するパスワード
   * @salt        {[string]}    ハッシュ化処理で使用するソルト
   * @callback    {[function]}  パスワードのハッシュ化後に呼び出されるコールバック
   */
  function hashPassword(password, salt, callback) {
    var iterations         = 1000;
    var passwordHashLength = 32;
    crypto.pbkdf2(password, salt, iterations, passwordHashLength, function (err, hashed) {
      if (err) {
        return callback(err);
      }
      var result = Buffer.concat([Buffer.from([0], 1), salt, Buffer.from(hashed, 'binary')]);
      var resultBase64 = result.toString('base64');
      callback(null, resultBase64);
    });
  }
  connection.on('debug', function(text) {
      // 接続に問題がある場合は、詳細情報を取得するためにコメントアウトを解除してください
      //console.log(text);
  }).on('errorMessage', function(text) {
      // SQL データベースへの接続時または SQL ステートメントのエラーが表示されます
    console.log(JSON.stringify(text));
  });
  connection.on('connect', function (err) {
    if (err) {
      return callback(err);
    }
    updateMembershipUser(email, newPassword, function(err, wasUpdated) {
      if (err) {
        return callback(err); // 500 を返します
      }
      callback(null, wasUpdated);
    });
  });
  function findUserId(email, callback) {
    var findUserIdFromEmail =
      'SELECT UserProfile.UserId FROM ' +
      'UserProfile INNER JOIN webpages_Membership ' +
      'ON UserProfile.UserId = webpages_Membership.UserId ' +
      'WHERE UserName = @Email';
    var findUserIdFromEmailQuery = new Request(findUserIdFromEmail, function (err, rowCount, rows) {
      if (err) {
        return callback(err);
      }
      // そのメールアドレスに一致するレコードが見つかりません
      if (rowCount < 1) {
        return callback(null, null);
      }
      var userId = rows[0][0].value;
      callback(null, userId);
    });
    findUserIdFromEmailQuery.addParameter('Email', TYPES.VarChar, email);
    connection.execSql(findUserIdFromEmailQuery);
  }
  function updateMembershipUser(email, newPassword, callback) {
    findUserId(email, function (err, userId) {
      if (err) {
        return callback(err);
      }
      if (userId === null) {
        return callback();
      }
      var salt = crypto.randomBytes(16);
      var updateMembership =
        'UPDATE webpages_Membership '+
        'SET Password=@NewPassword, PasswordChangedDate=GETDATE() '+
        'WHERE UserId=@UserId';
      var updateMembershipQuery = new Request(updateMembership, function (err, rowCount) {
        if (err) {
          return callback(err);
        }
        if (rowCount < 1) {
          return callback();
        }
        callback(null, rowCount > 0);
      });
      hashPassword(newPassword, salt, function (err, hashedPassword) {
        if (err) {
          return callback(err);
        }
        updateMembershipQuery.addParameter('NewPassword',   TYPES.VarChar, hashedPassword);
        updateMembershipQuery.addParameter('UserId',        TYPES.VarChar, userId);
        connection.execSql(updateMembershipQuery);
      });
    });
  }
}

MongoDB

function changePassword(email, newPassword, callback) {
  const bcrypt = require('bcrypt');
  const MongoClient = require('mongodb@3.1.4').MongoClient;
  const client = new MongoClient('mongodb://user:pass@mymongoserver.com');
  client.connect(function (err) {
    if (err) return callback(err);
    const db = client.db('db-name');
    const users = db.collection('users');
    bcrypt.hash(newPassword, 10, function (err, hash) {
      if (err) {
        client.close();
        return callback(err);
      }
      users.update({ email: email }, { $set: { password: hash } }, function (err, count) {
        client.close();
        if (err) return callback(err);
        callback(null, count > 0);
      });
    });
  });
}

MySQL

function changePassword(email, newPassword, callback) {
  const mysql = require('mysql');
  const bcrypt = require('bcrypt');
  const connection = mysql({
    host: 'localhost',
    user: 'me',
    password: 'secret',
    database: 'mydb'
  });
  connection.connect();
  const query = 'UPDATE users SET password = ? WHERE email = ?';
  bcrypt.hash(newPassword, 10, function(err, hash) {
    if (err) return callback(err);
    connection.query(query, [ hash, email ], function(err, results) {
      if (err) return callback(err);
      callback(null, results.length > 0);
    });
  });
}

PostgreSQL

function changePassword (email, newPassword, callback) {
  //この例では "pg" ライブラリを使用しています
  //詳細はこちら: https://github.com/brianc/node-postgres
  const bcrypt = require('bcrypt');
  const postgres = require('pg');
  const conString = 'postgres://user:pass@localhost/mydb';
  postgres.connect(conString, function (err, client, done) {
    if (err) return callback(err);
    bcrypt.hash(newPassword, 10, function (err, hash) {
      if (err) return callback(err);
      const query = 'UPDATE users SET password = $1 WHERE email = $2';
      client.query(query, [hash, email], function (err, result) {
        // 注意: データベースへの接続を閉じるために
        // 必ずここで `done()` を呼び出してください
        done();
        return callback(err, result && result.rowCount > 0);
      });
    });
  });
}

SQL Server

function changePassword (email, newPassword, callback) {
  //この例では "tedious" ライブラリを使用しています
  //詳細はこちら: http://tediousjs.github.io/tedious/
  const bcrypt = require('bcrypt');
  const sqlserver = require('tedious@1.11.0');
  const Connection = sqlserver.Connection;
  const Request = sqlserver.Request;
  const TYPES = sqlserver.TYPES;
  const connection = new Connection({
    userName:  'test',
    password:  'test',
    server:    'localhost',
    options:  {
      database: 'mydb'
    }
  });
  const query = 'UPDATE dbo.Users SET Password = @NewPassword WHERE Email = @Email';
  connection.on('debug', function(text) {
    console.log(text);
  }).on('errorMessage', function(text) {
    console.log(JSON.stringify(text, null, 2));
  }).on('infoMessage', function(text) {
    console.log(JSON.stringify(text, null, 2));
  });
  connection.on('connect', function (err) {
    if (err) return callback(err);
    const request = new Request(query, function (err, rows) {
      if (err) return callback(err);
      callback(null, rows > 0);
    });
    bcrypt.hash(newPassword, 10, function (err, hash) {
      if (err) return callback(err);
      request.addParameter('NewPassword', TYPES.VarChar, hash);
      request.addParameter('Email', TYPES.VarChar, email);
      connection.execSql(request);
    });
  });
}

Windows Azure SQL Database

function changePassword (email, newPassword, callback) {
  //この例では "tedious" ライブラリを使用しています
  //詳細はこちら: http://pekim.github.io/tedious/index.html
  var Connection = require('tedious@1.11.0').Connection;
  var Request = require('tedious@1.11.0').Request;
  var TYPES = require('tedious@1.11.0').TYPES;
  var bcrypt = require('bcrypt');
  var connection = new Connection({
    userName:  'your-user@your-server-id.database.windows.net',
    password:  'the-password',
    server:    'your-server-id.database.windows.net',
    options:  {
      database: 'mydb',
      encrypt:  true
    }
  });
  var query = 'UPDATE dbo.Users SET Password = @NewPassword ' +
    'WHERE Email = @Email';
  connection.on('debug', function(text) {
    // デバッグメッセージを有効にするには次の行のコメントを解除してください
    // console.log(text);
  }).on('errorMessage', function(text) {
    console.log(JSON.stringify(text, null, 2));
  }).on('infoMessage', function(text) {
    // 情報メッセージを有効にするには次の行のコメントを解除してください
    // console.log(JSON.stringify(text, null, 2));
  });
  connection.on('connect', function (err) {
    if (err) { return callback(err); }
    var request = new Request(query, function (err, rows) {
      if (err) { return callback(err); }
      console.log('rows: ' + rows);
      callback(null, rows > 0);
    });
    bcrypt.hash(newPassword, 10, function (err, hash) {
      if (err) { return callback(err); }
      request.addParameter('NewPassword', TYPES.VarChar, hash);
      request.addParameter('Email', TYPES.VarChar, email);
      connection.execSql(request);
    });
  });
}

​ChangePassword 関数

​定義

​例

​暗号化

​例

​コールバック関数

​定義

​成功を返す

​例

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

​例

​失敗を返す

​例

​エラーを返す

​例

​言語別のスクリプト例

​JavaScript

​ASP.NET Membership プロバイダー (MVC3 - Universal Providers)

​ASP.NET Membership Provider (MVC4 - Simple Membership)

​MongoDB

​MySQL

​PostgreSQL

​SQL Server

​Windows Azure SQL Database

​関連情報

ChangePassword 関数

定義

例

暗号化

例

コールバック関数

定義

成功を返す

例

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

例

失敗を返す

例

エラーを返す

例

言語別のスクリプト例

JavaScript

ASP.NET Membership プロバイダー (MVC3 - Universal Providers)

ASP.NET Membership Provider (MVC4 - Simple Membership)

MongoDB

MySQL

PostgreSQL

SQL Server

Windows Azure SQL Database

関連情報