summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man (follow)
Commit message (Collapse)AuthorAgeFilesLines
...
* Delete bogus cross reference reported by jmc@.schwarze2017-01-061-5/+6
| | | | | Documenting these trivial PKCS7_type_is_*() macros does not seem useful, at least not right now.
* delete bogus cross references reported by jmc@schwarze2017-01-061-11/+7
| | | | and add some missing escaping of backslashes while here
* tweak previous;jmc2017-01-061-11/+13
|
* Also document the weird d2i_ASN1_UINTEGER(3), listed in <openssl/asn1.h>schwarze2017-01-051-1/+16
| | | | and in OpenSSL doc/man3/d2i_X509.pod (with wrong prototype).
* Write new d2i_ASN1_OCTET_STRING(3) manual page from scratch.schwarze2017-01-053-2/+373
| | | | | | All 36 functions listed in <openssl/asn1.h> and in OpenSSL doc/man3/d2i_X509.pod, six of them with wrong prototypes.
* minor tweaks;jmc2017-01-052-5/+5
|
* Complete rewrite, documenting 16 additional constructor/destructor pairs.schwarze2017-01-051-98/+189
| | | | | | | | | | | | While OpenSSL does not document them, they are public in <openssl/asn1.h>, and OpenSSL does document the related decoders and encoders. It makes no sense to me to document object methods without documenting the public constructors as well. While here: Bugfix: The type assigned by ASN1_STRING_new() was wrong. Remove implementation details. Add small amounts of useful auxiliary information.
* Write new d2i_ASN1_SEQUENCE_ANY(3) manual page from scratch.schwarze2017-01-042-1/+87
| | | | | | | | All four functions are listed in <openssl/asn1.h> and in OpenSSL doc/man3/d2i_X509.pod. Note that in the OpenSSL documentation, three of the four prototypes are incorrect.
* Complete rewrite:schwarze2017-01-041-58/+72
| | | | | | | | | | | | | | | | Better one-line description. Specify the correct header file. Same parameter names as in ASN1_item_d2i(3). Lots of new information. The ASN1_OBJECT interfaces appear specifically designed to maximize the number and subtlety of traps, maybe in order to trap the wary along with the unwary. All the quirks, caveats, and bugs of ASN1_item_d2i(3) apply, and there are three additional ones on top in this page. It looks like that design approach was so successful that the designers managed to trap even themselves: see the new BUGS section.
* Describe what ASN1_OBJECT_new(3), ASN1_OBJECT_free(3), OBJ_dup(3),schwarze2017-01-042-34/+105
| | | | | | | | | | and OBJ_create(3) really do rather than making broad and incomplete statements that are only true in some cases. Improve the one-line descriptions. Some minor wording improvements while here. There is obviously more work to do in the vicinity...
* Document d2i_ASN1_TYPE(3) and i2d_ASN1_TYPE(3),schwarze2017-01-031-9/+46
| | | | | both listed in <openssl/asn1.h> and in OpenSSL doc/man3/d2i_X509.pod. Minor wording improvements while here.
* Document ASN1_TYPE_new(3) and ASN1_TYPE_free(3), even though OpenSSLschwarze2017-01-032-34/+106
| | | | | | | | | | | does not document them. By being in <openssl/asn1.h>, they are public, and it makes no sense to document accessors but not document constructors and destructors. Improve the one-line description. Mention various missing details. Many wording improvements. Add some cross references.
* It takes a special style of creative writing to be unspecific about the errorbeck2017-01-031-15/+5
| | | | | | return code of a function in a man page. Let's remove the ambiguity and half truths in here. ok jsing@
* Write d2i_ASN1_NULL(3) manual page from scratch.schwarze2016-12-292-1/+86
| | | | | | | | | | | Both functions are listed in <openssl/asn1.h> and in OpenSSL doc/man3/d2i_X509.pod. After reading the code, i'm not amused. You wouldn't think that it might take eight stack levels to decode a constant sixteen bit value that does not even allow a single content octet, or would you? Nota bene, this is an average of four stack levels for each non-zero bit decoded... :-(
* Write documentation for <openssl/x509v3.h> DER decoding andschwarze2016-12-289-8/+861
| | | | | encoding functions from scratch. All 46 functions are listed in OpenSSL doc/man3/d2i_X509.pod.
* add missing .Vt macrosschwarze2016-12-282-8/+15
|
* standard section name;jmc2016-12-281-3/+3
|
* Rewrite and add d2i_X509_REQ_INFO(3) and i2d_X509_REQ_INFO(3),schwarze2016-12-281-66/+99
| | | | both listed in <openssl/x509.h> and in OpenSSL doc/man3/d2i_X509.pod.
* Rewrite and add d2i_X509_CRL_INFO(3), i2d_X509_CRL_INFO(3),schwarze2016-12-281-67/+94
| | | | | d2i_X509_REVOKED(3), and i2d_X509_CRL_INFO(3), all listed in <openssl/x509.h> and in OpenSSL doc/man3/d2i_X509.pod.
* Use the same parameter names as in ASN1_item_d2i(3).schwarze2016-12-281-53/+32
| | | | | Use simpler standard wordings. Add X.509 references.
* rewrite in the standard wayschwarze2016-12-281-60/+29
|
* Minor cleanup:schwarze2016-12-281-17/+19
| | | | | | Improve the one-line description. Use the standard wordings in some places. Complete the RETURN VALUES section.
* Write new manual pages d2i_X509_ATTRIBUTE(3) and d2i_X509_EXTENSION(3)schwarze2016-12-286-7/+176
| | | | | from scratch. All six functions are listed in <openssl/x509.h> and in OpenSSL doc/man3/d2i_X509.pod.
* In contrast to OpenSSL, do not attempt to document the worldschwarze2016-12-281-5/+98
| | | | | | in this page - but do include documentation for immediate subobjects that are used nowhere else. All six functions listed in <openssl/x509.h> and in OpenSSL doc/man3/d2i_X509.pod.
* Basic cleanup:schwarze2016-12-281-311/+60
| | | | | | | | | | Improve .Nd. Sort functions. Use the same parameter names as in ASN1_item_d2i(3). Point to ASN1_item_d2i(3) for all he details. Delete all the information that's now in ASN1_item_d2i(3). Add missing entries to the RETURN VALUES section. Add STANDARDS section.
* Full rewrite.schwarze2016-12-281-60/+123
| | | | | | | | | | | Also document d2i_PKCS8_bio(3), i2d_PKCS8_bio(3), d2i_PKCS8_fp(3), and i2d_PKCS8_fp(3) while here, listed in <openssl/x509.h> and in OpenSSL doc/man3/d2i_X509.pod. No, these functions have nothing to do with the many other d2i_PKCS8*(3) functions all around, and nothing with PKCS#8 at all in the first place. Read the BUGS section. I couldn't make this stuff up.
* Add a dire warning to not confuse i2d_PKCS8PrivateKey_bio(3)schwarze2016-12-281-4/+12
| | | | | | with i2d_PKCS8PrivateKeyInfo_bio(3). While here, polish the cross references.
* Document i2d_PKCS8PrivateKeyInfo_bio(3) and i2d_PKCS8PrivateKeyInfo_fp(3),schwarze2016-12-281-6/+41
| | | | | | | | listed in <openssl/x509.h> and in OpenSSL doc/man3/d2i_X509.pod. These functions are very similar to i2d_PrivateKey(3) but very different from i2d_PKCS8PrivateKey_bio(3), that's why they go into this manual page and not into the other one. When the naming was decided, somebody clearly considered too briefly or too long.
* Write new manual page d2i_PKCS8_PRIV_KEY_INFO(3) from scratch.schwarze2016-12-282-1/+116
| | | | | These six function are listed in <openssl/x509.h> and in OpenSSL doc/man3/d2i_X509.pod.
* Write new manual pages d2i_OCSP_REQUEST(3) and d2i_OCSP_RESPONSE(3)schwarze2016-12-273-1/+423
| | | | | from scratch. All these functions are listed in <openssl/ocsp.h> and in OpenSSL doc/man3/d2i_X509.pod.
* New manual pages d2i_ESS_SIGNING_CERT(3) and d2i_TS_REQ(3) writtenschwarze2016-12-273-1/+446
| | | | | from scratch. All functions listed in <openssl/ts.h> and in OpenSSL doc/man3/s2i_X509.pod.
* remove a stray comment line that might cause confusionschwarze2016-12-271-2/+1
|
* minor fixes;jmc2016-12-272-7/+7
|
* also document the weird i2d_PKCS7_NDEF(3)schwarze2016-12-261-1/+14
| | | | listed in <openssl/pkcs7.h> and OpenSSL doc/man3/d2i_X509.pod
* Write the missing d2i_PKCS7(3) manual page from scratch.schwarze2016-12-262-1/+316
| | | | | | It is already referenced by one other manual page. All these functions are listed in <openssl/pkcs7.h> and in OpenSSL doc/man3/d2i_X509.pod.
* Write the missing d2i_PKCS12(3) manual page from scratch.schwarze2016-12-262-1/+188
| | | | | | It is already referenced from some other manuals. All these functions are listed in <openssl/pkcs12.h> and in OpenSSL doc/man3/d2i_X509.pod.
* Document d2i_RSA_PSS_PARAMS(3) and i2d_RSA_PSS_PARAMS(3)schwarze2016-12-261-6/+60
| | | | | found in OpenSSL doc/man3/d2i_X509.pod. Add STANDARDS references.
* add eight missing functions found in OpenSSL doc/man3/d2i_X509.podschwarze2016-12-261-2/+78
|
* Basic cleanup:schwarze2016-12-261-80/+102
| | | | | | | | | Simplify one-line description. List each function with the correct header file. Use the same parameter names as in ASN1_item_d2i(3). Point to ASN1_item_d2i(3) for details. Sort the text. Add some useful cross references.
* describe what happens for val_out == NULL and for der_out == NULLschwarze2016-12-261-3/+26
|
* Consistently mark up various ASN.1 type names defined in standardsschwarze2016-12-2548-315/+481
| | | | related to X.509 with .Vt such that they can be searched for.
* Add missing functions d2i_PublicKey(3) and i2d_PublicKey(3)schwarze2016-12-251-35/+113
| | | | | | | | | | | | found in OpenSSL doc/man3/d2i_X509.pod. Simplify one-line description. Use the same parameter names as in ASN1_item_d2i(3). Point to ASN1_item_d2i(3) for details. Add a STANDRADS reference regarding PKCS#8 PrivateKeyInfo. Mention d2i_PrivateKey_bio(3) and d2i_PrivateKey_fp(3) in the DESCRIPTION and below RETURN VALUES. Add some missing markup and tweak some wording. Add some cross references.
* Correct the DESCRIPTION of ECParameters_dup(3).schwarze2016-12-251-11/+59
| | | | | | | Clarify requirements for o2i_ECPublicKey(3). Add STANDARDS references for d2i_ECPrivateKey(3) and d2i_EC_PUBKEY(3). Trim some excessive cross references that are only tangentially related and add some more relevant ones instead.
* Basic cleanup to prepare for content improvements:schwarze2016-12-251-171/+172
| | | | | | | | | | Use the same parameter names as in ASN1_item_d2i(3). Point to ASN1_item_d2i(3) for details. Delete lots of rendundant text. While here, add ten missing functions found in OpenSSL doc/man3/d2i_X509.pod and fix errors in the prototypes of i2d_ECPKParameters_bio(3) and i2d_ECPKParameters_fp(3).
* Clarify what DSAparams_dup(3) does.schwarze2016-12-251-19/+47
| | | | | | | | | | Add STANDARDS references. Add cross references to manual pages documenting conversion functions that are used by the functions documented here. Mark up the names of custom ASN.1 datatypes that are defined in standards with .Vt, allowing to search for them. Do not mark up basic ASN.1 data types. They stand out by being ALL CAPS anyway, and searching for them would be pointless.
* First example of how to fix the d2i_*() manuals:schwarze2016-12-241-98/+123
| | | | | | | | | | | - add four missing functions found in OpenSSL doc/man3/d2i_X509.pod - simplify .Nd - drop needless extra include line - use the same parameter names as in ASN1_item_d2i(3) - point to ASN1_item_d2i(3) for details - sort the text and simplify the wording More work is needed on STANDARDS references.
* Very carefully tweak OpenSSL doc/man3/d2i_X509.pod and create a newschwarze2016-12-243-1/+514
| | | | | | | | | | | | | | | | | | | | | | | ASN1_item_d2i(3) manual page from it. Enough text remains to keep Stephen Henson's Copyright. The eight functions documented in this new page are listed in <openssl/asn1.h> and in Symbols.list, so they are public even though OpenSSL does not document them. They are very important because hundreds of documented, much-used public interface functions are trivial wrappers around them, sharing their complicated semantics and their copious CAVEATS and BUGS. The plan is for the many pages documenting the wrappers to become very concise, to focus on the few type-dependent specifics, and to point to this new page for the details of the semantics, for the CAVEATS, and for the BUGS. While here, write a companion page ASN1_item_new(3) from scratch. The user interface described in that page scares the hell out of me, and i think people writing code to handle ASN.1 ought to be aware of that dangerous user interface design, or they will sooner or later get trapped.
* minor fixes;jmc2016-12-241-6/+6
|
* sprinkle some cross references to newly written x509v3 manual pagesschwarze2016-12-246-12/+32
|
* Write new SXNET_new(3) manual page from scratch. All four functionsschwarze2016-12-242-1/+93
| | | | | | | | | | | | | | | | are listed in <openssl/x509v3.h> and in OpenSSL doc/man3/X509_dup.pod. OpenSSL documentation specifies the wrong header file. I consider the quotation from http://www-03.ibm.com/security/library/wp_pki0730.shtml fair use because (1) it is a very brief extract from a long text, (2) no other source of information is available, (3) it is quoted for the purpose of education and research, (4) republishing happens in a not-for-profit context. I'm not including the URI into the manual page because large corporate websites are notorious for changing URIs during each spring cleaning.
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-08-24 17:54:08 +0000