#include <keyresolver.h>
Public Member Functions | |
| KeyResolver (bool encToSelf, bool showApproval, bool oppEncryption, unsigned int format, int encrKeyNearExpiryThresholdDays, int signKeyNearExpiryThresholdDays, int encrRootCertNearExpiryThresholdDays, int signRootCertNearExpiryThresholdDays, int encrChainCertNearExpiryThresholdDays, int signChainCertNearExpiryThresholdDays) | |
| Kpgp::Result | setEncryptToSelfKeys (const TQStringList &fingerprints) |
| Kpgp::Result | setSigningKeys (const TQStringList &fingerprints) |
| void | setPrimaryRecipients (const TQStringList &addresses) |
| void | setSecondaryRecipients (const TQStringList &addresses) |
| Action | checkSigningPreferences (bool signingRequested) const |
| Action | checkEncryptionPreferences (bool encryptionRequested) const |
| Kpgp::Result | resolveAllKeys (bool &signingRequested, bool &encryptionRequested) |
| std::vector< GpgME::Key > | signingKeys (CryptoMessageFormat f) const |
| std::vector< SplitInfo > | encryptionItems (CryptoMessageFormat f) const |
Friends | |
| class | ::Kleo::KeyResolver::EncryptionPreferenceCounter |
| class | ::Kleo::KeyResolver::SigningPreferenceCounter |
Detailed Description
A class to resolve signing/encryption keys w.r.t.
per-recipient preferences
1: Set the information needed
The constructor takes some basic options as arguments, such as whether or not encryption was actually requested. Recipient and sender information is then set by using setEncryptToSelfKeys(), setSigningKeys(), setPrimaryRecipients() (To/Cc) and setSecondaryRecipients() (Bcc).
1: Set the information needed
First, checkSigningPreferences() goes through all recipient's signing perferences, to determine whether or not to sign. It also takes into account the available signing keys and whether or not the user explicitly requested signing.
checkEncryptionPreferences() does the same for encryption preferences. If opportunistic encryption is enabled, recipients without encryption preferences set are treated as if they had a preference of AskWheneverPossible.
In both cases an Action code is returned, with the following meanings:
- Conflict
A conflict was detected. E.g. one recipient's preference was set to "always encrypt", while another one's preference was set to "never encrypt". You should ask the user what to do.
- DoIt, DontDoIt
Do/Don't sign/encrypt
- Ask
(Some) crypto preferences request to prompt the user, so do it.
- Impossible
- Signing or encryption is impossible, e.g. due to missing keys or unsupported formats.
1: Set the information needed
In case signing or encryption was implicitly or explicitly requested by the user, resolveAllKeys() tries to find signing keys for each required format, as well as encryption keys for all recipients (incl. the sender, if encrypt-to-self is set).
1: Set the information needed
If, after key resolving, signing is still requested and apparently possible, you can get the result of all this by iterating over the available message formats and retrieving the set of signing keys to use with a call to signingKeys().
1: Set the information needed
If after key resolving, encryption is still requested and apparently possible, you can get the result of all this by calling encryptionItems() with the current message format at hand as its argument.
This will return a list of recipient-list/key-list pairs that each describe a copy of the (possibly signed) message to be encrypted independantly.
Note that it's only necessary to sign the message once for each message format, although it might be necessary to create more than one message when encrypting. This is because encryption allows the recipients to learn about the other recipients the message was encrypted to, so each secondary (BCC) recipient need a copy of it's own to hide the other secondary recipients.
Definition at line 127 of file keyresolver.h.
Member Function Documentation
◆ checkEncryptionPreferences()
| Kleo::Action Kleo::KeyResolver::checkEncryptionPreferences | ( | bool | encryptionRequested | ) | const |
Determine whether to encrypt or not, depending on the per-recipient encryption preferences, as well as the availability of usable encryption keys.
Definition at line 1007 of file keyresolver.cpp.
◆ checkSigningPreferences()
| Kleo::Action Kleo::KeyResolver::checkSigningPreferences | ( | bool | signingRequested | ) | const |
Determine whether to sign or not, depending on the per-recipient signing preferences, as well as the availability of usable signing keys.
Definition at line 981 of file keyresolver.cpp.
◆ encryptionItems()
| std::vector< Kleo::KeyResolver::SplitInfo > Kleo::KeyResolver::encryptionItems | ( | CryptoMessageFormat | f | ) | const |
- Returns
- the found distinct sets of items for format f. The returned vector will contain more than one item only if secondary recipients have been specified.
Definition at line 1560 of file keyresolver.cpp.
◆ resolveAllKeys()
| Kpgp::Result Kleo::KeyResolver::resolveAllKeys | ( | bool & | signingRequested, |
| bool & | encryptionRequested | ||
| ) |
Queries the user for missing keys and displays a key approval dialog if needed.
Definition at line 1061 of file keyresolver.cpp.
◆ setEncryptToSelfKeys()
| Kpgp::Result Kleo::KeyResolver::setEncryptToSelfKeys | ( | const TQStringList & | fingerprints | ) |
Set the fingerprints of keys to be used for encrypting to self.
Also looks them up and complains if they're not usable or found.
Definition at line 852 of file keyresolver.cpp.
◆ setPrimaryRecipients()
| void Kleo::KeyResolver::setPrimaryRecipients | ( | const TQStringList & | addresses | ) |
Set the list of primary (To/CC) recipient addresses.
Also looks up possible keys, but doesn't interact with the user.
Definition at line 944 of file keyresolver.cpp.
◆ setSecondaryRecipients()
| void Kleo::KeyResolver::setSecondaryRecipients | ( | const TQStringList & | addresses | ) |
Set the list of secondary (BCC) recipient addresses.
Also looks up possible keys, but doesn't interact with the user.
Definition at line 948 of file keyresolver.cpp.
◆ setSigningKeys()
| Kpgp::Result Kleo::KeyResolver::setSigningKeys | ( | const TQStringList & | fingerprints | ) |
Set the fingerprints of keys to be used for signing.
Also looks them up and complains if they're not usable or found.
Definition at line 900 of file keyresolver.cpp.
◆ signingKeys()
| std::vector< GpgME::Key > Kleo::KeyResolver::signingKeys | ( | CryptoMessageFormat | f | ) | const |
- Returns
- the signing keys to use (if any) for the given message format.
Definition at line 1567 of file keyresolver.cpp.
The documentation for this class was generated from the following files: