GnuPGContext Class

An OpenPgpContext that uses the GnuPG keyrings.

Inheritance Hierarchy

SystemObject
  MimeKit.CryptographyCryptographyContext
    MimeKit.CryptographyOpenPgpContext
      MimeKit.CryptographyGnuPGContext

Namespace: MimeKit.Cryptography
Assembly: MimeKit (in MimeKit.dll) Version: 4.12.0

Syntax

Copy

public abstract class GnuPGContext : OpenPgpContext

The GnuPGContext type exposes the following members.

Constructors

	Name	Description
	GnuPGContext	Initialize a new instance of the GnuPGContext class.
	GnuPGContext(String)	Initialize a new instance of the GnuPGContext class.

Top

Properties

	Name	Description
	AutoKeyRetrieve	Get or set whether unknown PGP keys should automtically be retrieved. (Inherited from OpenPgpContext)
	DefaultEncryptionAlgorithm	Get or set the default encryption algorithm. (Inherited from OpenPgpContext)
	DigestAlgorithmRank	Get the preferred rank order for the digest algorithms; from the most preferred to the least. (Inherited from CryptographyContext)
	EnabledDigestAlgorithms	Get the enabled digest algorithms in ranked order. (Inherited from CryptographyContext)
	EnabledEncryptionAlgorithms	Get the enabled encryption algorithms in ranked order. (Inherited from CryptographyContext)
	EncryptionAlgorithmRank	Get the preferred rank order for the encryption algorithms; from the most preferred to the least. (Inherited from CryptographyContext)
	EncryptionProtocol	Get the encryption protocol. (Inherited from OpenPgpContext)
	KeyExchangeProtocol	Get the key exchange protocol. (Inherited from OpenPgpContext)
	KeyServer	Get or set the key server to use when automatically retrieving keys. (Inherited from OpenPgpContext)
	PrepareBeforeSigning	Get or set whether a MimeEntity should be prepared before signing. (Inherited from CryptographyContext)
	PublicKeyRingBundle	Get the public keyring bundle.
	PublicKeyRingPath	Get the public keyring path.
	SecretKeyRingBundle	Get the secret keyring bundle.
	SecretKeyRingPath	Get the secret keyring path.
	SignatureProtocol	Get the signature protocol. (Inherited from OpenPgpContext)

Top

Methods

	Name	Description
	CanEncrypt	Check whether the cryptography context can encrypt to a particular recipient. (Overrides CryptographyContextCanEncrypt(MailboxAddress, CancellationToken))
	CanEncryptAsync	Asynchronously check whether the cryptography context can encrypt to a particular recipient. (Inherited from CryptographyContext)
	CanSign	Check whether a particular mailbox address can be used for signing. (Overrides CryptographyContextCanSign(MailboxAddress, CancellationToken))
	CanSignAsync	Asynchronously check whether a particular mailbox address can be used for signing. (Inherited from CryptographyContext)
	Decrypt(Stream, CancellationToken)	Decrypt the specified encryptedData. (Inherited from OpenPgpContext)
	Decrypt(Stream, DigitalSignatureCollection, CancellationToken)	Decrypt the specified encryptedData and extracts the digital signers if the content was also signed. (Inherited from OpenPgpContext)
	DecryptAsync	Asynchronously decrypt the specified encryptedData. (Inherited from OpenPgpContext)
	DecryptTo	Decrypt an encrypted stream and extract the digital signers if the content was also signed. (Inherited from OpenPgpContext)
	DecryptToAsync	Asynchronously decrypt an encrypted stream and extract the digital signers if the content was also signed. (Inherited from OpenPgpContext)
	Delete(PgpPublicKeyRing)	Delete a public pgp keyring.
	Delete(PgpSecretKeyRing)	Delete a secret pgp keyring.
	Disable(DigestAlgorithm)	Disable the digest algorithm. (Inherited from CryptographyContext)
	Disable(EncryptionAlgorithm)	Disable the encryption algorithm. (Inherited from CryptographyContext)
	Dispose	Releases all resources used by the CryptographyContext object. (Inherited from CryptographyContext)
	Dispose(Boolean)	Releases all resources used by the OpenPgpContext object. (Inherited from OpenPgpContext)
	Enable(DigestAlgorithm)	Enable the digest algorithm. (Inherited from CryptographyContext)
	Enable(EncryptionAlgorithm)	Enable the encryption algorithm. (Inherited from CryptographyContext)
	Encrypt(IEnumerableMailboxAddress, Stream, CancellationToken)	Encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	Encrypt(IEnumerablePgpPublicKey, Stream, CancellationToken)	Encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	Encrypt(EncryptionAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken)	Encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	Encrypt(EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken)	Encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	EncryptAsync(IEnumerableMailboxAddress, Stream, CancellationToken)	Asynchronously encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	EncryptAsync(IEnumerablePgpPublicKey, Stream, CancellationToken)	Asynchronously encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	EncryptAsync(EncryptionAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken)	Asynchronously encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	EncryptAsync(EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken)	Asynchronously encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	EnumeratePublicKeyRings	Enumerate all public keyrings.
	EnumeratePublicKeyRings(MailboxAddress)	Enumerate the public keyrings for a particular mailbox.
	EnumeratePublicKeys	Enumerate all public keys.
	EnumeratePublicKeys(MailboxAddress)	Enumerate the public keys for a particular mailbox.
	EnumerateSecretKeyRings	Enumerate all secret keyrings.
	EnumerateSecretKeyRings(MailboxAddress)	Enumerate the secret keyrings for a particular mailbox.
	EnumerateSecretKeys	Enumerate all secret keys.
	EnumerateSecretKeys(MailboxAddress)	Enumerate the secret keys for a particular mailbox.
	Equals	(Inherited from Object)
	Export(IEnumerableMailboxAddress, CancellationToken)	Export the public keys for the specified mailboxes. (Overrides CryptographyContextExport(IEnumerableMailboxAddress, CancellationToken))
	Export(IEnumerablePgpPublicKey, CancellationToken)	Export the specified public keys. (Inherited from OpenPgpContext)
	Export(PgpPublicKeyRingBundle, CancellationToken)	Export the specified public keys. (Inherited from OpenPgpContext)
	Export(IEnumerableMailboxAddress, Stream, Boolean, CancellationToken)	Export the public keyrings for the specified mailboxes. (Overrides OpenPgpContextExport(IEnumerableMailboxAddress, Stream, Boolean, CancellationToken))
	Export(IEnumerablePgpPublicKey, Stream, Boolean, CancellationToken)	Export the specified public keys. (Inherited from OpenPgpContext)
	Export(PgpPublicKeyRingBundle, Stream, Boolean, CancellationToken)	Export the public keyring bundle. (Inherited from OpenPgpContext)
	ExportAsync(IEnumerableMailboxAddress, CancellationToken)	Asynchronously export the public keys for the specified mailboxes. (Overrides CryptographyContextExportAsync(IEnumerableMailboxAddress, CancellationToken))
	ExportAsync(IEnumerablePgpPublicKey, CancellationToken)	Asynchronously export the specified public keys. (Inherited from OpenPgpContext)
	ExportAsync(PgpPublicKeyRingBundle, CancellationToken)	Asynchronously export the specified public keys. (Inherited from OpenPgpContext)
	ExportAsync(IEnumerableMailboxAddress, Stream, Boolean, CancellationToken)	Asynchronously export the public keyrings for the specified mailboxes. (Overrides OpenPgpContextExportAsync(IEnumerableMailboxAddress, Stream, Boolean, CancellationToken))
	ExportAsync(IEnumerablePgpPublicKey, Stream, Boolean, CancellationToken)	Asynchronously export the specified public keys. (Inherited from OpenPgpContext)
	ExportAsync(PgpPublicKeyRingBundle, Stream, Boolean, CancellationToken)	Asynchronously export the public keyring bundle. (Inherited from OpenPgpContext)
	Finalize	(Inherited from Object)
	GenerateKeyPair	Generate a new key pair.
	GetDigestAlgorithm(String)	Get the digest algorithm from the micalg parameter value in a multipart/signed part. (Inherited from OpenPgpContext)
	GetDigestAlgorithmName	Get the string name of the digest algorithm for use with the micalg parameter of a multipart/signed part. (Inherited from OpenPgpContext)
	GetHashCode	(Inherited from Object)
	GetPasswordForKey	Get the password for a secret key. (Inherited from OpenPgpContext)
	GetPrivateKey	Gets the private key from the specified secret key. (Inherited from OpenPgpContext)
	GetPublicKey	Get the public key associated with the mailbox address.
	GetPublicKeyRing	Get the public keyring that contains the specified key. (Overrides OpenPgpContextGetPublicKeyRing(Int64, CancellationToken))
	GetPublicKeyRingAsync	Asynchronously get the public keyring that contains the specified key. (Overrides OpenPgpContextGetPublicKeyRingAsync(Int64, CancellationToken))
	GetPublicKeys	Get the public keys for the specified mailbox addresses. (Overrides OpenPgpContextGetPublicKeys(IEnumerableMailboxAddress, CancellationToken))
	GetPublicKeysAsync	Asynchronously get the public keys for the specified mailbox addresses. (Inherited from OpenPgpContext)
	GetSecretKey	Get the secret key for a specified key identifier. (Overrides OpenPgpContextGetSecretKey(Int64, CancellationToken))
	GetSecretKeyAsync	Asynchronously get the secret key for a specified key identifier. (Inherited from OpenPgpContext)
	GetSigningKey	Get the signing key associated with the mailbox address. (Overrides OpenPgpContextGetSigningKey(MailboxAddress, CancellationToken))
	GetSigningKeyAsync	Asynchronously get the signing key associated with the mailbox address. (Inherited from OpenPgpContext)
	GetType	(Inherited from Object)
	Import(PgpPublicKeyRing, CancellationToken)	Import a public pgp keyring. (Overrides OpenPgpContextImport(PgpPublicKeyRing, CancellationToken))
	Import(PgpPublicKeyRingBundle, CancellationToken)	Import the specified public keyring bundle. (Overrides OpenPgpContextImport(PgpPublicKeyRingBundle, CancellationToken))
	Import(PgpSecretKeyRing, CancellationToken)	Import a secret pgp keyring. (Overrides OpenPgpContextImport(PgpSecretKeyRing, CancellationToken))
	Import(PgpSecretKeyRingBundle, CancellationToken)	Import a secret pgp keyring bundle. (Overrides OpenPgpContextImport(PgpSecretKeyRingBundle, CancellationToken))
	Import(Stream, CancellationToken)	Import public pgp keys from the specified stream. (Inherited from OpenPgpContext)
	ImportAsync	Asynchronously import public pgp keys from the specified stream. (Inherited from OpenPgpContext)
	IsEnabled(DigestAlgorithm)	Check whether the specified digest algorithm is enabled. (Inherited from CryptographyContext)
	IsEnabled(EncryptionAlgorithm)	Check whether the specified encryption algorithm is enabled. (Inherited from CryptographyContext)
	MemberwiseClone	(Inherited from Object)
	RetrievePublicKeyRing	Retrieve the public keyring using the configured key server. (Inherited from OpenPgpContext)
	RetrievePublicKeyRingAsync	Asynchronously retrieve the public keyring using the configured key server. (Inherited from OpenPgpContext)
	SavePublicKeyRingBundle	Saves the public key-ring bundle.
	SaveSecretKeyRingBundle	Saves the secret key-ring bundle.
	Sign(MailboxAddress, DigestAlgorithm, Stream, CancellationToken)	Sign the content using the specified signer and digest algorithm. (Inherited from OpenPgpContext)
	Sign(PgpSecretKey, DigestAlgorithm, Stream, CancellationToken)	Sign the content using the specified signer and digest algorithm. (Inherited from OpenPgpContext)
	SignAndEncrypt(MailboxAddress, DigestAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken)	Sign and encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	SignAndEncrypt(PgpSecretKey, DigestAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken)	Sign and encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	SignAndEncrypt(MailboxAddress, DigestAlgorithm, EncryptionAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken)	Sign and encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	SignAndEncrypt(PgpSecretKey, DigestAlgorithm, EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken)	Sign and encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	SignAndEncryptAsync(MailboxAddress, DigestAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken)	Asynchronously sign and encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	SignAndEncryptAsync(PgpSecretKey, DigestAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken)	Asynchronously sign and encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	SignAndEncryptAsync(MailboxAddress, DigestAlgorithm, EncryptionAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken)	Asynchronously sign and encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	SignAndEncryptAsync(PgpSecretKey, DigestAlgorithm, EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken)	Asynchronously sign and encrypt the specified content for the specified recipients. (Inherited from OpenPgpContext)
	SignAsync(MailboxAddress, DigestAlgorithm, Stream, CancellationToken)	Asynchronously sign the content using the specified signer and digest algorithm. (Inherited from OpenPgpContext)
	SignAsync(PgpSecretKey, DigestAlgorithm, Stream, CancellationToken)	Asynchronously sign the content using the specified signer and digest algorithm. (Inherited from OpenPgpContext)
	SignKey	Sign a public key.
	Supports	Check whether the specified protocol is supported. (Inherited from OpenPgpContext)
	ToString	(Inherited from Object)
	Verify	Verify the specified content using the detached signatureData. (Inherited from OpenPgpContext)
	VerifyAsync	Asynchronously verify the specified content using the detached signatureData. (Inherited from OpenPgpContext)

Top

Remarks

An OpenPgpContext that uses the GnuPG keyrings.

Reference

MimeKit.Cryptography Namespace