Package org.cyclos.security.access

Class PasswordServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.access.PasswordServiceSecurity

All Implemented Interfaces:

PasswordService, Service

@Security
public class PasswordServiceSecurity
extends BaseServiceSecurity
implements PasswordService

Security layer for password checks

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.services.access.PasswordService

MAX_PASSWORD_LENGTH, MIN_PASSWORD_LENGTH

Constructor Summary

Constructors

Constructor	Description
PasswordServiceSecurity()

Method Summary

Modifier and Type	Method	Description
String	activate(PasswordTypeVO passwordTypeVO)	Activates a password whose mode is PasswordMode.GENERATED creating a new password for the current user.
void	allowActivation(PasswordActionDTO params)	Allows the given user to activate the given generated and pending password
void	change(ChangePasswordDTO dto)	Manually changes a password
void	changeForgottenPassword(ChangeForgottenPasswordDTO dto)	Changes a manual password leaving as PasswordStatus.ACTIVE, or if generated, send a new one (leaving as PasswordStatus.ACTIVE or PasswordStatus.RESET whether the user has the change permission or not)
void	disable(PasswordActionDTO params)	Disables a password.
void	enable(PasswordActionDTO params)	Enables a disabled password.
ForgotPasswordRequestResponse	forgotPasswordRequest(ForgotPasswordRequestDTO params)	Initiates the forgot password operation, sending a code either by e-mail or SMS to the user.
String	generateNew(ChangeGeneratedPasswordDTO params)	Allows to change a generated password by generating a new one
ChangeForgottenPasswordData	getChangeForgottenPasswordData(GetChangeForgottenPasswordDataParams params)	Returns data for a forgot password change request
ChangePasswordData	getChangePasswordData(boolean changeSecondaryPassword)	Returns data for change the main/secondary access password (manual or generated)
UserPasswordsData	getData(UserLocatorVO locator)	Returns data for user passwords
PasswordData	getPasswordData(UserLocatorVO locator, PasswordTypeVO type)	Returns data for a given password of the given user.
SetSecurityQuestionData	getSetSecurityQuestionData()	Returns data used to set the security question
List<String>	requestNewOTP(SendMedium medium, String channel)	Generates a new OTP (removing any previous password, if any) and sends it by the specified medium using the confirmation mode configured the given channel for the logged user.
List<String>	requestNewOTPForSecondaryPassword(SendMedium medium)	Same as PasswordService.requestNewOTP(SendMedium, String) but using the secondary password type configured in the current channel for the logged user.
void	reset(PasswordActionDTO params)	Resets the given generated password and allow it to be activated again
void	resetAndSend(ResetAndSendPasswordDTO params)	Generates a new value of a manual password and send it to the user (for example, via e-mail).
void	resetSecurityQuestion(UserLocatorVO locator)	Resets the security question, forcing the user to set a new one in the next login
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none
void	setSecurityQuestion(SetSecurityQuestionDTO params)	Sets the security question's answer for the logged user
void	unblock(PasswordActionDTO params)	Unblocks the given user password

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PasswordServiceSecurity

public PasswordServiceSecurity()

Method Detail

activate

public String activate(PasswordTypeVO passwordTypeVO)
                throws FrameworkException,
                       IllegalActionException

Description copied from interface: PasswordService

Activates a password whose mode is PasswordMode.GENERATED creating a new password for the current user.

Specified by:

activate in interface PasswordService

Throws:

IllegalActionException - When the given password type is not generated, or is not in any of the following statuses:

• PasswordStatus.NEVER_CREATED
• PasswordStatus.PENDING
• PasswordStatus.EXPIRED
• PasswordStatus.RESET

FrameworkException

allowActivation

public void allowActivation(PasswordActionDTO params)
                     throws FrameworkException,
                            IllegalActionException

Description copied from interface: PasswordService

Allows the given user to activate the given generated and pending password

Specified by:

allowActivation in interface PasswordService

Throws:

IllegalActionException - When the given password is not generated / doesn't apply to the given user

FrameworkException

change

public void change(ChangePasswordDTO dto)
            throws FrameworkException,
                   IllegalActionException,
                   PasswordException,
                   ValidationException

Description copied from interface: PasswordService

Manually changes a password

Specified by:

change in interface PasswordService

Throws:

PasswordException - The current password is invalid

ValidationException - When the given new password is invalid according to the constraints

IllegalActionException - When the current password cannot be changed (for example, it is generated)

FrameworkException

changeForgottenPassword

public void changeForgottenPassword(ChangeForgottenPasswordDTO dto)
                             throws FrameworkException,
                                    InvalidSecurityAnswerException

Description copied from interface: PasswordService

Changes a manual password leaving as PasswordStatus.ACTIVE, or if generated, send a new one (leaving as PasswordStatus.ACTIVE or PasswordStatus.RESET whether the user has the change permission or not)

Specified by:

changeForgottenPassword in interface PasswordService

Throws:

FrameworkException

InvalidSecurityAnswerException

disable

public void disable(PasswordActionDTO params)
             throws FrameworkException,
                    IllegalActionException

Description copied from interface: PasswordService

Disables a password. A disabled password cannot be used again, unless re-enabled

Specified by:

disable in interface PasswordService

Throws:

IllegalActionException - When the current password cannot be disabled (for example, is already disabled)

FrameworkException

enable

public void enable(PasswordActionDTO params)
            throws FrameworkException,
                   IllegalActionException

Description copied from interface: PasswordService

Enables a disabled password. A disabled password cannot be used again, unless re-enabled

Specified by:

enable in interface PasswordService

Throws:

IllegalActionException - When the current password cannot be enabled (not in the disabled state)

FrameworkException

forgotPasswordRequest

public ForgotPasswordRequestResponse forgotPasswordRequest(ForgotPasswordRequestDTO params)
                                                    throws FrameworkException

Description copied from interface: PasswordService

Initiates the forgot password operation, sending a code either by e-mail or SMS to the user. May also require a security question verification. Returns the e-mail address of phone numbers the code was sent to. The value will be masked if not the same one as requested in the params.

Specified by:

forgotPasswordRequest in interface PasswordService

Throws:

FrameworkException

generateNew

public String generateNew(ChangeGeneratedPasswordDTO params)
                   throws FrameworkException,
                          IllegalActionException

Description copied from interface: PasswordService

Allows to change a generated password by generating a new one

Specified by:

generateNew in interface PasswordService

Throws:

FrameworkException

IllegalActionException

getChangeForgottenPasswordData

public ChangeForgottenPasswordData getChangeForgottenPasswordData(GetChangeForgottenPasswordDataParams params)
                                                           throws FrameworkException

Description copied from interface: PasswordService

Returns data for a forgot password change request

Specified by:

getChangeForgottenPasswordData in interface PasswordService

Throws:

FrameworkException

getChangePasswordData

public ChangePasswordData getChangePasswordData(boolean changeSecondaryPassword)
                                         throws FrameworkException

Description copied from interface: PasswordService

Returns data for change the main/secondary access password (manual or generated)

Specified by:

getChangePasswordData in interface PasswordService

Throws:

FrameworkException

getData

public UserPasswordsData getData(UserLocatorVO locator)
                          throws FrameworkException

Description copied from interface: PasswordService

Returns data for user passwords

Specified by:

getData in interface PasswordService

Throws:

FrameworkException

getPasswordData

public PasswordData getPasswordData(UserLocatorVO locator,
                                    PasswordTypeVO type)
                             throws FrameworkException

Description copied from interface: PasswordService

Returns data for a given password of the given user.

Specified by:

getPasswordData in interface PasswordService

Throws:

FrameworkException

getSetSecurityQuestionData

public SetSecurityQuestionData getSetSecurityQuestionData()
                                                   throws FrameworkException

Description copied from interface: PasswordService

Returns data used to set the security question

Specified by:

getSetSecurityQuestionData in interface PasswordService

Throws:

FrameworkException

requestNewOTP

public List<String> requestNewOTP(SendMedium medium,
                                  String channel)
                           throws FrameworkException

Description copied from interface: PasswordService

Generates a new OTP (removing any previous password, if any) and sends it by the specified medium using the confirmation mode configured the given channel for the logged user. If the channel is null then it use the current channel.

Specified by:

requestNewOTP in interface PasswordService

Parameters:

medium - the medium used to send the OTP.

channel - the channel used to get the confirmation mode configuration (password type / device)

Returns:

the email or the normalized phones number the OTP was sent.

Throws:

SmsSendingException - only if medium is SendMedium.SMS and the OTP could not be sent to any enabled for sms phone.

FrameworkException

requestNewOTPForSecondaryPassword

public List<String> requestNewOTPForSecondaryPassword(SendMedium medium)
                                               throws FrameworkException

Description copied from interface: PasswordService

Same as PasswordService.requestNewOTP(SendMedium, String) but using the secondary password type configured in the current channel for the logged user.

Specified by:

requestNewOTPForSecondaryPassword in interface PasswordService

Throws:

FrameworkException

reset

public void reset(PasswordActionDTO params)
           throws FrameworkException,
                  IllegalActionException

Description copied from interface: PasswordService

Resets the given generated password and allow it to be activated again

Specified by:

reset in interface PasswordService

Throws:

FrameworkException

IllegalActionException

resetAndSend

public void resetAndSend(ResetAndSendPasswordDTO params)
                  throws FrameworkException,
                         IllegalActionException

Description copied from interface: PasswordService

Generates a new value of a manual password and send it to the user (for example, via e-mail). If the password is generated, it will be initially active. If it is manual, it will keep the status PasswordStatus.RESET, forcing the user to change it.

Specified by:

resetAndSend in interface PasswordService

Throws:

FrameworkException

IllegalActionException

resetSecurityQuestion

public void resetSecurityQuestion(UserLocatorVO locator)
                           throws FrameworkException

Description copied from interface: PasswordService

Resets the security question, forcing the user to set a new one in the next login

Specified by:

resetSecurityQuestion in interface PasswordService

Throws:

FrameworkException

setSecurityQuestion

public void setSecurityQuestion(SetSecurityQuestionDTO params)
                         throws FrameworkException

Description copied from interface: PasswordService

Sets the security question's answer for the logged user

Specified by:

setSecurityQuestion in interface PasswordService

Throws:

FrameworkException

unblock

public void unblock(PasswordActionDTO params)
             throws FrameworkException,
                    IllegalActionException

Description copied from interface: PasswordService

Unblocks the given user password

Specified by:

unblock in interface PasswordService

Throws:

IllegalActionException - When the given password is not blocked / doesn't apply to the given user

FrameworkException

resolveEntityCheck

protected EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity