summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man
AgeCommit message (Collapse)Author
2023-08-05remove trailing comma in NAME;Jason McIntyre
2023-07-29Remove BF_options() documentationTheo Buehler
2023-07-28The CRYPTO_EX_DATA type is not opaqueTheo Buehler
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
2023-07-28Remove ASN1_BIT_STRING_set docoTheo Buehler
2023-07-28Remove stale .Xr missed in previousTheo Buehler
2023-07-28Remove ASN1_BIT_STRING_num_asc.3Theo Buehler
2023-07-27Fix two mandoc -Tlint warnings left in previousTheo Buehler
2023-07-27Fix typoTheo Buehler
2023-07-26Remove ERR_get_{err_state,string}_table documentationTheo Buehler
2023-07-26Remove BUF_reverse and BUF_strdup documentationTheo Buehler
2023-07-26BN_BLINDING will be made internal-only. Remove its documentationTheo Buehler
2023-07-26BIO_f_asn1 and the prefix/suffix API will be removedTheo Buehler
Remove their documentation and mark some associated constants as intentionally undocumented until they will be removed from public headers.
2023-07-26Document CMS_SignerInfos_get_version and CMS_get_version which willTheo Buehler
be added in the upcoming bump.
2023-07-22Actually add OBJ_find_sigid_algsTheo Buehler
2023-07-22Rename OBJ_add_sigid.3 to OBJ_find_sigid_algs.3Theo Buehler
2023-07-21Simple adjustments for DSO removalTheo Buehler
openssl.cnf.5 will need a major overhaul. But that isn't new...
2023-07-21Stop mentioning some ERR_load_*_strings that will be removedTheo Buehler
2023-07-21Fix Xr order to appease mandoc -TlintTheo Buehler
2023-07-21Remove OBJ_add_sigid and OBJ_sigid_free documentationTheo Buehler
These will be made internal and will likely go away. The OBJ_add_sigid.3 manual should probably be renamed; this can be done in a second step.
2023-07-21Remove ASN1_buf_print documentationTheo Buehler
This function will be made internal-only and likely be renamed/rewritten.
2023-07-21Remove remaining ECDSA_METHOD documentationTheo Buehler
2023-07-21Remove documentation of ECDH/ECDSA ex_data APITheo Buehler
2023-07-21Document ENGINE_get_default_ECTheo Buehler
ENGINE_get_default_{ECDH,ECDSA} will go away and won't come back. Replace their documentation with the missing ENGINE_get_defaulT_EC. In the unlikely event that we will need to bring back ENGINE after the next bump, this manual will not be outdated and incomplete.
2023-07-21Document ENGINE_{get,set}_ECTheo Buehler
ENGINE_{get,set}_{ECDH,ECDSA} will go away and won't come back. Replace their documentation with the missing ENGINE_{get,set}_EC. In the unlikely event that we will need to bring back ENGINE after the next bump, this manual will not be outdated and incomplete.
2023-07-20Move get_rfc3526_prime_8192.3 to BN_get_rfc3526_prime_8192.3Theo Buehler
This way we will have a manual corresponding to an existing function after the next bump.
2023-07-20Remove get_rfc*_prime_* documentationTheo Buehler
Their BN_get_rfc*_prime_* aliases from the OpenSSL 1.1 API will remain. Perhaps the manual should be moved to BN_get_rfc3526_prime_8192.3; that can be done in a second step.
2023-07-20Remove ECDSA_{do_,}sign_ex() and ECDSA_sign_setup()Theo Buehler
These very poorly designed interfaces will go away, so stop documenting them.
2023-07-09Add Xr to EVP_MD_meth_new to top level libraryTheo Buehler
2023-07-09Fix OpenBSD releaseTheo Buehler
2023-07-09ASN1_bn_print() will be removed soon. Remove docs.Theo Buehler
2023-07-08link EVP_MD_meth_new.3 to buildTheo Buehler
2023-07-08Import EVP_MD_meth_new.3 from OpenSSL 1.1.1 headTheo Buehler
As usual, this has a lot of room for improvement, but it is better than nothing at all. It leaves a dangling reference to EVP_MD_CTX_md_data(), which I leave for schwarze to document. This is a terrible API and the way it is used in the wild is terrifying.
2023-06-28Adjust EC_GROUP_get_basis_type() documentationTheo Buehler
After the GF2m removal, this function always returns 0, so adjust the documentation and remove EC_GROUP_get_{trinomial,pentanomial}_basis() that were left behind. Also add a tiny grammar tweak in the HISTORY section.
2023-06-25Adjust/fix X509_check_purpose(3) documentationTheo Buehler
2023-06-06In 1995, Eric A. Young chose a confusing name for the "lastUpdate" fieldIngo Schwarze
of the X509_CRL_INFO object. It should have been called "thisUpdate" like in RFC 5280 section 5.1 (and in its precursor RFC 2459). Then again, RFC 2459 was only published in 1999, so maybe the terminology wasn't firmly established yet when Young wrote his code several years earlier - just guessing, neither we nor the OpenSSL folks appear to know the real reasons... Anyway, we have been stuck with the "lastUpdate" names in the API for more than two decades now, so clarify in the documentation what they refer to and what they really mean. Requested by and OK tb@.
2023-06-05Improve the description of CMS_get0_signers()Job Snijders
Suggestion from Małgorzata Olszówka, they noted: "The original wording suggests that it is required to execute CMS_get0_signers() after CMS_verify(), while it is CMS_get0_signers() that requires prior successful invocation of CMS_verify()." OK tb@
2023-05-30fix some nits on previousOmar Polo
- move a sentence out of a Bd block - add some .Pp for spacing - avoid a double colon on a sentence and the usage of second person - mark STORE_CTX with .Vt - change one Vt -> Dv (done after this has been ok'd by beck) ok beck@
2023-05-29Oops, Fa -> .FaBob Beck
2023-05-29Make X509_NAME_get_text_by[NID|OBJ] safer.Bob Beck
This is an un-revert with nits of the previously landed change to do this which broke libtls. libtls has now been changed to not use this function. This change ensures that if something is returned it is "text" (UTF-8) and a C string not containing a NUL byte. Historically callers to this function assume the result is text and a C string however the OpenSSL version simply hands them the bytes from an ASN1_STRING and expects them to know bad things can happen which they almost universally do not check for. Partly inspired by goings on in boringssl. ok jsing@ tb@
2023-05-29Stop suggesting that children play with loaded revolvers.Bob Beck
This takes much of the language that boring uses to document the verify callback, and corrects the historical horror that OpenSSL introduced years ago by suggesting people ignore expiry dates using the callback instead of the verify flags. nits by jsg@ and tb@ ok tb@
2023-05-24Update X509_VERIFY_PARAM_inherit() to reflect the change of behaviorTheo Buehler
in x509_vpm.c r1.39.
2023-05-22Remove misplaced semicolons in .FaTheo Buehler
2023-05-14Fix another mandoc -Tlint warningTheo Buehler
With this the only -Tlint warnings are about Xr to undocumented functions: EVP_CIPHER_CTX_copy, EVP_CIPHER_CTX_get_cipher_data, X509V3_EXT_get_nid.
2023-05-14Rephrase a sentence slightly to apease mandoc -TlintTheo Buehler
2023-05-14Fix Xr as BN_is_prime(3) is in the atticTheo Buehler
2023-05-14Zap trailing commaTheo Buehler
2023-05-14X509_policy_tree_level_count(3) is goneTheo Buehler
2023-05-12primility -> primalityJonathan Gray
ok tb@
2023-05-12Be a bit more precise on how s2i_ASN1_OCTET_STRING handles colonsTheo Buehler
2023-05-11Document recent changes in primality testingTheo Buehler
With input from beck and jsing