GUACAMOLE-284: Clarify semantics of disabled user accounts.

This commit is contained in:
Michael Jumper
2017-06-04 14:15:47 -07:00
parent f4fce6a07a
commit 862e2c398a
3 changed files with 30 additions and 25 deletions

View File

@@ -89,9 +89,9 @@ public class JDBCAuthenticationProviderService implements AuthenticationProvider
ModeledUser user = userService.retrieveUser(authenticationProvider, authenticatedUser); ModeledUser user = userService.retrieveUser(authenticationProvider, authenticatedUser);
if (user != null && !user.isDisabled()) { if (user != null && !user.isDisabled()) {
// Apply account restrictions if this extension authenticated // Account restrictions specific to this extension apply if this
// the user OR if an account from this extension is explicitly // extension authenticated the user OR if an account from this
// required // extension is explicitly required
if (authenticatedUser instanceof ModeledAuthenticatedUser if (authenticatedUser instanceof ModeledAuthenticatedUser
|| environment.isUserRequired()) { || environment.isUserRequired()) {

View File

@@ -767,24 +767,26 @@ public class ModeledUser extends ModeledDirectoryObject<UserModel> implements Us
} }
/** /**
* Returns whether the user has been disabled. Disabled users are not * Returns whether this user account has been disabled. The credentials of
* allowed to login. Although their account data exists, all login attempts * disabled user accounts are treated as invalid, effectively disabling
* will fail as if the account does not exist. * that user's access to data for which they would otherwise have
* permission.
* *
* @return * @return
* true if the account is disabled, false otherwise. * true if this user account has been disabled, false otherwise.
*/ */
public boolean isDisabled() { public boolean isDisabled() {
return getModel().isDisabled(); return getModel().isDisabled();
} }
/** /**
* Returns whether the user's password has expired. If a user's password is * Returns whether this user's password has expired. If a user's password
* expired, it must be immediately changed upon login. A user account with * is expired, it must be immediately changed upon login. A user account
* an expired password cannot be used until the password has been changed. * with an expired password cannot be used until the password has been
* changed.
* *
* @return * @return
* true if the user's password has expired, false otherwise. * true if this user's password has expired, false otherwise.
*/ */
public boolean isExpired() { public boolean isExpired() {
return getModel().isExpired(); return getModel().isExpired();

View File

@@ -194,48 +194,51 @@ public class UserModel extends ObjectModel {
} }
/** /**
* Returns whether the user has been disabled. Disabled users are not * Returns whether this user account has been disabled. The credentials of
* allowed to login. Although their account data exists, all login attempts * disabled user accounts are treated as invalid, effectively disabling
* will fail as if the account does not exist. * that user's access to data for which they would otherwise have
* permission.
* *
* @return * @return
* true if the account is disabled, false otherwise. * true if this user account is disabled, false otherwise.
*/ */
public boolean isDisabled() { public boolean isDisabled() {
return disabled; return disabled;
} }
/** /**
* Sets whether the user is disabled. Disabled users are not allowed to * Sets whether this user account has been disabled. The credentials of
* login. Although their account data exists, all login attempts will fail * disabled user accounts are treated as invalid, effectively disabling
* as if the account does not exist. * that user's access to data for which they would otherwise have
* permission.
* *
* @param disabled * @param disabled
* true if the account should be disabled, false otherwise. * true if this user account should be disabled, false otherwise.
*/ */
public void setDisabled(boolean disabled) { public void setDisabled(boolean disabled) {
this.disabled = disabled; this.disabled = disabled;
} }
/** /**
* Returns whether the user's password has expired. If a user's password is * Returns whether this user's password has expired. If a user's password
* expired, it must be immediately changed upon login. A user account with * is expired, it must be immediately changed upon login. A user account
* an expired password cannot be used until the password has been changed. * with an expired password cannot be used until the password has been
* changed.
* *
* @return * @return
* true if the user's password has expired, false otherwise. * true if this user's password has expired, false otherwise.
*/ */
public boolean isExpired() { public boolean isExpired() {
return expired; return expired;
} }
/** /**
* Sets whether the user's password is expired. If a user's password is * Sets whether this user's password is expired. If a user's password is
* expired, it must be immediately changed upon login. A user account with * expired, it must be immediately changed upon login. A user account with
* an expired password cannot be used until the password has been changed. * an expired password cannot be used until the password has been changed.
* *
* @param expired * @param expired
* true to expire the user's password, false otherwise. * true if this user's password has expired, false otherwise.
*/ */
public void setExpired(boolean expired) { public void setExpired(boolean expired) {
this.expired = expired; this.expired = expired;