> ## Documentation Index
> Fetch the complete documentation index at: https://auth0-docs-ia-custom-database-connections.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Change Password Database Action Script and Templates

> The Change Password script runs during when you or the user start a password change workflow.

The Change Password script implements the defined function to change the specified user's password in the external database. We recommend naming this function `changePassword`.

The script is used only in a [legacy authentication scenario](/docs/authenticate/database-connections/custom-db/overview-custom-db-connections) and is required if you want to change a user's password in the external database. It will execute when a user performs a [password reset workflow](/docs/customize/login-pages/classic-login/customize-password-reset-page), or when a password change workflow is started from the <Tooltip tip="Auth0 Dashboard: Auth0's main product to configure your services." cta="View Glossary" href="/docs/glossary?term=Auth0+Dashboard">Auth0 Dashboard</Tooltip> or the Auth0 <Tooltip tip="Management API: A product to allow customers to perform administrative tasks." cta="View Glossary" href="/docs/glossary?term=Management+API">Management API</Tooltip>.

## ChangePassword function

The `changePassword` function should:

* Update the user's password in the external database.
* Return `true` (or an object containing the `last_password_reset` property) if the password change operation succeeded. If the `last_password_reset` property is present in the object, it will be updated on the user's profile.
* Return `false` if the password change operation failed.
* Return an error if the external database could not be reached.

### Definition

The `changePassword` function accepts three parameters and returns a `callback` function:

```js lines theme={null}
changePassword(email, newPassword, callback): function
```

| Parameter     | Type     | Description                                                                                                                                                                                         |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `email`       | String   | User's email address in Auth0 and external database.                                                                                                                                                |
| `newPassword` | String   | Value to be set as user's new password in the external database. This value is sent as plaintext to the function and [should be encrypted](#Encryption) before being sent to the external database. |
| `callback`    | Function | Used to pass data or operation result data through the pipeline.                                                                                                                                    |

### Example

This is a pseudo-JavaScript example of how you could implement the `changePassword` function. For language-specific examples, read [Language-specific script examples](#language-specific-script-examples).

```javascript lines expandable theme={null}
function changePassword(email, newPassword, callback) {
  // Hash the provided password 
  let hashedPassword = hash(newPassword);

  // Prepare the API call
  let options = {
    url: "https://example.com/api/users",
    body: {
      email: email,
      password: hashedPassword
    }
  };

  // Call the API
  send(options, err => {
    if (err && err.id == "FAIL_CHANGE_PASSWORD") {
      // Return false in callback if password change failed
      return callback(null, false);
    } else if (err) {
      // Return error in callback if other error occurred
      return callback(new Error("My custom error message.");
    } else {
      // Return true in callback if password change operation succeeded
      return callback(null, true);

      // Or return an object containing the `last_password_reset` property 
      // if the password change operation succeeded.
      // If the `last_password_reset` property is present in the object,
      // it will be updated on the user's profile.
      return callback(null, { "last_password_reset": Date.now() });
    }
  });
}
```

### Encryption

To prevent any potential data leak, encrypt the password value using a cryptographic hash encryption library such as `bcrypt`. Avoid logging, storing, or transporting the password credential anywhere in its unencrypted form.

For example:

```js lines theme={null}
bcrypt.hash(password, 10, function (err, hash) {
    if (err) {
        return callback(err);
    } else {
        // Return hashed password
    }
});
```

## Callback function

The `callback` function accepts two parameters and is used to pass error data or indicate the result of the operation.

### Definition

```js lines theme={null}
callback(error, operationResult | resultObj): function
```

| Parameter         | Type    | Required | Description                                                                                                                                         |
| ----------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `error`           | Object  | Required | Contains error data.                                                                                                                                |
| `operationResult` | Boolean | Optional | Indicates the result of the change password operation.                                                                                              |
| `resultObj`       | Object  | Optional | Indicates that the change password operation succeeded. If the `last_password_reset` property is present, it will be updated on the user's profile. |

### Return a success

If the change password operation succeeded, return the `callback` function, and pass a `null` value as the `error` parameter and a `true` value as the `operationResult` parameter. For example:

```js lines theme={null}
return callback(null, true);
```

### Return a success and update last\_password\_reset attribute

If the change password operation succeeded, return the `callback` function, and pass a `null` value as the `error` parameter and an object value as the `profile` parameter. If `last_password_reset` attribute is provided in the object, it will be updated on the user's profile. For example:

```js lines theme={null}
return callback(null, { "last_password_reset": Date.now() });
```

### Return a failure

If the change password operation failed, return the `callback` function, and pass a `null` value as the `error` parameter and a `false` value as the `operationResult` parameter. For example:

```js lines theme={null}
return callback(null, false);
```

### Return an error

If an error occurs, return `callback` function, and pass relevant error information as the `error` parameter. For example:

```js lines theme={null}
return callback(new Error("My custom error message."));
```

## Language-specific script examples

Auth0 provides sample scripts for use with the following languages/technologies:

<CodeGroup>
  ```javascript JavaScript lines expandable theme={null}
  function changePassword(email, newPassword, callback) {
    // This script should change the password stored for the current user in your
    // database. It is executed when the user clicks on the confirmation link
    // after a reset password request.
    // The content and behavior of password confirmation emails can be customized
    // here: https://manage.auth0.com/#/emails
    // The `newPassword` parameter of this function is in plain text. It must be
    // hashed/salted to match whatever is stored in your database.
    //
    // There are three ways that this script can finish:
    // 1. The user's password was updated successfully:
    //     callback(null, true);
    // 2. The user's password was not updated:
    //     callback(null, false);
    // 3. Something went wrong while trying to reach your database:
    //     callback(new Error("my error message"));
    //
    // If an error is returned, it will be passed to the query string of the page
    // to which the user is being redirected after clicking the confirmation link.
    // For example, returning `callback(new Error("error"))` and redirecting to
    // https://example.com would redirect to the following 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));
  }
  ```

  ```javascript ASP.NET MVC3 lines expandable theme={null}
  // For ASP.NET Membership Provider (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
     *
     * This function creates a hashed version of the password to store in the database.
     *
     * @password  {[string]}      the password entered by the user
     * @return    {[string]}      the hashed password
     */
    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);
    }
  }
  ```

  ```javascript ASP.NET MVC4 lines expandable theme={null}
  // For 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',
        // encrypt: true for Windows Azure enable this
      }
    });
    /**
     * hashPassword
     *
     * This function hashes a password using HMAC SHA256 algorithm.
     *
     * @password    {[string]}    password to be hased
     * @salt        {[string]}    salt to be used in the hashing process
     * @callback    {[function]}  callback to be called after hashing the password
     */
    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) {
        // 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 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);
        }
        // No record found with that email
        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);
        });
      });
    }
  }
  ```

  ```javascript MongoDB lines theme={null}
  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);
        });
      });
    });
  }
  ```

  ```javascript MySQL lines theme={null}
  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);
      });
    });
  }
  ```

  ```javascript PostgreSQL lines theme={null}
  function changePassword (email, newPassword, callback) {
    //this example uses the "pg" library
    //more info here: 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) {
          // NOTE: always call `done()` here to close
          // the connection to the database
          done();
          return callback(err, result && result.rowCount > 0);
        });
      });
    });
  }
  ```

  ```javascript SQL Server lines expandable theme={null}
  function changePassword (email, newPassword, callback) {
    //this example uses the "tedious" library
    //more info here: 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);
      });
    });
  }
  ```

  ```javascript Azure SQL Database lines expandable theme={null}
  function changePassword (email, newPassword, callback) {
    //this example uses the "tedious" library
    //more info here: 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) {
      // Uncomment next line in order to enable debugging messages
      // console.log(text);
    }).on('errorMessage', function(text) {
      console.log(JSON.stringify(text, null, 2));
    }).on('infoMessage', function(text) {
      // Uncomment next line in order to enable information messages
      // 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);
      });
    });
  }
  ```
</CodeGroup>