diff options
author | Rich Salz <rsalz@openssl.org> | 2016-07-28 17:00:05 -0400 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2016-07-28 17:00:05 -0400 |
commit | 1a627771634adba9d4f3b5cf7be74d6bab428a5f (patch) | |
tree | 182ece217c2dbe9ed37b23e00a71096b14ca837a /doc | |
parent | 29df3061b3cba1e343a76e69e47149f1dc526361 (diff) |
Various doc fixes.
Cannot nest B<> tags
Document "openssl speed" command.
Fix doc nits: missing NAME/SYNOPSIS stuff
Reviewed-by: Tim Hudson <tjh@openssl.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/apps/list.pod | 81 | ||||
-rw-r--r-- | doc/apps/speed.pod | 28 | ||||
-rw-r--r-- | doc/crypto/HMAC.pod | 4 | ||||
-rw-r--r-- | doc/crypto/OCSP_resp_find_status.pod | 2 | ||||
-rw-r--r-- | doc/crypto/X509_STORE_CTX_set_verify_cb.pod | 11 | ||||
-rw-r--r-- | doc/crypto/X509_STORE_set_verify_cb_func.pod | 28 | ||||
-rw-r--r-- | doc/crypto/X509_get_extension_flags.pod | 2 | ||||
-rw-r--r-- | doc/ssl/SSL_get_all_async_fds.pod | 8 | ||||
-rw-r--r-- | doc/ssl/SSL_get_current_cipher.pod | 2 |
9 files changed, 134 insertions, 32 deletions
diff --git a/doc/apps/list.pod b/doc/apps/list.pod new file mode 100644 index 0000000000..e6e1f17617 --- /dev/null +++ b/doc/apps/list.pod @@ -0,0 +1,81 @@ +=pod + +=head1 NAME + +list - list algorithms and features + +=head1 SYNOPSIS + +B<openssl list> +[B<-help>] +[B<-commands>] +[B<-digest-commands>] +[B<-digest-algorithms>] +[B<-cipher-commands>] +[B<-cipher-algorithms>] +[B<-public-key-algorithms>] +[B<-disabled>] + +=head1 DESCRIPTION + +This command is used to generate list of algorithms or disabled +features. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Display out a usage message. + +=item B<-commands> + +Display a list of standard commands. + +=item B<-digest-commands> + +Display a list of message digest commands, which are typically used +as input to the L<dgst(1)> or L<speed(1)> commands. + +=item B<-digest-algorithms> + +Display a list of message digest algorithms. +If a line is of the form + foo => bar +then B<foo> is an alias for the official algorithm name, B<bar>. + +=item B<-cipher-commands> + +Display a list of cipher commands, which are typically used as input +to the L<dgst(1)> or L<speed(1)> commands. + +=item B<-cipher-algorithms> + +Display a list of cipher algorithms. +If a line is of the form + foo => bar +then B<foo> is an alias for the official algorithm name, B<bar>. + +=item B<-public-key-algorithms> + +Display a list of public key algorithms, with each algorithm as +a block of multiple lines, all but the first are indented. + +=item B<-disabled> + +Display a list of disabled features, those that were compiled out +of the installation. + +=back + +=head1 COPYRIGHT + +Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut diff --git a/doc/apps/speed.pod b/doc/apps/speed.pod index ab2c7d76ac..ad81bfbc74 100644 --- a/doc/apps/speed.pod +++ b/doc/apps/speed.pod @@ -12,35 +12,13 @@ B<openssl speed> [B<-elapsed>] [B<-evp algo>] [B<-decrypt>] -[B<md2>] -[B<mdc2>] -[B<md5>] -[B<hmac>] -[B<sha1>] -[B<rmd160>] -[B<idea-cbc>] -[B<rc2-cbc>] -[B<rc5-cbc>] -[B<bf-cbc>] -[B<des-cbc>] -[B<des-ede3>] -[B<rc4>] -[B<rsa512>] -[B<rsa1024>] -[B<rsa2048>] -[B<rsa4096>] -[B<dsa512>] -[B<dsa1024>] -[B<dsa2048>] -[B<idea>] -[B<rc2>] -[B<des>] -[B<rsa>] -[B<blowfish>] +[B<algorithm...>] =head1 DESCRIPTION This command is used to test the performance of cryptographic algorithms. +To see the list of supported algorithms, use the I<list --digest-commands> +or I<list --cipher-commands> command. =head1 OPTIONS diff --git a/doc/crypto/HMAC.pod b/doc/crypto/HMAC.pod index 91d0bdc3d5..87f7e33086 100644 --- a/doc/crypto/HMAC.pod +++ b/doc/crypto/HMAC.pod @@ -87,9 +87,9 @@ of an B<HMAC_CTX> in this function. B<N.B. HMAC_Init() had this undocumented behaviour in previous versions of OpenSSL - failure to switch to HMAC_Init_ex() in programs that expect it will cause them to stop working>. -B<NB: if HMAC_Init_ex() is called with B<key> NULL and B<evp_md> is not the +B<NOTE:> If HMAC_Init_ex() is called with B<key> NULL and B<evp_md> is not the same as the previous digest used by B<ctx> then an error is returned -because reuse of an existing key with a different digest is not supported.> +because reuse of an existing key with a different digest is not supported. HMAC_Update() can be called repeatedly with chunks of the message to be authenticated (B<len> bytes at B<data>). diff --git a/doc/crypto/OCSP_resp_find_status.pod b/doc/crypto/OCSP_resp_find_status.pod index b94896592b..2dcd318f54 100644 --- a/doc/crypto/OCSP_resp_find_status.pod +++ b/doc/crypto/OCSP_resp_find_status.pod @@ -2,6 +2,8 @@ =head1 NAME +OCSP_resp_get0_certs, +OCSP_resp_get0_id, OCSP_resp_get0_produced_at, OCSP_resp_find_status, OCSP_resp_count, OCSP_resp_get0, OCSP_resp_find, OCSP_single_get0_status, OCSP_check_validity diff --git a/doc/crypto/X509_STORE_CTX_set_verify_cb.pod b/doc/crypto/X509_STORE_CTX_set_verify_cb.pod index 527cba1017..034a5804e9 100644 --- a/doc/crypto/X509_STORE_CTX_set_verify_cb.pod +++ b/doc/crypto/X509_STORE_CTX_set_verify_cb.pod @@ -2,6 +2,17 @@ =head1 NAME +X509_STORE_CTX_get_cleanup, +X509_STORE_CTX_get_lookup_crls, +X509_STORE_CTX_get_lookup_certs, +X509_STORE_CTX_get_check_policy, +X509_STORE_CTX_get_cert_crl, +X509_STORE_CTX_get_check_crl, +X509_STORE_CTX_get_get_crl, +X509_STORE_CTX_get_check_revocation, +X509_STORE_CTX_get_check_issued, +X509_STORE_CTX_get_get_issuer, +X509_STORE_CTX_get_verify, X509_STORE_CTX_get_verify_cb, X509_STORE_CTX_set_verify_cb - get and set verification callback diff --git a/doc/crypto/X509_STORE_set_verify_cb_func.pod b/doc/crypto/X509_STORE_set_verify_cb_func.pod index 950e83385d..dd21325f74 100644 --- a/doc/crypto/X509_STORE_set_verify_cb_func.pod +++ b/doc/crypto/X509_STORE_set_verify_cb_func.pod @@ -2,7 +2,33 @@ =head1 NAME -X509_STORE_set_verify_cb_func, X509_STORE_set_verify_cb - set verification callback +X509_STORE_set_lookup_crls_cb, +X509_STORE_set_verify_func, +X509_STORE_get_cleanup, +X509_STORE_set_cleanup, +X509_STORE_get_lookup_crls, +X509_STORE_set_lookup_crls, +X509_STORE_get_lookup_certs, +X509_STORE_set_lookup_certs, +X509_STORE_get_check_policy, +X509_STORE_set_check_policy, +X509_STORE_get_cert_crl, +X509_STORE_set_cert_crl, +X509_STORE_get_check_crl, +X509_STORE_set_check_crl, +X509_STORE_get_get_crl, +X509_STORE_set_get_crl, +X509_STORE_get_check_revocation, +X509_STORE_set_check_revocation, +X509_STORE_get_check_issued, +X509_STORE_set_check_issued, +X509_STORE_get_get_issuer, +X509_STORE_set_get_issuer, +X509_STORE_CTX_get_verify, +X509_STORE_set_verify, +X509_STORE_get_verify_cb, +X509_STORE_set_verify_cb_func, X509_STORE_set_verify_cb +- set verification callback =head1 SYNOPSIS diff --git a/doc/crypto/X509_get_extension_flags.pod b/doc/crypto/X509_get_extension_flags.pod index 0fc42e8b92..a4a33ae937 100644 --- a/doc/crypto/X509_get_extension_flags.pod +++ b/doc/crypto/X509_get_extension_flags.pod @@ -21,7 +21,7 @@ X509_get_proxy_pathlen - retrieve certificate extension data uint32_t X509_get_extended_key_usage(X509 *x); const ASN1_OCTET_STRING *X509_get0_subject_key_id(X509 *x); void X509_set_proxy_flag(X509 *x); - void X509_set_proxy_path_length(int l); + void X509_set_proxy_pathlen(int l); long X509_get_proxy_pathlen(X509 *x); =head1 DESCRIPTION diff --git a/doc/ssl/SSL_get_all_async_fds.pod b/doc/ssl/SSL_get_all_async_fds.pod index 636f765508..b4fa4ee0d1 100644 --- a/doc/ssl/SSL_get_all_async_fds.pod +++ b/doc/ssl/SSL_get_all_async_fds.pod @@ -2,8 +2,12 @@ =head1 NAME -SSL_waiting_for_async, SSL_get_all_async_fds, SSL_get_changed_async_fds - manage -asynchronous operations +SSL_waiting_for_async, +SSL_get_all_async_fds, +SSL_get_changed_async_fds +- manage asynchronous operations + +=for comment multiple includes =head1 SYNOPSIS diff --git a/doc/ssl/SSL_get_current_cipher.pod b/doc/ssl/SSL_get_current_cipher.pod index 52453a41e0..87cecb0ce2 100644 --- a/doc/ssl/SSL_get_current_cipher.pod +++ b/doc/ssl/SSL_get_current_cipher.pod @@ -2,7 +2,7 @@ =head1 NAME -SSL_get_current_cipher, SSL_get_cipher_name, *SSL_get_cipher, +SSL_get_current_cipher, SSL_get_cipher_name, SSL_get_cipher, SSL_get_cipher_bits, SSL_get_cipher_version - get SSL_CIPHER of a connection =head1 SYNOPSIS |