summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man (follow)
Commit message (Collapse)AuthorAgeFilesLines
...
* document OBJ_new_nid(3), OBJ_add_object(3), and OBJ_create_objects(3);schwarze2021-12-151-9/+91
| | | | mark OBJ_create_and_add_object() as intentionally undocumented
* Move OBJ_create(3) into its own manual pageschwarze2021-12-155-63/+157
| | | | | because OBJ_nid2obj(3) is already long and more functions related to OBJ_create(3) have to be documented.
* Document i2c_ASN1_INTEGER(3).schwarze2021-12-151-7/+46
| | | | | | | | | | | | | While it was probably a mistake that steve@ made some i2c_*() and c2i_*() functions public back in 2000 and while we would like to delete them from the API, it may not be possible to delete this particular function because in contrast to the others (which are already marked as intentionally undocumented), this one is used by various real-world software, so for now, explain what it does, just in case people find it in existing code. While here, use the familiar term "byte" that we generally use throughout all our manual pages, even though the ASN.1 standard uses the term "octet" instead, which is more precise only in theory.
* forgotten .Dv macros in -column listsschwarze2021-12-142-19/+19
|
* add roff(7) comments listing some M_ASN1_* aliasesschwarze2021-12-143-6/+11
| | | | that are intentionally undocumented
* document the very quirky behaviour of the SMIME_OLDMIME flagschwarze2021-12-141-3/+39
|
* new manual page SMIME_text(3)schwarze2021-12-144-5/+65
|
* new manual page SMIME_read_ASN1(3)schwarze2021-12-144-8/+134
| | | | using parts of the text from SMIME_read_CMS(3) and SMIME_read_PKCS7(3)
* new manual page PEM_write_bio_ASN1_stream(3);schwarze2021-12-135-6/+100
| | | | | certainly not perfect, but arguably better than the even terser PEM_write_bio_CMS_stream(3) and PEM_write_bio_PKCS7_stream(3)
* new manual page SMIME_write_ASN1(3);schwarze2021-12-135-9/+179
| | | | still vague in various respects, but it's a start
* new manual pages i2d_ASN1_bio_stream(3) and SMIME_crlf_copy(3)schwarze2021-12-136-8/+203
|
* document the ub_* constantsschwarze2021-12-121-2/+22
|
* typoschwarze2021-12-121-2/+2
|
* New manual page providing a rudimentary description of BIO_new_NDEF(3).schwarze2021-12-124-5/+127
| | | | | | | The API surrounding this is so complicated and streaming is so rarely used in practice that describing this in more detail is not a priority right now. The documentation of the wrapper BIO_new_CMS(3) is also rather vague, and BIO_new_PKCS7() isn't described at all so far.
* document STABLE_NO_MASK and STABLE_FLAGS_MALLOC,schwarze2021-12-111-13/+32
| | | | | mention which argument values can be used to not change the respective fields, and tweak a few additional wordings
* two more "the the" fixes;jmc2021-12-111-3/+3
|
* explain how X509_NAME_ENTRY_set_data(3) uses MBSTRING_FLAGschwarze2021-12-101-5/+20
|
* document the following constants:schwarze2021-12-102-4/+28
| | | | | B_ASN1_DIRECTORYSTRING, B_ASN1_PRINTABLE, B_ASN1_DISPLAYTEXT, B_ASN1_TIME, DIRSTRING_TYPE, PKCS9STRING_TYPE
* document V_ASN1_SEQUENCE and V_ASN1_SETschwarze2021-12-091-4/+9
|
* document V_ASN1_BOOLEANschwarze2021-12-091-2/+4
|
* improve the documentation of V_ASN1_APP_CHOOSEschwarze2021-12-092-6/+15
|
* Mention V_ASN1_PRIMITIVE_TAG and V_ASN1_EOC.schwarze2021-12-091-5/+14
| | | | | Seeing the symbolic names in addition to the magic numbers makes it esier to understand the text.
* add the missing STANDARDS sectionschwarze2021-12-091-2/+8
|
* Document V_ASN1_ANY.schwarze2021-12-091-12/+15
| | | | | | While here, tweak some wordings a bit to make it less likely that readers confuse the type held by an ASN1_TYPE object with the type of the ASN1_TYPE object itself, which is always V_ASN1_ANY.
* document V_ASN1_NEGschwarze2021-12-091-3/+10
|
* document V_ASN1_OBJECTschwarze2021-12-091-2/+6
|
* document V_ASN1_NULLschwarze2021-12-091-2/+6
|
* fix a typo in an .Xr argumentschwarze2021-12-091-3/+3
|
* Add a section "NAMING CONVENTIONS".schwarze2021-12-091-36/+285
| | | | | | | | | There is no need to explain well-known acronyms that are widely used outside OpenSSL, too (like AES, ASN.1, CMS, ECDSA, PKCS...), but OpenSSL uses plenty of idiosyncratic naming elements that deserve to be explained (like d2i, ex, get0, ndef, sk, ...). Requested by jsing@; feedback and OK tb@.
* new manual page ASN1_bn_print(3)schwarze2021-12-084-5/+126
|
* document BIO_indent(3);schwarze2021-12-081-12/+53
| | | | while here, improve some of the existing text in minor ways
* mark c2i_ASN1_OBJECT as intentionally undocumented;schwarze2021-12-081-2/+4
| | | | discussed with jsing@
* mark i2c_ASN1_BIT_STRING, c2i_ASN1_BIT_STRING, and c2i_ASN1_INTEGERschwarze2021-12-081-2/+5
| | | | as intentionally undocumented; discussed with jsing@
* In the next major bump, some BN macros will become functions.schwarze2021-12-065-27/+11
| | | | | | In order to not forget it, already remove the statements that these APIs are currently implemented as macros: Not saying that doesn't make the documentation wrong.
* Add missing const qualifiers in a number of BN_* manuals.tb2021-11-308-52/+52
| | | | ok schwarze
* document ASN1_tag2bit(3)schwarze2021-11-281-5/+66
|
* Document ASN1_object_size(3).schwarze2021-11-281-17/+53
| | | | | | | | | While here, * call the function arguments "content_length" rather than just "length" to make it less likely that the reader confuses them with the total length returned by ASN1_object_size(3); * state that only the short form is supported for content_length <= 127; * add the missing STANDARDS section.
* mark ASN1_check_infinite_end() and ASN1_const_check_infinite_end()schwarze2021-11-281-2/+5
| | | | as intentionally undocumented
* new manual page BIO_f_asn1(3)schwarze2021-11-273-3/+233
|
* spellingjsg2021-11-267-22/+22
| | | | ok schwarze@
* after the bugfix in x509_vfy.c rev. 1.100,schwarze2021-11-261-16/+12
| | | | replace the BUGS section with a shorter CAVEATS section
* Document BIO_method_name(3).schwarze2021-11-251-48/+97
| | | | | | | | | | | While here, also improve the rest of the page: * add missing BIO_TYPE_* constants * describe BIO_TYPE_START * better function argument names * more precision in the descriptions and regarding the RETURN VALUES * lots of wording improvements * improve the coding style below EXAMPLES * delete a BUGS section describing cretaceous behaviour
* add the missing const qualifiers below EXAMPLES;schwarze2021-11-241-8/+11
| | | | | | from <Malgorzata dot Olszowka at stunnel dot org> via OpenSSL commit 256989ce in the OpenSSL 1.1.1 branch, which is still under a free license
* document ASN1_item_ndef_i2d(3)schwarze2021-11-241-4/+22
|
* document ASN1_TYPE_set_int_octetstring(3) and ASN1_TYPE_get_int_octetstring(3)schwarze2021-11-231-9/+77
|
* Use LIBRESSL_NEXT_API to document the commented-out functions that aretb2021-11-231-13/+13
| | | | | | not yet available. ok schwarze
* document ASN1_TYPE_set_octetstring(3) and ASN1_TYPE_get_octetstring(3)schwarze2021-11-231-5/+67
|
* document a2i_ASN1_INTEGER(3),schwarze2021-11-232-69/+135
| | | | i2a_ASN1_ENUMERATED(3), and a2i_ASN1_ENUMERATED(3)
* Fix typojob2021-11-221-2/+2
| | | | thanks Matthias Schmidt
* new manual page ASN1_NULL_new(3), also documenting ASN1_NULL_free(3)schwarze2021-11-224-5/+70
|