diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/OSSL_CMP_ITAV_set0.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/OSSL_CMP_ITAV_set0.3 | 180 |
1 files changed, 63 insertions, 117 deletions
diff --git a/secure/lib/libcrypto/man/man3/OSSL_CMP_ITAV_set0.3 b/secure/lib/libcrypto/man/man3/OSSL_CMP_ITAV_set0.3 index 411763ba0c4b..44973437c568 100644 --- a/secure/lib/libcrypto/man/man3/OSSL_CMP_ITAV_set0.3 +++ b/secure/lib/libcrypto/man/man3/OSSL_CMP_ITAV_set0.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,103 +52,47 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "OSSL_CMP_ITAV_SET0 3ossl" -.TH OSSL_CMP_ITAV_SET0 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH OSSL_CMP_ITAV_SET0 3ossl 2025-07-01 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME OSSL_CMP_ITAV_create, OSSL_CMP_ITAV_set0, OSSL_CMP_ITAV_get0_type, OSSL_CMP_ITAV_get0_value, -OSSL_CMP_ITAV_push0_stack_item +OSSL_CMP_ITAV_push0_stack_item, +OSSL_CMP_ITAV_new0_certProfile, +OSSL_CMP_ITAV_get0_certProfile \&\- OSSL_CMP_ITAV utility functions -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" -.Vb 6 -\& #include <openssl/cmp.h> -\& OSSL_CMP_ITAV *OSSL_CMP_ITAV_create(ASN1_OBJECT *type, ASN1_TYPE *value); -\& void OSSL_CMP_ITAV_set0(OSSL_CMP_ITAV *itav, ASN1_OBJECT *type, -\& ASN1_TYPE *value); -\& ASN1_OBJECT *OSSL_CMP_ITAV_get0_type(const OSSL_CMP_ITAV *itav); -\& ASN1_TYPE *OSSL_CMP_ITAV_get0_value(const OSSL_CMP_ITAV *itav); +.Vb 1 +\& #include <openssl/cmp.h> \& -\& int OSSL_CMP_ITAV_push0_stack_item(STACK_OF(OSSL_CMP_ITAV) **itav_sk_p, -\& OSSL_CMP_ITAV *itav); +\& OSSL_CMP_ITAV *OSSL_CMP_ITAV_create(ASN1_OBJECT *type, ASN1_TYPE *value); +\& void OSSL_CMP_ITAV_set0(OSSL_CMP_ITAV *itav, ASN1_OBJECT *type, +\& ASN1_TYPE *value); +\& ASN1_OBJECT *OSSL_CMP_ITAV_get0_type(const OSSL_CMP_ITAV *itav); +\& ASN1_TYPE *OSSL_CMP_ITAV_get0_value(const OSSL_CMP_ITAV *itav); +\& int OSSL_CMP_ITAV_push0_stack_item(STACK_OF(OSSL_CMP_ITAV) **itav_sk_p, +\& OSSL_CMP_ITAV *itav); +\& OSSL_CMP_ITAV +\& *OSSL_CMP_ITAV_new0_certProfile(STACK_OF(ASN1_UTF8STRING) *certProfile); +\& int OSSL_CMP_ITAV_get0_certProfile(const OSSL_CMP_ITAV *itav, +\& STACK_OF(ASN1_UTF8STRING) **out); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -Certificate Management Protocol (\s-1CMP, RFC 4210\s0) extension to OpenSSL -.PP -\&\s-1ITAV\s0 is short for InfoTypeAndValue. This type is defined in \s-1RFC 4210\s0 -section 5.3.19 and Appendix F. It is used at various places in \s-1CMP\s0 messages, +ITAV is short for InfoTypeAndValue. This type is defined in RFC 4210 +section 5.3.19 and Appendix F. It is used at various places in CMP messages, e.g., in the generalInfo PKIHeader field, to hold a key-value pair. .PP -\&\fBOSSL_CMP_ITAV_create()\fR creates a new \fB\s-1OSSL_CMP_ITAV\s0\fR structure and fills it in. +\&\fBOSSL_CMP_ITAV_create()\fR creates a new \fBOSSL_CMP_ITAV\fR structure and fills it in. It combines \fBOSSL_CMP_ITAV_new()\fR and \fBOSSL_CMP_ITAV_set0()\fR. .PP \&\fBOSSL_CMP_ITAV_set0()\fR sets the \fIitav\fR with an infoType of \fItype\fR and an @@ -175,29 +103,45 @@ internally, so they must \fBnot\fR be freed up after the call. \&\fIitav\fR. .PP \&\fBOSSL_CMP_ITAV_get0_value()\fR returns a direct pointer to the infoValue in -the \fIitav\fR as generic \fB\s-1ASN1_TYPE\s0\fR pointer. +the \fIitav\fR as generic \fBASN1_TYPE\fR pointer. .PP \&\fBOSSL_CMP_ITAV_push0_stack_item()\fR pushes \fIitav\fR to the stack pointed to -by \fI*itav_sk_p\fR. It creates a new stack if \fI*itav_sk_p\fR points to \s-1NULL.\s0 -.SH "NOTES" +by \fI*itav_sk_p\fR. It creates a new stack if \fI*itav_sk_p\fR points to NULL. +.PP +\&\fBOSSL_CMP_ITAV_new0_certProfile()\fR creates a new \fBOSSL_CMP_ITAV\fR structure +of type \fBcertProfile\fR that includes the optionally given list of profile names. +On success, ownership of the list is with the new \fBOSSL_CMP_ITAV\fR structure. +.PP +\&\fBOSSL_CMP_ITAV_get0_certProfile()\fR on success assigns to \fI*out\fR +an internal pointer to the +list of certificate profile names contained in the infoValue field of \fIitav\fR. +The pointer may be NULL if no profile name is included. +It is an error if the infoType of \fIitav\fR is not \fBcertProfile\fR. +.SH NOTES .IX Header "NOTES" -\&\s-1CMP\s0 is defined in \s-1RFC 4210\s0 (and \s-1CRMF\s0 in \s-1RFC 4211\s0). +CMP is defined in RFC 4210 and RFC 9480 (and CRMF in RFC 4211). +.PP +OIDs to use as types in \fBOSSL_CMP_ITAV\fR can be found at +<https://datatracker.ietf.org/doc/html/rfc9480#section\-4.2.2>. +The respective OpenSSL NIDs, such as \fBNID_id_it_certProfile\fR, +are defined in the \fI<openssl/obj_mac.h>\fR header file. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fBOSSL_CMP_ITAV_create()\fR returns a pointer to the \s-1ITAV\s0 structure on success, -or \s-1NULL\s0 on error. +\&\fBOSSL_CMP_ITAV_create()\fR and \fBOSSL_CMP_ITAV_new0_certProfile()\fR +return a pointer to an ITAV structure on success, or NULL on error. .PP \&\fBOSSL_CMP_ITAV_set0()\fR does not return a value. .PP \&\fBOSSL_CMP_ITAV_get0_type()\fR and \fBOSSL_CMP_ITAV_get0_value()\fR -return the respective pointer or \s-1NULL\s0 if their input is \s-1NULL.\s0 +return the respective pointer or NULL if their input is NULL. .PP -\&\fBOSSL_CMP_ITAV_push0_stack_item()\fR returns 1 on success, 0 on error. -.SH "EXAMPLES" +\&\fBOSSL_CMP_ITAV_push0_stack_item()\fR and \fBOSSL_CMP_ITAV_get0_certProfile()\fR +return 1 on success, 0 on error. +.SH EXAMPLES .IX Header "EXAMPLES" The following code creates and sets a structure representing a generic -InfoTypeAndValue sequence, using an \s-1OID\s0 created from text as type, and an -integer as value. Afterwards, it is pushed to the \fB\s-1OSSL_CMP_CTX\s0\fR to be later +InfoTypeAndValue sequence, using an OID created from text as type, and an +integer as value. Afterwards, it is pushed to the \fBOSSL_CMP_CTX\fR to be later included in the requests' PKIHeader's genInfo field. .PP .Vb 2 @@ -214,10 +158,9 @@ included in the requests' PKIHeader's genInfo field. \& OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_create(type, val); \& if (itav == NULL) ... \& -\& OSSL_CMP_CTX *ctx = OSSL_CMP_CTX_new(); -\& if (ctx == NULL || !OSSL_CMP_CTX_geninfo_push0_ITAV(ctx, itav)) { +\& if (!OSSL_CMP_CTX_push0_geninfo_ITAV(ctx, itav)) { \& OSSL_CMP_ITAV_free(itav); /* also frees type and val */ -\& goto err; +\& ... \& } \& \& ... @@ -227,14 +170,17 @@ included in the requests' PKIHeader's genInfo field. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBOSSL_CMP_CTX_new\fR\|(3), \fBOSSL_CMP_CTX_free\fR\|(3), \fBASN1_TYPE_set\fR\|(3) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" -The OpenSSL \s-1CMP\s0 support was added in OpenSSL 3.0. -.SH "COPYRIGHT" +The OpenSSL CMP support was added in OpenSSL 3.0. +.PP +\&\fBOSSL_CMP_ITAV_new0_certProfile()\fR and \fBOSSL_CMP_ITAV_get0_certProfile()\fR +were added in OpenSSL 3.3. +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2007\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |