secure/lib/libcrypto/man/EVP_SealInit.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   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.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  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 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  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 "EVP_SealInit 3"
 132 .TH EVP_SealInit 3 "2006-11-19" "0.9.8d" "OpenSSL"
 133 .SH "NAME"
 134 EVP_SealInit, EVP_SealUpdate, EVP_SealFinal \- EVP envelope encryption
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& #include <openssl/evp.h>
 139 .Ve
 140 .PP
 141 .Vb 7
 142 \& int EVP_SealInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
 143 \&                  unsigned char **ek, int *ekl, unsigned char *iv,
 144 \&                  EVP_PKEY **pubk, int npubk);
 145 \& int EVP_SealUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
 146 \&         int *outl, unsigned char *in, int inl);
 147 \& int EVP_SealFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
 148 \&         int *outl);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 The \s-1EVP\s0 envelope routines are a high level interface to envelope
 153 encryption. They generate a random key and \s-1IV\s0 (if required) then
 154 \&\*(L"envelope\*(R" it by using public key encryption. Data can then be
 155 encrypted using this key.
 156 .PP
 157 \&\fIEVP_SealInit()\fR initializes a cipher context \fBctx\fR for encryption
 158 with cipher \fBtype\fR using a random secret key and \s-1IV\s0. \fBtype\fR is normally
 159 supplied by a function such as \fIEVP_des_cbc()\fR. The secret key is encrypted
 160 using one or more public keys, this allows the same encrypted data to be
 161 decrypted using any of the corresponding private keys. \fBek\fR is an array of
 162 buffers where the public key encrypted secret key will be written, each buffer
 163 must contain enough room for the corresponding encrypted key: that is
 164 \&\fBek[i]\fR must have room for \fBEVP_PKEY_size(pubk[i])\fR bytes. The actual
 165 size of each encrypted secret key is written to the array \fBekl\fR. \fBpubk\fR is
 166 an array of \fBnpubk\fR public keys.
 167 .PP
 168 The \fBiv\fR parameter is a buffer where the generated \s-1IV\s0 is written to. It must
 169 contain enough room for the corresponding cipher's \s-1IV\s0, as determined by (for
 170 example) EVP_CIPHER_iv_length(type).
 171 .PP
 172 If the cipher does not require an \s-1IV\s0 then the \fBiv\fR parameter is ignored
 173 and can be \fB\s-1NULL\s0\fR.
 174 .PP
 175 \&\fIEVP_SealUpdate()\fR and \fIEVP_SealFinal()\fR have exactly the same properties
 176 as the \fIEVP_EncryptUpdate()\fR and \fIEVP_EncryptFinal()\fR routines, as
 177 documented on the \fIEVP_EncryptInit\fR\|(3) manual
 178 page.
 179 .SH "RETURN VALUES"
 180 .IX Header "RETURN VALUES"
 181 \&\fIEVP_SealInit()\fR returns 0 on error or \fBnpubk\fR if successful.
 182 .PP
 183 \&\fIEVP_SealUpdate()\fR and \fIEVP_SealFinal()\fR return 1 for success and 0 for
 184 failure.
 185 .SH "NOTES"
 186 .IX Header "NOTES"
 187 Because a random secret key is generated the random number generator
 188 must be seeded before calling \fIEVP_SealInit()\fR.
 189 .PP
 190 The public key must be \s-1RSA\s0 because it is the only OpenSSL public key
 191 algorithm that supports key transport.
 192 .PP
 193 Envelope encryption is the usual method of using public key encryption
 194 on large amounts of data, this is because public key encryption is slow
 195 but symmetric encryption is fast. So symmetric encryption is used for
 196 bulk encryption and the small random symmetric key used is transferred
 197 using public key encryption.
 198 .PP
 199 It is possible to call \fIEVP_SealInit()\fR twice in the same way as
 200 \&\fIEVP_EncryptInit()\fR. The first call should have \fBnpubk\fR set to 0
 201 and (after setting any cipher parameters) it should be called again
 202 with \fBtype\fR set to \s-1NULL\s0.
 203 .SH "SEE ALSO"
 204 .IX Header "SEE ALSO"
 205 \&\fIevp\fR\|(3), \fIrand\fR\|(3),
 206 \&\fIEVP_EncryptInit\fR\|(3),
 207 \&\fIEVP_OpenInit\fR\|(3)
 208 .SH "HISTORY"
 209 .IX Header "HISTORY"
 210 \&\fIEVP_SealFinal()\fR did not return a value before OpenSSL 0.9.7.