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