Open
An abstract OpenPGP cryptography context which can be used for PGP/MIME.
Definition
Namespace: MimeKit.Cryptography
Assembly: MimeKit.Cryptography (in MimeKit.Cryptography.dll) Version: 5.0.0
Assembly: MimeKit.Cryptography (in MimeKit.Cryptography.dll) Version: 5.0.0
C#
public abstract class OpenPgpContext : CryptographyContext- Inheritance
- Object CryptographyContext OpenPgpContext
- Derived
Remarks
An abstract OpenPGP cryptography context which can be used for PGP/MIME.
Note
Generally speaking, applications should not use an OpenPgpContext
directly, but rather via higher level APIs such as MultipartSigned
and MultipartEncrypted.
Constructors
| OpenPgpContext | Initialize a new instance of the OpenPgpContext class. |
Properties
| AllowUnauthenticatedDecryption | Get or set whether encrypted data without integrity protection may be decrypted. |
| AutoKeyRetrieve | Get or set whether unknown PGP keys should automtically be retrieved. |
| DefaultEncryptionAlgorithm | Get or set the default encryption algorithm. |
| DigestAlgorithmRank | Get or set the preferred rank order for the digest algorithms; from the most preferred to the least. |
| EnabledDigestAlgorithms | Get the enabled digest algorithms in ranked order. |
| 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.
(Overrides CryptographyContextEncryptionProtocol) |
| KeyExchangeProtocol |
Get the key exchange protocol.
(Overrides CryptographyContextKeyExchangeProtocol) |
| KeyServer | Get or set the key server to use when automatically retrieving keys. |
| PrepareBeforeSigning |
Get or set whether a MimeEntity should be prepared before signing.
(Inherited from CryptographyContext) |
| SignatureProtocol |
Get the signature protocol.
(Overrides CryptographyContextSignatureProtocol) |
Methods
| CanEncrypt |
Check whether the cryptography context can encrypt to a particular recipient.
(Inherited from CryptographyContext) |
| 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.
(Inherited from CryptographyContext) |
| CanSignAsync |
Asynchronously check whether a particular mailbox address can be used for signing.
(Inherited from CryptographyContext) |
| Decrypt(Stream, CancellationToken) |
Decrypt the specified encryptedData.
(Overrides CryptographyContextDecrypt(Stream, CancellationToken)) |
| Decrypt(Stream, DigitalSignatureCollection, CancellationToken) | Decrypt the specified encryptedData and extracts the digital signers if the content was also signed. |
| DecryptAsync |
Asynchronously decrypt the specified encryptedData.
(Overrides CryptographyContextDecryptAsync(Stream, CancellationToken)) |
| DecryptTo | Decrypt an encrypted stream and extract the digital signers if the content was also signed. |
| DecryptToAsync | Asynchronously decrypt an encrypted stream and extract the digital signers if the content was also signed. |
| Disable(DigestAlgorithm) | Disable the digest algorithm. |
| 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.
(Overrides CryptographyContextDispose(Boolean)) |
| Enable(DigestAlgorithm) | Enable the digest algorithm. |
| Enable(EncryptionAlgorithm) |
Enable the encryption algorithm.
(Inherited from CryptographyContext) |
| Encrypt(IEnumerableMailboxAddress, Stream, CancellationToken) |
Encrypt the specified content for the specified recipients.
(Overrides CryptographyContextEncrypt(IEnumerableMailboxAddress, Stream, CancellationToken)) |
| Encrypt(IEnumerablePgpPublicKey, Stream, CancellationToken) | Encrypt the specified content for the specified recipients. |
| Encrypt(EncryptionAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken) | Encrypt the specified content for the specified recipients. |
| Encrypt(EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken) | Encrypt the specified content for the specified recipients. |
| EncryptAsync(IEnumerableMailboxAddress, Stream, CancellationToken) |
Asynchronously encrypt the specified content for the specified recipients.
(Overrides CryptographyContextEncryptAsync(IEnumerableMailboxAddress, Stream, CancellationToken)) |
| EncryptAsync(IEnumerablePgpPublicKey, Stream, CancellationToken) | Asynchronously encrypt the specified content for the specified recipients. |
| EncryptAsync(EncryptionAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken) | Asynchronously encrypt the specified content for the specified recipients. |
| EncryptAsync(EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken) | Asynchronously encrypt the specified content for the specified recipients. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Export(IEnumerableMailboxAddress, CancellationToken) |
Exports the keys for the specified mailboxes.
(Inherited from CryptographyContext) |
| Export(IEnumerablePgpPublicKey, CancellationToken) | Export the specified public keys. |
| Export(PgpPublicKeyRingBundle, CancellationToken) | Export the specified public keys. |
| Export(IEnumerableMailboxAddress, Stream, Boolean, CancellationToken) | Export the public keyrings for the specified mailboxes. |
| Export(IEnumerablePgpPublicKey, Stream, Boolean, CancellationToken) | Export the specified public keys. |
| Export(PgpPublicKeyRingBundle, Stream, Boolean, CancellationToken) | Export the public keyring bundle. |
| ExportAsync(IEnumerableMailboxAddress, CancellationToken) |
Asynchronously exports the keys for the specified mailboxes.
(Inherited from CryptographyContext) |
| ExportAsync(IEnumerablePgpPublicKey, CancellationToken) | Asynchronously export the specified public keys. |
| ExportAsync(PgpPublicKeyRingBundle, CancellationToken) | Asynchronously export the specified public keys. |
| ExportAsync(IEnumerableMailboxAddress, Stream, Boolean, CancellationToken) | Asynchronously export the public keyrings for the specified mailboxes. |
| ExportAsync(IEnumerablePgpPublicKey, Stream, Boolean, CancellationToken) | Asynchronously export the specified public keys. |
| ExportAsync(PgpPublicKeyRingBundle, Stream, Boolean, CancellationToken) | Asynchronously export the public keyring bundle. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetDigestAlgorithm(HashAlgorithmTag) | Gets the equivalent DigestAlgorithm for the specified HashAlgorithmTag. |
| GetDigestAlgorithm(String) |
Get the digest algorithm from the micalg parameter value in a multipart/signed part.
(Overrides CryptographyContextGetDigestAlgorithm(String)) |
| GetDigestAlgorithmName |
Get the string name of the digest algorithm for use with the micalg parameter of a multipart/signed part.
(Overrides CryptographyContextGetDigestAlgorithmName(DigestAlgorithm)) |
| GetHashAlgorithm | Gets the equivalent HashAlgorithmTag for the specified DigestAlgorithm. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPasswordForKey | Get the password for a secret key. |
| GetPrivateKey | Gets the private key from the specified secret key. |
| GetPublicKeyAlgorithm | Gets the equivalent PublicKeyAlgorithm for the specified PublicKeyAlgorithmTag. |
| GetPublicKeyRing | Get the public keyring that contains the specified key. |
| GetPublicKeyRingAsync | Asynchronously get the public keyring that contains the specified key asynchronously. |
| GetPublicKeys | Get the public keys for the specified mailbox addresses. |
| GetPublicKeysAsync | Asynchronously get the public keys for the specified mailbox addresses. |
| GetSecretKey | Get the secret key for a specified key identifier. |
| GetSecretKeyAsync | Asynchronously get the secret key for a specified key identifier. |
| GetSigningKey | Get the signing key associated with the mailbox address. |
| GetSigningKeyAsync | Asynchronously get the signing key associated with the mailbox address. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Import(PgpPublicKeyRing, CancellationToken) | Import a public pgp keyring. |
| Import(PgpPublicKeyRingBundle, CancellationToken) | Import the specified public keyring bundle. |
| Import(PgpSecretKeyRing, CancellationToken) | Import a secret pgp keyring. |
| Import(PgpSecretKeyRingBundle, CancellationToken) | Import a secret pgp keyring bundle. |
| Import(Stream, CancellationToken) |
Import public pgp keys from the specified stream.
(Overrides CryptographyContextImport(Stream, CancellationToken)) |
| ImportAsync |
Asynchronously import public pgp keys from the specified stream.
(Overrides CryptographyContextImportAsync(Stream, CancellationToken)) |
| IsEnabled(DigestAlgorithm) | Check whether the specified digest algorithm is enabled. |
| IsEnabled(EncryptionAlgorithm) |
Check whether the specified encryption algorithm is enabled.
(Inherited from CryptographyContext) |
| IsExpired | Check if a public key is expired. |
| IsMatch(PgpPublicKey, MailboxAddress) | Check that a public key is a match for the specified mailbox. |
| IsMatch(PgpSecretKey, MailboxAddress) | Check that a secret key is a match for the specified mailbox. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RetrievePublicKeyRing | Retrieve the public keyring using the configured key server. |
| RetrievePublicKeyRingAsync | Asynchronously retrieve the public keyring using the configured key server. |
| Sign(MailboxAddress, DigestAlgorithm, Stream, CancellationToken) |
Sign the content using the specified signer and digest algorithm.
(Overrides CryptographyContextSign(MailboxAddress, DigestAlgorithm, Stream, CancellationToken)) |
| Sign(PgpSecretKey, DigestAlgorithm, Stream, CancellationToken) | Sign the content using the specified signer and digest algorithm. |
| SignAndEncrypt(MailboxAddress, DigestAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken) | Sign and encrypt the specified content for the specified recipients. |
| SignAndEncrypt(PgpSecretKey, DigestAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken) | Sign and encrypt the specified content for the specified recipients. |
| SignAndEncrypt(MailboxAddress, DigestAlgorithm, EncryptionAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken) | Sign and encrypt the specified content for the specified recipients. |
| SignAndEncrypt(PgpSecretKey, DigestAlgorithm, EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken) | Sign and encrypt the specified content for the specified recipients. |
| SignAndEncryptAsync(MailboxAddress, DigestAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken) | Asynchronously sign and encrypt the specified content for the specified recipients. |
| SignAndEncryptAsync(PgpSecretKey, DigestAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken) | Asynchronously sign and encrypt the specified content for the specified recipients. |
| SignAndEncryptAsync(MailboxAddress, DigestAlgorithm, EncryptionAlgorithm, IEnumerableMailboxAddress, Stream, CancellationToken) | Asynchronously sign and encrypt the specified content for the specified recipients. |
| SignAndEncryptAsync(PgpSecretKey, DigestAlgorithm, EncryptionAlgorithm, IEnumerablePgpPublicKey, Stream, CancellationToken) | Asynchronously sign and encrypt the specified content for the specified recipients. |
| SignAsync(MailboxAddress, DigestAlgorithm, Stream, CancellationToken) |
Asynchronously sign the content using the specified signer and digest algorithm.
(Overrides CryptographyContextSignAsync(MailboxAddress, DigestAlgorithm, Stream, CancellationToken)) |
| SignAsync(PgpSecretKey, DigestAlgorithm, Stream, CancellationToken) | Asynchronously sign the content using the specified signer and digest algorithm. |
| Supports |
Check whether the specified protocol is supported.
(Overrides CryptographyContextSupports(String)) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Verify |
Verify the specified content using the detached signatureData.
(Overrides CryptographyContextVerify(Stream, Stream, CancellationToken)) |
| VerifyAsync |
Asynchronously verify the specified content using the detached signatureData.
(Overrides CryptographyContextVerifyAsync(Stream, Stream, CancellationToken)) |