clarify documentation
[heimdal.git] / lib / hcrypto / md2.h
blobaf765060aa53f09d8a35ef0e24a8e49d4ef7332b
1 /*
2 * Copyright (c) 2006 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
34 /* $Id$ */
36 #ifndef HEIM_MD2_H
37 #define HEIM_MD2_H 1
39 /* symbol renaming */
40 #define MD2_Init hc_MD2_Init
41 #define MD2_Update hc_MD2_Update
42 #define MD2_Final hc_MD2_Final
48 #define MD2_DIGEST_LENGTH 16
50 struct md2 {
51 size_t len;
52 unsigned char data[16]; /* stored unalligned data between Update's */
53 unsigned char checksum[16];
54 unsigned char state[16]; /* lower 16 bytes of X */
57 typedef struct md2 MD2_CTX;
59 void MD2_Init (struct md2 *m);
60 void MD2_Update (struct md2 *m, const void *p, size_t len);
61 void MD2_Final (void *res, struct md2 *m);
63 #endif /* HEIM_MD2_H */