net.prasenjit.crypto.KeyEncryptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crypto Show documentation

A easy to use cryptography library implementing common use cases for enterprise security requirements.

The newest version!

/*
 *    Copyright 2018 Prasenjit Purohit
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package net.prasenjit.crypto;

import java.security.Key;


/**
 * KeyEncryptor interface.
 *
 * @author prasenjit
 * @version $Id: $Id
 * @since 1.2
 */
public interface KeyEncryptor {

    /**
     * Wrap or encrypt a {@link java.security.Key} object and generates a {@link java.lang.String}.
     *
     * @param key a {@link java.security.Key} object to be wrapped.
     * @return a encrypted Base64 encoded {@link java.lang.String}.
     */
    String wrapKey(Key key);

    /**
     * Unwrap or decrypt a Base64 encoded encrypted {@link java.lang.String} and create a {@link java.security.Key}.
     *
     * @param encryptedKey a Base64 encoded encrypted {@link java.lang.String}.
     * @param algorithm    a of the original encrypted key.
     * @param type         a integer representing key type. Values can be one of Cipher.SECRET_KEY
     *                     or Cipher.PUBLIC_KEY or Cipher.PRIVATE_KEY.
     * @return a decrypted {@link java.security.Key} object.
     */
    Key unwrapKey(String encryptedKey, String algorithm, int type);
}