diff options
| author | lloyd <[email protected]> | 2010-06-16 00:25:34 +0000 |
|---|---|---|
| committer | lloyd <[email protected]> | 2010-06-16 00:25:34 +0000 |
| commit | b1405ff3191a4343d098c513af157d831723b92d (patch) | |
| tree | 0d32527cabf7301c7a25cbe14040ab8d2d7bab3a /src/kdf/kdf.h | |
| parent | ee412caaa1b7ef69fd6dfeb0d2c474fe0ddf4737 (diff) | |
Doxygen comments
Diffstat (limited to 'src/kdf/kdf.h')
| -rw-r--r-- | src/kdf/kdf.h | 46 |
1 files changed, 42 insertions, 4 deletions
diff --git a/src/kdf/kdf.h b/src/kdf/kdf.h index 614988f5a..ecf7f4621 100644 --- a/src/kdf/kdf.h +++ b/src/kdf/kdf.h @@ -19,25 +19,63 @@ namespace Botan { class BOTAN_DLL KDF { public: + /** + * Derive a key + * @param key_len the desired output length in bytes + * @param secret the secret input + * @param salt a diversifier + */ SecureVector<byte> derive_key(u32bit key_len, const MemoryRegion<byte>& secret, const std::string& salt = "") const; + /** + * Derive a key + * @param key_len the desired output length in bytes + * @param secret the secret input + * @param salt a diversifier + */ SecureVector<byte> derive_key(u32bit key_len, const MemoryRegion<byte>& secret, const MemoryRegion<byte>& salt) const; + /** + * Derive a key + * @param key_len the desired output length in bytes + * @param secret the secret input + * @param salt a diversifier + * @param salt_len size of salt in bytes + */ SecureVector<byte> derive_key(u32bit key_len, const MemoryRegion<byte>& secret, - const byte salt[], u32bit salt_len) const; + const byte salt[], + u32bit salt_len) const; + /** + * Derive a key + * @param key_len the desired output length in bytes + * @param secret the secret input + * @param secret_len size of secret in bytes + * @param salt a diversifier + */ SecureVector<byte> derive_key(u32bit key_len, - const byte secret[], u32bit secret_len, + const byte secret[], + u32bit secret_len, const std::string& salt = "") const; + /** + * Derive a key + * @param key_len the desired output length in bytes + * @param secret the secret input + * @param secret_len size of secret in bytes + * @param salt a diversifier + * @param salt_len size of salt in bytes + */ SecureVector<byte> derive_key(u32bit key_len, - const byte secret[], u32bit secret_len, - const byte salt[], u32bit salt_len) const; + const byte secret[], + u32bit secret_len, + const byte salt[], + u32bit salt_len) const; virtual ~KDF() {} private: |