Package org.apereo.cas.configuration.support

Class CasConfigurationJasyptCipherExecutor

  • All Implemented Interfaces:
    org.apereo.cas.util.crypto.CipherExecutor<java.lang.String,​java.lang.String>, org.apereo.cas.util.crypto.DecodableCipher<java.lang.String,​java.lang.String>, org.apereo.cas.util.crypto.EncodableCipher<java.lang.String,​java.lang.String>
    public class CasConfigurationJasyptCipherExecutor
extends java.lang.Object
implements org.apereo.cas.util.crypto.CipherExecutor<java.lang.String,​java.lang.String>
    This is CasConfigurationJasyptCipherExecutor.
    Since:
    5.1.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ENCRYPTED_VALUE_PREFIX
      Prefix inserted at the beginning of a value to indicate it's encrypted.

      • Fields inherited from interface org.apereo.cas.util.crypto.CipherExecutor

        DEFAULT_CONTENT_ENCRYPTION_ALGORITHM, DEFAULT_STRINGABLE_ENCRYPTION_KEY_SIZE, DEFAULT_STRINGABLE_SIGNING_KEY_SIZE

      • Fields inherited from interface org.apereo.cas.util.crypto.DecodableCipher

        LOGGER

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String decode​(java.lang.String value, java.lang.Object[] parameters)  
      java.lang.String decryptValue​(java.lang.String value)
      Decrypt value string.
      java.lang.String encode​(java.lang.String value, java.lang.Object[] parameters)  
      java.lang.String encryptValue​(java.lang.String value)
      Encrypt value as string.
      java.lang.String encryptValue​(java.lang.String value, java.util.function.Function<java.lang.Exception,​java.lang.String> handler)
      Encrypt value string.
      static java.lang.String extractEncryptedValue​(java.lang.String value)
      Extract encrypted value as string to decode later.
      java.lang.String getName()  
      static boolean isValueEncrypted​(java.lang.String value)
      Is value encrypted, and does it start with the required prefix.
      void setAlgorithm​(java.lang.String alg)
      Sets algorithm.
      void setIvGenerator​(org.jasypt.iv.IvGenerator iv)
      Sets iv generator.
      void setKeyObtentionIterations​(java.lang.String iter)
      Sets key obtention iterations.
      void setPassword​(java.lang.String psw)
      Sets password.
      void setProviderName​(java.lang.String pName)
      Sets provider name.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.apereo.cas.util.crypto.CipherExecutor

        getSigningKey, isEnabled

      • Methods inherited from interface org.apereo.cas.util.crypto.DecodableCipher

        decode, decode

      • Methods inherited from interface org.apereo.cas.util.crypto.EncodableCipher

        encode

    • Field Detail

      • ENCRYPTED_VALUE_PREFIX

        public static final java.lang.String ENCRYPTED_VALUE_PREFIX
        Prefix inserted at the beginning of a value to indicate it's encrypted.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CasConfigurationJasyptCipherExecutor

        public CasConfigurationJasyptCipherExecutor​(java.lang.String algorithm,
                                            java.lang.String password)

      • CasConfigurationJasyptCipherExecutor

        public CasConfigurationJasyptCipherExecutor​(org.springframework.core.env.Environment environment)

    • Method Detail

      • setAlgorithm

        public void setAlgorithm​(java.lang.String alg)
        Sets algorithm.
        Parameters:
        alg - the alg

      • setIvGenerator

        public void setIvGenerator​(org.jasypt.iv.IvGenerator iv)
        Sets iv generator.
        Parameters:
        iv - the iv

      • setPassword

        public void setPassword​(java.lang.String psw)
        Sets password.
        Parameters:
        psw - the psw

      • setKeyObtentionIterations

        public void setKeyObtentionIterations​(java.lang.String iter)
        Sets key obtention iterations.
        Parameters:
        iter - the iter

      • setProviderName

        public void setProviderName​(java.lang.String pName)
        Sets provider name.
        Parameters:
        pName - the p name

      • encode

        public java.lang.String encode​(java.lang.String value,
                               java.lang.Object[] parameters)
        Specified by:
        encode in interface org.apereo.cas.util.crypto.EncodableCipher<java.lang.String,​java.lang.String>

      • decode

        public java.lang.String decode​(java.lang.String value,
                               java.lang.Object[] parameters)
        Specified by:
        decode in interface org.apereo.cas.util.crypto.DecodableCipher<java.lang.String,​java.lang.String>

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface org.apereo.cas.util.crypto.CipherExecutor<java.lang.String,​java.lang.String>

      • encryptValue

        public java.lang.String encryptValue​(java.lang.String value,
                                     java.util.function.Function<java.lang.Exception,​java.lang.String> handler)
        Encrypt value string.
        Parameters:
        value - the value
        handler - the handler
        Returns:
        the string

      • encryptValue

        public java.lang.String encryptValue​(java.lang.String value)
        Encrypt value as string.
        Parameters:
        value - the value
        Returns:
        the string

      • decryptValue

        public java.lang.String decryptValue​(java.lang.String value)
        Decrypt value string.
        Parameters:
        value - the value
        Returns:
        the string

      • isValueEncrypted

        public static boolean isValueEncrypted​(java.lang.String value)
        Is value encrypted, and does it start with the required prefix.
        Parameters:
        value - the value
        Returns:
        true/false

      • extractEncryptedValue

        public static java.lang.String extractEncryptedValue​(java.lang.String value)
        Extract encrypted value as string to decode later.
        Parameters:
        value - the value
        Returns:
        the string