diff options
author | Rich Salz <rsalz@akamai.com> | 2015-10-27 15:11:48 -0400 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2015-10-30 17:21:42 -0400 |
commit | b0700d2c8de79252ba605748a075cf2e5d670da1 (patch) | |
tree | 80d8b70286dfab4ef907cf1ac388f691821b0f2e /doc | |
parent | 87d9cafa332bd006086b56dc645c03fe7cfed654 (diff) |
Replace "SSLeay" in API with OpenSSL
All instances of SSLeay (any combination of case) were replaced with
the case-equivalent OpenSSL.
Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/apps/dhparam.pod | 2 | ||||
-rw-r--r-- | doc/apps/enc.pod | 5 | ||||
-rw-r--r-- | doc/apps/req.pod | 3 | ||||
-rw-r--r-- | doc/apps/verify.pod | 2 | ||||
-rw-r--r-- | doc/crypto/OPENSSL_VERSION_NUMBER.pod | 8 | ||||
-rw-r--r-- | doc/crypto/RAND_set_rand_method.pod | 8 | ||||
-rw-r--r-- | doc/crypto/SSLeay_version.pod | 70 | ||||
-rw-r--r-- | doc/ssl/SSL_library_init.pod | 6 |
8 files changed, 16 insertions, 88 deletions
diff --git a/doc/apps/dhparam.pod b/doc/apps/dhparam.pod index b0a9802009..59199358d4 100644 --- a/doc/apps/dhparam.pod +++ b/doc/apps/dhparam.pod @@ -117,7 +117,7 @@ for all available algorithms. =head1 WARNINGS The program B<dhparam> combines the functionality of the programs B<dh> and -B<gendh> in previous versions of OpenSSL and SSLeay. The B<dh> and B<gendh> +B<gendh> in previous versions of OpenSSL. The B<dh> and B<gendh> programs are retained for now but may have different purposes in future versions of OpenSSL. diff --git a/doc/apps/enc.pod b/doc/apps/enc.pod index 26e678ca1b..8f7e1cb7f8 100644 --- a/doc/apps/enc.pod +++ b/doc/apps/enc.pod @@ -62,8 +62,7 @@ use a salt in the key derivation routines. This is the default. =item B<-nosalt> don't use a salt in the key derivation routines. This option B<SHOULD NOT> be -used except for test purposes or compatibility with ancient versions of OpenSSL -and SSLeay. +used except for test purposes or compatibility with ancient versions of OpenSSL. =item B<-e> @@ -181,7 +180,7 @@ A password will be prompted for to derive the key and IV if necessary. The B<-salt> option should B<ALWAYS> be used if the key is being derived from a password unless you want compatibility with previous versions of -OpenSSL and SSLeay. +OpenSSL. Without the B<-salt> option it is possible to perform efficient dictionary attacks on the password and to attack stream cipher encrypted data. The reason diff --git a/doc/apps/req.pod b/doc/apps/req.pod index ec19192d19..880061e9db 100644 --- a/doc/apps/req.pod +++ b/doc/apps/req.pod @@ -621,8 +621,7 @@ for more information. The variable B<OPENSSL_CONF> if defined allows an alternative configuration file location to be specified, it will be overridden by the B<-config> command -line switch if it is present. For compatibility reasons the B<SSLEAY_CONF> -environment variable serves the same purpose but its use is discouraged. +line switch if it is present. =head1 BUGS diff --git a/doc/apps/verify.pod b/doc/apps/verify.pod index c9352692a8..74477e5c0f 100644 --- a/doc/apps/verify.pod +++ b/doc/apps/verify.pod @@ -307,7 +307,7 @@ the B<CERTIFICATE EXTENSIONS> section of the B<x509> utility. The third operation is to check the trust settings on the root CA. The root CA should be trusted for the supplied purpose. For compatibility with previous -versions of SSLeay and OpenSSL a certificate with no trust settings is considered +versions of OpenSSL, a certificate with no trust settings is considered to be valid for all purposes. The final operation is to check the validity of the certificate chain. The validity diff --git a/doc/crypto/OPENSSL_VERSION_NUMBER.pod b/doc/crypto/OPENSSL_VERSION_NUMBER.pod index c8fed0f255..fc16536ba9 100644 --- a/doc/crypto/OPENSSL_VERSION_NUMBER.pod +++ b/doc/crypto/OPENSSL_VERSION_NUMBER.pod @@ -2,7 +2,8 @@ =head1 NAME -OPENSSL_VERSION_NUMBER, OpenSSL_version - get OpenSSL version number +OPENSSL_VERSION_NUMBER, OpenSSL_version, +OpenSSL_version_num - get OpenSSL version number =head1 SYNOPSIS @@ -10,6 +11,8 @@ OPENSSL_VERSION_NUMBER, OpenSSL_version - get OpenSSL version number #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL #include <openssl/crypto.h> + + unsigned long OpenSSL_version_num(); const char *OpenSSL_version(int t); =head1 DESCRIPTION @@ -42,8 +45,7 @@ Version 0.9.5a had an interim interpretation that is like the current one, except the patch level got the highest bit set, to keep continuity. The number was therefore 0x0090581f. - -For backward compatibility, OPENSSL_VERSION_NUMBER is also defined. +OpenSSL_version_num() returns the version number. OpenSSL_version() returns different strings depending on B<t>: diff --git a/doc/crypto/RAND_set_rand_method.pod b/doc/crypto/RAND_set_rand_method.pod index fe7f44162d..533d577fa6 100644 --- a/doc/crypto/RAND_set_rand_method.pod +++ b/doc/crypto/RAND_set_rand_method.pod @@ -2,7 +2,7 @@ =head1 NAME -RAND_set_rand_method, RAND_get_rand_method, RAND_SSLeay - select RAND method +RAND_set_rand_method, RAND_get_rand_method, RAND_OpenSSL - select RAND method =head1 SYNOPSIS @@ -12,7 +12,7 @@ RAND_set_rand_method, RAND_get_rand_method, RAND_SSLeay - select RAND method const RAND_METHOD *RAND_get_rand_method(void); - RAND_METHOD *RAND_SSLeay(void); + RAND_METHOD *RAND_OpenSSL(void); =head1 DESCRIPTION @@ -23,7 +23,7 @@ information about how these RAND API functions are affected by the use of B<ENGINE> API calls. Initially, the default RAND_METHOD is the OpenSSL internal implementation, as -returned by RAND_SSLeay(). +returned by RAND_OpenSSL(). RAND_set_default_method() makes B<meth> the method for PRNG use. B<NB>: This is true only whilst no ENGINE has been set as a default for RAND, so this function @@ -53,7 +53,7 @@ Each component may be NULL if the function is not implemented. =head1 RETURN VALUES RAND_set_rand_method() returns no value. RAND_get_rand_method() and -RAND_SSLeay() return pointers to the respective methods. +RAND_OpenSSL() return pointers to the respective methods. =head1 NOTES diff --git a/doc/crypto/SSLeay_version.pod b/doc/crypto/SSLeay_version.pod deleted file mode 100644 index 4862cd4f33..0000000000 --- a/doc/crypto/SSLeay_version.pod +++ /dev/null @@ -1,70 +0,0 @@ -=pod - -=head1 NAME - -SSLeay_version - retrieve version/build information about OpenSSL library - -=head1 SYNOPSIS - - #include <openssl/crypto.h> - - const char *SSLeay_version(int type); - -=head1 DESCRIPTION - -SSLeay_version() returns a pointer to a constant string describing the -version of the OpenSSL library or giving information about the library -build. - -The following B<type> values are supported: - -=over 4 - -=item SSLEAY_VERSION - -The version of the OpenSSL library including the release date. - -=item SSLEAY_CFLAGS - -The compiler flags set for the compilation process in the form -"compiler: ..." if available or "compiler: information not available" -otherwise. - -=item SSLEAY_BUILT_ON - -The date of the build process in the form "built on: ..." if available -or "built on: date not available" otherwise. - -=item SSLEAY_PLATFORM - -The "Configure" target of the library build in the form "platform: ..." -if available or "platform: information not available" otherwise. - -=item SSLEAY_DIR - -The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "..."" -if available or "OPENSSLDIR: N/A" otherwise. - -=back - -=head1 RETURN VALUES - -The following return values can occur: - -=over 4 - -=item "not available" - -An invalid value for B<type> was given. - -=item Pointer to constant string - -Textual description. - -=back - -=head1 SEE ALSO - -L<crypto(3)> - -=cut diff --git a/doc/ssl/SSL_library_init.pod b/doc/ssl/SSL_library_init.pod index ab9d05d3db..d96d3f0613 100644 --- a/doc/ssl/SSL_library_init.pod +++ b/doc/ssl/SSL_library_init.pod @@ -2,7 +2,7 @@ =head1 NAME -SSL_library_init, OpenSSL_add_ssl_algorithms, SSLeay_add_ssl_algorithms +SSL_library_init, OpenSSL_add_ssl_algorithms, - initialize SSL library by registering algorithms =head1 SYNOPSIS @@ -11,14 +11,12 @@ SSL_library_init, OpenSSL_add_ssl_algorithms, SSLeay_add_ssl_algorithms int SSL_library_init(void); #define OpenSSL_add_ssl_algorithms() SSL_library_init() - #define SSLeay_add_ssl_algorithms() SSL_library_init() =head1 DESCRIPTION SSL_library_init() registers the available SSL/TLS ciphers and digests. -OpenSSL_add_ssl_algorithms() and SSLeay_add_ssl_algorithms() are synonyms -for SSL_library_init(). +OpenSSL_add_ssl_algorithms() is a synonym for SSL_library_init(). =head1 NOTES |