303 lines
40 KiB
HTML
303 lines
40 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
|
<title>auth/PasswordlessAuthenticator.js - Documentation</title>
|
||
|
|
|
||
|
|
<script src="scripts/prettify/prettify.js"></script>
|
||
|
|
<script src="scripts/prettify/lang-css.js"></script>
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||
|
|
<label for="nav-trigger" class="navicon-button x">
|
||
|
|
<div class="navicon"></div>
|
||
|
|
</label>
|
||
|
|
|
||
|
|
<label for="nav-trigger" class="overlay"></label>
|
||
|
|
|
||
|
|
<nav>
|
||
|
|
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html">AuthenticationClient</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#changePassword">changePassword</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#clientCredentialsGrant">clientCredentialsGrant</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#getClientInfo">getClientInfo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#getDelegationToken">getDelegationToken</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#getProfile">getProfile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#passwordGrant">passwordGrant</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestChangePasswordEmail">requestChangePasswordEmail</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestEmailCode">requestEmailCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestMagicLink">requestMagicLink</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestSMSCode">requestSMSCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#verifySMSCode">verifySMSCode</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html">DatabaseAuthenticator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#changePassword">changePassword</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#requestChangePasswordEmail">requestChangePasswordEmail</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#signIn">signIn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#signUp">signUp</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html">OAuthAuthenticator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html#passwordGrant">passwordGrant</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html#signIn">signIn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html#socialSignIn">s
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="main">
|
||
|
|
|
||
|
|
<h1 class="page-title">auth/PasswordlessAuthenticator.js</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<article>
|
||
|
|
<pre class="prettyprint source linenums"><code>var extend = require('util')._extend;
|
||
|
|
|
||
|
|
var ArgumentError = require('rest-facade').ArgumentError;
|
||
|
|
var RestClient = require('rest-facade').Client;
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @class
|
||
|
|
* Handles authenticator with passwordless flows, e.g. SMS, Touch ID, etc.
|
||
|
|
* @constructor
|
||
|
|
* @memberOf module:auth
|
||
|
|
*
|
||
|
|
* @param {Object} options Authenticator options.
|
||
|
|
* @param {String} options.baseUrl The auth0 account URL.
|
||
|
|
* @param {String} [options.clientId] Default client ID.
|
||
|
|
* @param {OAuthAuthenticator} oauth OAuthAuthenticator instance.
|
||
|
|
*/
|
||
|
|
var PasswordlessAuthenticator = function (options, oauth) {
|
||
|
|
if (!options) {
|
||
|
|
throw new ArgumentError('Missing authenticator options');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof options !== 'object') {
|
||
|
|
throw new ArgumentError('The authenticator options must be an object');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Options object for the Rest Client instace.
|
||
|
|
*
|
||
|
|
* @type {Object}
|
||
|
|
*/
|
||
|
|
var clientOptions = {
|
||
|
|
errorFormatter: { message: 'message', name: 'error' }
|
||
|
|
};
|
||
|
|
|
||
|
|
this.oauth = oauth;
|
||
|
|
this.passwordless = new RestClient(options.baseUrl + '/passwordless/start', clientOptions);
|
||
|
|
this.clientId = options.clientId;
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sign in with the given user credentials.
|
||
|
|
*
|
||
|
|
* @method signIn
|
||
|
|
* @memberOf module:auth.PasswordlessAuthenticator.prototype
|
||
|
|
* @example <caption>
|
||
|
|
* Given the user credentials (`phone_number` and `code`), it will do the
|
||
|
|
* authentication on the provider and return a JSON with the `access_token`
|
||
|
|
* and `id_token`.
|
||
|
|
* </caption>
|
||
|
|
*
|
||
|
|
* var data = {
|
||
|
|
* username: '{PHONE_NUMBER}',
|
||
|
|
* password: '{VERIFICATION_CODE}'
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* auth0.passwordless.signIn(data, function (err) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @example <caption>
|
||
|
|
* The user data object has the following structure.
|
||
|
|
* </caption>
|
||
|
|
*
|
||
|
|
* {
|
||
|
|
* id_token: String,
|
||
|
|
* access_token: String,
|
||
|
|
* token_type: String
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* @param {Object} userData User credentials object.
|
||
|
|
* @param {String} userData.username Username.
|
||
|
|
* @param {String} userData.password Password.
|
||
|
|
* @param {String} [userData.client_id] Client ID.
|
||
|
|
* @param {Function} [cb] Method callback.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
PasswordlessAuthenticator.prototype.signIn = function (userData, cb) {
|
||
|
|
var defaultFields = {
|
||
|
|
client_id: this.clientId
|
||
|
|
};
|
||
|
|
var data = extend(defaultFields, userData);
|
||
|
|
|
||
|
|
// Don't let the user override the connection nor the grant type.
|
||
|
|
data.connection = 'sms';
|
||
|
|
data.grant_type = 'password';
|
||
|
|
|
||
|
|
if (!userData || typeof userData !== 'object') {
|
||
|
|
throw new ArgumentError('Missing user data object');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.username !== 'string'
|
||
|
|
|| data.username.trim().length === 0) {
|
||
|
|
throw new ArgumentError('username field (phone number) is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.password !== 'string'
|
||
|
|
|| data.password.trim().length === 0) {
|
||
|
|
throw new ArgumentError('password field (verification code) is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.oauth.signIn(data, cb);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Start passwordless flow sending an email.
|
||
|
|
*
|
||
|
|
* @method sendEmail
|
||
|
|
* @memberOf module:auth.PasswordlessAuthenticator.prototype
|
||
|
|
* @example <caption>
|
||
|
|
* Given the user `email` address, it will send an email with:
|
||
|
|
*
|
||
|
|
* <ul>
|
||
|
|
* <li>A link (default, `send:"link"`). You can then authenticate with this
|
||
|
|
* user opening the link and he will be automatically logged in to the
|
||
|
|
* application. Optionally, you can append/override parameters to the link
|
||
|
|
* (like `scope`, `redirect_uri`, `protocol`, `response_type`, etc.) using
|
||
|
|
* `authParams` object.
|
||
|
|
* </li>
|
||
|
|
* <li>
|
||
|
|
* A verification code (`send:"code"`). You can then authenticate with
|
||
|
|
* this user using the `/oauth/ro` endpoint specifying `email` as
|
||
|
|
* `username` and `code` as `password`.
|
||
|
|
* </li>
|
||
|
|
* </ul>
|
||
|
|
*
|
||
|
|
* Find more information in the
|
||
|
|
* <a href="https://auth0.com/docs/auth-api#!#post--with_email">API Docs</a>
|
||
|
|
* </caption>
|
||
|
|
*
|
||
|
|
* var data = {
|
||
|
|
* email: '{EMAIL}',
|
||
|
|
* send: 'link',
|
||
|
|
* authParams: {} // Optional auth params.
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* auth0.passwordless.sendEmail(data, function (err) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} userData User account data.
|
||
|
|
* @param {String} userData.email User email address.
|
||
|
|
* @param {String} userData.send The type of email to be sent.
|
||
|
|
* @param {Function} [cb] Method callback.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
PasswordlessAuthenticator.prototype.sendEmail = function (userData, cb) {
|
||
|
|
var defaultFields = {
|
||
|
|
client_id: this.clientId
|
||
|
|
};
|
||
|
|
var data = extend(defaultFields, userData);
|
||
|
|
|
||
|
|
// Don't let the user override the connection nor the grant type.
|
||
|
|
data.connection = 'email';
|
||
|
|
|
||
|
|
if (!userData || typeof userData !== 'object') {
|
||
|
|
throw new ArgumentError('Missing user data object');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.email !== 'string'
|
||
|
|
|| data.email.trim().length === 0) {
|
||
|
|
throw new ArgumentError('email field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.send !== 'string'
|
||
|
|
|| data.send.trim().length === 0) {
|
||
|
|
throw new ArgumentError('send field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.passwordless.create(data, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.passwordless.create(data);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Start passwordless flow sending an SMS.
|
||
|
|
*
|
||
|
|
* @method sendSMS
|
||
|
|
* @memberOf module:auth.PasswordlessAuthenticator.prototype
|
||
|
|
*
|
||
|
|
* @example <caption>
|
||
|
|
* Given the user `phone_number`, it will send a SMS message with a
|
||
|
|
* verification code. You can then authenticate with this user using the
|
||
|
|
* `/oauth/ro` endpoint specifying `phone_number` as `username` and `code` as
|
||
|
|
* `password`:
|
||
|
|
* </caption>
|
||
|
|
*
|
||
|
|
* var data = {
|
||
|
|
* phone_number: '{PHONE}'
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* auth0.passwordless.sendSMS(data, function (err) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} userData User account data.
|
||
|
|
* @param {String} userData.phone_number User phone number.
|
||
|
|
* @param {String} [userData.client_id] Client ID.
|
||
|
|
* @param {Function} [cb] Method callback.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
PasswordlessAuthenticator.prototype.sendSMS = function (userData, cb) {
|
||
|
|
var defaultFields = {
|
||
|
|
client_id: this.clientId
|
||
|
|
};
|
||
|
|
var data = extend(defaultFields, userData);
|
||
|
|
|
||
|
|
// Don't let the user override the connection nor the grant type.
|
||
|
|
data.connection = 'sms';
|
||
|
|
|
||
|
|
if (!userData || typeof userData !== 'object') {
|
||
|
|
throw new ArgumentError('Missing user data object');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.phone_number !== 'string'
|
||
|
|
|| data.phone_number.trim().length === 0) {
|
||
|
|
throw new ArgumentError('phone_number field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.passwordless.create(data, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.passwordless.create(data);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
module.exports = PasswordlessAuthenticator;
|
||
|
|
</code></pre>
|
||
|
|
</article>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<br class="clear">
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Dec 08 2017 10:01:22 GMT-0300 (-03) using the Minami theme.
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
<script>prettyPrint();</script>
|
||
|
|
<script src="scripts/linenumber.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|