com.azure.security.keyvault.keys.cryptography.implementation.AsymmetricEncryptionAlgorithm Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-security-keyvault-keys Show documentation

This module contains client library for Microsoft Azure KeyVault Keys.

There is a newer version: 4.9.1

Show newest version

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.security.keyvault.keys.cryptography.implementation;

import javax.crypto.NoSuchPaddingException;
import java.security.InvalidKeyException;
import java.security.KeyPair;
import java.security.NoSuchAlgorithmException;
import java.security.Provider;

/**
 * Abstract base class for all asymmetric encryption implementation.
 *
 */
abstract class AsymmetricEncryptionAlgorithm extends LocalEncryptionAlgorithm {

    /**
     * Constructor.
     *
     * @param name The name of the algorithm.
     */
    protected AsymmetricEncryptionAlgorithm(String name) {
        super(name);
    }

    /**
     * Creates a {@link ICryptoTransform} implementation for encryption that
     * uses the specified {@link KeyPair} and the default {@link Provider} provider.
     *
     * @param keyPair The key pair to use.
     * @return abstract {@link ICryptoTransform}
     * @throws InvalidKeyException when key is not valid
     * @throws NoSuchAlgorithmException if algorithm is not found
     * @throws NoSuchPaddingException if padding is set wrong
     */
    public abstract ICryptoTransform createEncryptor(KeyPair keyPair)
        throws InvalidKeyException, NoSuchAlgorithmException, NoSuchPaddingException;

    /**
     * Creates a {@link ICryptoTransform} implementation for encryption that
     * uses the specified {@link KeyPair} and {@link Provider}.
     *
     * @param keyPair The key pair to use.
     * @param provider The provider to use.
     * @return abstract {@link ICryptoTransform}
     * @throws InvalidKeyException when key is not valid
     * @throws NoSuchAlgorithmException if algorithm is not found
     * @throws NoSuchPaddingException if padding is set wrong
     */
    public abstract ICryptoTransform createEncryptor(KeyPair keyPair, Provider provider)
        throws InvalidKeyException, NoSuchAlgorithmException, NoSuchPaddingException;

    /**
     * Creates a {@link ICryptoTransform} implementation for decryption that
     * uses the specified {@link KeyPair} and the default {@link Provider} provider.
     *
     * @param keyPair The key pair to use.
     * @return abstract {@link ICryptoTransform}
     * @throws InvalidKeyException when key is not valid
     * @throws NoSuchAlgorithmException if algorithm is not found
     * @throws NoSuchPaddingException if padding is set wrong
     */
    public abstract ICryptoTransform createDecryptor(KeyPair keyPair)
        throws InvalidKeyException, NoSuchAlgorithmException, NoSuchPaddingException;

    /**
     * Creates a {@link ICryptoTransform} implementation for decryption that
     * uses the specified {@link KeyPair} and {@link Provider}.
     *
     * @param keyPair The key pair to use.
     * @param provider The provider to use.
     * @return abstract {@link ICryptoTransform}
     * @throws InvalidKeyException when key is not valid
     * @throws NoSuchAlgorithmException if algorithm is not found
     * @throws NoSuchPaddingException if padding is set wrong
     */
    public abstract ICryptoTransform createDecryptor(KeyPair keyPair, Provider provider)
        throws InvalidKeyException, NoSuchAlgorithmException, NoSuchPaddingException;
}