secure/lib/libcrypto/man/CMS_decrypt.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 "CMS_DECRYPT 3"
 132 .TH CMS_DECRYPT 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 CMS_decrypt \- decrypt content from a CMS envelopedData structure
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/cms.h>
 143 \&
 144 \& int CMS_decrypt(CMS_ContentInfo *cms, EVP_PKEY *pkey, X509 *cert,
 145 \&                 BIO *dcont, BIO *out, unsigned int flags);
 146 .Ve
 147 .SH "DESCRIPTION"
 148 .IX Header "DESCRIPTION"
 149 \&\fICMS_decrypt()\fR extracts and decrypts the content from a \s-1CMS\s0 EnvelopedData
 150 structure. \fBpkey\fR is the private key of the recipient, \fBcert\fR is the
 151 recipient's certificate, \fBout\fR is a \s-1BIO\s0 to write the content to and
 152 \&\fBflags\fR is an optional set of flags.
 153 .PP
 154 The \fBdcont\fR parameter is used in the rare case where the encrypted content
 155 is detached. It will normally be set to \s-1NULL.\s0
 156 .SH "NOTES"
 157 .IX Header "NOTES"
 158 Although the recipients certificate is not needed to decrypt the data it is
 159 needed to locate the appropriate (of possible several) recipients in the \s-1CMS\s0
 160 structure.
 161 .PP
 162 If \fBcert\fR is set to \s-1NULL\s0 all possible recipients are tried. This case however
 163 is problematic. To thwart the \s-1MMA\s0 attack (Bleichenbacher's attack on
 164 \&\s-1PKCS\s0 #1 v1.5 \s-1RSA\s0 padding) all recipients are tried whether they succeed or
 165 not. If no recipient succeeds then a random symmetric key is used to decrypt
 166 the content: this will typically output garbage and may (but is not guaranteed
 167 to) ultimately return a padding error only. If \fICMS_decrypt()\fR just returned an
 168 error when all recipient encrypted keys failed to decrypt an attacker could
 169 use this in a timing attack. If the special flag \fB\s-1CMS_DEBUG_DECRYPT\s0\fR is set
 170 then the above behaviour is modified and an error \fBis\fR returned if no
 171 recipient encrypted key can be decrypted \fBwithout\fR generating a random
 172 content encryption key. Applications should use this flag with
 173 \&\fBextreme caution\fR especially in automated gateways as it can leave them
 174 open to attack.
 175 .PP
 176 It is possible to determine the correct recipient key by other means (for
 177 example looking them up in a database) and setting them in the \s-1CMS\s0 structure
 178 in advance using the \s-1CMS\s0 utility functions such as \fICMS_set1_pkey()\fR. In this
 179 case both \fBcert\fR and \fBpkey\fR should be set to \s-1NULL.\s0
 180 .PP
 181 To process KEKRecipientInfo types \fICMS_set1_key()\fR or \fICMS_RecipientInfo_set0_key()\fR
 182 and \fICMS_RecipientInfo_decrypt()\fR should be called before \fICMS_decrypt()\fR and
 183 \&\fBcert\fR and \fBpkey\fR set to \s-1NULL.\s0
 184 .PP
 185 The following flags can be passed in the \fBflags\fR parameter.
 186 .PP
 187 If the \fB\s-1CMS_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are deleted
 188 from the content. If the content is not of type \fBtext/plain\fR then an error is
 189 returned.
 190 .SH "RETURN VALUES"
 191 .IX Header "RETURN VALUES"
 192 \&\fICMS_decrypt()\fR returns either 1 for success or 0 for failure.
 193 The error can be obtained from \fIERR_get_error\fR\|(3)
 194 .SH "BUGS"
 195 .IX Header "BUGS"
 196 The lack of single pass processing and the need to hold all data in memory as
 197 mentioned in \fICMS_verify()\fR also applies to \fICMS_decrypt()\fR.
 198 .SH "SEE ALSO"
 199 .IX Header "SEE ALSO"
 200 \&\fIERR_get_error\fR\|(3), \fICMS_encrypt\fR\|(3)
 201 .SH "COPYRIGHT"
 202 .IX Header "COPYRIGHT"
 203 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
 204 .PP
 205 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 206 this file except in compliance with the License.  You can obtain a copy
 207 in the file \s-1LICENSE\s0 in the source distribution or at
 208 <https://www.openssl.org/source/license.html>.