secure/lib/libcrypto/man/PKCS7_sign.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   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 "PKCS7_SIGN 3"
 136 .TH PKCS7_SIGN 3 "2019-09-10" "1.1.1d" "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 PKCS7_sign \- create a PKCS#7 signedData structure
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/pkcs7.h>
 147 \&
 148 \& PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs,
 149 \&                   BIO *data, int flags);
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 \&\fBPKCS7_sign()\fR creates and returns a PKCS#7 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 PKCS#7
 156 structure (for example any intermediate CAs in the chain).
 157 .PP
 158 The data to be signed is read from \s-1BIO\s0 \fBdata\fR.
 159 .PP
 160 \&\fBflags\fR is an optional set of flags.
 161 .SH "NOTES"
 162 .IX Header "NOTES"
 163 Any of the following flags (ored together) can be passed in the \fBflags\fR
 164 parameter.
 165 .PP
 166 Many S/MIME clients expect the signed content to include valid \s-1MIME\s0 headers. If
 167 the \fB\s-1PKCS7_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are prepended
 168 to the data.
 169 .PP
 170 If \fB\s-1PKCS7_NOCERTS\s0\fR is set the signer's certificate will not be included in the
 171 \&\s-1PKCS7\s0 structure, the signer's certificate must still be supplied in the
 172 \&\fBsigncert\fR parameter though. This can reduce the size of the signature if the
 173 signers certificate can be obtained by other means: for example a previously
 174 signed message.
 175 .PP
 176 The data being signed is included in the \s-1PKCS7\s0 structure, unless
 177 \&\fB\s-1PKCS7_DETACHED\s0\fR is set in which case it is omitted. This is used for \s-1PKCS7\s0
 178 detached signatures which are used in S/MIME plaintext signed messages for
 179 example.
 180 .PP
 181 Normally the supplied content is translated into \s-1MIME\s0 canonical format (as
 182 required by the S/MIME specifications) if \fB\s-1PKCS7_BINARY\s0\fR is set no translation
 183 occurs. This option should be used if the supplied data is in binary format
 184 otherwise the translation will corrupt it.
 185 .PP
 186 The signedData structure includes several PKCS#7 authenticatedAttributes
 187 including the signing time, the PKCS#7 content type and the supported list of
 188 ciphers in an SMIMECapabilities attribute. If \fB\s-1PKCS7_NOATTR\s0\fR is set then no
 189 authenticatedAttributes will be used. If \fB\s-1PKCS7_NOSMIMECAP\s0\fR is set then just
 190 the SMIMECapabilities are omitted.
 191 .PP
 192 If present the SMIMECapabilities attribute indicates support for the following
 193 algorithms: triple \s-1DES, 128\s0 bit \s-1RC2, 64\s0 bit \s-1RC2, DES\s0 and 40 bit \s-1RC2.\s0 If any of
 194 these algorithms is disabled then it will not be included.
 195 .PP
 196 If the flags \fB\s-1PKCS7_STREAM\s0\fR is set then the returned \fB\s-1PKCS7\s0\fR structure is
 197 just initialized ready to perform the signing operation. The signing is however
 198 \&\fBnot\fR performed and the data to be signed is not read from the \fBdata\fR
 199 parameter. Signing is deferred until after the data has been written. In this
 200 way data can be signed in a single pass.
 201 .PP
 202 If the \fB\s-1PKCS7_PARTIAL\s0\fR flag is set a partial \fB\s-1PKCS7\s0\fR structure is output to
 203 which additional signers and capabilities can be added before finalization.
 204 .SH "NOTES"
 205 .IX Header "NOTES"
 206 If the flag \fB\s-1PKCS7_STREAM\s0\fR is set the returned \fB\s-1PKCS7\s0\fR structure is \fBnot\fR
 207 complete and outputting its contents via a function that does not properly
 208 finalize the \fB\s-1PKCS7\s0\fR structure will give unpredictable results.
 209 .PP
 210 Several functions including \fBSMIME_write_PKCS7()\fR, \fBi2d_PKCS7_bio_stream()\fR,
 211 \&\fBPEM_write_bio_PKCS7_stream()\fR finalize the structure. Alternatively finalization
 212 can be performed by obtaining the streaming \s-1ASN1\s0 \fB\s-1BIO\s0\fR directly using
 213 \&\fBBIO_new_PKCS7()\fR.
 214 .PP
 215 If a signer is specified it will use the default digest for the signing
 216 algorithm. This is \fB\s-1SHA1\s0\fR for both \s-1RSA\s0 and \s-1DSA\s0 keys.
 217 .PP
 218 The \fBcerts\fR, \fBsigncert\fR and \fBpkey\fR parameters can all be
 219 \&\fB\s-1NULL\s0\fR if the \fB\s-1PKCS7_PARTIAL\s0\fR flag is set. One or more signers can be added
 220 using the function \fBPKCS7_sign_add_signer()\fR. \fBPKCS7_final()\fR must also be
 221 called to finalize the structure if streaming is not enabled. Alternative
 222 signing digests can also be specified using this method.
 223 .PP
 224 If \fBsigncert\fR and \fBpkey\fR are \s-1NULL\s0 then a certificates only
 225 PKCS#7 structure is output.
 226 .PP
 227 In versions of OpenSSL before 1.0.0 the \fBsigncert\fR and \fBpkey\fR parameters must
 228 \&\fB\s-1NOT\s0\fR be \s-1NULL.\s0
 229 .SH "BUGS"
 230 .IX Header "BUGS"
 231 Some advanced attributes such as counter signatures are not supported.
 232 .SH "RETURN VALUES"
 233 .IX Header "RETURN VALUES"
 234 \&\fBPKCS7_sign()\fR returns either a valid \s-1PKCS7\s0 structure or \s-1NULL\s0 if an error
 235 occurred.  The error can be obtained from \fBERR_get_error\fR\|(3).
 236 .SH "SEE ALSO"
 237 .IX Header "SEE ALSO"
 238 \&\fBERR_get_error\fR\|(3), \fBPKCS7_verify\fR\|(3)
 239 .SH "HISTORY"
 240 .IX Header "HISTORY"
 241 The \fB\s-1PKCS7_PARTIAL\s0\fR flag, and the ability for \fBcerts\fR, \fBsigncert\fR,
 242 and \fBpkey\fR parameters to be \fB\s-1NULL\s0\fR were added in OpenSSL 1.0.0.
 243 .PP
 244 The \fB\s-1PKCS7_STREAM\s0\fR flag was added in OpenSSL 1.0.0.
 245 .SH "COPYRIGHT"
 246 .IX Header "COPYRIGHT"
 247 Copyright 2002\-2016 The OpenSSL Project Authors. All Rights Reserved.
 248 .PP
 249 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 250 this file except in compliance with the License.  You can obtain a copy
 251 in the file \s-1LICENSE\s0 in the source distribution or at
 252 <https://www.openssl.org/source/license.html>.