secure/lib/libcrypto/man/man3/CMS_sign.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "CMS_SIGN 3"
 136 .TH CMS_SIGN 3 "2020-03-17" "1.1.1e" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 CMS_sign \- create a CMS SignedData structure
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/cms.h>
 147 \&
 148 \& CMS_ContentInfo *CMS_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs,
 149 \&                           BIO *data, unsigned int flags);
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 \&\fBCMS_sign()\fR creates and returns a \s-1CMS\s0 SignedData structure. \fBsigncert\fR is
 154 the certificate to sign with, \fBpkey\fR is the corresponding private key.
 155 \&\fBcerts\fR is an optional additional set of certificates to include in the \s-1CMS\s0
 156 structure (for example any intermediate CAs in the chain). Any or all of
 157 these parameters can be \fB\s-1NULL\s0\fR, see \fB\s-1NOTES\s0\fR below.
 158 .PP
 159 The data to be signed is read from \s-1BIO\s0 \fBdata\fR.
 160 .PP
 161 \&\fBflags\fR is an optional set of flags.
 162 .SH "NOTES"
 163 .IX Header "NOTES"
 164 Any of the following flags (ored together) can be passed in the \fBflags\fR
 165 parameter.
 166 .PP
 167 Many S/MIME clients expect the signed content to include valid \s-1MIME\s0 headers. If
 168 the \fB\s-1CMS_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are prepended
 169 to the data.
 170 .PP
 171 If \fB\s-1CMS_NOCERTS\s0\fR is set the signer's certificate will not be included in the
 172 CMS_ContentInfo structure, the signer's certificate must still be supplied in
 173 the \fBsigncert\fR parameter though. This can reduce the size of the signature if
 174 the signers certificate can be obtained by other means: for example a
 175 previously signed message.
 176 .PP
 177 The data being signed is included in the CMS_ContentInfo structure, unless
 178 \&\fB\s-1CMS_DETACHED\s0\fR is set in which case it is omitted. This is used for
 179 CMS_ContentInfo detached signatures which are used in S/MIME plaintext signed
 180 messages for example.
 181 .PP
 182 Normally the supplied content is translated into \s-1MIME\s0 canonical format (as
 183 required by the S/MIME specifications) if \fB\s-1CMS_BINARY\s0\fR is set no translation
 184 occurs. This option should be used if the supplied data is in binary format
 185 otherwise the translation will corrupt it.
 186 .PP
 187 The SignedData structure includes several \s-1CMS\s0 signedAttributes including the
 188 signing time, the \s-1CMS\s0 content type and the supported list of ciphers in an
 189 SMIMECapabilities attribute. If \fB\s-1CMS_NOATTR\s0\fR is set then no signedAttributes
 190 will be used. If \fB\s-1CMS_NOSMIMECAP\s0\fR is set then just the SMIMECapabilities are
 191 omitted.
 192 .PP
 193 If present the SMIMECapabilities attribute indicates support for the following
 194 algorithms in preference order: 256 bit \s-1AES,\s0 Gost R3411\-94, Gost 28147\-89, 192
 195 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
 196 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
 197 not loaded.
 198 .PP
 199 OpenSSL will by default identify signing certificates using issuer name
 200 and serial number. If \fB\s-1CMS_USE_KEYID\s0\fR is set it will use the subject key
 201 identifier value instead. An error occurs if the signing certificate does not
 202 have a subject key identifier extension.
 203 .PP
 204 If the flags \fB\s-1CMS_STREAM\s0\fR is set then the returned \fBCMS_ContentInfo\fR
 205 structure is just initialized ready to perform the signing operation. The
 206 signing is however \fBnot\fR performed and the data to be signed is not read from
 207 the \fBdata\fR parameter. Signing is deferred until after the data has been
 208 written. In this way data can be signed in a single pass.
 209 .PP
 210 If the \fB\s-1CMS_PARTIAL\s0\fR flag is set a partial \fBCMS_ContentInfo\fR structure is
 211 output to which additional signers and capabilities can be added before
 212 finalization.
 213 .PP
 214 If the flag \fB\s-1CMS_STREAM\s0\fR is set the returned \fBCMS_ContentInfo\fR structure is
 215 \&\fBnot\fR complete and outputting its contents via a function that does not
 216 properly finalize the \fBCMS_ContentInfo\fR structure will give unpredictable
 217 results.
 218 .PP
 219 Several functions including \fBSMIME_write_CMS()\fR, \fBi2d_CMS_bio_stream()\fR,
 220 \&\fBPEM_write_bio_CMS_stream()\fR finalize the structure. Alternatively finalization
 221 can be performed by obtaining the streaming \s-1ASN1\s0 \fB\s-1BIO\s0\fR directly using
 222 \&\fBBIO_new_CMS()\fR.
 223 .PP
 224 If a signer is specified it will use the default digest for the signing
 225 algorithm. This is \fB\s-1SHA1\s0\fR for both \s-1RSA\s0 and \s-1DSA\s0 keys.
 226 .PP
 227 If \fBsigncert\fR and \fBpkey\fR are \s-1NULL\s0 then a certificates only \s-1CMS\s0 structure is
 228 output.
 229 .PP
 230 The function \fBCMS_sign()\fR is a basic \s-1CMS\s0 signing function whose output will be
 231 suitable for many purposes. For finer control of the output format the
 232 \&\fBcerts\fR, \fBsigncert\fR and \fBpkey\fR parameters can all be \fB\s-1NULL\s0\fR and the
 233 \&\fB\s-1CMS_PARTIAL\s0\fR flag set. Then one or more signers can be added using the
 234 function \fBCMS_sign_add1_signer()\fR, non default digests can be used and custom
 235 attributes added. \fBCMS_final()\fR must then be called to finalize the
 236 structure if streaming is not enabled.
 237 .SH "BUGS"
 238 .IX Header "BUGS"
 239 Some attributes such as counter signatures are not supported.
 240 .SH "RETURN VALUES"
 241 .IX Header "RETURN VALUES"
 242 \&\fBCMS_sign()\fR returns either a valid CMS_ContentInfo structure or \s-1NULL\s0 if an error
 243 occurred. The error can be obtained from \fBERR_get_error\fR\|(3).
 244 .SH "SEE ALSO"
 245 .IX Header "SEE ALSO"
 246 \&\fBERR_get_error\fR\|(3), \fBCMS_verify\fR\|(3)
 247 .SH "HISTORY"
 248 .IX Header "HISTORY"
 249 The \fB\s-1CMS_STREAM\s0\fR flag is only supported for detached data in OpenSSL 0.9.8,
 250 it is supported for embedded data in OpenSSL 1.0.0 and later.
 251 .SH "COPYRIGHT"
 252 .IX Header "COPYRIGHT"
 253 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
 254 .PP
 255 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 256 this file except in compliance with the License.  You can obtain a copy
 257 in the file \s-1LICENSE\s0 in the source distribution or at
 258 <https://www.openssl.org/source/license.html>.