secure/lib/libcrypto/man/CMS_add1_signer.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "CMS_ADD1_SIGNER 3"
 132 .TH CMS_ADD1_SIGNER 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 CMS_add1_signer, CMS_SignerInfo_sign \- add a signer to a CMS_ContentInfo signed data structure
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/cms.h>
 143 \&
 144 \& CMS_SignerInfo *CMS_add1_signer(CMS_ContentInfo *cms, X509 *signcert,
 145 \&                                 EVP_PKEY *pkey, const EVP_MD *md,
 146 \&                                 unsigned int flags);
 147 \&
 148 \& int CMS_SignerInfo_sign(CMS_SignerInfo *si);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fICMS_add1_signer()\fR adds a signer with certificate \fBsigncert\fR and private
 153 key \fBpkey\fR using message digest \fBmd\fR to CMS_ContentInfo SignedData
 154 structure \fBcms\fR.
 155 .PP
 156 The CMS_ContentInfo structure should be obtained from an initial call to
 157 \&\fICMS_sign()\fR with the flag \fB\s-1CMS_PARTIAL\s0\fR set or in the case or re-signing a
 158 valid CMS_ContentInfo SignedData structure.
 159 .PP
 160 If the \fBmd\fR parameter is \fB\s-1NULL\s0\fR then the default digest for the public
 161 key algorithm will be used.
 162 .PP
 163 Unless the \fB\s-1CMS_REUSE_DIGEST\s0\fR flag is set the returned CMS_ContentInfo
 164 structure is not complete and must be finalized either by streaming (if
 165 applicable) or a call to \fICMS_final()\fR.
 166 .PP
 167 The \fICMS_SignerInfo_sign()\fR function will explicitly sign a CMS_SignerInfo
 168 structure, its main use is when \fB\s-1CMS_REUSE_DIGEST\s0\fR and \fB\s-1CMS_PARTIAL\s0\fR flags
 169 are both set.
 170 .SH "NOTES"
 171 .IX Header "NOTES"
 172 The main purpose of \fICMS_add1_signer()\fR is to provide finer control
 173 over a \s-1CMS\s0 signed data structure where the simpler \fICMS_sign()\fR function defaults
 174 are not appropriate. For example if multiple signers or non default digest
 175 algorithms are needed. New attributes can also be added using the returned
 176 CMS_SignerInfo structure and the \s-1CMS\s0 attribute utility functions or the
 177 \&\s-1CMS\s0 signed receipt request functions.
 178 .PP
 179 Any of the following flags (ored together) can be passed in the \fBflags\fR
 180 parameter.
 181 .PP
 182 If \fB\s-1CMS_REUSE_DIGEST\s0\fR is set then an attempt is made to copy the content
 183 digest value from the CMS_ContentInfo structure: to add a signer to an existing
 184 structure.  An error occurs if a matching digest value cannot be found to copy.
 185 The returned CMS_ContentInfo structure will be valid and finalized when this
 186 flag is set.
 187 .PP
 188 If \fB\s-1CMS_PARTIAL\s0\fR is set in addition to \fB\s-1CMS_REUSE_DIGEST\s0\fR then the
 189 CMS_SignerInfo structure will not be finalized so additional attributes
 190 can be added. In this case an explicit call to \fICMS_SignerInfo_sign()\fR is
 191 needed to finalize it.
 192 .PP
 193 If \fB\s-1CMS_NOCERTS\s0\fR is set the signer's certificate will not be included in the
 194 CMS_ContentInfo structure, the signer's certificate must still be supplied in
 195 the \fBsigncert\fR parameter though. This can reduce the size of the signature if
 196 the signers certificate can be obtained by other means: for example a
 197 previously signed message.
 198 .PP
 199 The SignedData structure includes several \s-1CMS\s0 signedAttributes including the
 200 signing time, the \s-1CMS\s0 content type and the supported list of ciphers in an
 201 SMIMECapabilities attribute. If \fB\s-1CMS_NOATTR\s0\fR is set then no signedAttributes
 202 will be used. If \fB\s-1CMS_NOSMIMECAP\s0\fR is set then just the SMIMECapabilities are
 203 omitted.
 204 .PP
 205 OpenSSL will by default identify signing certificates using issuer name
 206 and serial number. If \fB\s-1CMS_USE_KEYID\s0\fR is set it will use the subject key
 207 identifier value instead. An error occurs if the signing certificate does not
 208 have a subject key identifier extension.
 209 .PP
 210 If present the SMIMECapabilities attribute indicates support for the following
 211 algorithms in preference order: 256 bit \s-1AES,\s0 Gost R3411\-94, Gost 28147\-89, 192
 212 bit \s-1AES, 128\s0 bit \s-1AES,\s0 triple \s-1DES, 128\s0 bit \s-1RC2, 64\s0 bit \s-1RC2, DES\s0 and 40 bit \s-1RC2.\s0
 213 If any of these algorithms is not available then it will not be included: for example the \s-1GOST\s0 algorithms will not be included if the \s-1GOST ENGINE\s0 is
 214 not loaded.
 215 .PP
 216 \&\fICMS_add1_signer()\fR returns an internal pointer to the CMS_SignerInfo
 217 structure just added, this can be used to set additional attributes
 218 before it is finalized.
 219 .SH "RETURN VALUES"
 220 .IX Header "RETURN VALUES"
 221 \&\fICMS_add1_signer()\fR returns an internal pointer to the CMS_SignerInfo
 222 structure just added or \s-1NULL\s0 if an error occurs.
 223 .SH "SEE ALSO"
 224 .IX Header "SEE ALSO"
 225 \&\fIERR_get_error\fR\|(3), \fICMS_sign\fR\|(3),
 226 \&\fICMS_final\fR\|(3),
 227 .SH "COPYRIGHT"
 228 .IX Header "COPYRIGHT"
 229 Copyright 2014\-2016 The OpenSSL Project Authors. All Rights Reserved.
 230 .PP
 231 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 232 this file except in compliance with the License.  You can obtain a copy
 233 in the file \s-1LICENSE\s0 in the source distribution or at
 234 <https://www.openssl.org/source/license.html>.