boring2/openssl/src
Philipp Keck 1767cd5464 Pointer from PKey docs to sign module.
Could even add a link, but I don't know how.

Someone who wants to use OpenSSL to compute an HMAC won't find a "hmac" module and won't find HMACs in the "hash" module. Unless the person knows that HMACs are used to "sign" messages (the usual term in this context would be "authenticate"), they will probably use the search function and look for "hmac", then they'll find this method. So it's helpful to include a pointer to the right API to use. Without such a pointer, the API user is left with a seemingly useless Pkey instance.

Similar pointers could be helpful from the other creator methods in this file. And/or from the top-level documentation or the hash documentation towards the sign module. Another idea would be a trivial `hmac` module with a few helper functions that internally just use Pkey. If many users who just want a simple HMAC value can use that API, there are fewer dependencies on `Pkey` and `sign`, which is probably a good thing.
2017-01-03 14:48:46 +01:00
..
ssl Typo 2017-01-02 09:37:31 -08:00
x509 Macroise from_pem 2016-11-13 17:56:48 +00:00
asn1.rs Rustfmt 2016-11-05 10:54:17 -07:00
bio.rs Rustfmt 2016-10-30 16:37:45 -07:00
bn.rs Add a missing init 2016-11-12 14:30:53 +00:00
crypto.rs Fix drop signature 2016-10-26 22:00:33 -07:00
dh.rs Macroise from_pem 2016-11-13 17:56:48 +00:00
dsa.rs Remove some stray manual impls 2016-11-13 18:00:42 +00:00
ec.rs Return Option from group 2016-11-16 15:45:15 -08:00
ec_key.rs Rename ec_key to ec 2016-11-14 22:37:01 +01:00
error.rs Fix ErrorStack display 2016-12-09 21:32:41 -08:00
hash.rs Fix docs 2017-01-01 10:07:32 -08:00
lib.rs Release v0.9.4 2016-12-23 13:38:52 -05:00
macros.rs Macroise from_pem 2016-11-13 17:56:48 +00:00
memcmp.rs Use constants rather than constructors for Nid 2016-10-22 15:58:06 -07:00
nid.rs Rustfmt 2016-10-30 16:37:45 -07:00
pkcs5.rs Fix doc reference 2017-01-01 09:53:08 -08:00
pkcs12.rs Macroise from_der 2016-11-13 17:06:50 +00:00
pkey.rs Pointer from PKey docs to sign module. 2017-01-03 14:48:46 +01:00
rand.rs Flatten crypto module 2016-10-22 09:16:38 -07:00
rsa.rs Remove some stray manual impls 2016-11-13 18:00:42 +00:00
sign.rs Indicate that memcmp::eq should be used for HMACs 2016-12-31 09:44:57 -08:00
stack.rs Add Stack::pop 2016-11-05 13:40:53 -07:00
symm.rs Stick tag description on the right function 2017-01-01 10:13:34 -08:00
types.rs Get rid of Ref 2016-11-04 17:16:59 -07:00
util.rs Make password callback return a Result 2016-11-13 16:18:52 +00:00
verify.rs Get rid of Ref 2016-11-04 17:16:59 -07:00
version.rs Little cleanup 2017-01-01 11:05:54 -08:00