 | OpenPgpContext Class |
An abstract OpenPGP cryptography context which can be used for OpenPGP and PGP/MIME that
manages keyrings stored on the local file system as keyring bundles.
Inheritance HierarchySystemObject
MimeKit.CryptographyCryptographyContext
MimeKit.CryptographyOpenPgpContextBase
MimeKit.CryptographyOpenPgpContext
MimeKit.CryptographyGnuPGContext
MimeKit.CryptographyCryptographyContext
MimeKit.CryptographyOpenPgpContextBase
MimeKit.CryptographyOpenPgpContext
MimeKit.CryptographyGnuPGContext
Namespace: MimeKit.Cryptography
Assembly: MimeKit (in MimeKit.dll) Version: 2.14.0
SyntaxC#
public abstract class OpenPgpContext : OpenPgpContextBase
The OpenPgpContext type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OpenPgpContext |
Initialize a new instance of the OpenPgpContext class.
|
| OpenPgpContext(String, String) |
Initialize a new instance of the OpenPgpContext class.
|
Properties| Name | Description | |
|---|---|---|
 | AutoKeyRetrieve |
Get or set whether unknown PGP keys should automtically be retrieved.
(Inherited from OpenPgpContextBase.) |
| DefaultEncryptionAlgorithm |
Get or set the default encryption algorithm.
(Inherited from OpenPgpContextBase.) |
 | 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 OpenPgpContextBase.) |
| KeyExchangeProtocol |
Get the key exchange protocol.
(Inherited from OpenPgpContextBase.) |
| KeyServer |
Get or set the key server to use when automatically retrieving keys.
(Inherited from OpenPgpContextBase.) |
| 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 OpenPgpContextBase.) |
Methods| Name | Description | |
|---|---|---|
 | CanEncrypt |
Check whether or not the cryptography context can encrypt to a particular recipient.
(Overrides CryptographyContextCanEncrypt(MailboxAddress).) |
| CanSign |
Check whether or not a particular mailbox address can be used for signing.
(Overrides CryptographyContextCanSign(MailboxAddress).) |
| Decrypt(Stream, CancellationToken) |
Decrypts the specified encryptedData.
(Inherited from OpenPgpContextBase.) |
| Decrypt(Stream, DigitalSignatureCollection, CancellationToken) |
Decrypts the specified encryptedData and extracts the digital signers if the content was also signed.
(Inherited from OpenPgpContextBase.) |
| DecryptTo |
Decrypt an encrypted stream and extract the digital signers if the content was also signed.
(Inherited from OpenPgpContextBase.) |
| DecryptToAsync |
Asynchronously decrypt an encrypted stream and extract the digital signers if the content was also signed.
(Inherited from OpenPgpContextBase.) |
| 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 OpenPgpContextBase.) |
| Enable(DigestAlgorithm) |
Enable the digest algorithm.
(Inherited from CryptographyContext.) |
| Enable(EncryptionAlgorithm) |
Enable the encryption algorithm.
(Inherited from CryptographyContext.) |
| Encrypt(IEnumerablePgpPublicKey, Stream) |
Encrypt the specified content for the specified recipients.
(Inherited from OpenPgpContextBase.) |
| Encrypt(IEnumerableMailboxAddress, Stream) |
Encrypt the specified content for the specified recipients.
(Inherited from OpenPgpContextBase.) |
| Encrypt(EncryptionAlgorithm, IEnumerableMailboxAddress, Stream) |
Encrypt the specified content for the specified recipients.
(Inherited from OpenPgpContextBase.) |
| Encrypt(EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream) |
Encrypt the specified content for the specified recipients.
(Inherited from OpenPgpContextBase.) |
| 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 | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Export(PgpPublicKeyRingBundle) |
Export the specified public keys.
|
| Export(IEnumerablePgpPublicKey) |
Exports the specified public keys.
|
| Export(IEnumerableMailboxAddress) |
Exports the public keys for the specified mailboxes.
(Overrides CryptographyContextExport(IEnumerableMailboxAddress).) |
| Export(PgpPublicKeyRingBundle, Stream, Boolean) |
Export the public keyring bundle.
|
| Export(IEnumerablePgpPublicKey, Stream, Boolean) |
Export the specified public keys.
|
| Export(IEnumerableMailboxAddress, Stream, Boolean) |
Export the public keyrings for the specified mailboxes.
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (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 OpenPgpContextBase.) |
| GetDigestAlgorithmName |
Get the string name of the digest algorithm for use with the micalg parameter of a multipart/signed part.
(Inherited from OpenPgpContextBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetPasswordForKey |
Get the password for a secret key.
(Inherited from OpenPgpContextBase.) |
| GetPrivateKey |
Gets the private key from the specified secret key.
(Inherited from OpenPgpContextBase.) |
| GetPublicKey |
Get the public key associated with the mailbox address.
|
| GetPublicKeyRing |
Get the public keyring that contains the specified key.
(Overrides OpenPgpContextBaseGetPublicKeyRing(Int64, CancellationToken).) |
| GetPublicKeyRingAsync |
Asynchronously get the public keyring that contains the specified key.
(Overrides OpenPgpContextBaseGetPublicKeyRingAsync(Int64, CancellationToken).) |
| GetPublicKeys |
Get the public keys for the specified mailbox addresses.
(Overrides OpenPgpContextBaseGetPublicKeys(IEnumerableMailboxAddress).) |
| GetSecretKey |
Get the secret key for a specified key identifier.
(Overrides OpenPgpContextBaseGetSecretKey(Int64).) |
| GetSigningKey |
Get the signing key associated with the mailbox address.
(Overrides OpenPgpContextBaseGetSigningKey(MailboxAddress).) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Import(PgpPublicKeyRing) |
Imports a public pgp keyring.
|
| Import(PgpPublicKeyRingBundle) |
Imports a public pgp keyring bundle.
(Overrides OpenPgpContextBaseImport(PgpPublicKeyRingBundle).) |
| Import(PgpSecretKeyRing) |
Imports a secret pgp keyring.
|
| Import(PgpSecretKeyRingBundle) |
Imports a secret pgp keyring bundle.
|
| Import(Stream) |
Imports public pgp keys from the specified stream.
(Overrides CryptographyContextImport(Stream).) |
| 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 | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RetrievePublicKeyRing |
Retrieve the public keyring using the configured key server.
(Inherited from OpenPgpContextBase.) |
| RetrievePublicKeyRingAsync |
Asynchronously retrieve the public keyring using the configured key server.
(Inherited from OpenPgpContextBase.) |
| SavePublicKeyRingBundle |
Saves the public key-ring bundle.
|
| SaveSecretKeyRingBundle |
Saves the secret key-ring bundle.
|
| Sign(PgpSecretKey, DigestAlgorithm, Stream) |
Cryptographically signs the content.
(Inherited from OpenPgpContextBase.) |
| Sign(MailboxAddress, DigestAlgorithm, Stream) |
Cryptographically signs the content.
(Inherited from OpenPgpContextBase.) |
| SignAndEncrypt(PgpSecretKey, DigestAlgorithm, IEnumerablePgpPublicKey, Stream) |
Cryptographically sign and encrypt the specified content for the specified recipients.
(Inherited from OpenPgpContextBase.) |
| SignAndEncrypt(MailboxAddress, DigestAlgorithm, IEnumerableMailboxAddress, Stream) |
Cryptographically sign and encrypt the specified content for the specified recipients.
(Inherited from OpenPgpContextBase.) |
| SignAndEncrypt(PgpSecretKey, DigestAlgorithm, EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream) |
Cryptographically sign and encrypt the specified content for the specified recipients.
(Inherited from OpenPgpContextBase.) |
| SignAndEncrypt(MailboxAddress, DigestAlgorithm, EncryptionAlgorithm, IEnumerableMailboxAddress, Stream) |
Cryptographically sign and encrypt the specified content for the specified recipients.
(Inherited from OpenPgpContextBase.) |
| SignKey |
Sign a public key.
|
| Supports |
Check whether or not the specified protocol is supported.
(Inherited from OpenPgpContextBase.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Verify |
Verify the specified content using the detached signatureData.
(Inherited from OpenPgpContextBase.) |
| VerifyAsync |
Asynchronously verify the specified content using the detached signatureData.
(Inherited from OpenPgpContextBase.) |
RemarksPGP software such as older versions of GnuPG (pre 2.1.0) typically store the user's keyrings on the file system using the OpenPGP Keyring Bundle format.
 Note |
|---|
| Generally speaking, applications should not use a OpenPgpContext directly, but rather via higher level APIs such as MultipartSigned and MultipartEncrypted. |
See Also