From: Viktor Dukhovni Date: Wed, 27 Jan 2016 05:55:19 +0000 (-0500) Subject: Doc fixes suggested by Claus Assmann X-Git-Tag: OpenSSL_1_1_0-pre3~405 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8f243018d2e5e4dfe988906849a7f30532e288aa;p=openssl Doc fixes suggested by Claus Assmann RT4264, RT4268 Reviewed-by: Tim Hudson --- diff --git a/doc/crypto/X509_LOOKUP_hash_dir.pod b/doc/crypto/X509_LOOKUP_hash_dir.pod index 680a9fd043..e863ab5a87 100644 --- a/doc/crypto/X509_LOOKUP_hash_dir.pod +++ b/doc/crypto/X509_LOOKUP_hash_dir.pod @@ -24,7 +24,7 @@ lookup methods B and B are two certificate lookup methods to use with B, provided by OpenSSL library. -Users of the library typically do not need to create instanses of these +Users of the library typically do not need to create instances of these methods manually, they would be created automatically by L or L @@ -61,47 +61,55 @@ caching policy. =head2 FILE METHOD -B method loads entire set of certificates and CRLs -into memory immediately when file name is passed to it. +The B method loads all the certificates or CRLs +present in a file into memory at the time the file is added as a +lookup source. File format is ASCII text which contains concatenated PEM certificates and CRLs. -This method should be used by applications which work with limited set -of CAs. - +This method should be used by applications which work with a small +set of CAs. =head2 HASHED DIR METHOD -B is more sophisticated method, which loads -certificates and CRLs on demand, but caches them in the memory once they -are loaded. However, since OpenSSL 1.0.0beta1 it checks for newer CRLs -upon each lookup, so if newer CRL would appear in the directory, it -would be loaded. - -Directory should contain each certificate and CRL in the separate file -in the PEM format, with file name derived from certificate subject (or CRL -issuer) hash, as returned by L -function of with option B<-hash> of L or -L command. - -This hash value is appended by suffix .I for certificates and -B<.r>I for CRLs where I is sequentual -number among certificates with same hash value, so it is possible to -have in the store several certificates with same subject or several CRLs -with same issuer (and, for example, different validity period). - -When checking for new CRLs once one CRL for given hash value is loaded, -hash_dir lookup method checks only for certificates with sequentual -number greater than one of already cached CRL. - -Note that hash algorithm used for subject hashing is changed in OpenSSL -1.0, so all certificate stores have to be rehashed upon transitopn from +B is a more advanced method, which loads +certificates and CRLs on demand, and caches them in memory once +they are loaded. As of OpenSSL 1.0.0, it also checks for newer CRLs +upon each lookup, so that newer CRLs are as soon as they appear in +the directory. + +The directory should contain one certificate or CRL per file in PEM format, +with a file name of the form I.I for a certificate, or +I.BI for a CRL. +The I is the value returned by the L function applied +to the subject name for certificates or issuer name for CRLs. +The hash can also be obtained via the B<-hash> option of the L or +L commands. + +The .I or .BI suffix is a sequence number that starts at zero, and is +incremented consecutively for each certificate or CRL with the same I +value. +Gaps in the sequence numbers are not supported, it is assumed that there are no +more objects with the same hash beyond the first missing number in the +sequence. + +Sequence numbers make it possible for the directory to contain multiple +certificates with same subject name hash value. +For example, it is possible to have in the store several certificates with same +subject or several CRLs with same issuer (and, for example, different validity +period). + +When checking for new CRLs once one CRL for given hash value is +loaded, hash_dir lookup method checks only for certificates with +sequence number greater than that of the already cached CRL. + +Note that the hash algorithm used for subject name hashing changed in OpenSSL +1.0.0, and all certificate stores have to be rehashed when moving from OpenSSL 0.9.8 to 1.0.0. -OpenSSL includes utility L which creates -symlinks with correct hashed names for all files with .pem suffix in the -given directory. +OpenSSL includes a L utility which creates symlinks with correct +hashed names for all files with .pem suffix in a given directory. =head1 SEE ALSO diff --git a/doc/ssl/SSL_get_session.pod b/doc/ssl/SSL_get_session.pod index d360e8a3bb..d8aa705ae6 100644 --- a/doc/ssl/SSL_get_session.pod +++ b/doc/ssl/SSL_get_session.pod @@ -58,7 +58,7 @@ The following return values can occur: There is no session available in B. -=item Pointer to an SSL +=item Pointer to an SSL_SESSION The return value points to the data of an SSL session.