From f59cacc01b042210865a8cb9b766c646dce23629 Mon Sep 17 00:00:00 2001 From: lloyd Date: Mon, 13 Oct 2008 03:15:59 +0000 Subject: More Doxygen comments from InSiTo --- src/pubkey/keypair/keypair.h | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) (limited to 'src/pubkey/keypair') 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*); } -- cgit v1.2.3