This class implements the Spring Security 2.x org.springframework.security.providers.encoding.PasswordEncoder interface, allowing Spring Security-enabled applications to use JASYPT for password encryption.
Important: This class allows bi-directional password-based encryption of user passwords in Spring Security using Jasypt. But please note that passwords should not be encrypted in a bi-directional way, but instead as uni-directional digests (hashes). Encrypting passwords in a way they can be decrypted can be a severe security issue, and should only be considered in legacy or complex inter-application integration scenarios.
Objects of this class will internally hold either an object of type org.jasypt.util.text.TextEncryptor or an object of type org.jasypt.encryption.pbe.PBEStringEncryptor (only one of them), which should be set by respectively calling {@link #setTextEncryptor(TextEncryptor)} or{@link #setPbeStringEncryptor(PBEStringEncryptor)}after creation. If neither a TextEncryptor nor a PBEStringEncryptor are set, a new org.jasypt.util.text.BasicTextEncryptor object is created and internally used.
Important: This implementation ignores any salt provided through the interface methods, as the internal Jasypt TextEncryptor or PBEStringEncryptor objects normally use a random one. This means that salt can be safely passed as null.
Usage with a TextEncryptor
This class can be used like this from your Spring XML resource files:
... <!-- Your application may use the TextEncryptor in several places, --> <!-- like for example at new user sign-up. --> <bean id="jasyptTextEncryptor" class="org.jasypt.util.text.StrongTextEncryptor" > <property name="password" value="myPassword" /> </bean> ... ... <!-- This Spring Security-friendly PasswordEncoder implementation will --> <!-- wrap the TextEncryptor instance so that it can be used from --> <!-- the security framework. --> <bean id="passwordEncoder" class="org.jasypt.spring.security2.PBEPasswordEncoder"> <property name="textEncryptor"> <ref bean="jasyptTextEncryptor" /> </property> </bean> ... ... <!-- Your DaoAuthenticationProvider will then use it like with any --> <!-- other implementation of the PasswordEncoder interface. --> <bean id="daoAuthenticationProvider" class="org.springframework.security.providers.dao.DaoAuthenticationProvider"> <property name="userDetailsService" ref="userDetailsService"/> <property name="passwordEncoder"> <ref bean="passwordEncoder" /> </property> </bean> ...
Usage with a PBEStringEncryptor
This class can be used like this from your Spring XML resource files:
... <!-- Your application may use the PBEStringEncryptor in several places,--> <!-- like for example at new user sign-up. --> <bean id="jasyptPBEStringEncryptor" class="org.jasypt.encryption.pbe.StandardPBEStringEncryptor" > <property name="algorithm" value="PBEWithMD5AndTripleDES" /> <property name="password" value="myPassword" /> </bean> ... ... <!-- This Spring Security-friendly PasswordEncoder implementation will --> <!-- wrap the PBEStringEncryptor instance so that it can be used from --> <!-- the security framework. --> <bean id="passwordEncoder" class="org.jasypt.spring.security2.PBEPasswordEncoder"> <property name="pbeStringEncryptor"> <ref bean="jasyptPBEStringEncryptor" /> </property> </bean> ... ... <!-- Your DaoAuthenticationProvider will then use it like with any --> <!-- other implementation of the PasswordEncoder interface. --> <bean id="daoAuthenticationProvider" class="org.springframework.security.providers.dao.DaoAuthenticationProvider"> <property name="userDetailsService" ref="userDetailsService"/> <property name="passwordEncoder"> <ref bean="passwordEncoder" /> </property> </bean> ...
This class is thread-safe
@since 1.5 @author Daniel Fernández | |