mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-06 13:17:41 +00:00
339 lines
12 KiB
JavaScript
339 lines
12 KiB
JavaScript
/*
|
|
* Copyright (C) 2014 Glyptodon LLC
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
/**
|
|
* A service for authenticating a user against the REST API.
|
|
*
|
|
* This service broadcasts two events on $rootScope depending on the result of
|
|
* authentication operations: 'guacLogin' if authentication was successful and
|
|
* a new token was created, and 'guacLogout' if an existing token is being
|
|
* destroyed or replaced. Both events will be passed the related token as their
|
|
* sole parameter.
|
|
*
|
|
* If a login attempt results in an existing token being replaced, 'guacLogout'
|
|
* will be broadcast first for the token being replaced, followed by
|
|
* 'guacLogin' for the new token.
|
|
*
|
|
* Failed logins may also result in guacInsufficientCredentials or
|
|
* guacInvalidCredentials events, if the provided credentials were rejected for
|
|
* being insufficient or invalid respectively. Both events will be provided
|
|
* the set of parameters originally given to authenticate() and the error that
|
|
* rejected the credentials. The Error object provided will contain set of
|
|
* expected credentials returned by the REST endpoint. This set of credentials
|
|
* will be in the form of a Field array.
|
|
*/
|
|
angular.module('auth').factory('authenticationService', ['$injector',
|
|
function authenticationService($injector) {
|
|
|
|
// Required types
|
|
var Error = $injector.get('Error');
|
|
|
|
// Required services
|
|
var $cookieStore = $injector.get('$cookieStore');
|
|
var $http = $injector.get('$http');
|
|
var $q = $injector.get('$q');
|
|
var $rootScope = $injector.get('$rootScope');
|
|
|
|
var service = {};
|
|
|
|
/**
|
|
* The unique identifier of the local cookie which stores the user's
|
|
* current authentication token and username.
|
|
*
|
|
* @type String
|
|
*/
|
|
var AUTH_COOKIE_ID = "GUAC_AUTH";
|
|
|
|
/**
|
|
* Makes a request to authenticate a user using the token REST API endpoint
|
|
* and given arbitrary parameters, returning a promise that succeeds only
|
|
* if the authentication operation was successful. The resulting
|
|
* authentication data can be retrieved later via getCurrentToken() or
|
|
* getCurrentUsername().
|
|
*
|
|
* The provided parameters can be virtually any object, as each property
|
|
* will be sent as an HTTP parameter in the authentication request.
|
|
* Standard parameters include "username" for the user's username,
|
|
* "password" for the user's associated password, and "token" for the
|
|
* auth token to check/update.
|
|
*
|
|
* If a token is provided, it will be reused if possible.
|
|
*
|
|
* @param {Object} parameters
|
|
* Arbitrary parameters to authenticate with.
|
|
*
|
|
* @returns {Promise}
|
|
* A promise which succeeds only if the login operation was successful.
|
|
*/
|
|
service.authenticate = function authenticate(parameters) {
|
|
|
|
var authenticationProcess = $q.defer();
|
|
|
|
/**
|
|
* Stores the given authentication data within the browser and marks
|
|
* the authentication process as completed.
|
|
*
|
|
* @param {Object} data
|
|
* The authentication data returned by the token REST endpoint.
|
|
*/
|
|
var completeAuthentication = function completeAuthentication(data) {
|
|
|
|
// Store auth data
|
|
$cookieStore.put(AUTH_COOKIE_ID, {
|
|
authToken : data.authToken,
|
|
username : data.username,
|
|
dataSource : data.dataSource
|
|
});
|
|
|
|
// Process is complete
|
|
authenticationProcess.resolve();
|
|
|
|
};
|
|
|
|
// Attempt authentication
|
|
$http({
|
|
method: 'POST',
|
|
url: 'api/tokens',
|
|
headers: {
|
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
},
|
|
data: $.param(parameters),
|
|
})
|
|
|
|
// If authentication succeeds, handle received auth data
|
|
.success(function authenticationSuccessful(data) {
|
|
|
|
var currentToken = service.getCurrentToken();
|
|
|
|
// If a new token was received, ensure the old token is invalidated,
|
|
// if any, and notify listeners of the new token
|
|
if (data.authToken !== currentToken) {
|
|
|
|
// If an old token existed, explicitly logout first
|
|
if (currentToken) {
|
|
service.logout()
|
|
['finally'](function logoutComplete() {
|
|
completeAuthentication(data);
|
|
$rootScope.$broadcast('guacLogin', data.authToken);
|
|
});
|
|
}
|
|
|
|
// Otherwise, simply complete authentication and notify of login
|
|
else {
|
|
completeAuthentication(data);
|
|
$rootScope.$broadcast('guacLogin', data.authToken);
|
|
}
|
|
|
|
}
|
|
|
|
// Otherwise, just finish the auth process
|
|
else
|
|
completeAuthentication(data);
|
|
|
|
})
|
|
|
|
// If authentication fails, propogate failure to returned promise
|
|
.error(function authenticationFailed(error) {
|
|
|
|
// Request credentials if provided credentials were invalid
|
|
if (error.type === Error.Type.INVALID_CREDENTIALS)
|
|
$rootScope.$broadcast('guacInvalidCredentials', parameters, error);
|
|
|
|
// Request more credentials if provided credentials were not enough
|
|
else if (error.type === Error.Type.INSUFFICIENT_CREDENTIALS)
|
|
$rootScope.$broadcast('guacInsufficientCredentials', parameters, error);
|
|
|
|
authenticationProcess.reject(error);
|
|
});
|
|
|
|
return authenticationProcess.promise;
|
|
|
|
};
|
|
|
|
/**
|
|
* Makes a request to update the current auth token, if any, using the
|
|
* token REST API endpoint. If the optional parameters object is provided,
|
|
* its properties will be included as parameters in the update request.
|
|
* This function returns a promise that succeeds only if the authentication
|
|
* operation was successful. The resulting authentication data can be
|
|
* retrieved later via getCurrentToken() or getCurrentUsername().
|
|
*
|
|
* If there is no current auth token, this function behaves identically to
|
|
* authenticate(), and makes a general authentication request.
|
|
*
|
|
* @param {Object} [parameters]
|
|
* Arbitrary parameters to authenticate with, if any.
|
|
*
|
|
* @returns {Promise}
|
|
* A promise which succeeds only if the login operation was successful.
|
|
*/
|
|
service.updateCurrentToken = function updateCurrentToken(parameters) {
|
|
|
|
// HTTP parameters for the authentication request
|
|
var httpParameters = {};
|
|
|
|
// Add token parameter if current token is known
|
|
var token = service.getCurrentToken();
|
|
if (token)
|
|
httpParameters.token = service.getCurrentToken();
|
|
|
|
// Add any additional parameters
|
|
if (parameters)
|
|
angular.extend(httpParameters, parameters);
|
|
|
|
// Make the request
|
|
return service.authenticate(httpParameters);
|
|
|
|
};
|
|
|
|
/**
|
|
* Makes a request to authenticate a user using the token REST API endpoint
|
|
* with a username and password, ignoring any currently-stored token,
|
|
* returning a promise that succeeds only if the login operation was
|
|
* successful. The resulting authentication data can be retrieved later
|
|
* via getCurrentToken() or getCurrentUsername().
|
|
*
|
|
* @param {String} username
|
|
* The username to log in with.
|
|
*
|
|
* @param {String} password
|
|
* The password to log in with.
|
|
*
|
|
* @returns {Promise}
|
|
* A promise which succeeds only if the login operation was successful.
|
|
*/
|
|
service.login = function login(username, password) {
|
|
return service.authenticate({
|
|
username: username,
|
|
password: password
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Makes a request to logout a user using the login REST API endpoint,
|
|
* returning a promise succeeds only if the logout operation was
|
|
* successful.
|
|
*
|
|
* @returns {Promise}
|
|
* A promise which succeeds only if the logout operation was
|
|
* successful.
|
|
*/
|
|
service.logout = function logout() {
|
|
|
|
// Clear authentication data
|
|
var token = service.getCurrentToken();
|
|
$cookieStore.remove(AUTH_COOKIE_ID);
|
|
|
|
// Notify listeners that a token is being destroyed
|
|
$rootScope.$broadcast('guacLogout', token);
|
|
|
|
// Delete old token
|
|
return $http({
|
|
method: 'DELETE',
|
|
url: 'api/tokens/' + token
|
|
});
|
|
|
|
};
|
|
|
|
/**
|
|
* Returns the username of the current user. If the current user is not
|
|
* logged in, this value may not be valid.
|
|
*
|
|
* @returns {String}
|
|
* The username of the current user, or null if no authentication data
|
|
* is present.
|
|
*/
|
|
service.getCurrentUsername = function getCurrentUsername() {
|
|
|
|
// Return username, if available
|
|
var authData = $cookieStore.get(AUTH_COOKIE_ID);
|
|
if (authData)
|
|
return authData.username;
|
|
|
|
// No auth data present
|
|
return null;
|
|
|
|
};
|
|
|
|
/**
|
|
* Returns the auth token associated with the current user. If the current
|
|
* user is not logged in, this token may not be valid.
|
|
*
|
|
* @returns {String}
|
|
* The auth token associated with the current user, or null if no
|
|
* authentication data is present.
|
|
*/
|
|
service.getCurrentToken = function getCurrentToken() {
|
|
|
|
// Return auth token, if available
|
|
var authData = $cookieStore.get(AUTH_COOKIE_ID);
|
|
if (authData)
|
|
return authData.authToken;
|
|
|
|
// No auth data present
|
|
return null;
|
|
|
|
};
|
|
|
|
/**
|
|
* Returns the identifier of the data source that authenticated the current
|
|
* user. If the current user is not logged in, this value may not be valid.
|
|
*
|
|
* @returns {String}
|
|
* The identifier of the data source that authenticated the current
|
|
* user, or null if no authentication data is present.
|
|
*/
|
|
service.getDataSource = function getDataSource() {
|
|
|
|
// Return data source, if available
|
|
var authData = $cookieStore.get(AUTH_COOKIE_ID);
|
|
if (authData)
|
|
return authData.dataSource;
|
|
|
|
// No auth data present
|
|
return null;
|
|
|
|
};
|
|
|
|
/**
|
|
* Returns the identifiers of all data sources available to the current
|
|
* user. If the current user is not logged in, this value may not be valid.
|
|
*
|
|
* @returns {String[]}
|
|
* The identifiers of all data sources availble to the current user,
|
|
* or null if no authentication data is present.
|
|
*/
|
|
service.getAvailableDataSources = function getAvailableDataSources() {
|
|
|
|
// Return data sources, if available
|
|
var authData = $cookieStore.get(AUTH_COOKIE_ID);
|
|
if (authData)
|
|
return authData.availableDataSources;
|
|
|
|
// No auth data present
|
|
return null;
|
|
|
|
};
|
|
|
|
return service;
|
|
}]);
|