summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man (follow)
Commit message (Collapse)AuthorAgeFilesLines
...
* Correct the RETURN VALUES of OBJ_add_object(3).schwarze2023-09-061-6/+33
| | | | | | | | The text was misleading before and after the improvement in obj_dat.c rev. 1.61. The way i'm fixing the documentation here takes that improvement into account. Also add a CAVEATS section about adding incomplete objects.
* add a BUGS section warning about the creation of incomplete objectsschwarze2023-09-051-3/+22
|
* document EVP_CIPHER_name(3)schwarze2023-09-051-2/+32
|
* add the missing .Dv macros to the list of flagsschwarze2023-09-051-13/+13
|
* improve the descriptions of almost all flags,schwarze2023-09-051-40/+101
| | | | in particular saying which API functions each flag affects
* Partial rewrite:schwarze2023-09-051-140/+231
| | | | | | | | | | | | | | | | | * Integrate the leftovers of the former NOTES section into the main text, resulting in a more logical order of information. * Make many descriptions more precise and tweak many wordings. For example, the description of OBJ_cmp(3) was totally misleading. Add a CAVEATS section explaining the scary ownership contracts of the functions returning ASN1_OBJECT pointers. Move the discussion of NID_undef to the BUGS section because the statement "objects which are not in the table have the NID value NID_undef" was misleading in more than one way. Considering that an API as fundamental as this one contains such a gigantic amount of quirks and traps and gaps makes me shudder.
* Many improvements, almost amounting to a partial rewrite:schwarze2023-09-011-48/+109
| | | | | | | | | | | | | * more precision what the CIPHER_CTX functions do * more precision what an NID is * avoid talking about RC2, use AES-256 for an example instead * clarify that block sizes are measured in bytes * mention additional restrictions regarding valid block sizes * add the missing description of the *_flags(3) functions * mention the public mask constant EVP_CIPH_MODE * add three missing modes that can occur as return values * add the missing entries for *_flags(3) and *_mode(3) below RETURN VALUES * tweak various wordings for precision and conciseness
* fix an obvious typo in the OBJ_NAME_add(3) prototypeschwarze2023-09-011-3/+3
|
* Split three new manual pages EVP_CIPHER_nid(3), EVP_CIPHER_CTX_ctrl(3),schwarze2023-08-316-451/+727
| | | | | | | | | | | and EVP_CIPHER_CTX_set_flags(3) out of the excessively large and unwieldy EVP_EncryptInit(3). This causes a number of inaccuracies and gaps to stand out, but i'm not mixing text changes or content additions into this split. Using very useful feedback from tb@ regarding what belongs together and how important the various functions are. I refrained from bothering him with the complete patch, but he likes the general direction.
* Document EVP_{CIPHER,MD}_do_all{,_sorted}(3)tb2023-08-303-3/+139
| | | | | | | | | | The function prototypes in the SYNOPSIS don't look great, but schwarze assures me that this is how it is supposed to be. It is rather strange that OpenSSL chose to sprinkle OPENSSL_init_crypto() calls into these four functions rather than two inside OBJ_NAME_do_all{,_sorted}(3). Surely there was a good reason for that. With input and fixes from schwarze
* Replace last ecdh.h and ecdsa.h occurrences with ec.htb2023-08-294-16/+12
| | | | | | Except if backward compatibility with older LibreSSL and OpenSSL versions is explicitly needed, ecdsa.h and ecdh.h should no longer be used. They are now trivial wrappers of ec.h.
* Move the weak SHA-1 and MD5 hashes out of EVP_DigestInit(3)schwarze2023-08-274-46/+138
| | | | | into a new EVP_sha1(3) manual page, and also mention EVP_md4(3) there. Using input from tb@ and jsing@, who like the general direction.
* document the return value of EVP_PKEY_asn1_find(3) andschwarze2023-08-271-4/+20
| | | | the "len" argument and the return value of EVP_PKEY_asn1_find_str(3)
* EVP_PKEY_set_type_str(3) is now documented, so switch from .Fn to .Xrschwarze2023-08-271-3/+3
|
* document EVP_PKEY_set_type_str(3)schwarze2023-08-271-7/+46
|
* add the missing information that and how flags can be combined,schwarze2023-08-261-3/+7
| | | | and add the missing link to evp(3)
* Write documentation for EVP_CIPHER_CTX_buf_noconst(3) from scratch.schwarze2023-08-261-5/+42
| | | | | | | Put it here rather than into EVP_EncryptInit(3) because similar to EVP_CIPHER_CTX_get_cipher_data(3), application software should not use it. These functions will likely not be needed except by people implementing custom encryption algorithms.
* write documentation for EVP_CIPHER_CTX_copy(3)schwarze2023-08-261-4/+86
| | | | and EVP_CIPHER_CTX_encrypting(3) from scratch
* transfering -> transferringjsg2023-08-261-3/+3
|
* make the one-line description read betterschwarze2023-08-251-3/+13
| | | | | and be more specific below RETURN VALUES; OK tb@
* In evp.h rev.s 1.90 and 1.97, tb@ provided EVP_CIPHER_CTX_get_cipher_data(3)schwarze2023-08-253-3/+114
| | | | | | and EVP_CIPHER_CTX_set_cipher_data(3). Import the manual page from the OpenSSL 1.1 branch, which is still under a free licence, with several improvements by me.
* fix eight more instances of copy & paste glitchesschwarze2023-08-251-9/+9
|
* Mention another bug for EVP_add_{cipher,digest}(3)tb2023-08-251-1/+4
|
* Improve EVP_add_cipher.3 a bittb2023-08-251-9/+26
| | | | | Fix some copy-paste errors in the prototypes, tweak the explanatory text and add some more details.
* Add more cross referencestb2023-08-252-4/+7
|
* Document EVP_add_{cipher,digest} and friendstb2023-08-253-3/+163
| | | | | These and EVP_{add,remove}_{cipher,digest}_alias() are mostly for internal use.
* Update references from RFC 7539 to RFC 8439tb2023-08-242-7/+7
| | | | | | | | RFC 7539 was superseded by RFC 8439, incorporating errata and making editorial improvements. Very little of substance changed, in particular section numbers remain the same. Prompted by a question from schwarze
* Align the documentation of EVP_chacha20() with actual behaviortb2023-08-241-6/+6
| | | | | | | | Incorrect OpenSSL documentation was moved here and inherited parts of a comment that was fixed in evp/e_chacha.c r1.13. Adjust the manual page accordingly. Discussed with schwarze
* Mention key and nonce lengths of AEAD ciphers.schwarze2023-08-232-33/+105
| | | | | | | | | Mention portability considerations regarding the EVP_AEAD API. Avoid confusing words like "older" and "native" API, be specific. Mention RFC 7905. Move publications we don't implement from STANDARDS to CAVEATS. Based on input from jsing@ and tb@, OK tb@.
* spellingjsg2023-08-211-4/+4
|
* add the missing entry for EVP_CIPHER_CTX_ctrl(3) to the RETURN VALUES sectionschwarze2023-08-161-2/+11
|
* Describe more precisely how these functions are supposed to be used,schwarze2023-08-161-19/+185
| | | | | | | | document the control operations supported by EVP_chacha20_poly1305(3), and add the missing STANDARDS and HISTORY sections. This replaces all text written by Matt Caswell and all text Copyrighted by OpenSSL in the year 2019.
* SHA-3 is not a symmetric cipher.schwarze2023-08-151-3/+3
| | | | | | | | | Fix a copy and paste mistake that Ronald Tse introduced in 2017 even though Richard Levitte and Bernd Edlinger reviewed his commit - and that i unwittingly copied. Even in the OpenSSL 3 main trunk, it wasn't fixed until 2022, and in OpenSSL-1.1.1, it is still wrong. Unfortunately, we need to be really careful before believing anything the OpenSSL documentation says...
* Import the EVP_chacha20(3) manual page from the OpenSSL 1.1 branch,schwarze2023-08-154-14/+102
| | | | | | which is still under a free license, to work on it in the tree. The required content changes have not been done yet, i only tweaked the markup and wording so far.
* Below SEE ALSO, point to all pages documenting the evp.h sub-library, andschwarze2023-08-141-11/+56
| | | | | | | | also point to a selection of functions from other sub-libraries that rely on evp.h objects, in particular on EVP_CIPHER, EVP_MD, and EVP_PKEY. While here, merge a few trivial improvements to orthography and punctuation from the OpenSSL 1.1 branch.
* import EVP_sha3_224(3) from the OpenSSL 1.1 branch, which is still underschwarze2023-08-143-3/+97
| | | | a free license, tweaked by me
* document return values of the control function in EVP_MD_meth_set_ctrl(3)schwarze2023-08-121-5/+15
|
* 1. Tweak the descriptions of EVP_MD_CTX_ctrl(3), EVP_MD_CTX_set_flags(3),schwarze2023-08-121-52/+107
| | | | | | | | EVP_MD_CTX_clear_flags(3), EVP_MD_CTX_test_flags(3), and the atrocious EVP_MD_CTX_set_pkey_ctx(3) for precision. 2. Tweak the description of EVP_MD_type(3) and EVP_MD_CTX_type(3) for conciseness. 3. Add a few missing HISTORY bits.
* Remove a blatant lie about DSA_dup_DHtb2023-08-121-6/+2
| | | | | q is copied across since OpenSSL 31360957 which hit our tree with OpenSSL 1.0.1c in October 2012.
* Merge various improvements from the OpenSSL 1.1 branch,schwarze2023-08-111-13/+148
| | | | | | | | | | | | | | which is still under a free license. * document EVP_MD_CTX_set_flags, EVP_MD_CTX_clear_flags, EVP_MD_CTX_test_flags * document EVP_MD_flags, EVP_MD_CTX_md_data * document EVP_MD_CTX_pkey_ctx, EVP_MD_CTX_set_pkey_ctx * correct arg type of EVP_MD_CTX_size, EVP_MD_CTX_block_size, EVP_MD_CTX_type * more information about EVP_MD_CTX_ctrl * add missing <string.h> and correct one variable type below EXAMPLES * two orthographic improvements with a few wording tweaks by me
* Add the missing ".Nm X509_STORE_CTX_check_issued_fn" to the NAME sectionschwarze2023-08-101-2/+4
| | | | | | | such that `man X509_STORE_CTX_check_issued_fn` works. While here, add a Copyright notice for Job Snijders because he added a significant amount of text to this file in March 2023. OK job@
* In x509_vfy.h rev. 1.60 and rev. 1.62 (April 2023), tb@ providedschwarze2023-08-101-26/+51
| | | | | X509_STORE_CTX_get1_certs(3) and X509_STORE_CTX_get1_crls(3). Document them and mark their aliases as deprecated.
* Add the forgotten .In lineschwarze2023-08-091-3/+4
| | | | and fix a typo: s/content objects/content octets/.
* In objects.h rev. 1.14 and 1.15 (Jan 2022), tb@ providedschwarze2023-08-091-5/+65
| | | | | OBJ_get0_data(3) and OBJ_length(3). Document them. Feedback and OK tb@.
* remove trailing comma in NAME;jmc2023-08-051-3/+3
|
* Remove BF_options() documentationtb2023-07-291-9/+3
|
* The CRYPTO_EX_DATA type is not opaquetb2023-07-281-5/+2
| | | | | | | | | By API misdesign, it cannot be opaque. The incorrect documentation was added as a part of a huge commit with a lot of churn. CRYPTO_EX_DATA typically lives as an embedded struct of an opaque struct, but it can also be used by applications, for example to initialize libssl. documentation error pointed out by jsing
* Remove ASN1_BIT_STRING_set docotb2023-07-281-42/+2
|
* Remove stale .Xr missed in previoustb2023-07-281-3/+2
|
* Remove ASN1_BIT_STRING_num_asc.3tb2023-07-283-151/+3
|
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-08-22 21:21:14 +0000