pgp-library
API
Generated with
pgp-library/com.jsuereth.pgp/PublicKeyRingCollection

PublicKeyRingCollection

com.jsuereth.pgp.PublicKeyRingCollection
See thePublicKeyRingCollection companion object
class PublicKeyRingCollection(val nested: PGPPublicKeyRingCollection) extends PublicKeyLike, StreamingSaveable

A collection of nested key rings.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Type members

Classlikes

object keyRings extends Iterable[PublicKeyRing]

A collection of all the nested key rings.

A collection of all the nested key rings.

Attributes

Supertypes
trait Iterable[PublicKeyRing]
trait IterableFactoryDefaults[PublicKeyRing, Iterable]
trait IterableOps[PublicKeyRing, Iterable, Iterable[PublicKeyRing]]
trait IterableOnceOps[PublicKeyRing, Iterable, Iterable[PublicKeyRing]]
trait IterableOnce[PublicKeyRing]
class Object
trait Matchable
class Any
Show all
Self type
keyRings.type

Value members

Concrete methods

def encryptionKeys: Iterable[PublicKey]

A collection that will traverse all keys that can be used to encrypt data.

A collection that will traverse all keys that can be used to encrypt data.

Attributes

def findEncryptionKey(value: String): Option[PublicKey]

Finds the first encryption key that has:

Finds the first encryption key that has:

  • A keyID containing the given hex code
  • A userID containing the given string

Attributes

def findPubKey(value: String): Option[PublicKey]

Finds the first public key that has:

Finds the first public key that has:

  • A keyID containing the given hex code
  • A userID containing the given string

Attributes

def findPubKeyRing(value: String): Option[PublicKeyRing]

Finds the first public key ring that has a public key that:

Finds the first public key ring that has a public key that:

  • A keyID containing the given hex code
  • A userID containing the given string

Attributes

def getKey(id: Long): Option[PublicKey]

Finds a public key using an exact id.

Finds a public key using an exact id.

Attributes

def publicKeys: Iterable[PublicKey]

A collection of all the public keys from all the key rings.

A collection of all the public keys from all the key rings.

Attributes

def saveTo(output: OutputStream): Unit

Saves the current entity to an output stream.

Saves the current entity to an output stream.

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def verifyMessageStream(input: InputStream, output: OutputStream): Boolean

Verifies a signed message and extracts the contents.

Verifies a signed message and extracts the contents.

Value parameters

input

The incoming PGP message.

output

The decoded and verified message.

Attributes

def verifySignatureStreams(msg: InputStream, signature: InputStream): Boolean

Verifies a signature stream against an input stream.

Verifies a signature stream against an input stream.

Value parameters

msg

The input stream containing the raw message to verify.

msgName

the name tied in the signature for this object. For a file, this is the filename.

signature

The input stream containing the PGP signature.

Attributes

Inherited methods

def saveToFile(file: File): Unit

Saves the current entity to a file.

Saves the current entity to a file.

Attributes

Inherited from:
StreamingSaveable
def saveToString: String

Saves the current entity into a string.

Saves the current entity into a string.

Attributes

Inherited from:
StreamingSaveable
final def verifyMessageFile(input: File, output: File): Boolean

Reads in a PGP message from a file, verifies the signature and writes to the output file.

Reads in a PGP message from a file, verifies the signature and writes to the output file.

Attributes

Inherited from:
PublicKeyLike
protected def verifyMessageStreamHelper(input: InputStream, output: OutputStream)(getKey: Long => PGPPublicKey): Boolean

Attributes

Inherited from:
PublicKeyLike
final def verifyMessageString(input: String): String

Reads in a PGP message and from a string, verifies the signature and returns the raw content.

Reads in a PGP message and from a string, verifies the signature and returns the raw content.

Attributes

Inherited from:
PublicKeyLike
final def verifySignatureFile(raw: File, signature: File): Boolean

Reads in a raw file, verifies the signature file is valid for this file.

Reads in a raw file, verifies the signature file is valid for this file.

Attributes

Inherited from:
PublicKeyLike
protected def verifySignatureStreamsHelper(msg: InputStream, signature: InputStream)(getKey: Long => PGPPublicKey): Boolean

Verifies that a stream was signed correctly by another stream.

Verifies that a stream was signed correctly by another stream.

Attributes

Throws
KeyNotFoundException

is signature contains an unknown public key.

Inherited from:
PublicKeyLike
final def verifySignatureString(msg: String, signature: String): Boolean

Reads in a PGP message from a string, verifies the signature string is accurate for the message.

Reads in a PGP message from a string, verifies the signature string is accurate for the message.

Attributes

Inherited from:
PublicKeyLike

Concrete fields

val nested: PGPPublicKeyRingCollection
Generated with