diff options
Diffstat (limited to 'src/pubkey')
| -rw-r--r-- | src/pubkey/pubkey/pk_keys.h | 100 |
1 files changed, 75 insertions, 25 deletions
diff --git a/src/pubkey/pubkey/pk_keys.h b/src/pubkey/pubkey/pk_keys.h index 16109c634..1aa5e3fa1 100644 --- a/src/pubkey/pubkey/pk_keys.h +++ b/src/pubkey/pubkey/pk_keys.h @@ -1,7 +1,7 @@ /************************************************* * PK Key Types Header File * * (C) 1999-2007 Jack Lloyd * -*************************************************/ +n*************************************************/ #ifndef BOTAN_PK_KEYS_H__ #define BOTAN_PK_KEYS_H__ @@ -12,23 +12,63 @@ namespace Botan { -/************************************************* -* Public Key Base Class * -*************************************************/ +/** +* Public Key Base Class. +*/ class BOTAN_DLL Public_Key { public: + /** + * Get the name of the underlying public key scheme. + * @return the name of the public key scheme + */ virtual std::string algo_name() const = 0; + + /** + * Get the OID of the underlying public key scheme. + * @return the OID of the public key scheme + */ virtual OID get_oid() const; + /** + * Test the key values for consistency. + * @param rng rng to use + * @param strong whether to perform strong and lengthy version + * of the test + * @return true if the test is passed + */ virtual bool check_key(RandomNumberGenerator&, bool) const { return true; } + /** + * Find out the number of message parts supported by this scheme. + * @return the number of message parts + */ virtual u32bit message_parts() const { return 1; } + + /** + * Find out the message part size supported by this scheme/key. + * @return the size of the message parts + */ virtual u32bit message_part_size() const { return 0; } + + /** + * Get the maximum message size in bits supported by this public key. + * @return the maximum message in bits + */ virtual u32bit max_input_bits() const = 0; + /** + * Get an X509 encoder that can be used to encode this key in X509 format. + * @return an X509 encoder for this key + */ virtual class X509_Encoder* x509_encoder() const = 0; + + /** + * Get an X509 decoder that can be used to set the values of this + * key based on an X509 encoded key object. + * @return an X509 decoder for this key + */ virtual class X509_Decoder* x509_decoder() = 0; virtual ~Public_Key() {} @@ -36,14 +76,24 @@ class BOTAN_DLL Public_Key virtual void load_check(RandomNumberGenerator&) const; }; -/************************************************* -* Private Key Base Class * -*************************************************/ +/** +* Private Key Base Class +*/ class BOTAN_DLL Private_Key : public virtual Public_Key { public: + /** + * Get a PKCS#8 encoder that can be used to encode this key in PKCS#8 format. + * @return an PKCS#8 encoder for this key + */ virtual class PKCS8_Encoder* pkcs8_encoder() const { return 0; } + + /** + * Get an PKCS#8 decoder that can be used to set the values of this key + * based on an PKCS#8 encoded key object. + * @return an PKCS#8 decoder for this key + */ virtual class PKCS8_Decoder* pkcs8_decoder(RandomNumberGenerator&) { return 0; } protected: @@ -51,9 +101,9 @@ class BOTAN_DLL Private_Key : public virtual Public_Key void gen_check(RandomNumberGenerator&) const; }; -/************************************************* -* PK Encrypting Key * -*************************************************/ +/** +* PK Encrypting Key. +*/ class BOTAN_DLL PK_Encrypting_Key : public virtual Public_Key { public: @@ -62,9 +112,9 @@ class BOTAN_DLL PK_Encrypting_Key : public virtual Public_Key virtual ~PK_Encrypting_Key() {} }; -/************************************************* -* PK Decrypting Key * -*************************************************/ +/** +* PK Decrypting Key +*/ class BOTAN_DLL PK_Decrypting_Key : public virtual Private_Key { public: @@ -72,9 +122,9 @@ class BOTAN_DLL PK_Decrypting_Key : public virtual Private_Key virtual ~PK_Decrypting_Key() {} }; -/************************************************* -* PK Signing Key * -*************************************************/ +/** +* PK Signing Key +*/ class BOTAN_DLL PK_Signing_Key : public virtual Private_Key { public: @@ -83,9 +133,9 @@ class BOTAN_DLL PK_Signing_Key : public virtual Private_Key virtual ~PK_Signing_Key() {} }; -/************************************************* -* PK Verifying Key, Message Recovery Version * -*************************************************/ +/** +* PK Verifying Key, Message Recovery Version +*/ class BOTAN_DLL PK_Verifying_with_MR_Key : public virtual Public_Key { public: @@ -93,9 +143,9 @@ class BOTAN_DLL PK_Verifying_with_MR_Key : public virtual Public_Key virtual ~PK_Verifying_with_MR_Key() {} }; -/************************************************* -* PK Verifying Key, No Message Recovery Version * -*************************************************/ +/** +* PK Verifying Key, No Message Recovery Version +*/ class BOTAN_DLL PK_Verifying_wo_MR_Key : public virtual Public_Key { public: @@ -104,9 +154,9 @@ class BOTAN_DLL PK_Verifying_wo_MR_Key : public virtual Public_Key virtual ~PK_Verifying_wo_MR_Key() {} }; -/************************************************* -* PK Secret Value Derivation Key * -*************************************************/ +/** +* PK Secret Value Derivation Key +*/ class BOTAN_DLL PK_Key_Agreement_Key : public virtual Private_Key { public: |