/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.crypto.provider;

import java.security.InvalidKeyException;

import java.security.spec.KeySpec;

import java.security.spec.InvalidKeySpecException;

import javax.crypto.SecretKey;

import javax.crypto.SecretKeyFactorySpi;

import javax.crypto.spec.PBEKeySpec;

import java.util.HashSet;

import java.util.Locale;

/**

 * This class implements a key factory for PBE keys according to PKCS#5,

 * meaning that the password must consist of printable ASCII characters

 * (values 32 to 126 decimal inclusive) and only the low order 8 bits

 * of each password character are used.

 *

 * @author Jan Luehe

 *

 */

abstract class PBEKeyFactory extends SecretKeyFactorySpi {

    private String type;

    private static HashSet<String> validTypes;

    /**

     * Simple constructor

     */

    private PBEKeyFactory(String keytype) {

        type = keytype;

    }

    static {

        validTypes = new HashSet<>(17);

        validTypes.add("PBEWithMD5AndDES".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithSHA1AndDESede".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithSHA1AndRC2_40".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithSHA1AndRC2_128".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithSHA1AndRC4_40".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithSHA1AndRC4_128".toUpperCase(Locale.ENGLISH));

        // Proprietary algorithm.

        validTypes.add("PBEWithMD5AndTripleDES".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA1AndAES_128".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA224AndAES_128".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA256AndAES_128".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA384AndAES_128".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA512AndAES_128".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA1AndAES_256".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA224AndAES_256".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA256AndAES_256".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA384AndAES_256".toUpperCase(Locale.ENGLISH));

        validTypes.add("PBEWithHmacSHA512AndAES_256".toUpperCase(Locale.ENGLISH));

    }

    public static final class PBEWithMD5AndDES

            extends PBEKeyFactory {

        public PBEWithMD5AndDES()  {

            super("PBEWithMD5AndDES");

        }

    }

    public static final class PBEWithSHA1AndDESede

            extends PBEKeyFactory {

        public PBEWithSHA1AndDESede()  {

            super("PBEWithSHA1AndDESede");

        }

    }

    public static final class PBEWithSHA1AndRC2_40

            extends PBEKeyFactory {

        public PBEWithSHA1AndRC2_40()  {

            super("PBEWithSHA1AndRC2_40");

        }

    }

    public static final class PBEWithSHA1AndRC2_128

            extends PBEKeyFactory {

        public PBEWithSHA1AndRC2_128()  {

            super("PBEWithSHA1AndRC2_128");

        }

    }

    public static final class PBEWithSHA1AndRC4_40

            extends PBEKeyFactory {

        public PBEWithSHA1AndRC4_40()  {

            super("PBEWithSHA1AndRC4_40");

        }

    }

    public static final class PBEWithSHA1AndRC4_128

            extends PBEKeyFactory {

        public PBEWithSHA1AndRC4_128()  {

            super("PBEWithSHA1AndRC4_128");

        }

    }

    /*

     * Private proprietary algorithm for supporting JCEKS.

     */

    public static final class PBEWithMD5AndTripleDES

            extends PBEKeyFactory {

        public PBEWithMD5AndTripleDES()  {

            super("PBEWithMD5AndTripleDES");

        }

    }

    public static final class PBEWithHmacSHA1AndAES_128

            extends PBEKeyFactory {

        public PBEWithHmacSHA1AndAES_128()  {

            super("PBEWithHmacSHA1AndAES_128");

        }

    }

    public static final class PBEWithHmacSHA224AndAES_128

            extends PBEKeyFactory {

        public PBEWithHmacSHA224AndAES_128()  {

            super("PBEWithHmacSHA224AndAES_128");

        }

    }

    public static final class PBEWithHmacSHA256AndAES_128

            extends PBEKeyFactory {

        public PBEWithHmacSHA256AndAES_128()  {

            super("PBEWithHmacSHA256AndAES_128");

        }

    }

    public static final class PBEWithHmacSHA384AndAES_128

            extends PBEKeyFactory {

        public PBEWithHmacSHA384AndAES_128()  {

            super("PBEWithHmacSHA384AndAES_128");

        }

    }

    public static final class PBEWithHmacSHA512AndAES_128

            extends PBEKeyFactory {

        public PBEWithHmacSHA512AndAES_128()  {

            super("PBEWithHmacSHA512AndAES_128");

        }

    }

    public static final class PBEWithHmacSHA1AndAES_256

            extends PBEKeyFactory {

        public PBEWithHmacSHA1AndAES_256()  {

            super("PBEWithHmacSHA1AndAES_256");

        }

    }

    public static final class PBEWithHmacSHA224AndAES_256

            extends PBEKeyFactory {

        public PBEWithHmacSHA224AndAES_256()  {

            super("PBEWithHmacSHA224AndAES_256");

        }

    }

    public static final class PBEWithHmacSHA256AndAES_256

            extends PBEKeyFactory {

        public PBEWithHmacSHA256AndAES_256()  {

            super("PBEWithHmacSHA256AndAES_256");

        }

    }

    public static final class PBEWithHmacSHA384AndAES_256

            extends PBEKeyFactory {

        public PBEWithHmacSHA384AndAES_256()  {

            super("PBEWithHmacSHA384AndAES_256");

        }

    }

    public static final class PBEWithHmacSHA512AndAES_256

            extends PBEKeyFactory {

        public PBEWithHmacSHA512AndAES_256()  {

            super("PBEWithHmacSHA512AndAES_256");

        }

    }

    /**

     * Generates a <code>SecretKey</code> object from the provided key

     * specification (key material).

     *

     * @param keySpec the specification (key material) of the secret key

     *

     * @return the secret key

     *

     * @exception InvalidKeySpecException if the given key specification

     * is inappropriate for this key factory to produce a public key.

     */

    protected SecretKey engineGenerateSecret(KeySpec keySpec)

        throws InvalidKeySpecException

    {

        if (!(keySpec instanceof PBEKeySpec)) {

            throw new InvalidKeySpecException("Invalid key spec");

        }

    }

    /**

     * Returns a specification (key material) of the given key

     * in the requested format.

     *

     * @param key the key

     *

     * @param keySpec the requested format in which the key material shall be

     * returned

     *

     * @return the underlying key specification (key material) in the

     * requested format

     *

     * @exception InvalidKeySpecException if the requested key specification is

     * inappropriate for the given key, or the given key cannot be processed

     * (e.g., the given key has an unrecognized algorithm or format).

     */

    protected KeySpec engineGetKeySpec(SecretKey key, Class<?> keySpecCl)

        throws InvalidKeySpecException {

        if ((key instanceof SecretKey)

            && (validTypes.contains(key.getAlgorithm().toUpperCase(Locale.ENGLISH)))

            && (key.getFormat().equalsIgnoreCase("RAW"))) {

            // Check if requested key spec is amongst the valid ones

            if ((keySpecCl != null)

                && PBEKeySpec.class.isAssignableFrom(keySpecCl)) {

                byte[] passwdBytes = key.getEncoded();

                char[] passwdChars = new char[passwdBytes.length];

                for (int i=0; i<passwdChars.length; i++)

                    passwdChars[i] = (char) (passwdBytes[i] & 0x7f);

                PBEKeySpec ret = new PBEKeySpec(passwdChars);

                // password char[] was cloned in PBEKeySpec constructor,

                // so we can zero it out here

                java.util.Arrays.fill(passwdChars, ' ');

                java.util.Arrays.fill(passwdBytes, (byte)0x00);

                return ret;

            } else {

                throw new InvalidKeySpecException("Invalid key spec");

            }

        } else {

            throw new InvalidKeySpecException("Invalid key "

                                              + "format/algorithm");

        }

    }

    /**

     * Translates a <code>SecretKey</code> object, whose provider may be

     * unknown or potentially untrusted, into a corresponding

     * <code>SecretKey</code> object of this key factory.

     *

     * @param key the key whose provider is unknown or untrusted

     *

     * @return the translated key

     *

     * @exception InvalidKeyException if the given key cannot be processed by

     * this key factory.

     */

    protected SecretKey engineTranslateKey(SecretKey key)

        throws InvalidKeyException

    {

        try {

            if ((key != null) &&

                (validTypes.contains(key.getAlgorithm().toUpperCase(Locale.ENGLISH))) &&

                (key.getFormat().equalsIgnoreCase("RAW"))) {

                // Check if key originates from this factory

                if (key instanceof com.sun.crypto.provider.PBEKey) {

                    return key;

                }

                // Convert key to spec

                PBEKeySpec pbeKeySpec = (PBEKeySpec)engineGetKeySpec

                    (key, PBEKeySpec.class);

                // Create key from spec, and return it

                return engineGenerateSecret(pbeKeySpec);

            } else {

                throw new InvalidKeyException("Invalid key format/algorithm");

            }

        } catch (InvalidKeySpecException ikse) {

            throw new InvalidKeyException("Cannot translate key: "

                                          + ikse.getMessage());

        }

    }

}