summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRich Salz <rsalz@akamai.com>2019-09-27 13:17:09 -0400
committerPauli <paul.dale@oracle.com>2019-10-03 10:33:54 +1000
commit9c0586d5fc7988d2f8544f7884572a3b430406f6 (patch)
treee591f47e8c70c423e4cdf4a98ef847a1e3a296c9 /doc
parent60a7817cacacf4b30a16414479789c2774360782 (diff)
Fix errors found by new find-doc-nits
Also patch find-doc-nits to ignore a Microsoft trademark and not flag it as a spelling error. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/10023)
Diffstat (limited to 'doc')
-rw-r--r--doc/HOWTO/proxy_certificates.txt2
-rw-r--r--doc/internal/man3/evp_generic_fetch.pod2
-rw-r--r--doc/internal/man3/ossl_cmp_asn1_octet_string_set1.pod2
-rw-r--r--doc/internal/man3/ossl_namemap_new.pod2
-rw-r--r--doc/internal/man3/ossl_provider_new.pod2
-rw-r--r--doc/man1/CA.pl.pod2
-rw-r--r--doc/man1/openssl-info.pod2
-rw-r--r--doc/man1/openssl-ocsp.pod2
-rw-r--r--doc/man1/openssl-ts.pod106
-rw-r--r--doc/man1/openssl-tsget.pod28
-rw-r--r--doc/man1/openssl-x509.pod2
-rw-r--r--doc/man1/openssl.pod2
-rw-r--r--doc/man3/ASN1_TIME_set.pod4
-rw-r--r--doc/man3/ASN1_TYPE_get.pod8
-rw-r--r--doc/man3/BIO_get_data.pod2
-rw-r--r--doc/man3/BIO_parse_hostserv.pod4
-rw-r--r--doc/man3/BIO_s_connect.pod2
-rw-r--r--doc/man3/BIO_s_file.pod2
-rw-r--r--doc/man3/BN_bn2bin.pod2
-rw-r--r--doc/man3/CONF_modules_free.pod2
-rw-r--r--doc/man3/CRYPTO_memcmp.pod4
-rw-r--r--doc/man3/CT_POLICY_EVAL_CTX_new.pod2
-rw-r--r--doc/man3/DES_random_key.pod4
-rw-r--r--doc/man3/DH_get0_pqg.pod2
-rw-r--r--doc/man3/DH_set_method.pod2
-rw-r--r--doc/man3/DSA_set_method.pod2
-rw-r--r--doc/man3/EC_GROUP_new.pod8
-rw-r--r--doc/man3/ENGINE_add.pod12
-rw-r--r--doc/man3/ERR_get_error.pod4
-rw-r--r--doc/man3/ERR_load_strings.pod2
-rw-r--r--doc/man3/ERR_new.pod2
-rw-r--r--doc/man3/ERR_print_errors.pod2
-rw-r--r--doc/man3/ERR_put_error.pod4
-rw-r--r--doc/man3/EVP_PKEY_CTX_ctrl.pod4
-rw-r--r--doc/man3/HMAC.pod2
-rw-r--r--doc/man3/OCSP_cert_to_id.pod2
-rw-r--r--doc/man3/OCSP_request_add1_nonce.pod2
-rw-r--r--doc/man3/OCSP_resp_find_status.pod4
-rw-r--r--doc/man3/OPENSSL_LH_COMPFUNC.pod2
-rw-r--r--doc/man3/OSSL_CMP_CTX_new.pod2
-rw-r--r--doc/man3/OSSL_CMP_log_open.pod2
-rw-r--r--doc/man3/OpenSSL_version.pod2
-rw-r--r--doc/man3/RAND_add.pod2
-rw-r--r--doc/man3/RAND_load_file.pod4
-rw-r--r--doc/man3/RSA_set_method.pod2
-rw-r--r--doc/man3/SCT_new.pod5
-rw-r--r--doc/man3/SSL_CONF_cmd.pod2
-rw-r--r--doc/man3/SSL_CTX_dane_enable.pod2
-rw-r--r--doc/man3/SSL_CTX_set_client_hello_cb.pod2
-rw-r--r--doc/man3/SSL_CTX_set_info_callback.pod2
-rw-r--r--doc/man3/SSL_CTX_set_mode.pod12
-rw-r--r--doc/man3/SSL_CTX_set_options.pod16
-rw-r--r--doc/man3/SSL_read_early_data.pod4
-rw-r--r--doc/man3/SSL_set1_host.pod2
-rw-r--r--doc/man3/SSL_set_shutdown.pod2
-rw-r--r--doc/man3/UI_UTIL_read_pw.pod2
-rw-r--r--doc/man3/UI_new.pod6
-rw-r--r--doc/man3/X509_ALGOR_dup.pod4
-rw-r--r--doc/man3/X509_LOOKUP_hash_dir.pod2
-rw-r--r--doc/man3/X509_VERIFY_PARAM_set_flags.pod2
-rw-r--r--doc/man3/X509_check_ca.pod2
-rw-r--r--doc/man3/X509_check_host.pod4
-rw-r--r--doc/man3/X509v3_get_ext_by_NID.pod2
-rw-r--r--doc/man3/d2i_X509.pod2
-rw-r--r--doc/man5/config.pod2
-rw-r--r--doc/man7/ossl_store.pod2
-rw-r--r--doc/man7/provider.pod2
67 files changed, 171 insertions, 170 deletions
diff --git a/doc/HOWTO/proxy_certificates.txt b/doc/HOWTO/proxy_certificates.txt
index 3c42349261..f6f754cc34 100644
--- a/doc/HOWTO/proxy_certificates.txt
+++ b/doc/HOWTO/proxy_certificates.txt
@@ -108,7 +108,7 @@ recognised:
superfluous, and was removed.
file indicates that the text of the policy should really be taken from a
- file. The string is then really a file name. This is useful for
+ file. The string is then really a filename. This is useful for
policies that are large (more than a few lines, e.g. XML documents).
The 'policy' setting can be split up in multiple lines like this:
diff --git a/doc/internal/man3/evp_generic_fetch.pod b/doc/internal/man3/evp_generic_fetch.pod
index 4c12158317..c4734394bb 100644
--- a/doc/internal/man3/evp_generic_fetch.pod
+++ b/doc/internal/man3/evp_generic_fetch.pod
@@ -39,7 +39,7 @@ I<new_method>, I<up_ref_method>, and I<free_method>.
evp_generic_fetch_by_number() does the same thing as evp_generic_fetch(),
but takes a I<name_id> instead of a number.
-I<name_id> must always be non-zero; as a matter of fact, it being zero
+I<name_id> must always be nonzero; as a matter of fact, it being zero
is considered a programming error.
This is meant to be used when one method needs to fetch an associated
other method, and is typically called from inside the given function
diff --git a/doc/internal/man3/ossl_cmp_asn1_octet_string_set1.pod b/doc/internal/man3/ossl_cmp_asn1_octet_string_set1.pod
index 83a6d94929..08941362fb 100644
--- a/doc/internal/man3/ossl_cmp_asn1_octet_string_set1.pod
+++ b/doc/internal/man3/ossl_cmp_asn1_octet_string_set1.pod
@@ -37,7 +37,7 @@ by L<OSSL_CMP_log(3)> etc.
according to the pattern OSSL_CMP_LOG_START#level ": %s\n", filling in
the variable pointed to by I<level> with the severity level or -1,
the variable pointed to by I<func> with the function name string or NULL,
-the variable pointed to by I<file> with the file name string or NULL, and
+the variable pointed to by I<file> with the filename string or NULL, and
the variable pointed to by I<line> with the line number or -1.
Any string returned via I<*func> and I<*file> must be freeed by the caller.
diff --git a/doc/internal/man3/ossl_namemap_new.pod b/doc/internal/man3/ossl_namemap_new.pod
index 8699b861b0..b82d47a5bf 100644
--- a/doc/internal/man3/ossl_namemap_new.pod
+++ b/doc/internal/man3/ossl_namemap_new.pod
@@ -43,7 +43,7 @@ ossl_namemap_add() adds a new name to the namemap if it's not already
present.
If the given I<number> is zero, a new number will be allocated to
identify this I<name>.
-If the given I<number> is non-zero, the I<name> is added to the set of
+If the given I<number> is nonzero, the I<name> is added to the set of
names already associated with that number.
ossl_namemap_name2num() finds the number corresponding to the given
diff --git a/doc/internal/man3/ossl_provider_new.pod b/doc/internal/man3/ossl_provider_new.pod
index 7154d5f36a..39c3cba027 100644
--- a/doc/internal/man3/ossl_provider_new.pod
+++ b/doc/internal/man3/ossl_provider_new.pod
@@ -184,7 +184,7 @@ ossl_provider_new().
ossl_provider_dso() returns a reference to the module, for providers
that come in the form of loadable modules.
-ossl_provider_module_name() returns the file name of the module, for
+ossl_provider_module_name() returns the filename of the module, for
providers that come in the form of loadable modules.
ossl_provider_module_path() returns the full path of the module file,
diff --git a/doc/man1/CA.pl.pod b/doc/man1/CA.pl.pod
index c4fa87c336..07366613a8 100644
--- a/doc/man1/CA.pl.pod
+++ b/doc/man1/CA.pl.pod
@@ -164,7 +164,7 @@ Create the CA directories and files:
CA.pl -newca
-enter cacert.pem when prompted for the CA file name.
+enter cacert.pem when prompted for the CA filename.
Create a DSA certificate request and private key (a different set of parameters
can optionally be created first):
diff --git a/doc/man1/openssl-info.pod b/doc/man1/openssl-info.pod
index e26218c417..3040d0add8 100644
--- a/doc/man1/openssl-info.pod
+++ b/doc/man1/openssl-info.pod
@@ -54,7 +54,7 @@ Outputs the DSO extension OpenSSL uses.
=item B<-dirnamesep>
Outputs the separator character between a directory specification and
-a file name.
+a filename.
Note that on some operating systems, this is not the same as the
separator between directory elements.
diff --git a/doc/man1/openssl-ocsp.pod b/doc/man1/openssl-ocsp.pod
index 726020ffa5..b53404d08c 100644
--- a/doc/man1/openssl-ocsp.pod
+++ b/doc/man1/openssl-ocsp.pod
@@ -178,7 +178,7 @@ Specify the responder URL. Both HTTP and HTTPS (SSL/TLS) URLs can be specified.
=item B<-host> I<hostname:port>, B<-path> I<pathname>
If the B<host> option is present then the OCSP request is sent to the host
-B<hostname> on port B<port>. B<path> specifies the HTTP path name to use
+B<hostname> on port B<port>. B<path> specifies the HTTP pathname to use
or "/" by default. This is equivalent to specifying B<-url> with scheme
http:// and the given hostname, port, and pathname.
diff --git a/doc/man1/openssl-ts.pod b/doc/man1/openssl-ts.pod
index 0d65601a41..40906452f1 100644
--- a/doc/man1/openssl-ts.pod
+++ b/doc/man1/openssl-ts.pod
@@ -102,23 +102,23 @@ the hash to the TSA.
=item 2.
The TSA attaches the current date and time to the received hash value,
-signs them and sends the time stamp token back to the client. By
+signs them and sends the timestamp token back to the client. By
creating this token the TSA certifies the existence of the original
data file at the time of response generation.
=item 3.
-The TSA client receives the time stamp token and verifies the
+The TSA client receives the timestamp token and verifies the
signature on it. It also checks if the token contains the same hash
value that it had sent to the TSA.
=back
There is one DER encoded protocol data unit defined for transporting a time
-stamp request to the TSA and one for sending the time stamp response
+stamp request to the TSA and one for sending the timestamp response
back to the client. The B<ts> command has three main functions:
-creating a time stamp request based on a data file,
-creating a time stamp response based on a request, verifying if a
+creating a timestamp request based on a data file,
+creating a timestamp response based on a request, verifying if a
response corresponds to a particular request or a data file.
There is no support for sending the requests/responses automatically
@@ -127,9 +127,9 @@ requests either by ftp or e-mail.
=head1 OPTIONS
-=head2 Time Stamp Request generation
+=head2 Timestamp Request generation
-The B<-query> switch can be used for creating and printing a time stamp
+The B<-query> switch can be used for creating and printing a timestamp
request with the following options:
=over 4
@@ -155,7 +155,7 @@ see L<openssl(1)/COMMAND SUMMARY>.
=item B<-data> I<file_to_hash>
-The data file for which the time stamp request needs to be
+The data file for which the timestamp request needs to be
created. stdin is the default if neither the B<-data> nor the B<-digest>
parameter is specified. (Optional)
@@ -176,7 +176,7 @@ The default is SHA-256. (Optional)
=item B<-tspolicy> I<object_id>
The policy that the client expects the TSA to use for creating the
-time stamp token. Either the dotted OID notation or OID names defined
+timestamp token. Either the dotted OID notation or OID names defined
in the config file can be used. If no policy is requested the TSA will
use its own default policy. (Optional)
@@ -194,7 +194,7 @@ response. (Optional)
=item B<-in> I<request.tsq>
-This option specifies a previously created time stamp request in DER
+This option specifies a previously created timestamp request in DER
format that will be printed into the output file. Useful when you need
to examine the content of a request in human-readable
format. (Optional)
@@ -211,15 +211,15 @@ instead of DER. (Optional)
=back
-=head2 Time Stamp Response generation
+=head2 Timestamp Response generation
-A time stamp response (TimeStampResp) consists of a response status
-and the time stamp token itself (ContentInfo), if the token generation was
-successful. The B<-reply> command is for creating a time stamp
-response or time stamp token based on a request and printing the
+A timestamp response (TimeStampResp) consists of a response status
+and the timestamp token itself (ContentInfo), if the token generation was
+successful. The B<-reply> command is for creating a timestamp
+response or timestamp token based on a request and printing the
response/token in human-readable format. If B<-token_out> is not
-specified the output is always a time stamp response (TimeStampResp),
-otherwise it is a time stamp token (ContentInfo).
+specified the output is always a timestamp response (TimeStampResp),
+otherwise it is a timestamp token (ContentInfo).
=over 4
@@ -238,7 +238,7 @@ used, see L</CONFIGURATION FILE OPTIONS> for details. (Optional)
=item B<-queryfile> I<request.tsq>
-The name of the file containing a DER encoded time stamp request. (Optional)
+The name of the file containing a DER encoded timestamp request. (Optional)
=item B<-passin> I<password_src>
@@ -283,19 +283,19 @@ B<default_policy> config file option. (Optional)
=item B<-in> I<response.tsr>
-Specifies a previously created time stamp response or time stamp token
+Specifies a previously created timestamp response or timestamp token
(if B<-token_in> is also specified) in DER format that will be written
to the output file. This option does not require a request, it is
useful e.g. when you need to examine the content of a response or
-token or you want to extract the time stamp token from a response. If
-the input is a token and the output is a time stamp response a default
+token or you want to extract the timestamp token from a response. If
+the input is a token and the output is a timestamp response a default
'granted' status info is added to the token. (Optional)
=item B<-token_in>
This flag can be used together with the B<-in> option and indicates
-that the input is a DER encoded time stamp token (ContentInfo) instead
-of a time stamp response (TimeStampResp). (Optional)
+that the input is a DER encoded timestamp token (ContentInfo) instead
+of a timestamp response (TimeStampResp). (Optional)
=item B<-out> I<response.tsr>
@@ -305,7 +305,7 @@ stdout. (Optional)
=item B<-token_out>
-The output is a time stamp token (ContentInfo) instead of time stamp
+The output is a timestamp token (ContentInfo) instead of timestamp
response (TimeStampResp). (Optional)
=item B<-text>
@@ -318,14 +318,14 @@ instead of DER. (Optional)
Specifying an engine (by its unique B<id> string) will cause B<ts>
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
-for all available algorithms. Default is builtin. (Optional)
+for all available algorithms. Default is built-in. (Optional)
=back
-=head2 Time Stamp Response verification
+=head2 Timestamp Response verification
-The B<-verify> command is for verifying if a time stamp response or time
-stamp token is valid and matches a particular time stamp request or
+The B<-verify> command is for verifying if a timestamp response or time
+stamp token is valid and matches a particular timestamp request or
data file. The B<-verify> command does not use the configuration file.
=over 4
@@ -346,18 +346,18 @@ specified with this one. (Optional)
=item B<-queryfile> I<request.tsq>
-The original time stamp request in DER format. The B<-data> and B<-digest>
+The original timestamp request in DER format. The B<-data> and B<-digest>
options must not be specified with this one. (Optional)
=item B<-in> I<response.tsr>
-The time stamp response that needs to be verified in DER format. (Mandatory)
+The timestamp response that needs to be verified in DER format. (Mandatory)
=item B<-token_in>
This flag can be used together with the B<-in> option and indicates
-that the input is a DER encoded time stamp token (ContentInfo) instead
-of a time stamp response (TimeStampResp). (Optional)
+that the input is a DER encoded timestamp token (ContentInfo) instead
+of a timestamp response (TimeStampResp). (Optional)
=item B<-CApath> I<trusted_cert_path>
@@ -431,14 +431,14 @@ See L<ca(1)> for description. (Optional)
=item B<serial>
The name of the file containing the hexadecimal serial number of the
-last time stamp response created. This number is incremented by 1 for
+last timestamp response created. This number is incremented by 1 for
each response. If the file does not exist at the time of response
generation a new file is created with serial number 1. (Mandatory)
=item B<crypto_device>
Specifies the OpenSSL engine that will be set as the default for
-all available algorithms. The default value is builtin, you can specify
+all available algorithms. The default value is built-in, you can specify
any other engines supported by OpenSSL (e.g. use chil for the NCipher HSM).
(Optional)
@@ -488,7 +488,7 @@ the components is missing zero is assumed for that field. (Optional)
=item B<clock_precision_digits>
Specifies the maximum number of digits, which represent the fraction of
-seconds, that need to be included in the time field. The trailing zeroes
+seconds, that need to be included in the time field. The trailing zeros
must be removed from the time, so there might actually be fewer digits,
or no fraction of seconds at all. Supported only on UNIX platforms.
The maximum value is 6, default is 0.
@@ -529,16 +529,16 @@ All the examples below presume that B<OPENSSL_CONF> is set to a proper
configuration file, e.g. the example configuration file
openssl/apps/openssl.cnf will do.
-=head2 Time Stamp Request
+=head2 Timestamp Request
-To create a time stamp request for design1.txt with SHA-256 digest,
+To create a timestamp request for design1.txt with SHA-256 digest,
without nonce and policy, and without requirement for a certificate
in the response:
openssl ts -query -data design1.txt -no_nonce \
-out design1.tsq
-To create a similar time stamp request with specifying the message imprint
+To create a similar timestamp request with specifying the message imprint
explicitly:
openssl ts -query -digest b7e5d3f93198b38379852f2c04e78d73abdd0f4b \
@@ -548,7 +548,7 @@ To print the content of the previous request in human readable format:
openssl ts -query -in design1.tsq -text
-To create a time stamp request which includes the SHA-512 digest
+To create a timestamp request which includes the SHA-512 digest
of design2.txt, requests the signer certificate and nonce, and
specifies a policy id (assuming the tsa_policy1 name is defined in the
OID section of the config file):
@@ -556,7 +556,7 @@ OID section of the config file):
openssl ts -query -data design2.txt -sha512 \
-tspolicy tsa_policy1 -cert -out design2.tsq
-=head2 Time Stamp Response
+=head2 Timestamp Response
Before generating a response a signing certificate must be created for
the TSA that contains the B<timeStamping> critical extended key usage extension
@@ -570,7 +570,7 @@ below assume that cacert.pem contains the certificate of the CA,
tsacert.pem is the signing certificate issued by cacert.pem and
tsakey.pem is the private key of the TSA.
-To create a time stamp response for a request:
+To create a timestamp response for a request:
openssl ts -reply -queryfile design1.tsq -inkey tsakey.pem \
-signer tsacert.pem -out design1.tsr
@@ -579,44 +579,44 @@ If you want to use the settings in the config file you could just write:
openssl ts -reply -queryfile design1.tsq -out design1.tsr
-To print a time stamp reply to stdout in human readable format:
+To print a timestamp reply to stdout in human readable format:
openssl ts -reply -in design1.tsr -text
-To create a time stamp token instead of time stamp response:
+To create a timestamp token instead of timestamp response:
openssl ts -reply -queryfile design1.tsq -out design1_token.der -token_out
-To print a time stamp token to stdout in human readable format:
+To print a timestamp token to stdout in human readable format:
openssl ts -reply -in design1_token.der -token_in -text -token_out
-To extract the time stamp token from a response:
+To extract the timestamp token from a response:
openssl ts -reply -in design1.tsr -out design1_token.der -token_out
-To add 'granted' status info to a time stamp token thereby creating a
+To add 'granted' status info to a timestamp token thereby creating a
valid response:
openssl ts -reply -in design1_token.der -token_in -out design1.tsr
-=head2 Time Stamp Verification
+=head2 Timestamp Verification
-To verify a time stamp reply against a request:
+To verify a timestamp reply against a request:
openssl ts -verify -queryfile design1.tsq -in design1.tsr \
-CAfile cacert.pem -untrusted tsacert.pem
-To verify a time stamp reply that includes the certificate chain:
+To verify a timestamp reply that includes the certificate chain:
openssl ts -verify -queryfile design2.tsq -in design2.tsr \