/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package org.mozilla.jss.crypto;

import org.mozilla.jss.asn1.OBJECT_IDENTIFIER;

/**
 * Algorithms that can be used for generating symmetric keys from passwords.
 */
public class PBEAlgorithm extends KeyGenAlgorithm {

    private EncryptionAlgorithm encAlg;
    private int saltLength;

    protected PBEAlgorithm(int oidTag, String name, int validStrength,
            OBJECT_IDENTIFIER oid, EncryptionAlgorithm encAlg, int saltLength)
    {
        super(oidTag, name, new FixedKeyStrengthValidator(validStrength),
            oid, PBEKeyGenParams.class);
        this.encAlg = encAlg;
        this.saltLength = saltLength;
    }

    /**
     * Returns the EncryptionAlgorithm that should be used with keys
     * generated with this PBEAlgorithm. For example,
     *  <code>PBE_MD2_DES_CBC.getEncryptionAlg()</code> returns
     *  <code>EncryptionAlgorithm.DES_CBC</code>.
     */
    public EncryptionAlgorithm getEncryptionAlg() {
        return encAlg;
    }

    /**
     * Returns the number of bytes of salt that should be supplied when
     * generating keys with this algorithm.
     *
     * <p>PKCS #5 algorithms require exactly 8 bytes of salt.  PKCS #12
     *      algorithms take
     *      a variable length, but recommend that the salt length be at least
     *      as long as the output of the hash function.  For SHA-1, the output
     *      length is 20 bytes.
     */
    public int getSaltLength() {
        return saltLength;
    }

    ///////////////////////////////////////////////////////////////////////
    // OIDs
    ///////////////////////////////////////////////////////////////////////
    private static final OBJECT_IDENTIFIER PKCS5 = OBJECT_IDENTIFIER.PKCS5;
    private static final OBJECT_IDENTIFIER PKCS12_PBE =
            OBJECT_IDENTIFIER.PKCS12.subBranch(1);

    ///////////////////////////////////////////////////////////////////////
    // OID mapping
    ///////////////////////////////////////////////////////////////////////

    //////////////////////////////////////////////////////////////
    // PKCS 5 v2
    public static final PBEAlgorithm
    PBE_PKCS5_PBKDF2 = new PBEAlgorithm(
        SEC_OID_PKCS5_PBKDF2, "PBKDF2", 128,
            PKCS5.subBranch(12), EncryptionAlgorithm.AES_128_CBC, 8 );

    //////////////////////////////////////////////////////////////
    // PKCS 5 v2
    public static final PBEAlgorithm
    PBE_PKCS5_PBES2 = new PBEAlgorithm(
        SEC_OID_PKCS5_PBES2, "PBES2", 128,
            PKCS5.subBranch(13), EncryptionAlgorithm.AES_128_CBC, 8 );

    //////////////////////////////////////////////////////////////
    // PKCS 5 v2
    public static final PBEAlgorithm
    PBE_PKCS5_PBMAC1 = new PBEAlgorithm(
        SEC_OID_PKCS5_PBMAC1, "PBMAC1", 128,
            PKCS5.subBranch(14), EncryptionAlgorithm.AES_128_CBC, 8 );

    //////////////////////////////////////////////////////////////
    public static final PBEAlgorithm
    PBE_MD2_DES_CBC = new PBEAlgorithm(
        SEC_OID_PKCS5_PBE_WITH_MD2_AND_DES_CBC, "PBE/MD2/DES/CBC", 56,
            PKCS5.subBranch(1), EncryptionAlgorithm.DES_CBC, 8 );

    //////////////////////////////////////////////////////////////
    public static final PBEAlgorithm
    PBE_MD5_DES_CBC = new PBEAlgorithm(
        SEC_OID_PKCS5_PBE_WITH_MD5_AND_DES_CBC, "PBE/MD5/DES/CBC", 56,
            PKCS5.subBranch(3), EncryptionAlgorithm.DES_CBC, 8 );

    //////////////////////////////////////////////////////////////
    @Deprecated(since="5.0.1", forRemoval=true)
    public static final PBEAlgorithm
    PBE_SHA1_DES_CBC = new PBEAlgorithm(
        SEC_OID_PKCS5_PBE_WITH_SHA1_AND_DES_CBC, "PBE/SHA1/DES/CBC", 56,
            PKCS5.subBranch(10), EncryptionAlgorithm.DES_CBC, 8 );

    //////////////////////////////////////////////////////////////
    @Deprecated(since="5.0.1", forRemoval=true)
    public static final PBEAlgorithm
    PBE_SHA1_RC4_128 = new PBEAlgorithm(
        SEC_OID_PKCS12_V2_PBE_WITH_SHA1_AND_128_BIT_RC4,
            "PBE/SHA1/RC4-128", 128, PKCS12_PBE.subBranch(1),
            EncryptionAlgorithm.RC4, 20 );

    //////////////////////////////////////////////////////////////
    @Deprecated(since="5.0.1", forRemoval=true)
    public static final PBEAlgorithm
    PBE_SHA1_RC4_40 = new PBEAlgorithm(
        SEC_OID_PKCS12_V2_PBE_WITH_SHA1_AND_40_BIT_RC4,
            "PBE/SHA1/RC4-40", 40, PKCS12_PBE.subBranch(2),
            EncryptionAlgorithm.RC4, 20 );

    //////////////////////////////////////////////////////////////
    @Deprecated(since="5.0.1", forRemoval=true)
    public static final PBEAlgorithm
    PBE_SHA1_DES3_CBC = new PBEAlgorithm(
        SEC_OID_PKCS12_V2_PBE_WITH_SHA1_AND_3KEY_TRIPLE_DES_CBC,
            "PBE/SHA1/DES3/CBC", 168, PKCS12_PBE.subBranch(3),
            EncryptionAlgorithm.DES3_CBC, 20 );

    //////////////////////////////////////////////////////////////
    @Deprecated(since="5.0.1", forRemoval=true)
    public static final PBEAlgorithm
    PBE_SHA1_RC2_128_CBC = new PBEAlgorithm(
        SEC_OID_PKCS12_V2_PBE_WITH_SHA1_AND_128_BIT_RC2_CBC,
            "PBE/SHA1/RC2-128", 128, PKCS12_PBE.subBranch(5),
            EncryptionAlgorithm.RC2_CBC, 20 );

    //////////////////////////////////////////////////////////////
    @Deprecated(since="5.0.1", forRemoval=true)
    public static final PBEAlgorithm
    PBE_SHA1_RC2_40_CBC = new PBEAlgorithm(
        SEC_OID_PKCS12_V2_PBE_WITH_SHA1_AND_40_BIT_RC2_CBC,
            "PBE/SHA1/RC2-40", 40, PKCS12_PBE.subBranch(6),
            EncryptionAlgorithm.RC2_CBC, 20 );
}
