summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man (follow)
Commit message (Collapse)AuthorAgeFilesLines
* As suggested by tb@, merge the description of OPENSSL_EC_NAMED_CURVEschwarze2021-09-141-9/+15
| | | | | | | | | | | | | | and OPENSSL_EC_EXPLICIT_CURVE from OpenSSL commit 146ca72c Feb 19 14:35:43 2015 +0000 after tb@ changed the default from 0 to OPENSSL_EC_NAMED_CURVE in ec/ec_lib.c rev. 1.41, which is the same default that OpenSSL uses since 1.1.0. While merging, drop the description of the pre-1.1.0 behaviour. It seems irrelevant to me because tb@ found no application in Debian codesearch using OPENSSL_EC_EXPLICIT_CURVE. A former devious default that was probably never relied upon by anyone does not need to be documented.
* Merge documentation of EC_GROUP_order_bits(3) from the OpenSSL 1.1.1schwarze2021-09-111-26/+70
| | | | | | | | | branch, which is still under a free license. While here, also merge a few other improvements, mostly regarding EC_GROUP_get_order(3) and EC_GROUP_get_cofactor(3); in particular, some statements below RETURN VALUES were outright wrong. This patch includes a few minor tweaks and an addition to HISTORY by me. Feedback and OK tb@.
* Merge documentation for BN_bn2binpad(3), BN_bn2lebinpad(3),schwarze2021-09-111-13/+77
| | | | | | | and BN_lebin2bn(3) from the OpenSSL 1.1.1 branch, which is still under a free license. While here, tweak a number of details for clarity. OK tb@
* Calling OpenSSL_add_all_digests() is no longer needed since the librarymillert2021-09-101-7/+2
| | | | automatically initializes itself. OK tb@
* Use BN_RAND_* instead of mysterious values in the documentation oftb2021-09-101-7/+19
| | | | | | | | BN_rand_range() From OpenSSL 1.1.1l ok beck jsing
* link X509_STORE_get_by_subject(3) and X509_ocspid_print(3) to the build,schwarze2021-08-061-1/+3
| | | | forgotten in earlier commits
* new manual page X509_ocspid_print(3)schwarze2021-08-063-6/+66
| | | | using input from tb@, and OK tb@ on an earlier version
* add a roff(7) comment marking the API function X509_get_default_private_dir()schwarze2021-08-061-2/+5
| | | | | as intentionally undocumented because it is trivial and unused in the wild; OK tb@
* Document X509_get_default_cert_dir_env(3)schwarze2021-08-031-8/+35
| | | | | | | | | and X509_get_default_cert_file_env(3). LibreSSL itself does not call getenv(3), but a few application programs including epic5, fetchmail, fossil, slic3r call these functions, so in case programmers find them in existing code, telling them what they do seems useful.
* Document X509_get_default_cert_area(3).schwarze2021-08-031-7/+41
| | | | | | | Put it into this page because this is the code actually using it. Despite its name and include file, it is unrelated to X.509 and unrelated to certificates: it is just the default directory containing the library configuration file, openssl.cnf(5).
* tweaks regarding X509_LOOKUP_by_subject(3):schwarze2021-08-021-8/+28
| | | | | | * document the X509_OBJECT output parameter * more precision regarding return values * clarify relationship with X509_LOOKUP_ctrl(3) for the dir lookup method
* new manual page X509_STORE_get_by_subject(3)schwarze2021-08-025-12/+212
|
* document X509_STORE_load_mem(3) and X509_STORE_add_lookup(3)schwarze2021-08-011-7/+67
|
* document X509_LOOKUP_mem(3) in X509_LOOKUP_hash_dir(3)schwarze2021-07-318-32/+636
| | | | and add a new manual page X509_LOOKUP_new(3)
* Move the explanations related to *ptree closer together and correctschwarze2021-07-301-16/+19
| | | | | | | | | the lie that *ptree is set upon success - in some cases of success, it is set to NULL, whereas in some cases of failure, a non-trivial tree may be returned. beck@ pointed out that statements related to *ptree were scattered all over the place, and this patch works for him.
* Fix a documentation bug i introduced that tb@ pointed out:schwarze2021-07-291-12/+3
| | | | | X509_policy_check(3) never returns 2. If validation succeeds, it always returns 1.
* Document X509_STORE_set_verify_func(3), mostly using text from theschwarze2021-07-291-8/+32
| | | | | | | OpenSSL 1.1.1 branch, which is still under a free license, tweaked by me. While here, garbage collect the weird BUGS section.
* document X509_STORE_CTX_get0_parent_ctx(3)schwarze2021-07-291-4/+34
|
* document X509_STORE_CTX_set_app_data(3) and X509_STORE_CTX_get_app_data(3)schwarze2021-07-291-4/+51
|
* document X509_STORE_CTX_get0_policy_tree(3)schwarze2021-07-281-4/+41
| | | | and X509_STORE_CTX_get_explicit_policy(3)
* document X509_policy_tree_free(3)schwarze2021-07-281-3/+19
|
* consisely explain the meaning of return values rather than merelyschwarze2021-07-281-3/+20
| | | | refering to child object names defined in the standard
* Explain the meaning of the policy_oids input argument, correct theschwarze2021-07-281-14/+12
| | | | | | description of the *pexplicit_policy output argument and make it less technical, and drop the mention of the expected_policy_set because the library provides no accessor function for it.
* explicitely -> explicitly;jmc2021-07-281-4/+4
|
* new manual page X509_policy_check(3)schwarze2021-07-276-10/+198
|
* new manual page X509_policy_tree_level_count(3)schwarze2021-07-264-6/+168
| | | | documenting the X509_POLICY_TREE object and its sub-objects
* Document X509_STORE_CTX_set_trust(3), X509_STORE_CTX_set_purpose(3),schwarze2021-07-251-4/+226
| | | | | and X509_STORE_CTX_purpose_inherit(3). These functions look deceptively simple on first sight, but their semantics is surprisingly complicated.
* Two new manual pages X509_TRUST_set(3) and X509_check_trust(3)schwarze2021-07-248-12/+516
| | | | | documenting ten functions related to X509_TRUST objects, trust identifiers, and trust indices.
* Add a roff(7) comment that X509_issuer_and_serial_hash() isschwarze2021-07-231-2/+4
| | | | | | intentionally undocumented because it uses MD5 only and is unused in real-world code according to codesearch.debian.net. No objection from tb@.
* clarify the meaning of the argument of X509_VERIFY_PARAM_set_purpose(3)schwarze2021-07-231-10/+16
|
* mention the possibility that user-defined purpose identifiers may haveschwarze2021-07-231-2/+13
| | | | been defined or user-supplied checking functions may have been installed
* new manual page X509_PURPOSE_set(3) documenting 11 functionsschwarze2021-07-234-5/+303
| | | | related to X509_PURPOSE objects, purpose identifiers, and purpose indices
* occured -> occurred;jmc2021-07-231-3/+3
|
* document X509_STORE_CTX_set_time(3) and X509_STORE_CTX_set_depth(3)schwarze2021-07-221-2/+34
|
* Major cleanup.schwarze2021-07-221-85/+66
| | | | | | | | | | | | | 1. Fix the order of functions to match the order they occur in application code, making the text significantly easier to follow. 2. Do not use the same argument placeholder *sk for several different things; call the arguments *trusted, *untrusted, and *crls as appropriate. 3. Avoid using the word "initialised" for two different concepts in the same manual page; it was sometimes intended to mean "fill with zeros" and sometimes "replace the zeros with useful data". 4. Generally, make the text more precise, more straightforward, and shorter (-84 +65 lines of mdoc code).
* Split the functions operating on the X509_VERIFY_PARAM object outschwarze2021-07-223-74/+172
| | | | | | | | | of X509_STORE_CTX_new(3) because i'm about to document five additional functions of this kind and the page X509_STORE_CTX_new(3) is growing unwieldy. No text change yet, except that i added an introductory sentence to the beginning of the DESCRIPTION of the new page.
* document X509_STORE_CTX_get0_current_issuer(3)schwarze2021-07-221-5/+51
| | | | and X509_STORE_CTX_get0_current_crl(3)
* Move X509_STORE_CTX_get0_cert(3) to the X509_STORE_CTX_new(3) manual.schwarze2021-07-222-65/+113
| | | | | | | | | | | | | | | | | | | OpenSSL documents it in X509_STORE_CTX_get_error(3), but it is misplaced there. It has nothing to do with accessing status or error information but merely retrieves a pointer to the certificate that the users wants to validate. It is a companion function to X509_STORE_CTX_init(3), X509_STORE_CTX_set_cert(3), X509_STORE_CTX_get0_store(3), and X509_STORE_CTX_get0_untrusted(3). While here: 1. Clarify how the new, init, verify, cleanup, and free calls interact, and who owns the memory involved, because this is all really confusing from the user perspective. 2. Clarify how X509_STORE_CTX_init(3), X509_STORE_CTX_set_cert(3), and X509_STORE_CTX_set_chain(3) partially override each other. 3. Move X509_STORE_CTX_set0_untrusted(3) to the proper place because it is the same as X509_STORE_CTX_set_chain(3). 4. Add a few missing words and improve some wordings.
* Document X509_STORE_CTX_get_chain(3).schwarze2021-07-211-5/+15
| | | | | It is deprecated, but it is still called by various application programs, so let's better mention it.
* Split X509_NAME_hash(3) out of d2i_X509_NAME(3) and documentschwarze2021-07-204-25/+102
| | | | | | | | | | X509_issuer_name_hash(3), X509_subject_name_hash(3), and the _old variants. Even though this is only tangentially related to decoding and encoding, including a single function in d2i_X509_NAME(3) was probably OK, but let's not bog down that page with six functions that are likely to become obsolete at some point - even though right now, they are still being used both internally and by external software.
* document X509_CRL_print(3) and X509_CRL_print_fp(3)schwarze2021-07-195-7/+124
|
* new manual page X509_print_ex(3)schwarze2021-07-124-5/+287
|
* document X509V3_extensions_print(3)schwarze2021-07-126-7/+112
|
* document X509V3_EXT_print(3)schwarze2021-07-125-8/+167
|
* While the traditional OpenSSL return value and behaviour of BIO_dump(3)beck2021-07-111-26/+7
| | | | | | | | | | | is pure comedy gold, and now documented as such, sadly this bit of pure Muppet genius can't really in good consience stay in the tree as is. Change BIO_dump to always return the number of bytes printed on success and to stop printing and return -1 on failure if a writing function fails. ok tb@, jsing@
* new manual page ASN1_parse_dump(3)schwarze2021-07-115-7/+222
|
* document ASN1_get_object(3)schwarze2021-07-114-5/+207
|
* new manual page BIO_dump(3)schwarze2021-07-103-3/+149
|
* Fix mixup between localKeyID and friendlyName.tb2021-07-091-3/+3
| | | | "please commit" schwarze
* new manual page for X509_keyid_set1(3), X509_keyid_get0(3),schwarze2021-07-095-9/+184
| | | | X509_alias_set1(3), X509_alias_get0(3)
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-04-04 06:45:01 +0000