openssl/doc/crypto
Emilia Kasper d64c533a20 Improve EVP_PKEY_sign documentation
Clarify the intended use of EVP_PKEY_sign. Make the code example compile.

Reviewed-by: Dr Stephen Henson <steve@openssl.org>
2014-08-22 15:00:11 +02:00
..
ASN1_generate_nconf.pod Close a whole bunch of documentation-related tickets: 2014-07-02 22:42:40 -04:00
ASN1_OBJECT_new.pod RT3239: Extra comma in NAME lines of two manpages 2014-08-12 15:59:18 -04:00
ASN1_STRING_length.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
ASN1_STRING_new.pod Add includes in synopsis. 2006-05-14 11:28:00 +00:00
ASN1_STRING_print_ex.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
BIO_ctrl.pod
BIO_f_base64.pod Close a whole bunch of documentation-related tickets: 2014-07-02 22:42:40 -04:00
BIO_f_buffer.pod PR: 2252 2010-05-03 15:30:07 +00:00
BIO_f_cipher.pod
BIO_f_md.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
BIO_f_null.pod
BIO_f_ssl.pod Update from 1.0.0-stable 2009-06-25 11:29:30 +00:00
BIO_find_type.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
BIO_new_CMS.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
BIO_new.pod
BIO_push.pod Typo. 2014-06-29 13:38:55 +01:00
BIO_read.pod
BIO_s_accept.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
BIO_s_bio.pod
BIO_s_connect.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
BIO_s_fd.pod
BIO_s_file.pod bss_file.c: refine UTF-8 logic on Windows. 2010-04-28 20:02:28 +00:00
BIO_s_mem.pod Updates from 1.0.0-stable branch. 2009-04-20 11:33:12 +00:00
BIO_s_null.pod
BIO_s_socket.pod
BIO_set_callback.pod fix documentation 2006-12-06 09:10:59 +00:00
BIO_should_retry.pod PR: 2209 2010-04-06 14:45:18 +00:00
bio.pod
blowfish.pod
BN_add_word.pod
BN_add.pod
BN_BLINDING_new.pod Fix various spelling errors 2014-02-14 22:29:12 +00:00
BN_bn2bin.pod
BN_cmp.pod
BN_copy.pod
BN_CTX_new.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
BN_CTX_start.pod
BN_generate_prime.pod RT 487. Mention that generated primes are "at least" B<bits> long. 2014-06-27 15:59:08 -04:00
bn_internal.pod PR: 2078 2009-10-28 13:52:07 +00:00
BN_mod_inverse.pod
BN_mod_mul_montgomery.pod
BN_mod_mul_reciprocal.pod
BN_new.pod
BN_num_bytes.pod
BN_rand.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
BN_set_bit.pod
BN_swap.pod
BN_zero.pod
bn.pod Revert my earlier CRYPTO_THREADID commit, I will commit a reworked 2008-07-03 19:59:25 +00:00
buffer.pod
CMS_add0_cert.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
CMS_add1_recipient_cert.pod Reformat, fix typos and clarify CMS API docs. 2008-04-10 23:28:25 +00:00
CMS_compress.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
CMS_decrypt.pod Clarify CMS_decrypt behaviour. 2014-04-15 18:17:12 +01:00
CMS_encrypt.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
CMS_final.pod Reformat, fix typos and clarify CMS API docs. 2008-04-10 23:28:25 +00:00
CMS_get0_RecipientInfos.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
CMS_get0_SignerInfos.pod Add CMS_SignerInfo_get0_signature function. 2013-11-09 15:09:23 +00:00
CMS_get0_type.pod Spellcheck CMS docs. 2008-04-10 10:46:11 +00:00
CMS_get1_ReceiptRequest.pod Reformat, fix typos and clarify CMS API docs. 2008-04-10 23:28:25 +00:00
CMS_sign_add1_signer.pod Typo. 2009-03-08 12:01:20 +00:00
CMS_sign_receipt.pod Reformat, fix typos and clarify CMS API docs. 2008-04-10 23:28:25 +00:00
CMS_sign.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
CMS_uncompress.pod Revert argument swap change... oops CMS_uncompress() was consistent... 2008-04-11 23:23:18 +00:00
CMS_verify_receipt.pod Reformat, fix typos and clarify CMS API docs. 2008-04-10 23:28:25 +00:00
CMS_verify.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
CONF_modules_free.pod Corrected POD syntax errors. PR#3353 2014-05-14 21:07:51 +01:00
CONF_modules_load_file.pod Corrected POD syntax errors. PR#3353 2014-05-14 21:07:51 +01:00
CRYPTO_set_ex_data.pod Add includes in synopsis. 2006-05-14 11:28:00 +00:00
crypto.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
d2i_ASN1_OBJECT.pod
d2i_DHparams.pod
d2i_DSAPublicKey.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
d2i_ECPKParameters.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
d2i_PKCS8PrivateKey.pod
d2i_RSAPublicKey.pod Changes from 1.0.0-stable. 2009-04-07 16:33:26 +00:00
d2i_X509_ALGOR.pod
d2i_X509_CRL.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
d2i_X509_NAME.pod
d2i_X509_REQ.pod PR: 2023 2009-09-12 23:34:41 +00:00
d2i_X509_SIG.pod
d2i_X509.pod PR: 2023 2009-09-12 23:34:41 +00:00
des_modes.pod small cosmetics: align title with the other similar manual page 2007-02-27 07:41:54 +00:00
des.pod Minor documentation update removing "really" and a 2014-07-21 20:03:50 +10:00
DH_generate_key.pod
DH_generate_parameters.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
DH_get_ex_new_index.pod
DH_new.pod
DH_set_method.pod Typos in man pages: dependant->dependent 2007-11-19 09:18:03 +00:00
DH_size.pod
dh.pod
DSA_do_sign.pod
DSA_dup_DH.pod
DSA_generate_key.pod
DSA_generate_parameters.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
DSA_get_ex_new_index.pod Typo. 2009-10-17 17:06:19 +00:00
DSA_new.pod
DSA_set_method.pod Typos in man pages: dependant->dependent 2007-11-19 09:18:03 +00:00
DSA_SIG_new.pod
DSA_sign.pod
DSA_size.pod
dsa.pod
EC_GFp_simple_method.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
EC_GROUP_copy.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
EC_GROUP_new.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
EC_KEY_new.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
EC_POINT_add.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
EC_POINT_new.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
ec.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
ecdsa.pod Correct ECDSA example. 2013-08-21 13:43:00 +01:00
engine.pod Typos in man pages: dependant->dependent 2007-11-19 09:18:03 +00:00
ERR_clear_error.pod
ERR_error_string.pod
ERR_get_error.pod Fix doc typo. 2014-07-02 03:43:42 +01:00
ERR_GET_LIB.pod
ERR_load_crypto_strings.pod
ERR_load_strings.pod
ERR_print_errors.pod
ERR_put_error.pod
ERR_remove_state.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
ERR_set_mark.pod
err.pod Close a whole bunch of documentation-related tickets: 2014-07-02 22:42:40 -04:00
EVP_BytesToKey.pod PKCS5_PBKDF2_HMAC documentation submitted by Jeffrey Walton 2014-04-26 21:44:26 +01:00
EVP_DigestInit.pod Fixed minor duplication in docs 2014-06-07 12:30:18 +01:00
EVP_DigestSignInit.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
EVP_DigestVerifyInit.pod Constify. 2013-11-14 21:05:36 +00:00
EVP_EncryptInit.pod RT 2517: Various typo's. 2014-08-11 13:43:31 -04:00
EVP_OpenInit.pod
EVP_PKEY_cmp.pod RT2513: Fix typo's paramter-->parameter 2014-08-19 11:09:33 -04:00
EVP_PKEY_CTX_ctrl.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
EVP_PKEY_CTX_new.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
EVP_PKEY_decrypt.pod Correct EVP_PKEY_verifyrecover to EVP_PKEY_verify_recover (RT 2955). 2013-01-12 12:25:30 +00:00
EVP_PKEY_derive.pod Correct EVP_PKEY_verifyrecover to EVP_PKEY_verify_recover (RT 2955). 2013-01-12 12:25:30 +00:00
EVP_PKEY_encrypt.pod Correct EVP_PKEY_verifyrecover to EVP_PKEY_verify_recover (RT 2955). 2013-01-12 12:25:30 +00:00
EVP_PKEY_get_default_digest.pod Correct EVP_PKEY_verifyrecover to EVP_PKEY_verify_recover (RT 2955). 2013-01-12 12:25:30 +00:00
EVP_PKEY_keygen.pod Correct EVP_PKEY_verifyrecover to EVP_PKEY_verify_recover (RT 2955). 2013-01-12 12:25:30 +00:00
EVP_PKEY_new.pod
EVP_PKEY_print_private.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
EVP_PKEY_set1_RSA.pod
EVP_PKEY_sign.pod Improve EVP_PKEY_sign documentation 2014-08-22 15:00:11 +02:00
EVP_PKEY_verify_recover.pod Correct EVP_PKEY_verifyrecover to EVP_PKEY_verify_recover (RT 2955). 2013-01-12 12:25:30 +00:00
EVP_PKEY_verify.pod Correct EVP_PKEY_verifyrecover to EVP_PKEY_verify_recover (RT 2955). 2013-01-12 12:25:30 +00:00
EVP_SealInit.pod
EVP_SignInit.pod RT2513: Fix typo's paramter-->parameter 2014-08-19 11:09:33 -04:00
EVP_VerifyInit.pod New docs for EVP_Digest{Sign,Verify}*() function. Update existing docs. 2006-07-12 12:31:30 +00:00
evp.pod POD: Fix list termination 2013-10-22 07:38:25 +01:00
hmac.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
i2d_CMS_bio_stream.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
i2d_PKCS7_bio_stream.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
lh_stats.pod
lhash.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
md5.pod update md docs 2006-10-27 21:58:09 +00:00
mdc2.pod update md docs 2006-10-27 21:58:09 +00:00
OBJ_nid2obj.pod Add includes in synopsis. 2006-05-14 11:28:00 +00:00
OpenSSL_add_all_algorithms.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
OPENSSL_Applink.pod
OPENSSL_config.pod Corrected POD syntax errors. PR#3353 2014-05-14 21:07:51 +01:00
OPENSSL_ia32cap.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
OPENSSL_instrument_bus.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
OPENSSL_load_builtin_modules.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
OPENSSL_VERSION_NUMBER.pod
PEM_write_bio_CMS_stream.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
PEM_write_bio_PKCS7_stream.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
pem.pod Fix typo, add reference. 2014-07-17 12:07:37 +01:00
PKCS5_PBKDF2_HMAC.pod Fixed minor errors in docs 2014-04-26 21:56:36 +01:00
PKCS7_decrypt.pod Add includes in synopsis. 2006-05-14 11:28:00 +00:00
PKCS7_encrypt.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
PKCS7_sign_add_signer.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
PKCS7_sign.pod Change version from 0.9.9 to 1.0.0 in docs 2009-09-30 23:43:01 +00:00
PKCS7_verify.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
PKCS12_create.pod
PKCS12_parse.pod Update from 1.0.0-stable. 2009-05-17 14:48:31 +00:00
RAND_add.pod
RAND_bytes.pod Port from 0.9.8-stable 2007-09-24 11:01:18 +00:00
RAND_cleanup.pod
RAND_egd.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
RAND_load_file.pod
RAND_set_rand_method.pod Typos in man pages: dependant->dependent 2007-11-19 09:18:03 +00:00
rand.pod s/recommend/recommended/ 2013-09-05 21:43:50 +01:00
rc4.pod
ripemd.pod update md docs 2006-10-27 21:58:09 +00:00
RSA_blinding_on.pod
RSA_check_key.pod
RSA_generate_key.pod Document updates from wiki. 2013-06-12 23:42:08 +01:00
RSA_get_ex_new_index.pod fix documentation 2006-12-06 09:10:59 +00:00
RSA_new.pod
RSA_padding_add_PKCS1_type_1.pod
RSA_print.pod
RSA_private_encrypt.pod
RSA_public_encrypt.pod
RSA_set_method.pod Fix documentation for RSA_set_method(3) 2014-07-19 22:57:37 +01:00
RSA_sign_ASN1_OCTET_STRING.pod
RSA_sign.pod Close a whole bunch of documentation-related tickets: 2014-07-02 22:42:40 -04:00
RSA_size.pod
rsa.pod
sha.pod update md docs 2006-10-27 21:58:09 +00:00
SMIME_read_CMS.pod Reformat, fix typos and clarify CMS API docs. 2008-04-10 23:28:25 +00:00
SMIME_read_PKCS7.pod Add includes in synopsis. 2006-05-14 11:28:00 +00:00
SMIME_write_CMS.pod Reformat, fix typos and clarify CMS API docs. 2008-04-10 23:28:25 +00:00
SMIME_write_PKCS7.pod Oops... 2007-04-13 13:20:46 +00:00
SSLeay_version.pod
threads.pod RT2942: CRYPTO_set_dynlock_create_callback doc fix 2014-08-18 16:04:33 -04:00
ui_compat.pod Add includes in synopsis. 2006-05-14 11:28:00 +00:00
ui.pod Minor documentation update removing "really" and a 2014-07-21 20:03:50 +10:00
x509.pod
X509_check_host.pod Improve X509_check_host() documentation. 2014-07-07 20:34:06 +10:00
X509_NAME_add_entry_by_txt.pod s/recommend/recommended/ 2013-09-05 21:43:50 +01:00
X509_NAME_ENTRY_get_object.pod Corrected POD syntax errors. PR#3353 2014-05-14 21:07:51 +01:00
X509_NAME_get_index_by_NID.pod Add includes in synopsis. 2006-05-14 11:28:00 +00:00
X509_NAME_print_ex.pod Typos 2007-09-24 11:22:58 +00:00
X509_new.pod Add includes in synopsis. 2006-05-14 11:28:00 +00:00
X509_STORE_CTX_get_error.pod misspellings fixes by https://github.com/vlajos/misspell_fixer 2013-09-05 21:39:42 +01:00
X509_STORE_CTX_get_ex_new_index.pod Correct the return type on the signature for X509_STORE_CTX_get_ex_data given in the pod file. 2014-05-12 22:41:13 +01:00
X509_STORE_CTX_new.pod Add docs for X509_STORE_CTX_new() and related functions. 2009-10-17 18:05:53 +00:00
X509_STORE_CTX_set_verify_cb.pod Verification callback functions. 2009-10-18 13:26:08 +00:00
X509_STORE_set_verify_cb_func.pod PR: 2157 2010-01-27 12:54:58 +00:00
X509_verify_cert.pod More X509 verification docs. 2009-10-17 17:07:17 +00:00
X509_VERIFY_PARAM_set_flags.pod Update API to use (char *) for email addresses and hostnames 2014-07-07 19:11:38 +10:00