secure/lib/libcrypto/man/PKCS7_sign.3

   1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "PKCS7_sign 3"
 127 .TH PKCS7_sign 3 "2007-10-24" "0.9.8g" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 PKCS7_sign \- create a PKCS#7 signedData structure
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 \&\s-1PKCS7\s0 *PKCS7_sign(X509 *signcert, \s-1EVP_PKEY\s0 *pkey, \s-1STACK_OF\s0(X509) *certs, \s-1BIO\s0 *data, int flags);
 137 .SH "DESCRIPTION"
 138 .IX Header "DESCRIPTION"
 139 \&\fIPKCS7_sign()\fR creates and returns a PKCS#7 signedData structure. \fBsigncert\fR
 140 is the certificate to sign with, \fBpkey\fR is the corresponsding private key.
 141 \&\fBcerts\fR is an optional additional set of certificates to include in the
 142 PKCS#7 structure (for example any intermediate CAs in the chain).
 143 .PP
 144 The data to be signed is read from \s-1BIO\s0 \fBdata\fR.
 145 .PP
 146 \&\fBflags\fR is an optional set of flags.
 147 .SH "NOTES"
 148 .IX Header "NOTES"
 149 Any of the following flags (ored together) can be passed in the \fBflags\fR parameter.
 150 .PP
 151 Many S/MIME clients expect the signed content to include valid \s-1MIME\s0 headers. If
 152 the \fB\s-1PKCS7_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are prepended
 153 to the data.
 154 .PP
 155 If \fB\s-1PKCS7_NOCERTS\s0\fR is set the signer's certificate will not be included in the
 156 \&\s-1PKCS7\s0 structure, the signer's certificate must still be supplied in the \fBsigncert\fR
 157 parameter though. This can reduce the size of the signature if the signers certificate
 158 can be obtained by other means: for example a previously signed message.
 159 .PP
 160 The data being signed is included in the \s-1PKCS7\s0 structure, unless \fB\s-1PKCS7_DETACHED\s0\fR
 161 is set in which case it is omitted. This is used for \s-1PKCS7\s0 detached signatures
 162 which are used in S/MIME plaintext signed messages for example.
 163 .PP
 164 Normally the supplied content is translated into \s-1MIME\s0 canonical format (as required
 165 by the S/MIME specifications) if \fB\s-1PKCS7_BINARY\s0\fR is set no translation occurs. This
 166 option should be used if the supplied data is in binary format otherwise the translation
 167 will corrupt it.
 168 .PP
 169 The signedData structure includes several PKCS#7 autenticatedAttributes including
 170 the signing time, the PKCS#7 content type and the supported list of ciphers in
 171 an SMIMECapabilities attribute. If \fB\s-1PKCS7_NOATTR\s0\fR is set then no authenticatedAttributes
 172 will be used. If \fB\s-1PKCS7_NOSMIMECAP\s0\fR is set then just the SMIMECapabilities are
 173 omitted.
 174 .PP
 175 If present the SMIMECapabilities attribute indicates support for the following
 176 algorithms: triple \s-1DES\s0, 128 bit \s-1RC2\s0, 64 bit \s-1RC2\s0, \s-1DES\s0 and 40 bit \s-1RC2\s0. If any
 177 of these algorithms is disabled then it will not be included.
 178 .PP
 179 If the flags \fB\s-1PKCS7_PARTSIGN\s0\fR is set then the returned \fB\s-1PKCS7\s0\fR structure
 180 is just initialized ready to perform the signing operation. The signing
 181 is however \fBnot\fR performed and the data to be signed is not read from
 182 the \fBdata\fR parameter. Signing is deferred until after the data has been
 183 written. In this way data can be signed in a single pass. Currently the
 184 flag \fB\s-1PKCS7_DETACHED\s0\fR \fBmust\fR also be set.
 185 .SH "NOTES"
 186 .IX Header "NOTES"
 187 Currently the flag \fB\s-1PKCS7_PARTSIGN\s0\fR is only supported for detached
 188 data. If this flag is set the returned \fB\s-1PKCS7\s0\fR structure is \fBnot\fR
 189 complete and outputting its contents via a function that does not
 190 properly finalize the \fB\s-1PKCS7\s0\fR structure will give unpredictable
 191 results.
 192 .PP
 193 At present only the \fISMIME_write_PKCS7()\fR function properly finalizes the
 194 structure.
 195 .SH "BUGS"
 196 .IX Header "BUGS"
 197 \&\fIPKCS7_sign()\fR is somewhat limited. It does not support multiple signers, some
 198 advanced attributes such as counter signatures are not supported.
 199 .PP
 200 The \s-1SHA1\s0 digest algorithm is currently always used.
 201 .PP
 202 When the signed data is not detached it will be stored in memory within the
 203 \&\fB\s-1PKCS7\s0\fR structure. This effectively limits the size of messages which can be
 204 signed due to memory restraints. There should be a way to sign data without
 205 having to hold it all in memory, this would however require fairly major
 206 revisions of the OpenSSL \s-1ASN1\s0 code.
 207 .SH "RETURN VALUES"
 208 .IX Header "RETURN VALUES"
 209 \&\fIPKCS7_sign()\fR returns either a valid \s-1PKCS7\s0 structure or \s-1NULL\s0 if an error occurred.
 210 The error can be obtained from \fIERR_get_error\fR\|(3).
 211 .SH "SEE ALSO"
 212 .IX Header "SEE ALSO"
 213 \&\fIERR_get_error\fR\|(3), \fIPKCS7_verify\fR\|(3)
 214 .SH "HISTORY"
 215 .IX Header "HISTORY"
 216 \&\fIPKCS7_sign()\fR was added to OpenSSL 0.9.5
 217 .PP
 218 The \fB\s-1PKCS7_PARTSIGN\s0\fR flag was added in OpenSSL 0.9.8