aboutsummaryrefslogtreecommitdiffstats
path: root/src/pubkey/keypair/keypair.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/pubkey/keypair/keypair.h')
-rw-r--r--src/pubkey/keypair/keypair.h20
1 files changed, 17 insertions, 3 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*);
}