aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/pubkey/dh
diff options
context:
space:
mode:
authorRenĂ© Korthaus <[email protected]>2016-10-18 11:41:33 +0200
committerRenĂ© Korthaus <[email protected]>2016-10-19 09:13:38 +0200
commit61a7875fb261a049c70382517e83176b4108bb61 (patch)
tree0cf884b160918002abb72c53868152fa574668fb /src/lib/pubkey/dh
parent47532b63e947e020df15a03d91f9d67657cd11dd (diff)
Improve pubkey doxygen [ci skip]
Diffstat (limited to 'src/lib/pubkey/dh')
-rw-r--r--src/lib/pubkey/dh/dh.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/src/lib/pubkey/dh/dh.h b/src/lib/pubkey/dh/dh.h
index d15bc5eb3..e46a35dff 100644
--- a/src/lib/pubkey/dh/dh.h
+++ b/src/lib/pubkey/dh/dh.h
@@ -25,6 +25,11 @@ class BOTAN_DLL DH_PublicKey : public virtual DL_Scheme_PublicKey
DL_Group::Format group_format() const override { return DL_Group::ANSI_X9_42; }
+ /**
+ * Create a public key.
+ * @param alg_id the X.509 algorithm identifier
+ * @param key_bits X.509 subject public key info structure
+ */
DH_PublicKey(const AlgorithmIdentifier& alg_id,
const secure_vector<byte>& key_bits) :
DL_Scheme_PublicKey(alg_id, key_bits, DL_Group::ANSI_X9_42) {}
@@ -50,9 +55,9 @@ class BOTAN_DLL DH_PrivateKey : public DH_PublicKey,
std::vector<byte> public_value() const override;
/**
- * Load a DH private key
- * @param alg_id the algorithm id
- * @param key_bits the subject public key
+ * Load a private key.
+ * @param alg_id the X.509 algorithm identifier
+ * @param key_bits PKCS #8 structure
* @param rng a random number generator
*/
DH_PrivateKey(const AlgorithmIdentifier& alg_id,
@@ -60,7 +65,7 @@ class BOTAN_DLL DH_PrivateKey : public DH_PublicKey,
RandomNumberGenerator& rng);
/**
- * Construct a private key with predetermined value.
+ * Create a private key.
* @param rng random number generator to use
* @param grp the group to be used in the key
* @param x the key's secret value (or if zero, generate a new key)