org.bouncycastle.jcajce.spec.MQVParameterSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bc-fips-debug Show documentation
The FIPS 140-2 Bouncy Castle Crypto package is a Java implementation of cryptographic algorithms certified to FIPS 140-2 level 1. This jar contains the debug version JCE provider and low-level API for the BC-FJA version 1.0.2.3, FIPS Certificate #3514. Please note the debug jar is not certified.
There is a newer version: 2.0.0
Show newest version
package org.bouncycastle.jcajce.spec;

import java.security.KeyPair;
import java.security.PrivateKey;
import java.security.PublicKey;
import java.security.spec.AlgorithmParameterSpec;

/**
 * Parameter spec to provide MQV ephemeral keys and user keying material.
 */
public class MQVParameterSpec
    implements AlgorithmParameterSpec
{
    private final PublicKey ephemeralPublicKey;
    private final PrivateKey ephemeralPrivateKey;
    private final PublicKey otherPartyEphemeralKey;
    private final AlgorithmParameterSpec kdfParameterSpec;

    /**
     * Base constructor.
     *
     * @param ephemeralPublicKey our ephemeral public key.
     * @param ephemeralPrivateKey our ephemeral private key.
     * @param otherPartyEphemeralKey the ephemeral public key sent by the other party.
     * @param kdfParameterSpec parameter spec for key generator to mix with the calculated secret.
     */
    public MQVParameterSpec(PublicKey ephemeralPublicKey, PrivateKey ephemeralPrivateKey, PublicKey otherPartyEphemeralKey, AlgorithmParameterSpec kdfParameterSpec)
    {
        if (ephemeralPrivateKey == null)
        {
            throw new IllegalArgumentException("ephemeral private key cannot be null");
        }
        if (otherPartyEphemeralKey == null)
        {
            throw new IllegalArgumentException("other party ephemeral key cannot be null");
        }
        this.ephemeralPublicKey = ephemeralPublicKey;
        this.ephemeralPrivateKey = ephemeralPrivateKey;
        this.otherPartyEphemeralKey = otherPartyEphemeralKey;
        this.kdfParameterSpec = kdfParameterSpec;
    }

    /**
     * Base constructor.
     *
     * @param ephemeralPublicKey     our ephemeral public key.
     * @param ephemeralPrivateKey    our ephemeral private key.
     * @param otherPartyEphemeralKey the other party's ephemeral public key.
     * @param userKeyingMaterial     the user keying material for the key derivation function.
     */
    public MQVParameterSpec(PublicKey ephemeralPublicKey, PrivateKey ephemeralPrivateKey, PublicKey otherPartyEphemeralKey, byte[] userKeyingMaterial)
    {
        this(ephemeralPublicKey, ephemeralPrivateKey, otherPartyEphemeralKey, (userKeyingMaterial != null) ? new UserKeyingMaterialSpec(userKeyingMaterial) : null);
    }

    /**
     * Constructor without user keying material.
     *
     * @param ephemeralPublicKey     our ephemeral public key.
     * @param ephemeralPrivateKey    our ephemeral private key.
     * @param otherPartyEphemeralKey the other party's ephemeral public key.
     */
    public MQVParameterSpec(PublicKey ephemeralPublicKey, PrivateKey ephemeralPrivateKey, PublicKey otherPartyEphemeralKey)
    {
        this(ephemeralPublicKey, ephemeralPrivateKey, otherPartyEphemeralKey, (AlgorithmParameterSpec)null);
    }

    /**
     * Constructor taking an ephemeral key pair.
     *
     * @param ephemeralKeyPair       keypair holding our ephemeral public and private keys.
     * @param otherPartyEphemeralKey the other party's ephemeral public key.
     * @param userKeyingMaterial     the user keying material for the key derivation function.
     */
    public MQVParameterSpec(KeyPair ephemeralKeyPair, PublicKey otherPartyEphemeralKey, byte[] userKeyingMaterial)
    {
        this(ephemeralKeyPair.getPublic(), ephemeralKeyPair.getPrivate(), otherPartyEphemeralKey, userKeyingMaterial);
    }

    /**
     * Constructor taking an ephemeral key pair and an algorithm spec.
     *
     * @param ephemeralKeyPair       keypair holding our ephemeral public and private keys.
     * @param otherPartyEphemeralKey the other party's ephemeral public key.
     * @param kdfParameterSpec parameter spec for key generator to mix with the calculated secret.
     */
    public MQVParameterSpec(KeyPair ephemeralKeyPair, PublicKey otherPartyEphemeralKey, AlgorithmParameterSpec kdfParameterSpec)
    {
        this(ephemeralKeyPair.getPublic(), ephemeralKeyPair.getPrivate(), otherPartyEphemeralKey, kdfParameterSpec);
    }

    /**
     * Constructor without our ephemeral public key - in this case it is assumed the ephemeral public key can be calculated
     * later.
     *
     * @param ephemeralPrivateKey    our ephemeral private key.
     * @param otherPartyEphemeralKey the other party's ephemeral public key.
     * @param userKeyingMaterial     the user keying material for the key derivation function.
     */
    public MQVParameterSpec(PrivateKey ephemeralPrivateKey, PublicKey otherPartyEphemeralKey, byte[] userKeyingMaterial)
    {
        this(null, ephemeralPrivateKey, otherPartyEphemeralKey, userKeyingMaterial);
    }

    /**
      * Constructor without our ephemeral public key - in this case it is assumed the ephemeral public key can be calculated
      * later.
      *
      * @param ephemeralPrivateKey    our ephemeral private key.
      * @param otherPartyEphemeralKey the other party's ephemeral public key.
      * @param kdfParameterSpec parameter spec for key generator to mix with the calculated secret.
      */
     public MQVParameterSpec(PrivateKey ephemeralPrivateKey, PublicKey otherPartyEphemeralKey, AlgorithmParameterSpec kdfParameterSpec)
     {
         this(null, ephemeralPrivateKey, otherPartyEphemeralKey, kdfParameterSpec);
     }

    /**
     * Constructor taking an ephemeral key pair without user keying material.
     *
     * @param ephemeralKeyPair       keypair holding our ephemeral public and private keys.
     * @param otherPartyEphemeralKey the other party's ephemeral public key.
     */
    public MQVParameterSpec(KeyPair ephemeralKeyPair, PublicKey otherPartyEphemeralKey)
    {
        this(ephemeralKeyPair.getPublic(), ephemeralKeyPair.getPrivate(), otherPartyEphemeralKey, (AlgorithmParameterSpec)null);
    }

    /**
     * Constructor without our ephemeral public key or user keying material - in this case it is assumed the ephemeral
     * public key can be calculated later.
     *
     * @param ephemeralPrivateKey    our ephemeral private key.
     * @param otherPartyEphemeralKey the other party's ephemeral public key.
     */
    public MQVParameterSpec(PrivateKey ephemeralPrivateKey, PublicKey otherPartyEphemeralKey)
    {
        this(null, ephemeralPrivateKey, otherPartyEphemeralKey, (AlgorithmParameterSpec)null);
    }

    /**
     * Return our ephemeral private key.
     *
     * @return our ephemeral private key.
     */
    public PrivateKey getEphemeralPrivateKey()
    {
        return ephemeralPrivateKey;
    }

    /**
     * Return our ephemeral public key, if available.
     *
     * @return the ephemeral public key, may be null.
     */
    public PublicKey getEphemeralPublicKey()
    {
        return ephemeralPublicKey;
    }

    /**
     * Return the other party's ephemeral public key.
     *
     * @return the other party's public key.
     */
    public PublicKey getOtherPartyEphemeralKey()
    {
        return otherPartyEphemeralKey;
    }

    /**
     * Return the user keying material for the KDF used to derive the final secret key.
     *
     * @return the user keying material to be input into the KDF.
     */
    public byte[] getUserKeyingMaterial()
    {
        if (kdfParameterSpec instanceof UserKeyingMaterialSpec)
        {
            return ((UserKeyingMaterialSpec)kdfParameterSpec).getUserKeyingMaterial();
        }
        return null;
    }

    /**
     * Return the AlgorithmParameterSpec for the KDF used to derive the final secret key.
     *
     * @return the AlgorithmsParameterSpec to be passed to the KDF.
     */
    public AlgorithmParameterSpec getKdfParameterSpec()
    {
        return kdfParameterSpec;
    }
}