secure/lib/libcrypto/man/hmac.3

   1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   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 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  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 "hmac 3"
 127 .TH hmac 3 "2010-06-01" "1.0.0a" "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 HMAC, HMAC_Init, HMAC_Update, HMAC_Final, HMAC_cleanup \- HMAC message
 134 authentication code
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& #include <openssl/hmac.h>
 139 \&
 140 \& unsigned char *HMAC(const EVP_MD *evp_md, const void *key,
 141 \&               int key_len, const unsigned char *d, int n,
 142 \&               unsigned char *md, unsigned int *md_len);
 143 \&
 144 \& void HMAC_CTX_init(HMAC_CTX *ctx);
 145 \&
 146 \& int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
 147 \&               const EVP_MD *md);
 148 \& int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int key_len,
 149 \&                   const EVP_MD *md, ENGINE *impl);
 150 \& int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, int len);
 151 \& int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
 152 \&
 153 \& void HMAC_CTX_cleanup(HMAC_CTX *ctx);
 154 \& void HMAC_cleanup(HMAC_CTX *ctx);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\s-1HMAC\s0 is a \s-1MAC\s0 (message authentication code), i.e. a keyed hash
 159 function used for message authentication, which is based on a hash
 160 function.
 161 .PP
 162 \&\s-1\fIHMAC\s0()\fR computes the message authentication code of the \fBn\fR bytes at
 163 \&\fBd\fR using the hash function \fBevp_md\fR and the key \fBkey\fR which is
 164 \&\fBkey_len\fR bytes long.
 165 .PP
 166 It places the result in \fBmd\fR (which must have space for the output of
 167 the hash function, which is no more than \fB\s-1EVP_MAX_MD_SIZE\s0\fR bytes).
 168 If \fBmd\fR is \s-1NULL\s0, the digest is placed in a static array.  The size of
 169 the output is placed in \fBmd_len\fR, unless it is \fB\s-1NULL\s0\fR.
 170 .PP
 171 \&\fBevp_md\fR can be \fIEVP_sha1()\fR, \fIEVP_ripemd160()\fR etc.
 172 .PP
 173 \&\fIHMAC_CTX_init()\fR initialises a \fB\s-1HMAC_CTX\s0\fR before first use. It must be
 174 called.
 175 .PP
 176 \&\fIHMAC_CTX_cleanup()\fR erases the key and other data from the \fB\s-1HMAC_CTX\s0\fR
 177 and releases any associated resources. It must be called when an
 178 \&\fB\s-1HMAC_CTX\s0\fR is no longer required.
 179 .PP
 180 \&\fIHMAC_cleanup()\fR is an alias for \fIHMAC_CTX_cleanup()\fR included for back
 181 compatibility with 0.9.6b, it is deprecated.
 182 .PP
 183 The following functions may be used if the message is not completely
 184 stored in memory:
 185 .PP
 186 \&\fIHMAC_Init()\fR initializes a \fB\s-1HMAC_CTX\s0\fR structure to use the hash
 187 function \fBevp_md\fR and the key \fBkey\fR which is \fBkey_len\fR bytes
 188 long. It is deprecated and only included for backward compatibility
 189 with OpenSSL 0.9.6b.
 190 .PP
 191 \&\fIHMAC_Init_ex()\fR initializes or reuses a \fB\s-1HMAC_CTX\s0\fR structure to use
 192 the function \fBevp_md\fR and key \fBkey\fR. Either can be \s-1NULL\s0, in which
 193 case the existing one will be reused. \fIHMAC_CTX_init()\fR must have been
 194 called before the first use of an \fB\s-1HMAC_CTX\s0\fR in this
 195 function. \fBN.B. \f(BIHMAC_Init()\fB had this undocumented behaviour in
 196 previous versions of OpenSSL \- failure to switch to \f(BIHMAC_Init_ex()\fB in
 197 programs that expect it will cause them to stop working\fR.
 198 .PP
 199 \&\fIHMAC_Update()\fR can be called repeatedly with chunks of the message to
 200 be authenticated (\fBlen\fR bytes at \fBdata\fR).
 201 .PP
 202 \&\fIHMAC_Final()\fR places the message authentication code in \fBmd\fR, which
 203 must have space for the hash function output.
 204 .SH "RETURN VALUES"
 205 .IX Header "RETURN VALUES"
 206 \&\s-1\fIHMAC\s0()\fR returns a pointer to the message authentication code or \s-1NULL\s0 if
 207 an error occurred.
 208 .PP
 209 \&\fIHMAC_Init_ex()\fR, \fIHMAC_Update()\fR and \fIHMAC_Final()\fR return 1 for success or 0 if
 210 an error occurred.
 211 .PP
 212 \&\fIHMAC_CTX_init()\fR and \fIHMAC_CTX_cleanup()\fR do not return values.
 213 .SH "CONFORMING TO"
 214 .IX Header "CONFORMING TO"
 215 \&\s-1RFC\s0 2104
 216 .SH "SEE ALSO"
 217 .IX Header "SEE ALSO"
 218 \&\fIsha\fR\|(3), \fIevp\fR\|(3)
 219 .SH "HISTORY"
 220 .IX Header "HISTORY"
 221 \&\s-1\fIHMAC\s0()\fR, \fIHMAC_Init()\fR, \fIHMAC_Update()\fR, \fIHMAC_Final()\fR and \fIHMAC_cleanup()\fR
 222 are available since SSLeay 0.9.0.
 223 .PP
 224 \&\fIHMAC_CTX_init()\fR, \fIHMAC_Init_ex()\fR and \fIHMAC_CTX_cleanup()\fR are available
 225 since OpenSSL 0.9.7.
 226 .PP
 227 \&\fIHMAC_Init_ex()\fR, \fIHMAC_Update()\fR and \fIHMAC_Final()\fR did not return values in
 228 versions of OpenSSL before 1.0.0.