Use 'over 2' for bullet lists.
authorRich Salz <rsalz@openssl.org>
Fri, 7 Apr 2017 17:37:47 +0000 (13:37 -0400)
committerRich Salz <rsalz@openssl.org>
Fri, 7 Apr 2017 17:48:19 +0000 (13:48 -0400)
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/3117)

12 files changed:
doc/man1/ts.pod
doc/man3/BN_copy.pod
doc/man3/BN_generate_prime.pod
doc/man3/CRYPTO_THREAD_run_once.pod
doc/man3/CT_POLICY_EVAL_CTX_new.pod
doc/man3/DSA_generate_parameters.pod
doc/man3/RSA_generate_key.pod
doc/man3/SCT_new.pod
doc/man3/SCT_validate.pod
doc/man3/SSL_set_bio.pod
doc/man7/des_modes.pod
util/find-doc-nits

index 5b2e639..2ec9837 100644 (file)
@@ -608,25 +608,35 @@ You could also look at the 'test' directory for more examples.
 If you find any bugs or you have suggestions please write to
 Zoltan Glozik <zglozik@opentsa.org>. Known issues:
 
-=over 4
+=over 2
+
+=item *
 
-=item * No support for time stamps over SMTP, though it is quite easy
+No support for time stamps over SMTP, though it is quite easy
 to implement an automatic e-mail based TSA with L<procmail(1)>
 and L<perl(1)>. HTTP server support is provided in the form of
 a separate apache module. HTTP client support is provided by
 L<tsget(1)>. Pure TCP/IP protocol is not supported.
 
-=item * The file containing the last serial number of the TSA is not
+=item *
+
+The file containing the last serial number of the TSA is not
 locked when being read or written. This is a problem if more than one
 instance of L<openssl(1)> is trying to create a time stamp
 response at the same time. This is not an issue when using the apache
 server module, it does proper locking.
 
-=item * Look for the FIXME word in the source files.
+=item *
+
+Look for the FIXME word in the source files.
+
+=item *
+
+The source code should really be reviewed by somebody else, too.
 
-=item * The source code should really be reviewed by somebody else, too.
+=item *
 
-=item * More testing is needed, I have done only some basic tests (see
+More testing is needed, I have done only some basic tests (see
 test/testtsa).
 
 =back
index 500f4b2..46de544 100644 (file)
@@ -29,7 +29,7 @@ B<BN_FLG_CONSTTIME> flag set for constant time operations. The temporary copy in
 B<dest> will share some internal state with B<b>. For this reason the following
 restrictions apply to the use of B<dest>:
 
-=over 4
+=over 2
 
 =item *
 
index a4ef230..c97536b 100644 (file)
@@ -55,7 +55,7 @@ If B<ret> is not B<NULL>, it will be used to store the number.
 
 If B<cb> is not B<NULL>, it is used as follows:
 
-=over 4
+=over 2
 
 =item *
 
index 45545c8..b256a18 100644 (file)
@@ -32,9 +32,10 @@ supported by OpenSSL.
 
 The following multi-threading function are provided:
 
-=over 4
+=over 2
 
 =item *
+
 CRYPTO_THREAD_run_once() can be used to perform one-time initialization.
 The B<once> argument must be a pointer to a static object of type
 B<CRYPTO_ONCE> that was statically initialized to the value
@@ -45,22 +46,28 @@ In particular, this can be used to allocate locks in a thread-safe manner,
 which can then be used with the locking functions below.
 
 =item *
+
 CRYPTO_THREAD_lock_new() allocates, initializes and returns a new read/write
 lock.
 
 =item *
+
 CRYPTO_THREAD_read_lock() locks the provided B<lock> for reading.
 
 =item *
+
 CRYPTO_THREAD_write_lock() locks the provided B<lock> for writing.
 
 =item *
+
 CRYPTO_THREAD_unlock() unlocks the previously locked B<lock>.
 
 =item *
+
 CRYPTO_THREAD_lock_frees() frees the provided B<lock>.
 
 =item *
+
 CRYPTO_atomic_add() atomically adds B<amount> to B<val> and returns the
 result of the operation in B<ret>. B<lock> will be locked, unless atomic
 operations are supported on the specific platform. Because of this, if a
index 7839fd3..4d0cae3 100644 (file)
@@ -32,15 +32,23 @@ This policy may be, for example, that at least one valid SCT is available. To
 determine this, an SCT's timestamp and signature must be verified.
 This requires:
 
-=over 4
+=over 2
 
-=item * the public key of the log that issued the SCT
+=item *
 
-=item * the certificate that the SCT was issued for
+the public key of the log that issued the SCT
 
-=item * the issuer certificate (if the SCT was issued for a pre-certificate)
+=item *
 
-=item * the current time
+the certificate that the SCT was issued for
+
+=item *
+
+the issuer certificate (if the SCT was issued for a pre-certificate)
+
+=item *
+
+the current time
 
 =back
 
@@ -49,22 +57,30 @@ The above requirements are met using the setters described below.
 CT_POLICY_EVAL_CTX_new() creates an empty policy evaluation context. This
 should then be populated using:
 
-=over 4
+=over 2
 
-=item * CT_POLICY_EVAL_CTX_set1_cert() to provide the certificate the SCTs were issued for
+=item *
+
+CT_POLICY_EVAL_CTX_set1_cert() to provide the certificate the SCTs were issued for
 
 Increments the reference count of the certificate.
 
-=item * CT_POLICY_EVAL_CTX_set1_issuer() to provide the issuer certificate
+=item *
+
+CT_POLICY_EVAL_CTX_set1_issuer() to provide the issuer certificate
 
 Increments the reference count of the certificate.
 
-=item * CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE() to provide a list of logs that are trusted as sources of SCTs
+=item *
+
+CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE() to provide a list of logs that are trusted as sources of SCTs
 
 Holds a pointer to the CTLOG_STORE, so the CTLOG_STORE must outlive the
 CT_POLICY_EVAL_CTX.
 
-=item * CT_POLICY_EVAL_CTX_set_time() to set the time SCTs should be compared with to determine if they are valid
+=item *
+
+CT_POLICY_EVAL_CTX_set_time() to set the time SCTs should be compared with to determine if they are valid
 
 The SCT timestamp will be compared to this time to check whether the SCT was
 issued in the future. RFC6962 states that "TLS clients MUST reject SCTs whose
index 2cb20fa..fc05149 100644 (file)
@@ -42,7 +42,7 @@ called as shown below. For information on the BN_GENCB structure and the
 BN_GENCB_call function discussed below, refer to
 L<BN_generate_prime(3)>.
 
-=over 4
+=over 2
 
 =item *
 
index 24e05bd..e51c0b1 100644 (file)
@@ -32,7 +32,7 @@ progress of the key generation. If B<cb> is not B<NULL>, it
 will be called as follows using the BN_GENCB_call() function
 described on the L<BN_generate_prime(3)> page.
 
-=over 4
+=over 2
 
 =item *
 
index 23595e1..e85b21c 100644 (file)
@@ -84,31 +84,45 @@ An internal representation of an SCT can be created in one of two ways.
 The first option is to create a blank SCT, using SCT_new(), and then populate
 it using:
 
-=over 4
+=over 2
 
-=item * SCT_set_version() to set the SCT version.
+=item *
+
+SCT_set_version() to set the SCT version.
 
 Only SCT_VERSION_V1 is currently supported.
 
-=item * SCT_set_log_entry_type() to set the type of certificate the SCT was issued for:
+=item *
+
+SCT_set_log_entry_type() to set the type of certificate the SCT was issued for:
 
 B<CT_LOG_ENTRY_TYPE_X509> for a normal certificate.
 B<CT_LOG_ENTRY_TYPE_PRECERT> for a pre-certificate.
 
-=item * SCT_set0_log_id() or SCT_set1_log_id() to set the LogID of the CT log that the SCT came from.
+=item *
+
+SCT_set0_log_id() or SCT_set1_log_id() to set the LogID of the CT log that the SCT came from.
 
 The former takes ownership, whereas the latter makes a copy.
 See RFC 6962, Section 3.2 for the definition of LogID.
 
-=item * SCT_set_timestamp() to set the time the SCT was issued (epoch time in milliseconds).
+=item *
+
+SCT_set_timestamp() to set the time the SCT was issued (epoch time in milliseconds).
+
+=item *
+
+SCT_set_signature_nid() to set the NID of the signature.
 
-=item * SCT_set_signature_nid() to set the NID of the signature.
+=item *
 
-=item * SCT_set0_signature() or SCT_set1_signature() to set the raw signature value.
+SCT_set0_signature() or SCT_set1_signature() to set the raw signature value.
 
 The former takes ownership, whereas the latter makes a copy.
 
-=item * SCT_set0_extensions() or B<SCT_set1_extensions> to provide SCT extensions.
+=item *
+
+SCT_set0_extensions() or B<SCT_set1_extensions> to provide SCT extensions.
 
 The former takes ownership, whereas the latter makes a copy.
 
@@ -117,22 +131,33 @@ The former takes ownership, whereas the latter makes a copy.
 Alternatively, the SCT can be pre-populated from the following data using
 SCT_new_from_base64():
 
-=over 4
+=over 2
+
+=item *
+
+The SCT version (only SCT_VERSION_V1 is currently supported).
 
-=item * The SCT version (only SCT_VERSION_V1 is currently supported).
+=item *
 
-=item * The LogID (see RFC 6962, Section 3.2), base64 encoded.
+The LogID (see RFC 6962, Section 3.2), base64 encoded.
 
-=item * The type of certificate the SCT was issued for:
+=item *
 
+The type of certificate the SCT was issued for:
 B<CT_LOG_ENTRY_TYPE_X509> for a normal certificate.
 B<CT_LOG_ENTRY_TYPE_PRECERT> for a pre-certificate.
 
-=item * The time that the SCT was issued (epoch time in milliseconds).
+=item *
+
+The time that the SCT was issued (epoch time in milliseconds).
+
+=item *
+
+The SCT extensions, base64 encoded.
 
-=item * The SCT extensions, base64 encoded.
+=item *
 
-=item * The SCT signature, base64 encoded.
+The SCT signature, base64 encoded.
 
 =back
 
index 3c03e97..5ff0e8c 100644 (file)
@@ -31,20 +31,26 @@ SCT_get_validation_status().
 
 A CT_POLICY_EVAL_CTX must be provided that specifies:
 
-=over 4
+=over 2
 
-=item * The certificate the SCT was issued for.
+=item *
+
+The certificate the SCT was issued for.
 
 Failure to provide the certificate will result in the validation status being
 SCT_VALIDATION_STATUS_UNVERIFIED.
 
-=item * The issuer of that certificate.
+=item *
+
+The issuer of that certificate.
 
 This is only required if the SCT was issued for a pre-certificate
 (see RFC 6962). If it is required but not provided, the validation status will
 be SCT_VALIDATION_STATUS_UNVERIFIED.
 
-=item * A CTLOG_STORE that contains the CT log that issued this SCT.
+=item *
+
+A CTLOG_STORE that contains the CT log that issued this SCT.
 
 If the SCT was issued by a log that is not in this CTLOG_STORE, the validation
 status will be SCT_VALIDATION_STATUS_UNKNOWN_LOG.
index 104f406..4230940 100644 (file)
@@ -37,7 +37,7 @@ the rules for this are much more complex. For this reason this function is
 considered a legacy function and SSL_set0_rbio() and SSL_set0_wbio() should be
 used in preference. The ownership rules are as follows:
 
-=over 4
+=over 2
 
 =item *
 
index 12001e6..f7415d7 100644 (file)
@@ -16,7 +16,7 @@ other things.
 
 Normally, this is found as the function I<algorithm>_ecb_encrypt().
 
-=over 4
+=over 2
 
 =item *
 
@@ -43,7 +43,7 @@ Normally, this is found as the function I<algorithm>_cbc_encrypt().
 Be aware that des_cbc_encrypt() is not really DES CBC (it does
 not update the IV); use des_ncbc_encrypt() instead.
 
-=over 4
+=over 2
 
 =item *
 
@@ -75,7 +75,7 @@ An error will affect the current and the following ciphertext blocks.
 
 Normally, this is found as the function I<algorithm>_cfb_encrypt().
 
-=over 4
+=over 2
 
 =item *
 
@@ -122,8 +122,7 @@ An error will affect the current and the following ciphertext variables.
 
 Normally, this is found as the function I<algorithm>_ofb_encrypt().
 
-=over 4
-
+=over 2
 
 =item *
 
@@ -183,7 +182,7 @@ susceptible to a 'known plaintext' attack.
 
 Normally, this is found as the function I<algorithm>_ecb3_encrypt().
 
-=over 4
+=over 2
 
 =item *
 
@@ -218,7 +217,7 @@ ecb mode.
 
 Normally, this is found as the function I<algorithm>_ede3_cbc_encrypt().
 
-=over 4
+=over 2
 
 =item *
 
index 9befeb9..6369880 100755 (executable)
@@ -163,7 +163,7 @@ sub check()
     print "$id Duplicate $1 in L<>\n"
         if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2;
     print "$id Bad =over $1\n"
-        if $contents =~ /=over([^ ][^4])/;
+        if $contents =~ /=over([^ ][^24])/;
 
     # Look for multiple consecutive openssl #include lines.
     # Consecutive because of files like md5.pod. Sometimes it's okay