summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man
AgeCommit message (Collapse)Author
2023-10-11I forgot that we now have ASN1_INTEGER_set_uint64()Theo Buehler
2023-10-11Be more precise about X509_ALGOR_get0()Theo Buehler
2023-10-10Improve X509_ALGOR_new(3) documentationTheo Buehler
The previous wording was misleading since the result of X509_ALGOR_new() is not actually an empty X509_ALGOR object. Rather, it contains the undefined ASN1_OBJECT returned by OBJ_nid2obj(NID_undef). Therefore using X509_ALGOR_get0(3) for error checking X509_ALGOR_set_md() is not trivial. So: change the initial paragraph into a general intro referring to the OpenSSL API needed to interface with X509_ALGOR and write a new paragraph documenting X509_ALGOR_new(3) and drop the incorrect suggestion of an error check. Notably there's now a reference to the OBJ_nid2obj() family without which one cannot really use X509_ALGOR_* for anything at all. With and ok schwarze
2023-10-09Use the usual text for X509_ALGOR_free()Theo Buehler
2023-10-09Clarify that 'undefined type' means V_ASN1_UNDEFTheo Buehler
2023-10-09Clarify documentation of X509_ALGOR_{set0,set_md}()Theo Buehler
The X509_ALGOR_set0() and X509_ALGOR_set_md() documentation comes from upstream, which means it is as sloppy as the code and as vague as your average upstream manpage. Be precise on what X509_ALGOR_set0() does on different inputs and document return values and failure modes. X509_ALGOR_set_md() is a void function that calls X509_ALGOR_set0() in a way that can fail, leaving alg in a corrupted state. Document when that can occur and how to avoid or detect that, but do not go too far, because EVP_MD_meth_new(), one potential source of failures, is a whole another can of worms. joint work with schwarze
2023-10-03Fix a typo and move a wordTheo Buehler
2023-10-01Example code tweak: do not hardcode the size of arrayTheo Buehler
2023-10-01Document EVP_CIPHER_CTX_iv_length() return valuesTheo Buehler
We aligned with upstream behavior. Let's document it properly. Surprisingly, OpenSSL 1.1 half-assed the docs: two parts of the manual contradict each other. The part getting EVP_CIPHER_CTX_iv_length() right, incorrectly documents possible -1 return value to EVP_CIPHER_iv_length(). OpenSSL 3 documentation improvement efforts seem to have tried to address this issue with the result that the manual is now entirely wrong when it comes to the EVP_CIPHER_CTX_iv_length() replacement. Par for the course.
2023-10-01The colons separate the octets, not the digits; add missing link toTheo Buehler
crypto(3)
2023-10-01Improve a code comment in the EXAMPLES sectionTheo Buehler
2023-10-01Refer to RFC 3779, 2.1.2 for encoding of rangesTheo Buehler
Mention sections 2.1.1 and 2.1.2 in STANDARDS
2023-10-01Point out that the result of IPAddressRange_new() is an invalid rangeTheo Buehler
since it should be a prefix.
2023-10-01encoding -> decoding for d2iTheo Buehler
2023-09-30Reorder list of additional validation checks neededTheo Buehler
2023-09-30Switch copyright year to 2023.Theo Buehler
Apparently I should have used 2023 despite sharing versions of these files with several people under this license (and thus permitting them to redistribute and share with the public). It makes no sense to me, but shrug.
2023-09-30Use addrblocks for .FaTheo Buehler
2023-09-30avoid using the string "a" without markup as a placeholderIngo Schwarze
where that feels potentially confusing, and add one missing .Pp macro; no change of meaning
2023-09-30consistently use "allow_inherit" for the argument nameIngo Schwarze
and fix whitespace on one text line; no change of meaning
2023-09-30drop one pair of needless parenthesesIngo Schwarze
and polish one wording; no change of meaning
2023-09-30remove a useless repetition of a function nameIngo Schwarze
that was also followed by a bogus argument, and fix one grammatical error; no change of meaning
2023-09-30polish an awkward wordingIngo Schwarze
and capitalize "AFI" where is does not refer to the function argument; no change of meaning
2023-09-30two instances of missing .Fa macrosIngo Schwarze
and some missing escaping of HYPHEN-MINUS; no text change
2023-09-30fix one copy and paste error: d2i_*() decode rather than encode;Ingo Schwarze
plus some minor markup and punctuation fixes
2023-09-30garbage collect two stray words, no change of meaningIngo Schwarze
2023-09-29Some wording tweaks to make things a bit more precise.Theo Buehler
2023-09-29Fix a wrong tag and work around an ugly linebreakTheo Buehler
2023-09-29Document X509v3_{addr,asid}_validate_{path,resource_set}(3)Theo Buehler
These were the last four RFC 3779 things that check_complete.pl x509v3 complained about. I will surely tweak and try to improve a few things in the coming days, but the pages should now be stable enough that review efforts will likely not be wasted. Any feedback appreciated.
2023-09-28Document X509v3_{addr,asid}_subset.3 take two (missed cvs add)Theo Buehler
First RFC 3779 page without a BUG section. It could have one, but I'm in a lenient mood right now. Maybe it's just that this is bad but not quite as bad as EVP.
2023-09-28Document X509v3_{addr,asid}_subset.3Theo Buehler
First RFC 3779 page without a BUG section. It could have one, but I'm in a lenient mood right now. Maybe it's just that this is bad but not quite as bad as EVP.
2023-09-27Various small tweaks in the RFC 3779 docsTheo Buehler
Mention a few more bugs and unify manpage descriptions
2023-09-26Document X509v3_{addr,asid}_inherits(3)Theo Buehler
Also note another bug in X509v3_asid_{canonize,is_canonical}(3).
2023-09-26Document X509v3_addr_get_{afi,range}(3)Theo Buehler
2023-09-26Document the guts of RFC 3779 IPAddrBlocksTheo Buehler
Let's just say there's room for improvement...
2023-09-26Missing variable name in prototypeTheo Buehler
2023-09-26Fix section title of X.690 reference (missing article)Theo Buehler
2023-09-26Document some barely usable parts of the ASIdentifiers API.Theo Buehler
Someone clearly didn't actually use much of the code they wrote and exposed and therefore didn't think it through properly.
2023-09-25sortTheo Buehler
2023-09-25New manual page documenting the usual four ASN.1 functions for bothTheo Buehler
ASRange and ASIdOrRange
2023-09-25tweak wording and fix a typoTheo Buehler
2023-09-25Tiny tweaks: missing article, capitalize a word and change an XrTheo Buehler
2023-09-25Document the RFC 3779 extensions as supportedTheo Buehler
2023-09-25Add initial documentation for the RFC 3779 APITheo Buehler
This documents the part of the API that allows building the two extensions. It is all very complicated and the bug density is quite high. Surely there's lots of room for improvement, but I've been sitting way too long on versions of these. I'll never finish. Let's fix and improve in tree.
2023-09-18PEM_def_callback(3) does not truncate its argument but merely the copy,Ingo Schwarze
plus a few wording improvements
2023-09-18Rewrite RSA_get_ex_new_index(3) and CRYPTO_set_ex_data(3) from scratch.Ingo Schwarze
The defects of the old pages were too numerous to list in full but included vagueness, gaps, misleading statements, bad ordering, and duplication. Use my Copyright since none of the text we inherited from OpenSSL remains. Without doing a thorough review, tb@ thinks he likes the new pages after quickly reading through both of them.
2023-09-13replace the outdated statement that everything uses SHA-1Ingo Schwarze
by a table showing the supported algorithms
2023-09-13Document the special meaning of NID_undef in this context.Ingo Schwarze
From Matt Caswell <matt at openssl dot org> via OpenSSL commit 1212818e (Sep 11, 2018) from the OpenSSL 1.1 branch, which is still under a free license. Wording slightly tweaked by me.
2023-09-13Various improvements:Ingo Schwarze
* Document the ASN1_PKEY_CTRL_DEFAULT_MD_NID control operation. * Mention that EVP_PKEY_asn1_new(3) sets ASN1_PKEY_DYNAMIC. * Fix the description of EVP_PKEY_asn1_copy(3), which was totally wrong. * Warn about the crazy ASN1_PKEY_DYNAMIC handling in EVP_PKEY_asn1_free(3). * Be more precise about EVP_PKEY_asn1_new(3) RETURN VALUES.
2023-09-13document the EVP_PKEY_ASN1_METHOD flagsIngo Schwarze
ASN1_PKEY_ALIAS, ASN1_PKEY_DYNAMIC, and ASN1_PKEY_SIGPARAM_NULL
2023-09-13minor markup fixes: add one missing .Dv and one missing .Vt macroIngo Schwarze