Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support for oauth2-password-flow (refactored #1574) #1853

Closed
wants to merge 1 commit into from
Closed

Added support for oauth2-password-flow (refactored #1574) #1853

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
266 changes: 167 additions & 99 deletions lib/swagger-oauth.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,41 @@ var popupDialog;
var clientId;
var realm;
var redirect_uri;
var state;
var clientSecret;
var scopeSeparator;
var additionalQueryStringParams;

function handleLogin() {
var scopes = [];

var auths = window.swaggerUi.api.authSchemes || window.swaggerUi.api.securityDefinitions;
var auths = window.swaggerUi.api.authSchemes || window.swaggerUi.api.securityDefinitions,
passwordFlow = false;

if(auths) {
var key;
var defs = auths;
for(key in defs) {
var auth = defs[key];
if(auth.type === 'oauth2' && auth.scopes) {
var scope;
if(Array.isArray(auth.scopes)) {
// 1.2 support
var i;
for(i = 0; i < auth.scopes.length; i++) {
scopes.push(auth.scopes[i]);
if(auth.type === 'oauth2') {
passwordFlow = auth.flow === 'password';

if (auth.scopes) {
var scope;
if(Array.isArray(auth.scopes)) {
// 1.2 support
var i;
for(i = 0; i < auth.scopes.length; i++) {
scope = auth.scopes[i];
scope.OAuthSchemeKey = key;
scopes.push(scope);
}
}
}
else {
// 2.0 support
for(scope in auth.scopes) {
scopes.push({scope: scope, description: auth.scopes[scope], OAuthSchemeKey: key});
else {
// 2.0 support
for(scope in auth.scopes) {
scopes.push({scope: scope, description: auth.scopes[scope], OAuthSchemeKey: key});
}
}
}
}
Expand All @@ -41,29 +50,46 @@ function handleLogin() {
appName = window.swaggerUi.api.info.title;
}

$('.api-popup-dialog').remove();
popupDialog = $(
[
'<div class="api-popup-dialog">',
'<div class="api-popup-title">Select OAuth2.0 Scopes</div>',
'<div class="api-popup-content">',
'<p>Scopes are used to grant an application different levels of access to data on behalf of the end user. Each API may declare one or more scopes.',
'<a href="#">Learn how to use</a>',
'</p>',
'<p><strong>' + appName + '</strong> API requires the following scopes. Select which ones you want to grant to Swagger UI.</p>',
'<ul class="api-popup-scopes">',
'</ul>',
'<p class="error-msg"></p>',
'<div class="api-popup-actions"><button class="api-popup-authbtn api-button green" type="button">Authorize</button><button class="api-popup-cancel api-button gray" type="button">Cancel</button></div>',
'</div>',
'</div>'].join(''));
$('.api-popup-dialog').remove();

popupDialog = ['<div class="api-popup-dialog">'];

if (passwordFlow === true) {
popupDialog = popupDialog.concat([
'<fieldset>',
'<legend class="api-popup-title">Password Auth</legend>',
'<div><label for="username">Username:</label> <input type="text" name="username" id="username"></div>',
'<div><label for="password">Password:</label> <input type="password" name="password" id="password"></div>',
'</fieldset>'
]);
}

popupDialog = $(popupDialog.concat([
'<div class="api-popup-title">Select OAuth2.0 Scopes</div>',
'<div class="api-popup-content">',
'<p>',
'Scopes are used to grant an application different levels of access to data on behalf of the end user. Each API may declare one or more scopes. ',
'<a href="#">Learn how to use</a>',
'</p>',
'<p>',
'<strong>' + appName + '</strong> API requires the following scopes. Select which ones you want to grant to Swagger UI.',
'</p>',
'<ul class="api-popup-scopes"></ul>',
'<p class="error-msg"></p>',
'<div class="api-popup-actions">',
'<button class="api-popup-authbtn api-button green" type="button">Authorize</button>',
'<button class="api-popup-cancel api-button gray" type="button">Cancel</button>',
'</div>',
'</div>',
'</div>']).join(''));

$(document.body).append(popupDialog);

//TODO: only display applicable scopes (will need to pass them into handleLogin)
popup = popupDialog.find('ul.api-popup-scopes').empty();
for (i = 0; i < scopes.length; i ++) {
scope = scopes[i];
str = '<li><input type="checkbox" id="scope_' + i + '" scope="' + scope.scope + '"' +'" oauthtype="' + scope.OAuthSchemeKey +'"/>' + '<label for="scope_' + i + '">' + scope.scope ;
str = '<li><input type="checkbox" id="scope_' + i + '" scope="' + scope.scope +'" oauthtype="' + scope.OAuthSchemeKey +'"/>' + '<label for="scope_' + i + '">' + scope.scope ;
if (scope.description) {
if ($.map(auths, function(n, i) { return i; }).length > 1) //if we have more than one scheme, display schemes
str += '<br/><span class="api-scope-desc">' + scope.description + ' ('+ scope.OAuthSchemeKey+')' +'</span>';
Expand Down Expand Up @@ -101,86 +127,84 @@ function handleLogin() {
popupDialog.hide();

var authSchemes = window.swaggerUi.api.authSchemes;

var host = window.location;
var pathname = location.pathname.substring(0, location.pathname.lastIndexOf("/"));
var defaultRedirectUrl = host.protocol + '//' + host.host + pathname + '/o2c.html';
var redirectUrl = window.oAuthRedirectUrl || defaultRedirectUrl;
var url = null;
var scopes = []
var o = popup.find('input:checked');
var scopes = [];
var o = popup.find('input:checked');
var OAuthSchemeKeys = [];
var state;
for(k =0; k < o.length; k++) {
var scope = $(o[k]).attr('scope');
if (scopes.indexOf(scope) === -1)
scopes.push(scope);
var OAuthSchemeKey = $(o[k]).attr('oauthtype');
var OAuthSchemeKey = $(o[k]).attr('oauthtype');
if (OAuthSchemeKeys.indexOf(OAuthSchemeKey) === -1)
OAuthSchemeKeys.push(OAuthSchemeKey);
OAuthSchemeKeys.push(OAuthSchemeKey);
}
//TODO: merge not replace if scheme is different from any existing

//TODO: merge not replace if scheme is different from any existing
//(needs to be aware of schemes to do so correctly)
window.enabledScopes=scopes;
for (var key in authSchemes) {
window.enabledScopes = scopes;

for (var key in authSchemes) {
if (authSchemes.hasOwnProperty(key) && OAuthSchemeKeys.indexOf(key) != -1) { //only look at keys that match this scope.
var flow = authSchemes[key].flow;
var dets = authSchemes[key];
// RFC 6749 recommends to use state for Implicit and AccessCode Flows:
// state: An opaque value used by the client to maintain state between
// the request and callback. The authorization server includes
// this value when redirecting the user-agent back to the
// client. The parameter SHOULD be used for preventing
// cross-site request forgery as described in Section 10.12.
// We also use the state as a way to pass the authentication name to match it later.
state = key + '&' + Math.random();

if(authSchemes[key].type === 'oauth2' && flow && (flow === 'implicit' || flow === 'accessCode')) {
var dets = authSchemes[key];
url = dets.authorizationUrl + '?response_type=' + (flow === 'implicit' ? 'token' : 'code');
if (authSchemes[key].type === 'oauth2' && dets.flow) {
window.swaggerUi.tokenName = dets.tokenName || 'access_token';
window.swaggerUi.tokenUrl = (flow === 'accessCode' ? dets.tokenUrl : null);
state = key;
window.swaggerUi.tokenUrl = (dets.flow !== 'implicit' ? dets.tokenUrl : null);

if (dets.flow === 'implicit' || dets.flow === 'accessCode') {
var authorizationUrl = dets.authorizationUrl + '?response_type=' + (dets.flow === 'implicit' ? 'token' : 'code');
handleImplicitOrAccessCodeFlow(authorizationUrl, scopes, redirectUrl, state);
}
else if (dets.flow === 'application') {
handleClientCredentialsFlow(scopes, key);
}
else if (dets.flow === 'password') {
handlePasswordFlow(scopes, key);
}
}
else if(authSchemes[key].type === 'oauth2' && flow && (flow === 'application')) {
var dets = authSchemes[key];
window.swaggerUi.tokenName = dets.tokenName || 'access_token';
clientCredentialsFlow(scopes, dets.tokenUrl, key);
return;
}
else if(authSchemes[key].grantTypes) {
// 1.2 support
var o = authSchemes[key].grantTypes;
var authorizationUrl;
for(var t in o) {
if(o.hasOwnProperty(t) && t === 'implicit') {
var dets = o[t];
var ep = dets.loginEndpoint.url;
url = dets.loginEndpoint.url + '?response_type=token';
authorizationUrl = dets.loginEndpoint.url + '?response_type=token';
window.swaggerUi.tokenName = dets.tokenName;
}
else if (o.hasOwnProperty(t) && t === 'accessCode') {
var dets = o[t];
var ep = dets.tokenRequestEndpoint.url;
url = dets.tokenRequestEndpoint.url + '?response_type=code';
authorizationUrl = dets.tokenRequestEndpoint.url + '?response_type=code';
window.swaggerUi.tokenName = dets.tokenName;
}
}
handleImplicitOrAccessCodeFlow(authorizationUrl, scopes, redirectUrl, state);
}
}
}

redirect_uri = redirectUrl;

url += '&redirect_uri=' + encodeURIComponent(redirectUrl);
url += '&realm=' + encodeURIComponent(realm);
url += '&client_id=' + encodeURIComponent(clientId);
url += '&scope=' + encodeURIComponent(scopes.join(scopeSeparator));
url += '&state=' + encodeURIComponent(state);
for (var key in additionalQueryStringParams) {
url += '&' + key + '=' + encodeURIComponent(additionalQueryStringParams[key]);
}

window.open(url);
});

popupMask.show();
popupDialog.show();
return;
}


function handleLogout() {
for(key in window.swaggerUi.api.clientAuthorizations.authz){
window.swaggerUi.api.clientAuthorizations.remove(key)
Expand Down Expand Up @@ -224,36 +248,74 @@ function initOAuth(opts) {
});
}

function clientCredentialsFlow(scopes, tokenUrl, OAuthSchemeKey) {
var params = {
'client_id': clientId,
'client_secret': clientSecret,
'scope': scopes.join(' '),
'grant_type': 'client_credentials'
}
$.ajax(
{
url : tokenUrl,
type: "POST",
data: params,
success:function(data, textStatus, jqXHR)
{
onOAuthComplete(data,OAuthSchemeKey);
},
error: function(jqXHR, textStatus, errorThrown)
{
onOAuthComplete("");
}
});

function handleImplicitOrAccessCodeFlow(authorizationUrl, scopes, redirectUrl, state) {
redirect_uri = redirectUrl;
authorizationUrl += (
'&redirect_uri=' + encodeURIComponent(redirectUrl) +
'&realm=' + encodeURIComponent(realm) +
'&client_id=' + encodeURIComponent(clientId) +
'&scope=' + encodeURIComponent(scopes.join(scopeSeparator)) +
'&state=' + encodeURIComponent(state)
);
for (var key in additionalQueryStringParams) {
authorizationUrl += '&' + key + '=' + encodeURIComponent(additionalQueryStringParams[key]);
}

window.open(authorizationUrl);
}

function handleClientCredentialsFlow(scopes, OAuthSchemeKey) {
var params = {
'grant_type': 'client_credentials',
'client_id': clientId,
'client_secret': clientSecret,
'scope': scopes.join(' ')
}
$.ajax(
{
url : window.swaggerUi.tokenUrl,
type: "POST",
data: params,
success:function(data, textStatus, jqXHR)
{
onOAuthComplete(data, OAuthSchemeKey);
},
error: function(jqXHR, textStatus, errorThrown)
{
onOAuthComplete("");
}
});
}

function handlePasswordFlow(scopes, OAuthSchemeKey) {
var authParams = {
'grant_type': 'password',
'client_id': encodeURIComponent(clientId),
'client_secret': encodeURIComponent(clientSecret),
'username': $('#username').val(),
'password': encodeURIComponent($('#password').val()),
'scope': scopes.join(' ')
};

$.ajax({
url: window.swaggerUi.tokenUrl,
type: 'POST',
data: authParams,
success: function (data) {
onOAuthComplete(data, OAuthSchemeKey);
},
error: function(data) {
onOAuthComplete("");
}
});
}

window.processOAuthCode = function processOAuthCode(data) {
var OAuthSchemeKey = data.state;
var params = {
'grant_type': 'authorization_code',
'client_id': clientId,
'code': data.code,
'grant_type': 'authorization_code',
'redirect_uri': redirect_uri
};

Expand All @@ -264,7 +326,7 @@ window.processOAuthCode = function processOAuthCode(data) {
$.ajax(
{
url : window.swaggerUi.tokenUrl,
type: "POST",
type: 'POST',
data: params,
success:function(data, textStatus, jqXHR)
{
Expand All @@ -277,8 +339,8 @@ window.processOAuthCode = function processOAuthCode(data) {
});
};

window.onOAuthComplete = function onOAuthComplete(token,OAuthSchemeKey) {
if(token) {
window.onOAuthComplete = function onOAuthComplete(token, OAuthSchemeKey) {
if (token) {
if(token.error) {
var checkbox = $('input[type=checkbox],.secured')
checkbox.each(function(pos){
Expand All @@ -287,14 +349,20 @@ window.onOAuthComplete = function onOAuthComplete(token,OAuthSchemeKey) {
alert(token.error);
}
else {
var b = token[window.swaggerUi.tokenName];
if (!OAuthSchemeKey){
OAuthSchemeKey = token.state;
if (!OAuthSchemeKey) {
alert(1);
if (token.state !== state) {
alert("OAuth2 security error: State is different, possible CSRF attack.");
}
// Implicit and AccessCode Flows is expected to pass a
// 'OAuthSchemeKey&Math.random()' value
OAuthSchemeKey = token.state.replace(/^(.*)&/, '$1');
}
if(b){
var b = token[window.swaggerUi.tokenName];
if (b) {
// if all roles are satisfied
var o = null;
$.each($('.auth .api-ic .api_information_panel'), function(k, v) {
$.each($('.auth .api-ic .api_information_panel'), function(k, v) {
var children = v;
if(children && children.childNodes) {
var requiredScopes = [];
Expand Down