com.symphony.oss.models.fundamental.canon.facade.IOpenExchangeKey Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018 Symphony Communication Services, LLC.
 *
 * 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 com.symphony.oss.models.fundamental.canon.facade;

import javax.crypto.SecretKey;

import com.symphony.oss.models.crypto.canon.facade.WrappedKey;
import com.symphony.oss.models.crypto.cipher.ISymmetricCipherSuite;
import com.symphony.oss.models.fundamental.canon.facade.IExchangeKey;
import com.symphony.oss.models.fundamental.canon.facade.IOpenPublicKey;

/**
 * An open exchange key, i.e. an object containing the matching private key for the public key contained
 * in the super-class.
 * 
 * This object can be used to unwrap other keys.
 * 
 * @author Bruce Skingle
 *
 */
public interface IOpenExchangeKey extends IOpenPublicKey, IExchangeKey
{
  /**
   * Unwrap the given wrapped secret key.
   * 
   * @param wrappedKey              A wrapped secret key.
   * @param wrappedKeyCipherSuite   The CipherSuite of the given wrapped key/
   * 
   * @return The unwrapped secret key.
   */
  SecretKey unwrap(WrappedKey wrappedKey, ISymmetricCipherSuite wrappedKeyCipherSuite);

}