sys/man/2/sechash

   1 .TH SECHASH 2
   2 .SH NAME
   3 md4, md5,
   4 sha1, sha2_224, sha2_256, sha2_384, sha2_512,
   5 ripemd160, poly1305,
   6 hmac_x, hmac_md5,
   7 hmac_sha1, hmac_sha2_224, hmac_sha2_256, hmac_sha2_384, hmac_sha2_512,
   8 md5pickle, md5unpickle,
   9 sha1pickle, sha1unpickle \- cryptographically secure hashes
  10 .SH SYNOPSIS
  11 .nr Wd \w'\fLDS* \fP'u
  12 .nr In \w'\fLDS*   \fP'u
  13 .ta \n(Wdu \w'\fLSHA1state* \fP'u +\n(Wdu +\n(Wdu +\n(Wdu +\n(Wdu
  14 .
  15 .de Ti
  16 .PP
  17 .in +\\n(Inu
  18 .ti -\\n(Inu
  19 .B
  20 .nh
  21 ..
  22 .
  23 .ft L
  24 .nf
  25 #include <u.h>
  26 #include <libc.h>
  27 #include <mp.h>
  28 #include <libsec.h>
  29 #define DS DigestState  /* only to abbreviate SYNOPSIS */
  30 .fi
  31 .
  32 .Ti
  33 DS*     md4(uchar *data, ulong dlen, uchar *digest, DS *state)
  34 .Ti
  35 DS*     md5(uchar *data, ulong dlen, uchar *digest, DS *state)
  36 .PP
  37 .B
  38 char*   md5pickle(MD5state *state)
  39 .PP
  40 .B
  41 MD5state*       md5unpickle(char *p);
  42 .Ti
  43 DS*     sha1(uchar *data, ulong dlen, uchar *digest, DS *state)
  44 .PP
  45 .B
  46 char*   sha1pickle(SHA1state *state)
  47 .PP
  48 .B
  49 SHA1state*      sha1unpickle(char *p);
  50 .Ti
  51 DS*     sha2_224(uchar *data, ulong dlen, uchar *digest, DS *state)
  52 .Ti
  53 DS*     sha2_256(uchar *data, ulong dlen, uchar *digest, DS *state)
  54 .Ti
  55 DS*     sha2_384(uchar *data, ulong dlen, uchar *digest, DS *state)
  56 .Ti
  57 DS*     sha2_512(uchar *data, ulong dlen, uchar *digest, DS *state)
  58 .Ti
  59 DS*     ripemd160(uchar *data, ulong dlen, uchar *digest, DS *state)
  60 .Ti
  61 DS*     poly1305(uchar *p, ulong len, uchar *key, ulong klen, uchar *digest, DS *state)
  62 .Ti
  63 DS*     hmac_x(uchar *p, ulong len, uchar *key, ulong klen, uchar *digest, DS *s, DS*(*x)(uchar*, ulong, uchar*, DS*), int xlen)
  64 .Ti
  65 DS*     hmac_md5(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest, DS *state)
  66 .Ti
  67 DS*     hmac_sha1(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest, DS *state)
  68 .Ti
  69 DS*     hmac_sha2_224(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest, DS *state)
  70 .Ti
  71 DS*     hmac_sha2_256(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest, DS *state)
  72 .Ti
  73 DS*     hmac_sha2_384(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest, DS *state)
  74 .Ti
  75 DS*     hmac_sha2_512(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest, DS *state)
  76 .SH DESCRIPTION
  77 .DT
  78 We support several secure hash functions.  The output of a
  79 hash is called a
  80 .IR digest .
  81 A hash is secure if, given the hashed data and the digest,
  82 it is difficult to predict the change to the digest resulting
  83 from some change to the data without rehashing
  84 the whole data.  Therefore, if a secret is part of the hashed
  85 data, the digest can be used as an integrity check of the data by anyone
  86 possessing the secret.
  87 .PP
  88 The routines
  89 .IR md4 ,
  90 .IR md5 ,
  91 .IR sha1 ,
  92 .IR sha2_224 ,
  93 .IR sha2_256 ,
  94 .IR sha2_384 ,
  95 .IR sha2_512 ,
  96 .IR ripemd160 ,
  97 .IR poly1305 ,
  98 .IR hmac_md5 ,
  99 .IR hmac_sha1 ,
 100 .IR hmac_sha2_224 ,
 101 .IR hmac_sha2_256 ,
 102 .IR hmac_sha2_384 ,
 103 and
 104 .IR hmac_sha2_512
 105 differ only in the length of the resulting digest
 106 and in the security of the hash.
 107 .I Sha2_*
 108 and
 109 .I hmac_sha2_*
 110 are the SHA-2 functions; the number after the final underscore
 111 is the number of bits in the resulting digest.
 112 Usage for each is the same.
 113 The first call to the routine should have
 114 .B nil
 115 as the
 116 .I state
 117 parameter.  This call returns a state which can be used to chain
 118 subsequent calls.
 119 The last call should have digest
 120 .RL non- nil .
 121 .I Digest
 122 must point to a buffer of at least the size of the digest produced.
 123 This last call will free the state and copy the result into
 124 .IR digest .
 125 .PP
 126 The constants
 127 .IR MD4dlen ,
 128 .IR MD5dlen ,
 129 .IR SHA1dlen ,
 130 .IR SHA2_224dlen ,
 131 .IR SHA2_256dlen ,
 132 .IR SHA2_384dlen,
 133 .IR SHA2_512dlen ,
 134 and
 135 .I AESdlen
 136 define the lengths of the digests.
 137 .PP
 138 .IR Hmac_md5 ,
 139 .IR hmac_sha1 ,
 140 .IR hmac_sha2_224 ,
 141 .IR hmac_sha2_256 ,
 142 .IR hmac_sha2_384 ,
 143 and
 144 .IR hmac_sha2_512
 145 are used slightly differently.  These hash algorithms are keyed and require
 146 a key to be specified on every call.
 147 The digest lengths for these hashes are the obvious ones from
 148 the above list of length constants.
 149 These routines all call
 150 .I hmac_x
 151 internally, but
 152 .I hmac_x
 153 is not intended for general use.
 154 .PP
 155 .IR Poly1305
 156 is a one-time authenticator designed by D. J. Bernstein. It takes a 32-byte
 157 one-time key and a message and produces a 16-byte tag.
 158 .PP
 159 The functions
 160 .I md5pickle
 161 and
 162 .I sha1pickle
 163 marshal the state of a digest for transmission.
 164 .I Md5unpickle
 165 and
 166 .I sha1unpickle
 167 unmarshal a pickled digest.
 168 All four routines return a pointer to a newly
 169 .IR malloc (2)'d
 170 object.
 171 .SH EXAMPLES
 172 To hash a single buffer using
 173 .IR md5 :
 174 .IP
 175 .EX
 176 uchar digest[MD5dlen];
 177
 178 md5(data, len, digest, nil);
 179 .EE
 180 .PP
 181 To chain a number of buffers together,
 182 bounded on each end by some secret:
 183 .IP
 184 .EX
 185 char buf[256];
 186 uchar digest[MD5dlen];
 187 DigestState *s;
 188
 189 s = md5("my password", 11, nil, nil);
 190 while((n = read(fd, buf, 256)) > 0)
 191         md5(buf, n, nil, s);
 192 md5("drowssap ym", 11, digest, s);
 193 .EE
 194 .SH SOURCE
 195 .B /sys/src/libsec
 196 .SH SEE ALSO
 197 .IR blowfish (2),
 198 .IR des (2),
 199 .IR elgamal (2),
 200 .IR rc4 (2),
 201 .IR rsa (2)
 202 .PD 0
 203 .TF /lib/rfc/rfc2104
 204 .TP
 205 .B /lib/rfc/rfc2104
 206 HMAC specification