io.github.mmm.crypto.asymmetric.key.AsymmetricKeyPair Maven / Gradle / Ivy

Go to download
package io.github.mmm.crypto.asymmetric.key;

import java.security.Key;
import java.security.KeyPair;
import java.security.PrivateKey;
import java.security.PublicKey;
import java.util.HashSet;
import java.util.Set;

import io.github.mmm.crypto.key.KeySet;

/**
 * Interface for a key pair consisting of a {@link #getPrivateKey() private key} with its corresponding
 * {@link #getPublicKey() public key} for asymmetric encryption. The big advantage of asymmetric encryption is that no
 * secret has to be shared between the parties. The {@link PublicKey public key} can be made public and shared. Anybody
 * knowing your public key can
 * {@link io.github.mmm.crypto.asymmetric.crypt.AsymmetricCryptorFactory#newEncryptor(PublicKey) encrypt}
 * data for you that only you as the owner of the corresponding {@link PrivateKey private key} can
 * {@link io.github.mmm.crypto.asymmetric.crypt.AsymmetricCryptorFactory#newDecryptor(PrivateKey) decrypt}.
 * On the other hand only you as the owner of the {@link PrivateKey private key} can
 * {@link io.github.mmm.crypto.asymmetric.sign.SignatureSigner#sign(byte[], boolean) sign} arbitrary data in a way so
 * that everybody can {@link io.github.mmm.crypto.asymmetric.sign.SignatureVerifier#verifyAfterUpdate(byte[]) verify}
 * this signature using your {@link PublicKey public key}.
 *
 * @param  type of {@link #getPrivateKey()}
 * @param  type of {@link #getPublicKey()}.
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public interface AsymmetricKeyPair extends KeySet {

  /**
   * @return the {@link PrivateKey private key}. Has to be kept secret.
   */
  PR getPrivateKey();

  /**
   * @return the {@link PublicKey public key}. May be distributed or published.
   */
  PU getPublicKey();

  /**
   * @return the private and public key as java standard {@link KeyPair}.
   */
  KeyPair getKeyPair();

  @Override
  default Set getKeys() {

    Set set = new HashSet<>();
    set.add(getPrivateKey());
    set.add(getPublicKey());
    return set;
  }

}