crypto/external/bsd/openssl/lib/libcrypto/man/EVP_BytesToKey.3

   1 .\"     $NetBSD: EVP_BytesToKey.3,v 1.14 2015/06/12 17:01:13 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .de Vb \" Begin verbatim text
  12 .ft CW
  13 .nf
  14 .ne \\$1
  15 ..
  16 .de Ve \" End verbatim text
  17 .ft R
  18 .fi
  19 ..
  20 .\" Set up some character translations and predefined strings.  \*(-- will
  21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  22 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  23 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  24 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  25 .\" nothing in troff, for use with C<>.
  26 .tr \(*W-
  27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  28 .ie n \{\
  29 .    ds -- \(*W-
  30 .    ds PI pi
  31 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  32 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  33 .    ds L" ""
  34 .    ds R" ""
  35 .    ds C` ""
  36 .    ds C' ""
  37 'br\}
  38 .el\{\
  39 .    ds -- \|\(em\|
  40 .    ds PI \(*p
  41 .    ds L" ``
  42 .    ds R" ''
  43 .    ds C`
  44 .    ds C'
  45 'br\}
  46 .\"
  47 .\" Escape single quotes in literal strings from groff's Unicode transform.
  48 .ie \n(.g .ds Aq \(aq
  49 .el       .ds Aq '
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.SS), 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 .\"
  56 .\" Avoid warning from groff about undefined register 'F'.
  57 .de IX
  58 ..
  59 .nr rF 0
  60 .if \n(.g .if rF .nr rF 1
  61 .if (\n(rF:(\n(.g==0)) \{
  62 .    if \nF \{
  63 .        de IX
  64 .        tm Index:\\$1\t\\n%\t"\\$2"
  65 ..
  66 .        if !\nF==2 \{
  67 .            nr % 0
  68 .            nr F 2
  69 .        \}
  70 .    \}
  71 .\}
  72 .rr rF
  73 .\"
  74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  75 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  76 .    \" fudge factors for nroff and troff
  77 .if n \{\
  78 .    ds #H 0
  79 .    ds #V .8m
  80 .    ds #F .3m
  81 .    ds #[ \f1
  82 .    ds #] \fP
  83 .\}
  84 .if t \{\
  85 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  86 .    ds #V .6m
  87 .    ds #F 0
  88 .    ds #[ \&
  89 .    ds #] \&
  90 .\}
  91 .    \" simple accents for nroff and troff
  92 .if n \{\
  93 .    ds ' \&
  94 .    ds ` \&
  95 .    ds ^ \&
  96 .    ds , \&
  97 .    ds ~ ~
  98 .    ds /
  99 .\}
 100 .if t \{\
 101 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 102 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 103 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 104 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 105 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 106 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 107 .\}
 108 .    \" troff and (daisy-wheel) nroff accents
 109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 116 .ds ae a\h'-(\w'a'u*4/10)'e
 117 .ds Ae A\h'-(\w'A'u*4/10)'E
 118 .    \" corrections for vroff
 119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 121 .    \" for low resolution devices (crt and lpr)
 122 .if \n(.H>23 .if \n(.V>19 \
 123 \{\
 124 .    ds : e
 125 .    ds 8 ss
 126 .    ds o a
 127 .    ds d- d\h'-1'\(ga
 128 .    ds D- D\h'-1'\(hy
 129 .    ds th \o'bp'
 130 .    ds Th \o'LP'
 131 .    ds ae ae
 132 .    ds Ae AE
 133 .\}
 134 .rm #[ #] #H #V #F C
 135 .\" ========================================================================
 136 .\"
 137 .IX Title "EVP_BytesToKey 3"
 138 .TH EVP_BytesToKey 3 "2014-04-07" "1.0.1n" "OpenSSL"
 139 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 140 .\" way too many mistakes in technical documents.
 141 .if n .ad l
 142 .nh
 143 .SH "NAME"
 144 EVP_BytesToKey \- password based encryption routine
 145 .SH "LIBRARY"
 146 libcrypto, -lcrypto
 147 .SH "SYNOPSIS"
 148 .IX Header "SYNOPSIS"
 149 .Vb 1
 150 \& #include <openssl/evp.h>
 151 \&
 152 \& int EVP_BytesToKey(const EVP_CIPHER *type,const EVP_MD *md,
 153 \&                       const unsigned char *salt,
 154 \&                       const unsigned char *data, int datal, int count,
 155 \&                       unsigned char *key,unsigned char *iv);
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 \&\fIEVP_BytesToKey()\fR derives a key and \s-1IV\s0 from various parameters. \fBtype\fR is
 160 the cipher to derive the key and \s-1IV\s0 for. \fBmd\fR is the message digest to use.
 161 The \fBsalt\fR parameter is used as a salt in the derivation: it should point to
 162 an 8 byte buffer or \s-1NULL\s0 if no salt is used. \fBdata\fR is a buffer containing
 163 \&\fBdatal\fR bytes which is used to derive the keying data. \fBcount\fR is the
 164 iteration count to use. The derived key and \s-1IV\s0 will be written to \fBkey\fR
 165 and \fBiv\fR respectively.
 166 .SH "NOTES"
 167 .IX Header "NOTES"
 168 A typical application of this function is to derive keying material for an
 169 encryption algorithm from a password in the \fBdata\fR parameter.
 170 .PP
 171 Increasing the \fBcount\fR parameter slows down the algorithm which makes it
 172 harder for an attacker to peform a brute force attack using a large number
 173 of candidate passwords.
 174 .PP
 175 If the total key and \s-1IV\s0 length is less than the digest length and
 176 \&\fB\s-1MD5\s0\fR is used then the derivation algorithm is compatible with PKCS#5 v1.5
 177 otherwise a non standard extension is used to derive the extra data.
 178 .PP
 179 Newer applications should use more standard algorithms such as PKCS#5
 180 v2.0 for key derivation.
 181 .SH "KEY DERIVATION ALGORITHM"
 182 .IX Header "KEY DERIVATION ALGORITHM"
 183 The key and \s-1IV\s0 is derived by concatenating D_1, D_2, etc until
 184 enough data is available for the key and \s-1IV.\s0 D_i is defined as:
 185 .PP
 186 .Vb 1
 187 \&        D_i = HASH^count(D_(i\-1) || data || salt)
 188 .Ve
 189 .PP
 190 where || denotes concatentaion, D_0 is empty, \s-1HASH\s0 is the digest
 191 algorithm in use, HASH^1(data) is simply \s-1HASH\s0(data), HASH^2(data)
 192 is \s-1HASH\s0(\s-1HASH\s0(data)) and so on.
 193 .PP
 194 The initial bytes are used for the key and the subsequent bytes for
 195 the \s-1IV.\s0
 196 .SH "RETURN VALUES"
 197 .IX Header "RETURN VALUES"
 198 \&\fIEVP_BytesToKey()\fR returns the size of the derived key in bytes.
 199 .SH "SEE ALSO"
 200 .IX Header "SEE ALSO"
 201 \&\fIopenssl_evp\fR\|(3), \fIopenssl_rand\fR\|(3),
 202 \&\fIEVP_EncryptInit\fR\|(3)
 203 .SH "HISTORY"
 204 .IX Header "HISTORY"