secure/lib/libcrypto/man/CMS_sign.3

   1 .\" Automatically generated by Pod::Man 4.07 (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_sign 3"
 132 .TH CMS_sign 3 "2018-03-27" "1.0.2o" "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 .Vb 1
 139 \& CMS_sign \- create a CMS SignedData structure
 140 .Ve
 141 .SH "SYNOPSIS"
 142 .IX Header "SYNOPSIS"
 143 .Vb 1
 144 \& #include <openssl/cms.h>
 145 \&
 146 \& CMS_ContentInfo *CMS_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, BIO *data, unsigned int flags);
 147 .Ve
 148 .SH "DESCRIPTION"
 149 .IX Header "DESCRIPTION"
 150 \&\fICMS_sign()\fR creates and returns a \s-1CMS\s0 SignedData structure. \fBsigncert\fR is
 151 the certificate to sign with, \fBpkey\fR is the corresponding private key.
 152 \&\fBcerts\fR is an optional additional set of certificates to include in the \s-1CMS\s0
 153 structure (for example any intermediate CAs in the chain). Any or all of
 154 these parameters can be \fB\s-1NULL\s0\fR, see \fB\s-1NOTES\s0\fR below.
 155 .PP
 156 The data to be signed is read from \s-1BIO \s0\fBdata\fR.
 157 .PP
 158 \&\fBflags\fR is an optional set of flags.
 159 .SH "NOTES"
 160 .IX Header "NOTES"
 161 Any of the following flags (ored together) can be passed in the \fBflags\fR
 162 parameter.
 163 .PP
 164 Many S/MIME clients expect the signed content to include valid \s-1MIME\s0 headers. If
 165 the \fB\s-1CMS_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are prepended
 166 to the data.
 167 .PP
 168 If \fB\s-1CMS_NOCERTS\s0\fR is set the signer's certificate will not be included in the
 169 CMS_ContentInfo structure, the signer's certificate must still be supplied in
 170 the \fBsigncert\fR parameter though. This can reduce the size of the signature if
 171 the signers certificate can be obtained by other means: for example a
 172 previously signed message.
 173 .PP
 174 The data being signed is included in the CMS_ContentInfo structure, unless
 175 \&\fB\s-1CMS_DETACHED\s0\fR is set in which case it is omitted. This is used for
 176 CMS_ContentInfo detached signatures which are used in S/MIME plaintext signed
 177 messages for example.
 178 .PP
 179 Normally the supplied content is translated into \s-1MIME\s0 canonical format (as
 180 required by the S/MIME specifications) if \fB\s-1CMS_BINARY\s0\fR is set no translation
 181 occurs. This option should be used if the supplied data is in binary format
 182 otherwise the translation will corrupt it.
 183 .PP
 184 The SignedData structure includes several \s-1CMS\s0 signedAttributes including the
 185 signing time, the \s-1CMS\s0 content type and the supported list of ciphers in an
 186 SMIMECapabilities attribute. If \fB\s-1CMS_NOATTR\s0\fR is set then no signedAttributes
 187 will be used. If \fB\s-1CMS_NOSMIMECAP\s0\fR is set then just the SMIMECapabilities are
 188 omitted.
 189 .PP
 190 If present the SMIMECapabilities attribute indicates support for the following
 191 algorithms in preference order: 256 bit \s-1AES,\s0 Gost R3411\-94, Gost 28147\-89, 192
 192 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
 193 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
 194 not loaded.
 195 .PP
 196 OpenSSL will by default identify signing certificates using issuer name
 197 and serial number. If \fB\s-1CMS_USE_KEYID\s0\fR is set it will use the subject key
 198 identifier value instead. An error occurs if the signing certificate does not
 199 have a subject key identifier extension.
 200 .PP
 201 If the flags \fB\s-1CMS_STREAM\s0\fR is set then the returned \fBCMS_ContentInfo\fR
 202 structure is just initialized ready to perform the signing operation. The
 203 signing is however \fBnot\fR performed and the data to be signed is not read from
 204 the \fBdata\fR parameter. Signing is deferred until after the data has been
 205 written. In this way data can be signed in a single pass.
 206 .PP
 207 If the \fB\s-1CMS_PARTIAL\s0\fR flag is set a partial \fBCMS_ContentInfo\fR structure is
 208 output to which additional signers and capabilities can be added before
 209 finalization.
 210 .PP
 211 If the flag \fB\s-1CMS_STREAM\s0\fR is set the returned \fBCMS_ContentInfo\fR structure is
 212 \&\fBnot\fR complete and outputting its contents via a function that does not
 213 properly finalize the \fBCMS_ContentInfo\fR structure will give unpredictable
 214 results.
 215 .PP
 216 Several functions including \fISMIME_write_CMS()\fR, \fIi2d_CMS_bio_stream()\fR,
 217 \&\fIPEM_write_bio_CMS_stream()\fR finalize the structure. Alternatively finalization
 218 can be performed by obtaining the streaming \s-1ASN1 \s0\fB\s-1BIO\s0\fR directly using
 219 \&\fIBIO_new_CMS()\fR.
 220 .PP
 221 If a signer is specified it will use the default digest for the signing
 222 algorithm. This is \fB\s-1SHA1\s0\fR for both \s-1RSA\s0 and \s-1DSA\s0 keys.
 223 .PP
 224 If \fBsigncert\fR and \fBpkey\fR are \s-1NULL\s0 then a certificates only \s-1CMS\s0 structure is
 225 output.
 226 .PP
 227 The function \fICMS_sign()\fR is a basic \s-1CMS\s0 signing function whose output will be
 228 suitable for many purposes. For finer control of the output format the
 229 \&\fBcerts\fR, \fBsigncert\fR and \fBpkey\fR parameters can all be \fB\s-1NULL\s0\fR and the
 230 \&\fB\s-1CMS_PARTIAL\s0\fR flag set. Then one or more signers can be added using the
 231 function \fICMS_sign_add1_signer()\fR, non default digests can be used and custom
 232 attributes added. \fB\f(BICMS_final()\fB\fR must then be called to finalize the
 233 structure if streaming is not enabled.
 234 .SH "BUGS"
 235 .IX Header "BUGS"
 236 Some attributes such as counter signatures are not supported.
 237 .SH "RETURN VALUES"
 238 .IX Header "RETURN VALUES"
 239 \&\fICMS_sign()\fR returns either a valid CMS_ContentInfo structure or \s-1NULL\s0 if an error
 240 occurred. The error can be obtained from \fIERR_get_error\fR\|(3).
 241 .SH "SEE ALSO"
 242 .IX Header "SEE ALSO"
 243 \&\fIERR_get_error\fR\|(3), \fICMS_verify\fR\|(3)
 244 .SH "HISTORY"
 245 .IX Header "HISTORY"
 246 \&\fICMS_sign()\fR was added to OpenSSL 0.9.8
 247 .PP
 248 The \fB\s-1CMS_STREAM\s0\fR flag is only supported for detached data in OpenSSL 0.9.8,
 249 it is supported for embedded data in OpenSSL 1.0.0 and later.