diff options
Diffstat (limited to 'src/pubkey')
-rw-r--r-- | src/pubkey/keypair/keypair.h | 20 | ||||
-rw-r--r-- | src/pubkey/pk_lookup/pk_algs.h | 14 |
2 files changed, 28 insertions, 6 deletions
diff --git a/src/pubkey/keypair/keypair.h b/src/pubkey/keypair/keypair.h index 4013ad328..ead6ae68c 100644 --- a/src/pubkey/keypair/keypair.h +++ b/src/pubkey/keypair/keypair.h @@ -12,10 +12,24 @@ namespace Botan { namespace KeyPair { -/************************************************* -* Check key pair consistency * -*************************************************/ +/** +* Tests whether the specified encryptor and decryptor are related to each other, +* i.e. whether encrypting with the encryptor and consecutive decryption leads to +* the original plaintext. +* @param enc the encryptor to test +* @param dec the decryptor to test +* @throw Self_Test_Failure if the arguments are not related to each other +*/ BOTAN_DLL void check_key(RandomNumberGenerator&, PK_Encryptor*, PK_Decryptor*); + +/** +* Tests whether the specified signer and verifier are related to each other, +* i.e. whether a signature created with the signer and can be +* successfully verified with the verifier. +* @param sig the signer to test +* @param ver the verifier to test +* @throw Self_Test_Failure if the arguments are not related to each other +*/ BOTAN_DLL void check_key(RandomNumberGenerator&, PK_Signer*, PK_Verifier*); } diff --git a/src/pubkey/pk_lookup/pk_algs.h b/src/pubkey/pk_lookup/pk_algs.h index a8fa5f176..2bb9a546e 100644 --- a/src/pubkey/pk_lookup/pk_algs.h +++ b/src/pubkey/pk_lookup/pk_algs.h @@ -11,10 +11,18 @@ namespace Botan { -/************************************************* -* Get an PK key object * -*************************************************/ +/** +* Get an empty public key object. +* @param name the name of the desired public key algorithm +* @return the public key object +*/ BOTAN_DLL Public_Key* get_public_key(const std::string&); + +/** +* Get an empty private key object. +* @param name the name of the desired public key algorithm +* @return the private key object +*/ BOTAN_DLL Private_Key* get_private_key(const std::string&); } |