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

   1 .\"     $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sh \" Subsection heading
   8 .br
   9 .if t .Sp
  10 .ne 5
  11 .PP
  12 \fB\\$1\fR
  13 .PP
  14 ..
  15 .de Sp \" Vertical space (when we can't use .PP)
  16 .if t .sp .5v
  17 .if n .sp
  18 ..
  19 .de Vb \" Begin verbatim text
  20 .ft CW
  21 .nf
  22 .ne \\$1
  23 ..
  24 .de Ve \" End verbatim text
  25 .ft R
  26 .fi
  27 ..
  28 .\" Set up some character translations and predefined strings.  \*(-- will
  29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  30 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  31 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  32 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  33 .\" nothing in troff, for use with C<>.
  34 .tr \(*W-
  35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  36 .ie n \{\
  37 .    ds -- \(*W-
  38 .    ds PI pi
  39 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  40 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  41 .    ds L" ""
  42 .    ds R" ""
  43 .    ds C` ""
  44 .    ds C' ""
  45 'br\}
  46 .el\{\
  47 .    ds -- \|\(em\|
  48 .    ds PI \(*p
  49 .    ds L" ``
  50 .    ds R" ''
  51 'br\}
  52 .\"
  53 .\" Escape single quotes in literal strings from groff's Unicode transform.
  54 .ie \n(.g .ds Aq \(aq
  55 .el       .ds Aq '
  56 .\"
  57 .\" If the F register is turned on, we'll generate index entries on stderr for
  58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  59 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  60 .\" output yourself in some meaningful fashion.
  61 .ie \nF \{\
  62 .    de IX
  63 .    tm Index:\\$1\t\\n%\t"\\$2"
  64 ..
  65 .    nr % 0
  66 .    rr F
  67 .\}
  68 .el \{\
  69 .    de IX
  70 ..
  71 .\}
  72 .\"
  73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  74 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  75 .    \" fudge factors for nroff and troff
  76 .if n \{\
  77 .    ds #H 0
  78 .    ds #V .8m
  79 .    ds #F .3m
  80 .    ds #[ \f1
  81 .    ds #] \fP
  82 .\}
  83 .if t \{\
  84 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  85 .    ds #V .6m
  86 .    ds #F 0
  87 .    ds #[ \&
  88 .    ds #] \&
  89 .\}
  90 .    \" simple accents for nroff and troff
  91 .if n \{\
  92 .    ds ' \&
  93 .    ds ` \&
  94 .    ds ^ \&
  95 .    ds , \&
  96 .    ds ~ ~
  97 .    ds /
  98 .\}
  99 .if t \{\
 100 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 101 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 102 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 103 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 104 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 105 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 106 .\}
 107 .    \" troff and (daisy-wheel) nroff accents
 108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 115 .ds ae a\h'-(\w'a'u*4/10)'e
 116 .ds Ae A\h'-(\w'A'u*4/10)'E
 117 .    \" corrections for vroff
 118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 120 .    \" for low resolution devices (crt and lpr)
 121 .if \n(.H>23 .if \n(.V>19 \
 122 \{\
 123 .    ds : e
 124 .    ds 8 ss
 125 .    ds o a
 126 .    ds d- d\h'-1'\(ga
 127 .    ds D- D\h'-1'\(hy
 128 .    ds th \o'bp'
 129 .    ds Th \o'LP'
 130 .    ds ae ae
 131 .    ds Ae AE
 132 .\}
 133 .rm #[ #] #H #V #F C
 134 .\" ========================================================================
 135 .\"
 136 .IX Title "hmac 3"
 137 .TH hmac 3 "2008-11-02" "1.1.0-dev" "OpenSSL"
 138 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 139 .\" way too many mistakes in technical documents.
 140 .if n .ad l
 141 .nh
 142 .SH "NAME"
 143 HMAC, HMAC_Init, HMAC_Update, HMAC_Final, HMAC_cleanup \- HMAC message
 144 authentication code
 145 .SH "LIBRARY"
 146 libcrypto, -lcrypto
 147 .SH "SYNOPSIS"
 148 .IX Header "SYNOPSIS"
 149 .Vb 1
 150 \& #include <openssl/hmac.h>
 151 \&
 152 \& unsigned char *HMAC(const EVP_MD *evp_md, const void *key,
 153 \&               int key_len, const unsigned char *d, int n,
 154 \&               unsigned char *md, unsigned int *md_len);
 155 \&
 156 \& void HMAC_CTX_init(HMAC_CTX *ctx);
 157 \&
 158 \& int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
 159 \&               const EVP_MD *md);
 160 \& int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int key_len,
 161 \&                   const EVP_MD *md, ENGINE *impl);
 162 \& int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, int len);
 163 \& int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
 164 \&
 165 \& void HMAC_CTX_cleanup(HMAC_CTX *ctx);
 166 \& void HMAC_cleanup(HMAC_CTX *ctx);
 167 .Ve
 168 .SH "DESCRIPTION"
 169 .IX Header "DESCRIPTION"
 170 \&\s-1HMAC\s0 is a \s-1MAC\s0 (message authentication code), i.e. a keyed hash
 171 function used for message authentication, which is based on a hash
 172 function.
 173 .PP
 174 \&\s-1\fIHMAC\s0()\fR computes the message authentication code of the \fBn\fR bytes at
 175 \&\fBd\fR using the hash function \fBevp_md\fR and the key \fBkey\fR which is
 176 \&\fBkey_len\fR bytes long.
 177 .PP
 178 It places the result in \fBmd\fR (which must have space for the output of
 179 the hash function, which is no more than \fB\s-1EVP_MAX_MD_SIZE\s0\fR bytes).
 180 If \fBmd\fR is \s-1NULL\s0, the digest is placed in a static array.  The size of
 181 the output is placed in \fBmd_len\fR, unless it is \fB\s-1NULL\s0\fR.
 182 .PP
 183 \&\fBevp_md\fR can be \fIEVP_sha1()\fR, \fIEVP_ripemd160()\fR etc.
 184 \&\fBkey\fR and \fBevp_md\fR may be \fB\s-1NULL\s0\fR if a key and hash function have
 185 been set in a previous call to \fIHMAC_Init()\fR for that \fB\s-1HMAC_CTX\s0\fR.
 186 .PP
 187 \&\fIHMAC_CTX_init()\fR initialises a \fB\s-1HMAC_CTX\s0\fR before first use. It must be
 188 called.
 189 .PP
 190 \&\fIHMAC_CTX_cleanup()\fR erases the key and other data from the \fB\s-1HMAC_CTX\s0\fR
 191 and releases any associated resources. It must be called when an
 192 \&\fB\s-1HMAC_CTX\s0\fR is no longer required.
 193 .PP
 194 \&\fIHMAC_cleanup()\fR is an alias for \fIHMAC_CTX_cleanup()\fR included for back
 195 compatibility with 0.9.6b, it is deprecated.
 196 .PP
 197 The following functions may be used if the message is not completely
 198 stored in memory:
 199 .PP
 200 \&\fIHMAC_Init()\fR initializes a \fB\s-1HMAC_CTX\s0\fR structure to use the hash
 201 function \fBevp_md\fR and the key \fBkey\fR which is \fBkey_len\fR bytes
 202 long. It is deprecated and only included for backward compatibility
 203 with OpenSSL 0.9.6b.
 204 .PP
 205 \&\fIHMAC_Init_ex()\fR initializes or reuses a \fB\s-1HMAC_CTX\s0\fR structure to use
 206 the function \fBevp_md\fR and key \fBkey\fR. Either can be \s-1NULL\s0, in which
 207 case the existing one will be reused. \fIHMAC_CTX_init()\fR must have been
 208 called before the first use of an \fB\s-1HMAC_CTX\s0\fR in this
 209 function. \fBN.B. \f(BIHMAC_Init()\fB had this undocumented behaviour in
 210 previous versions of OpenSSL \- failure to switch to \f(BIHMAC_Init_ex()\fB in
 211 programs that expect it will cause them to stop working\fR.
 212 .PP
 213 \&\fIHMAC_Update()\fR can be called repeatedly with chunks of the message to
 214 be authenticated (\fBlen\fR bytes at \fBdata\fR).
 215 .PP
 216 \&\fIHMAC_Final()\fR places the message authentication code in \fBmd\fR, which
 217 must have space for the hash function output.
 218 .SH "RETURN VALUES"
 219 .IX Header "RETURN VALUES"
 220 \&\s-1\fIHMAC\s0()\fR returns a pointer to the message authentication code or \s-1NULL\s0 if
 221 an error occurred.
 222 .PP
 223 \&\fIHMAC_Init_ex()\fR, \fIHMAC_Update()\fR and \fIHMAC_Final()\fR return 1 for success or 0 if
 224 an error occurred.
 225 .PP
 226 \&\fIHMAC_CTX_init()\fR and \fIHMAC_CTX_cleanup()\fR do not return values.
 227 .SH "CONFORMING TO"
 228 .IX Header "CONFORMING TO"
 229 \&\s-1RFC\s0 2104
 230 .SH "SEE ALSO"
 231 .IX Header "SEE ALSO"
 232 \&\fIopenssl_sha\fR\|(3), \fIopenssl_evp\fR\|(3)
 233 .SH "HISTORY"
 234 .IX Header "HISTORY"
 235 \&\s-1\fIHMAC\s0()\fR, \fIHMAC_Init()\fR, \fIHMAC_Update()\fR, \fIHMAC_Final()\fR and \fIHMAC_cleanup()\fR
 236 are available since SSLeay 0.9.0.
 237 .PP
 238 \&\fIHMAC_CTX_init()\fR, \fIHMAC_Init_ex()\fR and \fIHMAC_CTX_cleanup()\fR are available
 239 since OpenSSL 0.9.7.
 240 .PP
 241 \&\fIHMAC_Init_ex()\fR, \fIHMAC_Update()\fR and \fIHMAC_Final()\fR did not return values in
 242 versions of OpenSSL before 0.9.9.