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

   1 .\"     $NetBSD: openssl_hmac.3,v 1.14 2015/06/12 17:01:15 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 "hmac 3"
 138 .TH hmac 3 "2009-12-26" "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 HMAC, HMAC_Init, HMAC_Update, HMAC_Final, HMAC_cleanup \- HMAC message
 145 authentication code
 146 .SH "LIBRARY"
 147 libcrypto, -lcrypto
 148 .SH "SYNOPSIS"
 149 .IX Header "SYNOPSIS"
 150 .Vb 1
 151 \& #include <openssl/hmac.h>
 152 \&
 153 \& unsigned char *HMAC(const EVP_MD *evp_md, const void *key,
 154 \&               int key_len, const unsigned char *d, int n,
 155 \&               unsigned char *md, unsigned int *md_len);
 156 \&
 157 \& void HMAC_CTX_init(HMAC_CTX *ctx);
 158 \&
 159 \& int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
 160 \&               const EVP_MD *md);
 161 \& int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int key_len,
 162 \&                   const EVP_MD *md, ENGINE *impl);
 163 \& int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, int len);
 164 \& int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
 165 \&
 166 \& void HMAC_CTX_cleanup(HMAC_CTX *ctx);
 167 \& void HMAC_cleanup(HMAC_CTX *ctx);
 168 .Ve
 169 .SH "DESCRIPTION"
 170 .IX Header "DESCRIPTION"
 171 \&\s-1HMAC\s0 is a \s-1MAC \s0(message authentication code), i.e. a keyed hash
 172 function used for message authentication, which is based on a hash
 173 function.
 174 .PP
 175 \&\s-1\fIHMAC\s0()\fR computes the message authentication code of the \fBn\fR bytes at
 176 \&\fBd\fR using the hash function \fBevp_md\fR and the key \fBkey\fR which is
 177 \&\fBkey_len\fR bytes long.
 178 .PP
 179 It places the result in \fBmd\fR (which must have space for the output of
 180 the hash function, which is no more than \fB\s-1EVP_MAX_MD_SIZE\s0\fR bytes).
 181 If \fBmd\fR is \s-1NULL,\s0 the digest is placed in a static array.  The size of
 182 the output is placed in \fBmd_len\fR, unless it is \fB\s-1NULL\s0\fR.
 183 .PP
 184 \&\fBevp_md\fR can be \fIEVP_sha1()\fR, \fIEVP_ripemd160()\fR etc.
 185 .PP
 186 \&\fIHMAC_CTX_init()\fR initialises a \fB\s-1HMAC_CTX\s0\fR before first use. It must be
 187 called.
 188 .PP
 189 \&\fIHMAC_CTX_cleanup()\fR erases the key and other data from the \fB\s-1HMAC_CTX\s0\fR
 190 and releases any associated resources. It must be called when an
 191 \&\fB\s-1HMAC_CTX\s0\fR is no longer required.
 192 .PP
 193 \&\fIHMAC_cleanup()\fR is an alias for \fIHMAC_CTX_cleanup()\fR included for back
 194 compatibility with 0.9.6b, it is deprecated.
 195 .PP
 196 The following functions may be used if the message is not completely
 197 stored in memory:
 198 .PP
 199 \&\fIHMAC_Init()\fR initializes a \fB\s-1HMAC_CTX\s0\fR structure to use the hash
 200 function \fBevp_md\fR and the key \fBkey\fR which is \fBkey_len\fR bytes
 201 long. It is deprecated and only included for backward compatibility
 202 with OpenSSL 0.9.6b.
 203 .PP
 204 \&\fIHMAC_Init_ex()\fR initializes or reuses a \fB\s-1HMAC_CTX\s0\fR structure to use
 205 the function \fBevp_md\fR and key \fBkey\fR. Either can be \s-1NULL,\s0 in which
 206 case the existing one will be reused. \fIHMAC_CTX_init()\fR must have been
 207 called before the first use of an \fB\s-1HMAC_CTX\s0\fR in this
 208 function. \fBN.B. \f(BIHMAC_Init()\fB had this undocumented behaviour in
 209 previous versions of OpenSSL \- failure to switch to \f(BIHMAC_Init_ex()\fB in
 210 programs that expect it will cause them to stop working\fR.
 211 .PP
 212 \&\fIHMAC_Update()\fR can be called repeatedly with chunks of the message to
 213 be authenticated (\fBlen\fR bytes at \fBdata\fR).
 214 .PP
 215 \&\fIHMAC_Final()\fR places the message authentication code in \fBmd\fR, which
 216 must have space for the hash function output.
 217 .SH "RETURN VALUES"
 218 .IX Header "RETURN VALUES"
 219 \&\s-1\fIHMAC\s0()\fR returns a pointer to the message authentication code or \s-1NULL\s0 if
 220 an error occurred.
 221 .PP
 222 \&\fIHMAC_Init_ex()\fR, \fIHMAC_Update()\fR and \fIHMAC_Final()\fR return 1 for success or 0 if
 223 an error occurred.
 224 .PP
 225 \&\fIHMAC_CTX_init()\fR and \fIHMAC_CTX_cleanup()\fR do not return values.
 226 .SH "CONFORMING TO"
 227 .IX Header "CONFORMING TO"
 228 \&\s-1RFC 2104\s0
 229 .SH "SEE ALSO"
 230 .IX Header "SEE ALSO"
 231 \&\fIopenssl_sha\fR\|(3), \fIopenssl_evp\fR\|(3)
 232 .SH "HISTORY"
 233 .IX Header "HISTORY"
 234 \&\s-1\fIHMAC\s0()\fR, \fIHMAC_Init()\fR, \fIHMAC_Update()\fR, \fIHMAC_Final()\fR and \fIHMAC_cleanup()\fR
 235 are available since SSLeay 0.9.0.
 236 .PP
 237 \&\fIHMAC_CTX_init()\fR, \fIHMAC_Init_ex()\fR and \fIHMAC_CTX_cleanup()\fR are available
 238 since OpenSSL 0.9.7.
 239 .PP
 240 \&\fIHMAC_Init_ex()\fR, \fIHMAC_Update()\fR and \fIHMAC_Final()\fR did not return values in
 241 versions of OpenSSL before 1.0.0.