lib/libcrypto/man/evp.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 "evp 3"
 136 .TH evp 3 "2016-05-03" "1.0.2h" "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 evp \- high\-level cryptographic functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/evp.h>
 147 .Ve
 148 .SH "DESCRIPTION"
 149 .IX Header "DESCRIPTION"
 150 The \s-1EVP\s0 library provides a high-level interface to cryptographic
 151 functions.
 152 .PP
 153 \&\fBEVP_Seal\fR\fI...\fR and \fBEVP_Open\fR\fI...\fR
 154 provide public key encryption and decryption to implement digital \*(L"envelopes\*(R".
 155 .PP
 156 The \fBEVP_DigestSign\fR\fI...\fR and
 157 \&\fBEVP_DigestVerify\fR\fI...\fR functions implement
 158 digital signatures and Message Authentication Codes (MACs). Also see the older
 159 \&\fBEVP_Sign\fR\fI...\fR and \fBEVP_Verify\fR\fI...\fR
 160 functions.
 161 .PP
 162 Symmetric encryption is available with the \fBEVP_Encrypt\fR\fI...\fR
 163 functions.  The \fBEVP_Digest\fR\fI...\fR functions provide message digests.
 164 .PP
 165 The \fB\s-1EVP_PKEY\s0\fR\fI...\fR functions provide a high level interface to
 166 asymmetric algorithms. To create a new \s-1EVP_PKEY\s0 see
 167 \&\fIEVP_PKEY_new\fR\|(3). EVP_PKEYs can be associated
 168 with a private key of a particular algorithm by using the functions
 169 described on the \fIEVP_PKEY_set1_RSA\fR\|(3) page, or
 170 new keys can be generated using \fIEVP_PKEY_keygen\fR\|(3).
 171 EVP_PKEYs can be compared using \fIEVP_PKEY_cmp\fR\|(3), or printed using
 172 \&\fIEVP_PKEY_print_private\fR\|(3).
 173 .PP
 174 The \s-1EVP_PKEY\s0 functions support the full range of asymmetric algorithm operations:
 175 .IP "For key agreement see \fIEVP_PKEY_derive\fR\|(3)" 4
 176 .IX Item "For key agreement see EVP_PKEY_derive"
 177 .PD 0
 178 .IP "For signing and verifying see \fIEVP_PKEY_sign\fR\|(3), \fIEVP_PKEY_verify\fR\|(3) and \fIEVP_PKEY_verify_recover\fR\|(3). However, note that these functions do not perform a digest of the data to be signed. Therefore normally you would use the \fBEVP_DigestSign\fR\fI...\fR functions for this purpose." 4
 179 .IX Item "For signing and verifying see EVP_PKEY_sign, EVP_PKEY_verify and EVP_PKEY_verify_recover. However, note that these functions do not perform a digest of the data to be signed. Therefore normally you would use the EVP_DigestSign... functions for this purpose."
 180 .ie n .IP "For encryption and decryption see \fIEVP_PKEY_encrypt\fR\|(3) and \fIEVP_PKEY_decrypt\fR\|(3) respectively. However, note that these functions perform encryption and decryption only. As public key encryption is an expensive operation, normally you would wrap an encrypted message in a ""digital envelope"" using the \fBEVP_Seal\fR\fI...\fR and \fBEVP_Open\fR\fI...\fR functions." 4
 181 .el .IP "For encryption and decryption see \fIEVP_PKEY_encrypt\fR\|(3) and \fIEVP_PKEY_decrypt\fR\|(3) respectively. However, note that these functions perform encryption and decryption only. As public key encryption is an expensive operation, normally you would wrap an encrypted message in a ``digital envelope'' using the \fBEVP_Seal\fR\fI...\fR and \fBEVP_Open\fR\fI...\fR functions." 4
 182 .IX Item "For encryption and decryption see EVP_PKEY_encrypt and EVP_PKEY_decrypt respectively. However, note that these functions perform encryption and decryption only. As public key encryption is an expensive operation, normally you would wrap an encrypted message in a digital envelope using the EVP_Seal... and EVP_Open... functions."
 183 .PD
 184 .PP
 185 The \fIEVP_BytesToKey\fR\|(3) function provides some limited support for password
 186 based encryption. Careful selection of the parameters will provide a PKCS#5 \s-1PBKDF1\s0 compatible
 187 implementation. However, new applications should not typically use this (preferring, for example,
 188 \&\s-1PBKDF2\s0 from PCKS#5).
 189 .PP
 190 The \fBEVP_Encode\fR\fI...\fR and
 191 \&\fBEVP_Decode\fR\fI...\fR functions implement base 64 encoding
 192 and decoding.
 193 .PP
 194 Algorithms are loaded with \fIOpenSSL_add_all_algorithms\fR\|(3).
 195 .PP
 196 All the symmetric algorithms (ciphers), digests and asymmetric algorithms
 197 (public key algorithms) can be replaced by \s-1ENGINE\s0 modules providing alternative
 198 implementations. If \s-1ENGINE\s0 implementations of ciphers or digests are registered
 199 as defaults, then the various \s-1EVP\s0 functions will automatically use those
 200 implementations automatically in preference to built in software
 201 implementations. For more information, consult the \fIengine\fR\|(3) man page.
 202 .PP
 203 Although low level algorithm specific functions exist for many algorithms
 204 their use is discouraged. They cannot be used with an \s-1ENGINE\s0 and \s-1ENGINE\s0
 205 versions of new algorithms cannot be accessed using the low level functions.
 206 Also makes code harder to adapt to new algorithms and some options are not
 207 cleanly supported at the low level and some operations are more efficient
 208 using the high level interface.
 209 .SH "SEE ALSO"
 210 .IX Header "SEE ALSO"
 211 \&\fIEVP_DigestInit\fR\|(3),
 212 \&\fIEVP_EncryptInit\fR\|(3),
 213 \&\fIEVP_OpenInit\fR\|(3),
 214 \&\fIEVP_SealInit\fR\|(3),
 215 \&\fIEVP_DigestSignInit\fR\|(3),
 216 \&\fIEVP_SignInit\fR\|(3),
 217 \&\fIEVP_VerifyInit\fR\|(3),
 218 \&\fIEVP_EncodeInit\fR\|(3),
 219 \&\fIEVP_PKEY_new\fR\|(3),
 220 \&\fIEVP_PKEY_set1_RSA\fR\|(3),
 221 \&\fIEVP_PKEY_keygen\fR\|(3),
 222 \&\fIEVP_PKEY_print_private\fR\|(3),
 223 \&\fIEVP_PKEY_decrypt\fR\|(3),
 224 \&\fIEVP_PKEY_encrypt\fR\|(3),
 225 \&\fIEVP_PKEY_sign\fR\|(3),
 226 \&\fIEVP_PKEY_verify\fR\|(3),
 227 \&\fIEVP_PKEY_verify_recover\fR\|(3),
 228 \&\fIEVP_PKEY_derive\fR\|(3),
 229 \&\fIEVP_BytesToKey\fR\|(3),
 230 \&\fIOpenSSL_add_all_algorithms\fR\|(3),
 231 \&\fIengine\fR\|(3)