safebox/guacamole-client
4
0
Fork 0
mirror of https://github.com/gyurix1968/guacamole-client.git synced 2025-09-06 13:17:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

GUACAMOLE-362: Update documentation to reflect code.

Browse Source
This commit is contained in:
Nick Couchman
2017-09-27 10:25:52 -04:00
committed by Nick Couchman
parent 1592cf563a
commit 6f04573b84
2 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/conf/ConfigurationService.java
View File

@@ -71,12 +71,11 @@ public class ConfigurationService {
}
/**
* Returns the path to the file that contains the private key
* used to decrypt the credential that is sent encrypted by CAS,
* or null if no key is defined.
* Returns the PrivateKey used to decrypt the credential object
* sent encrypted by CAS, or null if no key is defined.
*
* @return
* The path to the private key to decrypt the ClearPass
* The PrivateKey used to decrypt the ClearPass
* credential returned by CAS.
*
* @throws GuacamoleException

13
extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java
View File

@@ -42,20 +42,19 @@ public class TicketValidationService {
private ConfigurationService confService;
/**
* Validates and parses the given ID ticket, returning the username contained
* therein, as defined by the username claim type given in
* guacamole.properties. If the username claim type is missing or the ID
* ticket is invalid, an exception is thrown instead.
* Validates and parses the given ID ticket, returning the AttributePrincipal
* derived from the parameters provided by the CAS server in the ticket. If the
* ticket is invalid an exception is thrown.
*
* @param ticket
* The ID ticket to validate and parse.
*
* @return
* The username contained within the given ID ticket.
* The AttributePrincipal derived from parameters provided in the ticket.
*
* @throws GuacamoleException
* If the ID ticket is not valid, the username claim type is missing, or
* guacamole.properties could not be parsed.
* If the ID ticket is not valid or guacamole.properties could
* not be parsed.
*/
public AttributePrincipal validateTicket(String ticket) throws GuacamoleException {