name.neuhalfen.projects.crypto.bouncycastle.openpgp.validation.SignatureValidationStrategies Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bouncy-gpg-alpha Show documentation
Fork of bouncy-gpg.
The newest version!
package name.neuhalfen.projects.crypto.bouncycastle.openpgp.validation;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import name.neuhalfen.projects.crypto.bouncycastle.openpgp.keys.PGPUtilities;
import name.neuhalfen.projects.crypto.bouncycastle.openpgp.keys.keyrings.KeyringConfig;
import org.bouncycastle.openpgp.PGPException;
import org.bouncycastle.openpgp.PGPPublicKey;
import org.bouncycastle.openpgp.PGPPublicKeyRing;
import org.bouncycastle.openpgp.PGPPublicKeyRingCollection;

/**
 * Defines strategies for signature checking.
 */
public final class SignatureValidationStrategies {

  // no instances
  private SignatureValidationStrategies() {
  }

  /**
   * Ignore signatures, EVEN BROKEN signatures! . Use this at your own peril.
   *
   * @return an instance of the requested strategy
   **/
  public static SignatureValidationStrategy ignoreSignatures() {
    return new IgnoreSignaturesValidationStrategy();
  }

  /**
   * Require any signature for a public key in the keyring.
   *
   * @return an instance of the requested strategy
   * @see KeyringConfig#getPublicKeyRings()
   **/
  public static SignatureValidationStrategy requireAnySignature() {
    return new RequireAnySignatureValidationStrategy();
  }

  /**
   * Require signature from all of the passed keys. . The IDs are 32 bit key-IDs (
   * --keyid-format=0xlong)
   *
   * @param signaturesRequiredForTheseKeys KeyIds (32 bit IDs)
   * @return an instance of the requested strategy
   **/
  public static SignatureValidationStrategy requireSignatureFromAllKeys(
      Collection signaturesRequiredForTheseKeys) {
    return new RequireSpecificSignatureValidationStrategy(signaturesRequiredForTheseKeys);
  }

  /**
   * Require signature from all of the passed keys.
   *
   * @param publicKeyRings keyring
   * @param userIds A list of user IDs (e.g. '[email protected]')
   * @return an instance of the requested strategy
   * @throws PGPException No or more than one public key found for a user id
   **/
  @SuppressWarnings("PMD.LawOfDemeter")
  public static SignatureValidationStrategy requireSignatureFromAllKeys(
      PGPPublicKeyRingCollection publicKeyRings, String... userIds) throws PGPException {
    final List keyIds = new ArrayList<>(userIds.length);

    for (String userId : userIds) {

      final PGPPublicKeyRing pgpPublicKeys = PGPUtilities
          .extractPublicKeyRingForUserId(userId, publicKeyRings);
      if (pgpPublicKeys == null) {
        throw new PGPException("Could not find public-key for userid '" + userId + "'");
      }

      final PGPPublicKey signingKey = PGPUtilities.extractSigningPublicKey(pgpPublicKeys);
      if (signingKey == null) {
        throw new PGPException("Could not find public-key for userid '" + userId + "'");
      }
      keyIds.add(signingKey.getKeyID());

    }
    return new RequireSpecificSignatureValidationStrategy(keyIds);
  }

  /**
   * Require signature from all of the passed keys.
   *
   * @param keyIds The IDs are 32 bit key-IDs ( --keyid-format=0xlong)
   * @return an instance of the requested strategy
   **/
  public static SignatureValidationStrategy requireSignatureFromAllKeys(Long... keyIds) {
    return new RequireSpecificSignatureValidationStrategy(Arrays.asList(keyIds));
  }

  /**
   * Require signature from a specific key.
   *
   * @param signaturesRequiredForThisKey The ID is a 32 bit key-ID ( --keyid-format=0xlong)
   * @return an instance of the requested strategy
   **/
  public static SignatureValidationStrategy requireSignatureFromAllKeys(
      long signaturesRequiredForThisKey) {
    return new RequireSpecificSignatureValidationStrategy(
        Collections.singletonList(signaturesRequiredForThisKey));
  }
}