secure/lib/libcrypto/man/PKCS7_sign.3

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   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 turned on, 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 "2015-12-03" "0.9.8zh" "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, BIO *data, int flags);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fIPKCS7_sign()\fR creates and returns a PKCS#7 signedData structure. \fBsigncert\fR
 153 is the certificate to sign with, \fBpkey\fR is the corresponsding private key.
 154 \&\fBcerts\fR is an optional additional set of certificates to include in the
 155 PKCS#7 structure (for example any intermediate CAs in the chain).
 156 .PP
 157 The data to be signed is read from \s-1BIO \s0\fBdata\fR.
 158 .PP
 159 \&\fBflags\fR is an optional set of flags.
 160 .SH "NOTES"
 161 .IX Header "NOTES"
 162 Any of the following flags (ored together) can be passed in the \fBflags\fR parameter.
 163 .PP
 164 Many S/MIME clients expect the signed content to include valid \s-1MIME\s0 headers. If
 165 the \fB\s-1PKCS7_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-1PKCS7_NOCERTS\s0\fR is set the signer's certificate will not be included in the
 169 \&\s-1PKCS7\s0 structure, the signer's certificate must still be supplied in the \fBsigncert\fR
 170 parameter though. This can reduce the size of the signature if the signers certificate
 171 can be obtained by other means: for example a previously signed message.
 172 .PP
 173 The data being signed is included in the \s-1PKCS7\s0 structure, unless \fB\s-1PKCS7_DETACHED\s0\fR
 174 is set in which case it is omitted. This is used for \s-1PKCS7\s0 detached signatures
 175 which are used in S/MIME plaintext signed messages for example.
 176 .PP
 177 Normally the supplied content is translated into \s-1MIME\s0 canonical format (as required
 178 by the S/MIME specifications) if \fB\s-1PKCS7_BINARY\s0\fR is set no translation occurs. This
 179 option should be used if the supplied data is in binary format otherwise the translation
 180 will corrupt it.
 181 .PP
 182 The signedData structure includes several PKCS#7 autenticatedAttributes including
 183 the signing time, the PKCS#7 content type and the supported list of ciphers in
 184 an SMIMECapabilities attribute. If \fB\s-1PKCS7_NOATTR\s0\fR is set then no authenticatedAttributes
 185 will be used. If \fB\s-1PKCS7_NOSMIMECAP\s0\fR is set then just the SMIMECapabilities are
 186 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
 190 of these algorithms is disabled then it will not be included.
 191 .PP
 192 If the flags \fB\s-1PKCS7_PARTSIGN\s0\fR is set then the returned \fB\s-1PKCS7\s0\fR structure
 193 is just initialized ready to perform the signing operation. The signing
 194 is however \fBnot\fR performed and the data to be signed is not read from
 195 the \fBdata\fR parameter. Signing is deferred until after the data has been
 196 written. In this way data can be signed in a single pass. Currently the
 197 flag \fB\s-1PKCS7_DETACHED\s0\fR \fBmust\fR also be set.
 198 .SH "NOTES"
 199 .IX Header "NOTES"
 200 Currently the flag \fB\s-1PKCS7_PARTSIGN\s0\fR is only supported for detached
 201 data. If this flag is set the returned \fB\s-1PKCS7\s0\fR structure is \fBnot\fR
 202 complete and outputting its contents via a function that does not
 203 properly finalize the \fB\s-1PKCS7\s0\fR structure will give unpredictable
 204 results.
 205 .PP
 206 At present only the \fISMIME_write_PKCS7()\fR function properly finalizes the
 207 structure.
 208 .SH "BUGS"
 209 .IX Header "BUGS"
 210 \&\fIPKCS7_sign()\fR is somewhat limited. It does not support multiple signers, some
 211 advanced attributes such as counter signatures are not supported.
 212 .PP
 213 The \s-1SHA1\s0 digest algorithm is currently always used.
 214 .PP
 215 When the signed data is not detached it will be stored in memory within the
 216 \&\fB\s-1PKCS7\s0\fR structure. This effectively limits the size of messages which can be
 217 signed due to memory restraints. There should be a way to sign data without
 218 having to hold it all in memory, this would however require fairly major
 219 revisions of the OpenSSL \s-1ASN1\s0 code.
 220 .SH "RETURN VALUES"
 221 .IX Header "RETURN VALUES"
 222 \&\fIPKCS7_sign()\fR returns either a valid \s-1PKCS7\s0 structure or \s-1NULL\s0 if an error occurred.
 223 The error can be obtained from \fIERR_get_error\fR\|(3).
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fIERR_get_error\fR\|(3), \fIPKCS7_verify\fR\|(3)
 227 .SH "HISTORY"
 228 .IX Header "HISTORY"
 229 \&\fIPKCS7_sign()\fR was added to OpenSSL 0.9.5
 230 .PP
 231 The \fB\s-1PKCS7_PARTSIGN\s0\fR flag was added in OpenSSL 0.9.8