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

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

import java.io._

import org.bouncycastle.bcpg._
import org.bouncycastle.openpgp._
import org.bouncycastle.openpgp.operator.bc.BcKeyFingerprintCalculator

import scala.collection.JavaConverters._

/** A secret PGP key ring. Can be used to decrypt messages and to sign files/messages.  */
class SecretKeyRingCollection(val nested: PGPSecretKeyRingCollection) extends StreamingSaveable {

  /** A collection of all the nested secret key rings. */
  object keyRings extends Traversable[SecretKeyRing] {
    override def foreach[U](f: SecretKeyRing => U): Unit =
      iterator.foreach(f)
    def iterator: Iterator[SecretKeyRing] =
      nested.getKeyRings.asScala.map(SecretKeyRing.apply)
  }

  /** A collection of all the secret keys from all the key rings. */
  def secretKeys: Traversable[SecretKey] = keyRings.view flatMap (_.secretKeys)

  /** The default secret key ring to use. */
  def default: SecretKeyRing = keyRings.head

  /** Finds the first secret key ring that has a public key that:
   *  - A keyID containing the given hex code
   *  - A userID containing the given string
   */
  def findSecretKeyRing(value: String): Option[SecretKeyRing] =
    (for {
      ring <- keyRings
      key <- ring.secretKeys
      if PGP.isPublicKeyMatching(value)(key.publicKey)
    } yield ring).headOption

  /** Finds the first secret key that has:
   *  - A keyID containing the given hex code
   *  - A userID containing the given string
   */
  def findSecretKey(value: String): Option[SecretKey] = {
    secretKeys find { key =>
      PGP.isPublicKeyMatching(value)(key.publicKey)
    }
  }

  def saveTo(output: OutputStream): Unit = {
    val armoredOut = new ArmoredOutputStream(output)
    nested.encode(armoredOut)
    armoredOut.close()
  }

  override def toString = "SecretKeyRingCollection(" + secretKeys.mkString(",") + ")"
}

object SecretKeyRingCollection extends StreamingLoadable[SecretKeyRingCollection] {
  implicit def unwrap(ring: SecretKeyRingCollection): PGPSecretKeyRingCollection = ring.nested
  def apply(nested: PGPSecretKeyRingCollection) = new SecretKeyRingCollection(nested)
  def load(input: InputStream) =
    apply(new PGPSecretKeyRingCollection(PGPUtil.getDecoderStream(input), new BcKeyFingerprintCalculator))
}