com.launchkey.sdk.crypto.jwe.JWEService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of launchkey-sdk Show documentation

SDK for interacting with the LaunchKey distributed authentication and authorization platform

The newest version!

/**
 * Copyright 2016 LaunchKey, Inc. All rights reserved.
 * 
 * Licensed under the MIT License.
 * You may not use this file except in compliance with the License.
 * A copy of the License is located in the "LICENSE.txt" file accompanying
 * this file. This file 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 com.launchkey.sdk.crypto.jwe;

import java.security.PrivateKey;
import java.security.PublicKey;
import java.security.interfaces.RSAPrivateKey;
import java.security.interfaces.RSAPublicKey;
import java.util.Map;

/**
 * A service for encrypting and decrypting data with the JSON Web Encryption standard.
 * @see JSON Web Encryption RFC
 */
public interface JWEService {
    /**
     * Decrypt the provided JWE data
     * @param data JWE data
     * @return Decrypted value
     * @throws JWEFailure When an issue arises while attempting to decrypt the data
     */
    String decrypt(String data) throws JWEFailure;

    /**
     * Decrypt the provided JWE data using the provided private key
     * @param data JWE data
     * @param privateKey Private key for decryption
     * @return Decrypted value
     * @throws JWEFailure When an issue arises while attempting to decrypt the data
     */
    String decrypt(String data, PrivateKey privateKey) throws JWEFailure;

    /**
     * Encrypt the data and serialize compact serialization
     * @param data Data to encrypt
     * @param publicKey Public key that will encrypt the data
     * @param keyId The ID for the public key that will encrypt the data
     * @param contentType Content type of the data being passed to place in the header of the JWE
     * @return Compact serialized JWE
     * @throws JWEFailure When an issue arises while attempting to encrypt the data
     */
    String encrypt(String data, PublicKey publicKey, String keyId, String contentType) throws JWEFailure;

    /**
     * Get the JWE headers from the data
     * @param data JWE data
     * @return Headers
     */
    Map getHeaders(String data) throws JWEFailure;
}