com.jsuereth.pgp.KeyGen.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pgp-library_3 Show documentation
sbt-pgp provides PGP signing for sbt
The newest version!
package com.jsuereth.pgp

import java.security.{ SecureRandom, Security, KeyPairGenerator }
import java.util.Date

import org.bouncycastle.bcpg._
import org.bouncycastle.jce.spec.ElGamalParameterSpec
import org.bouncycastle.openpgp._
import org.bouncycastle.openpgp.operator.jcajce.{
  JcaPGPDigestCalculatorProviderBuilder,
  JcaPGPContentSignerBuilder,
  JcePBESecretKeyEncryptorBuilder,
  JcaPGPKeyPair
}

/** Helpers to generate various keys. */
object KeyGen {

  /** Constructs a new RSA PGPKeyPair (for encryption/signing) */
  def makeRsaKeyPair(bitStrength: Int = 2048): PGPKeyPair = {
    val rsa = {
      val generator = KeyPairGenerator.getInstance("RSA", "BC")
      generator.initialize(bitStrength)
      generator.generateKeyPair()
    }
    new JcaPGPKeyPair(PublicKeyAlgorithmTags.RSA_GENERAL, rsa, new Date())
  }

  /** Constructs a new DSA PGP Pair. (only useful for signing) */
  def makeDsaKeyPair(bitStrength: Int = 1024): PGPKeyPair = {
    val dsa = {
      val generator = KeyPairGenerator.getInstance("DSA", "BC")
      generator.initialize(bitStrength)
      generator.generateKeyPair()
    }
    new JcaPGPKeyPair(PublicKeyAlgorithmTags.DSA, dsa, new Date())
  }

  /** Make a new El Gamal key for signing/encrypting things. */
  def makeElGamalKeyPair(params: Option[ElGamalParameterSpec] = None, encryptOnly: Boolean = false): PGPKeyPair = {
    val elg = {
      val generator = KeyPairGenerator.getInstance("ELGAMAL", "BC")
      params foreach generator.initialize
      generator.generateKeyPair()
    }
    if (encryptOnly) new JcaPGPKeyPair(PublicKeyAlgorithmTags.ELGAMAL_ENCRYPT, elg, new Date())
    else new JcaPGPKeyPair(PublicKeyAlgorithmTags.ELGAMAL_GENERAL, elg, new Date())
  }

  /** Makes a new PGP Key ring generator, fully configured with reasonable defaults. */
  def makePgpKeyRingGenerator(
      identity: String,
      passPhrase: Array[Char],
      keyPair: PGPKeyPair,
      subKeyPairs: PGPKeyPair*
  ): PGPKeyRingGenerator = {
    val keyRingGen = {
      val provider = Security.getProvider("BC")
      val keyEncryptor = new JcePBESecretKeyEncryptorBuilder(SymmetricKeyAlgorithmTags.CAST5)
        .setProvider(provider)
        .setSecureRandom(new SecureRandom())
        .build(passPhrase)
      val keySignerBuilder = new JcaPGPContentSignerBuilder(keyPair.getPublicKey.getAlgorithm, HashAlgorithmTags.SHA1)
      val digestCalculator = new JcaPGPDigestCalculatorProviderBuilder().build().get(HashAlgorithmTags.SHA1)
      val certificationLevel = PGPSignature.POSITIVE_CERTIFICATION
      new PGPKeyRingGenerator(
        certificationLevel,
        keyPair,
        identity,
        digestCalculator,
        null,
        null,
        keySignerBuilder,
        keyEncryptor
      )
    }
    subKeyPairs foreach keyRingGen.addSubKey
    keyRingGen
  }

  /** Instantiates a KeyRingGenerator for combined DSA/ElGamal keys */
  def makeDsaKeyRingGenerator(identity: String, passPhrase: Array[Char], bitStrength: Int = 1024): PGPKeyRingGenerator =
    makePgpKeyRingGenerator(identity, passPhrase, makeDsaKeyPair(bitStrength), makeElGamalKeyPair(encryptOnly = true))

  /** Instantiates a KeyRingGenerator for RSA keys */
  def makeRsaKeyRingGenerator(identity: String, passPhrase: Array[Char]): PGPKeyRingGenerator =
    makePgpKeyRingGenerator(identity, passPhrase, makeRsaKeyPair())

  /** Instantiates a KeyRingGenerator for El Gamal keys */
  def makeElGamalKeyRingGenerator(identity: String, passPhrase: Array[Char]): PGPKeyRingGenerator =
    makePgpKeyRingGenerator(identity, passPhrase, makeElGamalKeyPair())

}