aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteven Fackler <[email protected]>2017-01-03 12:37:17 -0800
committerGitHub <[email protected]>2017-01-03 12:37:17 -0800
commit570af5ff09dc2adbb979da4fa53c7fe4d6a4f123 (patch)
treedede42f027f6fe466d40d56555ad6fdcffab6f69
parentMerge pull request #544 from tomusdrw/master (diff)
parentTweak layout a little bit (diff)
downloadrust-openssl-570af5ff09dc2adbb979da4fa53c7fe4d6a4f123.tar.xz
rust-openssl-570af5ff09dc2adbb979da4fa53c7fe4d6a4f123.zip
Merge pull request #545 from Philipp91/patch-2
Pointer from PKey docs to sign module.
-rw-r--r--openssl/src/pkey.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/openssl/src/pkey.rs b/openssl/src/pkey.rs
index 7f031244..7a32692b 100644
--- a/openssl/src/pkey.rs
+++ b/openssl/src/pkey.rs
@@ -117,6 +117,9 @@ impl PKey {
}
/// Creates a new `PKey` containing an HMAC key.
+ ///
+ /// # Note
+ /// To compute HMAC values, use the `sign` module.
pub fn hmac(key: &[u8]) -> Result<PKey, ErrorStack> {
unsafe {
assert!(key.len() <= c_int::max_value() as usize);