316 lines
40 KiB
HTML
316 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/OAuthAuthenticator.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/OAuthAuthenticator.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
|
||
|
|
* Abstracts the sign-in, sign-up and change-password processes for Database &
|
||
|
|
* Active Directory auhtentication services.
|
||
|
|
* @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 {String} [options.clientSecret] Default client Secret.
|
||
|
|
*/
|
||
|
|
var OAuthAuthenticator = function (options) {
|
||
|
|
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 = new RestClient(options.baseUrl + '/oauth/:type', clientOptions);
|
||
|
|
this.clientId = options.clientId;
|
||
|
|
this.clientSecret = options.clientSecret;
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sign in using a username and password.
|
||
|
|
*
|
||
|
|
* @method signIn
|
||
|
|
* @memberOf module:auth.OAuthAuthenticator.prototype
|
||
|
|
*
|
||
|
|
* @example <caption>
|
||
|
|
* Given the user's credentials and the connection specified, it
|
||
|
|
* will return a JSON with the access_token and id_token.
|
||
|
|
* More information in the
|
||
|
|
* <a href="https://auth0.com/docs/api/authentication#database-ad-ldap-active-">
|
||
|
|
* API Docs
|
||
|
|
* </a>.
|
||
|
|
* </caption>
|
||
|
|
*
|
||
|
|
* var data = {
|
||
|
|
* client_id: '{CLIENT_ID}', // Optional field.
|
||
|
|
* username: '{USERNAME}',
|
||
|
|
* password: '{PASSWORD}
|
||
|
|
* connection: '{CONNECTION_NAME}',
|
||
|
|
* scope: 'openid' // Optional field.
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* auth0.oauth.signIn(data, function (err, userData) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* console.log(userData);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} userData User credentials object.
|
||
|
|
* @param {String} userData.username Username.
|
||
|
|
* @param {String} userData.password User password.
|
||
|
|
* @param {String} userData.connection The identity provider in use.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
OAuthAuthenticator.prototype.signIn = function (userData, cb) {
|
||
|
|
var params = {
|
||
|
|
type: 'ro'
|
||
|
|
};
|
||
|
|
var defaultFields = {
|
||
|
|
client_id: this.clientId,
|
||
|
|
grant_type: 'password',
|
||
|
|
scope: 'openid'
|
||
|
|
};
|
||
|
|
var data = extend(defaultFields, userData);
|
||
|
|
|
||
|
|
if (!userData || typeof userData !== 'object') {
|
||
|
|
throw new ArgumentError('Missing user data object');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.connection !== 'string'
|
||
|
|
|| data.connection.split().length === 0)
|
||
|
|
{
|
||
|
|
throw new ArgumentError('connection field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.oauth.create(params, data, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.oauth.create(params, data);
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sign in using a username and password
|
||
|
|
*
|
||
|
|
* @method passwordGrant
|
||
|
|
* @memberOf module:auth.OAuthAuthenticator.prototype
|
||
|
|
*
|
||
|
|
* @example <caption>
|
||
|
|
* Given the user's credentials perform the OAuth password grant
|
||
|
|
* or Password Realm grant if a realm is provided,
|
||
|
|
* it will return a JSON with the access_token and id_token.
|
||
|
|
* More information in the
|
||
|
|
* <a href="https://auth0.com/docs/api/authentication#resource-owner-password">
|
||
|
|
* API Docs
|
||
|
|
* </a>.
|
||
|
|
* </caption>
|
||
|
|
*
|
||
|
|
* var data = {
|
||
|
|
* client_id: '{CLIENT_ID}', // Optional field.
|
||
|
|
* username: '{USERNAME}',
|
||
|
|
* password: '{PASSWORD}'
|
||
|
|
* realm: '{CONNECTION_NAME}', // Optional field.
|
||
|
|
* scope: 'openid' // Optional field.
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* auth0.oauth.token(data, function (err, userData) {
|
||
|
|
* if (err) {
|
||
|
|
* // Handle error.
|
||
|
|
* }
|
||
|
|
*
|
||
|
|
* console.log(userData);
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* @param {Object} userData User credentials object.
|
||
|
|
* @param {String} userData.username Username.
|
||
|
|
* @param {String} userData.password User password.
|
||
|
|
* @param {String} [userData.realm] Name of the realm to use to authenticate or the connection name
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
OAuthAuthenticator.prototype.passwordGrant = function (userData, cb) {
|
||
|
|
var params = {
|
||
|
|
type: 'token'
|
||
|
|
};
|
||
|
|
var defaultFields = {
|
||
|
|
client_id: this.clientId,
|
||
|
|
grant_type: 'password'
|
||
|
|
};
|
||
|
|
var data = extend(defaultFields, userData);
|
||
|
|
|
||
|
|
if (!userData || typeof userData !== 'object') {
|
||
|
|
throw new ArgumentError('Missing user data object');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.username !== 'string'
|
||
|
|
|| data.username.split().length === 0) {
|
||
|
|
throw new ArgumentError('username field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.password !== 'string'
|
||
|
|
|| data.password.split().length === 0) {
|
||
|
|
throw new ArgumentError('password field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.realm === 'string'
|
||
|
|
&& data.realm.split().length !== 0) {
|
||
|
|
data.grant_type = 'http://auth0.com/oauth/grant-type/password-realm';
|
||
|
|
}
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.oauth.create(params, data, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.oauth.create(params, data);
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sign in using a social provider access token.
|
||
|
|
*
|
||
|
|
* @method socialSignIn
|
||
|
|
* @memberOf module:auth.OAuthAuthenticator.prototype
|
||
|
|
*
|
||
|
|
* @param {Object} data User credentials object.
|
||
|
|
* @param {String} data.access_token User access token.
|
||
|
|
* @param {String} data.connection Identity provider.
|
||
|
|
*
|
||
|
|
* @return {Promise|undefined}
|
||
|
|
*/
|
||
|
|
OAuthAuthenticator.prototype.socialSignIn = function (data, cb) {
|
||
|
|
var params = {
|
||
|
|
type: 'access_token'
|
||
|
|
};
|
||
|
|
|
||
|
|
if (typeof data !== 'object') {
|
||
|
|
throw new ArgumentError('Missing user credential objects');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.access_token !== 'string'
|
||
|
|
|| data.access_token.trim().length === 0) {
|
||
|
|
throw new ArgumentError('access_token field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (typeof data.connection !== 'string'
|
||
|
|
|| data.connection.trim().length === 0) {
|
||
|
|
throw new ArgumentError('connection field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.oauth.create(params, data, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.oauth.create(params, data);
|
||
|
|
};
|
||
|
|
|
||
|
|
OAuthAuthenticator.prototype.clientCredentialsGrant = function(options, cb) {
|
||
|
|
|
||
|
|
var params = {
|
||
|
|
type: 'token'
|
||
|
|
};
|
||
|
|
|
||
|
|
var defaultFields = {
|
||
|
|
grant_type: "client_credentials",
|
||
|
|
client_id: this.clientId,
|
||
|
|
client_secret: this.clientSecret
|
||
|
|
};
|
||
|
|
|
||
|
|
var data = extend(defaultFields, options);
|
||
|
|
|
||
|
|
if (!options || typeof options !== 'object') {
|
||
|
|
throw new ArgumentError('Missing options object');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!data.client_id || data.client_id.trim().length === 0) {
|
||
|
|
throw new ArgumentError('client_id field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!data.client_secret || data.client_secret.trim().length === 0) {
|
||
|
|
throw new ArgumentError('client_secret field is required');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (cb && cb instanceof Function) {
|
||
|
|
return this.oauth.create(params, data, cb);
|
||
|
|
}
|
||
|
|
|
||
|
|
return this.oauth.create(params, data);
|
||
|
|
};
|
||
|
|
|
||
|
|
module.exports = OAuthAuthenticator;
|
||
|
|
</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>
|