.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .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' .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" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" 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_CRMF_MSG_SET1_REGCTRL_REGTOKEN 3" .TH OSSL_CRMF_MSG_SET1_REGCTRL_REGTOKEN 3 "2020-03-02" "3.0.0-dev" "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" OSSL_CRMF_MSG_set1_regCtrl_regToken, OSSL_CRMF_MSG_set1_regCtrl_authenticator, OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo, OSSL_CRMF_MSG_set0_SinglePubInfo, OSSL_CRMF_MSG_set_PKIPublicationInfo_action, OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo, OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey, OSSL_CRMF_MSG_set1_regCtrl_oldCertID, OSSL_CRMF_CERTID_gen \&\- functions setting CRMF Registration Controls .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include \& \& int OSSL_CRMF_MSG_set1_regCtrl_regToken(OSSL_CRMF_MSG *msg, \& const ASN1_UTF8STRING *tok); \& int OSSL_CRMF_MSG_set1_regCtrl_authenticator(OSSL_CRMF_MSG *msg, \& const ASN1_UTF8STRING *auth); \& int OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo( \& OSSL_CRMF_PKIPUBLICATIONINFO *pi, \& OSSL_CRMF_SINGLEPUBINFO *spi); \& int OSSL_CRMF_MSG_set0_SinglePubInfo(OSSL_CRMF_SINGLEPUBINFO *spi, \& int method, GENERAL_NAME *nm); \& int OSSL_CRMF_MSG_set_PKIPublicationInfo_action( \& OSSL_CRMF_PKIPUBLICATIONINFO *pi, int action); \& int OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo(OSSL_CRMF_MSG *msg, \& const OSSL_CRMF_PKIPUBLICATIONINFO *pi); \& int OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey(OSSL_CRMF_MSG *msg, \& const X509_PUBKEY *pubkey); \& int OSSL_CRMF_MSG_set1_regCtrl_oldCertID(OSSL_CRMF_MSG *msg, \& const OSSL_CRMF_CERTID *cid); \& OSSL_CRMF_CERTID *OSSL_CRMF_CERTID_gen(const X509_NAME *issuer, \& const ASN1_INTEGER *serial); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fIOSSL_CRMF_MSG_set1_regCtrl_regToken()\fR sets the regToken control in the given \&\fBmsg\fR copying the given \fBtok\fR as value. See \s-1RFC\s0 4211, section 6.1. .PP \&\fIOSSL_CRMF_MSG_set1_regCtrl_authenticator()\fR sets the authenticator control in the given \fBmsg\fR copying the given \fBauth\fR as value. See \s-1RFC\s0 4211, section 6.2. .PP \&\fIOSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo()\fR pushes the given \fBspi\fR to \fBsi\fR. Consumes the \fBspi\fR pointer. .PP \&\fIOSSL_CRMF_MSG_set0_SinglePubInfo()\fR sets in the given SinglePubInfo \fBspi\fR the \fBmethod\fR and publication location, in the form of a GeneralName, \fBnm\fR. The publication location is optional, and therefore \fBnm\fR may be \s-1NULL\s0. The function consumes the \fBnm\fR pointer if present. Available methods are: # define \s-1OSSL_CRMF_PUB_METHOD_DONTCARE\s0 0 # define \s-1OSSL_CRMF_PUB_METHOD_X500\s0 1 # define \s-1OSSL_CRMF_PUB_METHOD_WEB\s0 2 # define \s-1OSSL_CRMF_PUB_METHOD_LDAP\s0 3 .PP \&\fIOSSL_CRMF_MSG_set_PKIPublicationInfo_action()\fR sets the action in the given \fBpi\fR using the given \fBaction\fR as value. See \s-1RFC\s0 4211, section 6.3. Available actions are: # define \s-1OSSL_CRMF_PUB_ACTION_DONTPUBLISH\s0 0 # define \s-1OSSL_CRMF_PUB_ACTION_PLEASEPUBLISH\s0 1 .PP \&\fIOSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo()\fR sets the pkiPublicationInfo control in the given \fBmsg\fR copying the given \fBtok\fR as value. See \s-1RFC\s0 4211, section 6.3. .PP \&\fIOSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey()\fR sets the protocolEncrKey control in the given \fBmsg\fR copying the given \fBpubkey\fR as value. See \s-1RFC\s0 4211 section 6.6. .PP \&\fIOSSL_CRMF_MSG_set1_regCtrl_oldCertID()\fR sets the oldCertID control in the given \&\fBmsg\fR copying the given \fBcid\fR as value. See \s-1RFC\s0 4211, section 6.5. .PP OSSL_CRMF_CERTID_gen produces an OSSL_CRMF_CERTID_gen structure copying the given \fBissuer\fR name and \fBserial\fR number. .SH "RETURN VALUES" .IX Header "RETURN VALUES" OSSL_CRMF_CERTID_gen returns a pointer to the resulting structure or \s-1NULL\s0 on error. .PP All other functions return 1 on success, 0 on error. .SH "NOTES" .IX Header "NOTES" A function \fIOSSL_CRMF_MSG_set1_regCtrl_pkiArchiveOptions()\fR for setting an Archive Options Control is not yet implemented due to missing features to create the needed \s-1OSSL_CRMF_PKIARCHIVEOPTINS\s0 content. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1RFC\s0 4211 .SH "HISTORY" .IX Header "HISTORY" The OpenSSL \s-1CRMF\s0 support was added in OpenSSL 3.0. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2007\-2019 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the \*(L"License\*(R"). 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 .