aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* RT4562: Fix misleading doc on OPENSSL_configRich Salz2016-06-142-11/+12
| | | | | | Also changed the code to use "appname" not "filename" Reviewed-by: Matt Caswell <matt@openssl.org>
* Reorder the setter arguments to more consistently match that of other APIs,TJ Saunders2016-06-132-2/+2
| | | | | | | | per review comments. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Emilia Käsper <emilia@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1193)
* Implement DSA_SIG_set0() and ECDSA_SIG_set0(), for setting signature values.TJ Saunders2016-06-132-0/+18
| | | | | | | | | | | | | | | SSH2 implementations which use DSA_do_verify() and ECDSA_do_verify() are given the R and S values, and the data to be signed, by the client. Thus in order to validate these signatures, SSH2 implementations will digest and sign the data -- and then pass in properly provisioned DSA_SIG and ECDSA_SIG objects. Unfortunately, the existing OpenSSL-1.1.0 APIs do not allow for directly setting those R and S values in these objects, which makes using OpenSSL for such SSH2 implementations much more difficult. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Emilia Käsper <emilia@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1193)
* Update the SSL_set_session() documentationMatt Caswell2016-06-131-1/+5
| | | | | | | Update the SSL_set_session() documentation to reflect the fact that old bad sessions are removed from the cache if necessary. Reviewed-by: Rich Salz <rsalz@openssl.org>
* RT3809: basicConstraints is criticalRich Salz2016-06-131-1/+1
| | | | | | | This is really a security bugfix, not enhancement any more. Everyone knows critical extensions. Reviewed-by: Dr. Stephen Henson <steve@openssl.org>
* doc/crypto/OPENSSL_ia32cap.pod update.Andy Polyakov2016-06-131-15/+46
| | | | Reviewed-by: Rich Salz <rsalz@openssl.org>
* Ensure that the EVP_MD_meth_new docs properly match the declared functions;TJ Saunders2016-06-111-2/+2
| | | | | | | it looks like these names have shifted a little over time. Reviewed-by: Kurt Roeckx <kurt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1203)
* Expand SSL_CTX_set_default_verify_paths() documentationMatt Caswell2016-06-101-2/+6
| | | | | | | | | Add some information about the location of the default directory and the default file. RT#1051 Reviewed-by: Andy Polyakov <appro@openssl.org>
* More API docs; small changes.Rich Salz2016-06-0910-20/+14
| | | | | | | Also fix typo noted on GitHub. Suppport typedef and #define to find-doc-nits Reviewed-by: Richard Levitte <levitte@openssl.org>
* Clean up "generic" intro pod files.Rich Salz2016-06-0942-1211/+89
| | | | | | | | | | | | Files like dh.pod, etc., mostly duplicated the API-specific pod files. Removed the duplicated content; that often mean the whole file could be removed. Some of the content about internals got moved into README files in the source tree. Some content (e.g., err.pod) got moved into other pod pages. Annotate generic pages, remove dup NAME Reviewed-by: Richard Levitte <levitte@openssl.org>
* Write X509_dup, PEM_read, etc.Rich Salz2016-06-094-11/+435
| | | | | | | Partially document the ASN1 template stuff, and its use for i2d/d2i and PEM I/O. Reviewed-by: Richard Levitte <levitte@openssl.org>
* Docs: install generic manpages to man section 7Richard Levitte2016-06-093-0/+6
| | | | Reviewed-by: Rich Salz <rsalz@openssl.org>
* Add some accessor API'sRich Salz2016-06-083-4/+27
| | | | | | | | | GH1098: Add X509_get_pathlen() (and a test) GH1097: Add SSL_is_dtls() function. Documented. Reviewed-by: Matt Caswell <matt@openssl.org>
* Fix some typos in pod filesFdaSilvaYY2016-06-0811-20/+20
| | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1189)
* Unify d2i/i2d documentation.Rich Salz2016-06-0717-666/+656
| | | | | | | | | | Make d2i_X509 a generic d2i/i2d manpage. Pull common stuff out of other d2i/i2d docs. Update find-doc-nits to know about "generic" manpages. Cleanup some overlap. Fix up a bunch of other references. Reviewed-by: Matt Caswell <matt@openssl.org>
* Nit about pod filenamesRich Salz2016-06-071-0/+0
| | | | | | | | The asdf.pod filename must have asdf in its NAME section. also check for names existing as a different filename (via Levitte) Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
* Add documentation for the newly added SSL_get_tlsext_status_type()Matt Caswell2016-06-071-6/+30
| | | | | | And also for SSL_CTX_get_tlsext_status_type() Reviewed-by: Rich Salz <rsalz@openssl.org>
* Document the issue with threads and dlopen()Matt Caswell2016-06-071-3/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If using threads and OpenSSL is loaded via dlopen(), and subsequently closed again via dlclose() *before* the threads are destroyed, then OpenSSL will not free up the per thread resources. We need to document this restriction, and provide some guidance on what to do about it. I did some testing and discovered/verified a few of things (at least this is the behaviour on Linux): - Using OpenSSL via dlopen in a mutli-threaded app does leak memory if threads are destroyed after dlcose() is called. - In a single threaded environment, or if threads are destroyed prior to dlclose() being called, then no memory is leaked - Using the RTLD_NODELETE flag to dlopen solves the above problem - Interestingly the OpenSSL atexit() handler gets called when dlclose() is called rather than at application exit (I was worred that it might crash if there was an atexit() handler for a function that has been unloaded) - RTLD_NODELETE is a non-standard flag - but it does seem to be fairly widely supported. As far as I could determine (via google), at least Linux, Solaris, OpenBSD, FreeBSD, HP-UX all seem to support it. I also tested on Windows (using LoadLibrary instead of dlopen and FreeLibrary instead of dlclose) and experienced similar behaviour, except that (AFAIK) there is no equivalent of RTLD_NODELETE on Windows. GitHub Issue #653 Reviewed-by: Richard Levitte <levitte@openssl.org>
* More doc nitsRich Salz2016-06-0663-64/+64
| | | | | | | Update script to look for period or POD markup in NAME section, and fix them. Reviewed-by: Andy Polyakov <appro@openssl.org>
* Remove extra include's in synopsis.Rich Salz2016-06-0521-33/+24
| | | | Reviewed-by: Richard Levitte <levitte@openssl.org>
* Constify ASN1_generate_nconfFdaSilvaYY2016-06-041-1/+1
| | | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Kurt Roeckx <kurt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1074)
* Constify ASN1_generate_v3FdaSilvaYY2016-06-041-1/+1
| | | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Kurt Roeckx <kurt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1074)
* Fix documentation error in x509 app certopt flagMatt Caswell2016-06-031-2/+2
| | | | | | | | | | | | | | | | | According to the x509 man page in the section discussing -certopt it says that the ca_default option is the same as that used by the ca utility and (amongst other things) has the effect of suppressing printing of the signature - but in fact it doesn't. This error seems to have been present since the documentation was written back in 2001. It never had this effect. The default config file sets the certopt value to ca_default. The ca utility takes that and THEN adds additional options to suppress printing of the signature. So the ca utility DOES suppress printing of the signature - but it is not as a result of using the ca_default option. GitHub Issue #247 Reviewed-by: Rich Salz <rsalz@openssl.org>
* Fix nits in crypto.pod,ssl.podRich Salz2016-06-012-4/+16
| | | | | | | After this merge, the only things left (from doc-nit-check) is 74 pages without a "RETURN VALUES" section. Reviewed-by: Richard Levitte <levitte@openssl.org>
* Fix various doc nits.Rich Salz2016-06-016-67/+93
| | | | Reviewed-by: Richard Levitte <levitte@openssl.org>
* RT4337: Crash in DESRich Salz2016-06-011-6/+11
| | | | | | | Salt must be two ASCII characters. Add tests to check for that, and a test to test the checks. Reviewed-by: Matt Caswell <matt@openssl.org>
* Add dhparam sanity check and update DH_check documentationMatt Caswell2016-06-012-12/+37
| | | | | | | | | | | | | The -check argument to dhparam should never identify any problems if we have just generated the parameters. Add a sanity check for this and print an error and fail if necessary. Also updates the documentation for the -check argument, and the DH_check() function. RT#4244 Reviewed-by: Richard Levitte <levitte@openssl.org>
* Remove null check, per review feedback. Note this in the docs.TJ Saunders2016-05-311-1/+2
| | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1135)
* Add requested HISTORY section, remove copy/pastos, per review feedback.TJ Saunders2016-05-311-18/+7
| | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1135)
* Add an SSL_SESSION accessor for obtaining the protocol version number, withTJ Saunders2016-05-311-0/+54
| | | | | | | accompanying documentation. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1135)
* RT4539: Add section for renamed ciphers.Rich Salz2016-05-311-0/+7
| | | | Reviewed-by: Richard Levitte <levitte@openssl.org>
* Parameter copy sanity checks.Dr. Stephen Henson2016-05-311-1/+3
| | | | | | | | | | | | Don't copy parameters is they're already present in the destination. Return error if an attempt is made to copy different parameters to destination. Update documentation. If key type is not initialised return missing parameters RT#4149 Reviewed-by: Richard Levitte <levitte@openssl.org>
* fix deprecation version number in docsJoey Yandle2016-05-291-1/+1
| | | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1079)
* update docs with descriptions and deprecationJoey Yandle2016-05-291-0/+9
| | | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1079)
* fix return value in docsJoey Yandle2016-05-291-1/+1
| | | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1079)
* add removed functions back as deprecatedJoey Yandle2016-05-292-1/+16
| | | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1079)
* cherry pick pr-512 changesJoey Yandle2016-05-292-14/+2
| | | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1079)
* cherry pick pr-512 changesJoey Yandle2016-05-292-10/+1
| | | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1079)
* Update the documentation of BN_hex2bn()huangqinjin2016-05-271-7/+9
| | | | | Reviewed-by: Kurt Roeckx <kurt@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org>
* Add error return for OPENSSL_INIT_set_config_filename()Matt Caswell2016-05-231-5/+7
| | | | | | | | | The OPENSSL_INIT_set_config_filename() function can fail so ensure that it provides a suitable error code. GitHub Issue #920 Reviewed-by: Rich Salz <rsalz@openssl.org>
* Support for traditional format private keys.Dr. Stephen Henson2016-05-233-40/+82
| | | | | | | | Add new function PEM_write_bio_PrivateKey_traditional() to enforce the use of legacy "traditional" private key format. Add -traditional option to pkcs8 and pkey utilities. Reviewed-by: Matt Caswell <matt@openssl.org>
* Add a missing comma in OPENSSL_malloc.podRichard Levitte2016-05-231-1/+1
| | | | Reviewed-by: Rich Salz <rsalz@openssl.org>
* Add the missing NAME header in the OCSP docsRichard Levitte2016-05-235-0/+10
| | | | Reviewed-by: Rich Salz <rsalz@openssl.org>
* Doc nits cleanup, round 2Rich Salz2016-05-20429-1205/+190
| | | | | | | | | | | Fix some code examples, trailing whitespace Fix TBA sections in verify, remove others. Remove empty sections Use Mixed Case not ALL CAPS in head2 Enhance doc-nits script. Remove extra =cut line Reviewed-by: Richard Levitte <levitte@openssl.org>
* Rename lh_xxx,sk_xxx tp OPENSSL_{LH,SK}_xxxRich Salz2016-05-204-266/+268
| | | | | | | | | | | | Rename sk_xxx to OPENSSL_sk_xxx and _STACK to OPENSSL_STACK Rename lh_xxx API to OPENSSL_LH_xxx and LHASH_NODE to OPENSSL_LH_NODE Make lhash stuff opaque. Use typedefs for function pointers; makes the code simpler. Remove CHECKED_xxx macros. Add documentation; remove old X509-oriented doc. Add API-compat names for entire old API Reviewed-by: Dr. Stephen Henson <steve@openssl.org>
* Fix nits in pod files.Rich Salz2016-05-20208-1295/+1221
| | | | | | | | | Add doc-nit-check to help find future issues. Make podchecker be almost clean. Remove trailing whitespace. Tab expansion Reviewed-by: Richard Levitte <levitte@openssl.org>
* Use correct EOL in headers.Dr. Stephen Henson2016-05-192-0/+13
| | | | | | RT#1817 Reviewed-by: Rich Salz <rsalz@openssl.org>
* Add copyrightRich Salz2016-05-191-0/+11
| | | | Reviewed-by: Richard Levitte <levitte@openssl.org>
* Add copyright to manpagesRich Salz2016-05-19430-18/+4736
| | | | Reviewed-by: Richard Levitte <levitte@openssl.org>
* Remove needless license terms (for docs)Rich Salz2016-05-193-69/+0
| | | | Reviewed-by: Richard Levitte <levitte@openssl.org>
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-16 18:51:53 +0000