Package org.apache.commons.codec.digest

Class UnixCrypt

  • public class UnixCrypt
extends java.lang.Object
    Unix crypt(3) algorithm implementation.

    This class only implements the traditional 56 bit DES based algorithm. Please use Crypt.crypt() for a method that distinguishes between all the algorithms supported in the current glibc's crypt().

    The initial Java implementation was taken from the JetSpeed Portal project (see org.apache.jetspeed.services.security.ldap.UnixCrypt).

    This class is slightly incompatible if the given salt contains characters that are not part of the allowed range [a-zA-Z0-9./].

    This class is immutable and thread-safe.

    Since:
    1.7

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static int[] CON_SALT  
      private static int[] COV2CHAR  
      private static java.util.regex.Pattern CRYPT_SALT_PATTERN  
      private static java.lang.String CRYPT_SALT_REGEX  
      private static boolean[] SHIFT2  
      private static int[][] SKB  
      private static int[][] SPTRANS  

    • Constructor Summary

      Constructors 
      Constructor Description
      UnixCrypt()
      Deprecated.
      TODO Make private in 2.0.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      private static int[] body​(int[] schedule, int eSwap0, int eSwap1)  
      private static int byteToUnsigned​(byte b)  
      static java.lang.String crypt​(byte[] original)
      Generates a crypt(3) compatible hash using the DES algorithm.
      static java.lang.String crypt​(byte[] original, java.lang.String salt)
      Generates a crypt(3) compatible hash using the DES algorithm.
      static java.lang.String crypt​(java.lang.String original)
      Generates a crypt(3) compatible hash using the DES algorithm.
      static java.lang.String crypt​(java.lang.String original, java.lang.String salt)
      Generates a crypt(3) compatible hash using the DES algorithm.
      private static int dEncrypt​(int el, int r, int s, int e0, int e1, int[] sArr)  
      private static int[] desSetKey​(byte[] key)  
      private static int fourBytesToInt​(byte[] b, int offset)  
      private static int hPermOp​(int a, int n, int m)  
      private static void intToFourBytes​(int iValue, byte[] b, int offset)  
      private static void permOp​(int a, int b, int n, int m, int[] results)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • CRYPT_SALT_REGEX

        private static final java.lang.String CRYPT_SALT_REGEX
        See Also:
        Constant Field Values

      • CRYPT_SALT_PATTERN

        private static final java.util.regex.Pattern CRYPT_SALT_PATTERN

      • CON_SALT

        private static final int[] CON_SALT

      • COV2CHAR

        private static final int[] COV2CHAR

      • SHIFT2

        private static final boolean[] SHIFT2

      • SKB

        private static final int[][] SKB

      • SPTRANS

        private static final int[][] SPTRANS

    • Constructor Detail

      • UnixCrypt

        @Deprecated
public UnixCrypt()
        Deprecated.
        TODO Make private in 2.0.
        TODO Make private in 2.0.

    • Method Detail

      • body

        private static int[] body​(int[] schedule,
                          int eSwap0,
                          int eSwap1)

      • byteToUnsigned

        private static int byteToUnsigned​(byte b)

      • crypt

        public static java.lang.String crypt​(byte[] original)
        Generates a crypt(3) compatible hash using the DES algorithm.

        A salt is generated for you using SecureRandom.

        Parameters:
        original - Plaintext password.
        Returns:
        A 13 character string starting with the salt string.

      • crypt

        public static java.lang.String crypt​(byte[] original,
                                     java.lang.String salt)
        Generates a crypt(3) compatible hash using the DES algorithm.

        Using unspecified characters as salt results incompatible hash values.

        Parameters:
        original - Plaintext password.
        salt - a two character string drawn from [a-zA-Z0-9./]. The salt may be null, in which case a salt is generated for you using B64.getRandomSalt(int). Only the first two characters are used, others are ignored.
        Returns:
        A 13 character string starting with the salt string.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the salt does not match the allowed pattern.

      • crypt

        public static java.lang.String crypt​(java.lang.String original)
        Generates a crypt(3) compatible hash using the DES algorithm.

        A salt is generated for you using SecureRandom.

        Parameters:
        original - Plaintext password.
        Returns:
        A 13 character string starting with the salt string.

      • crypt

        public static java.lang.String crypt​(java.lang.String original,
                                     java.lang.String salt)
        Generates a crypt(3) compatible hash using the DES algorithm.
        Parameters:
        original - Plaintext password.
        salt - A two character string drawn from [a-zA-Z0-9./]. The salt may be null, in which case a salt is generated for you using SecureRandom.
        Returns:
        A 13 character string starting with the salt string.
        Throws:
        java.lang.IllegalArgumentException - if the salt does not match the allowed pattern.

      • dEncrypt

        private static int dEncrypt​(int el,
                            int r,
                            int s,
                            int e0,
                            int e1,
                            int[] sArr)

      • desSetKey

        private static int[] desSetKey​(byte[] key)

      • fourBytesToInt

        private static int fourBytesToInt​(byte[] b,
                                  int offset)

      • hPermOp

        private static int hPermOp​(int a,
                           int n,
                           int m)

      • intToFourBytes

        private static void intToFourBytes​(int iValue,
                                   byte[] b,
                                   int offset)

      • permOp

        private static void permOp​(int a,
                           int b,
                           int n,
                           int m,
                           int[] results)