summaryrefslogtreecommitdiffstats
path: root/libmd5/md5.h
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2003-10-26 21:03:52 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2003-10-26 21:03:52 (GMT)
commit49dcfeef8aaeca15320299194569f97b86a7e153 (patch)
tree4c65fd4f0ce24f06f9b7a5067eb6c577fb1479a2 /libmd5/md5.h
parent71fd38650147b953fb5063648a538673649bda85 (diff)
downloadDoxygen-49dcfeef8aaeca15320299194569f97b86a7e153.zip
Doxygen-49dcfeef8aaeca15320299194569f97b86a7e153.tar.gz
Doxygen-49dcfeef8aaeca15320299194569f97b86a7e153.tar.bz2
Release-1.3.4-20031026
Diffstat (limited to 'libmd5/md5.h')
-rw-r--r--libmd5/md5.h225
1 files changed, 225 insertions, 0 deletions
diff --git a/libmd5/md5.h b/libmd5/md5.h
new file mode 100644
index 0000000..6b35fc6
--- /dev/null
+++ b/libmd5/md5.h
@@ -0,0 +1,225 @@
+/*
+ * Declaration of functions and data types used for MD5 sum computing
+ * library functions. Copyright (C) 1995, 1996 Free Software
+ * Foundation, Inc. NOTE: The canonical source of this file is
+ * maintained with the GNU C Library. Bugs can be reported to
+ * bug-glibc@prep.ai.mit.edu.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2, or (at
+ * your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+ * 02111-1307, USA.
+ *
+ * $Id$
+ */
+
+/*
+ * NOTE: during quick performance tests on a sun ultra and an alpha
+ * 255 300, the md5 libraries performed upwards of 3mb/sec. That
+ * included disk i/o on bobcat and panther.
+ */
+
+#ifndef __MD5_H__
+#define __MD5_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * Size of a standard MD5 signature in bytes. This definition is for
+ * external programs only. The MD5 routines themselves reference the
+ * signature as 4 unsigned 32-bit integers.
+ */
+#define MD5_SIZE 16
+
+/*
+ * NOTE: the following is assumed to generate a 32-bit unsigned data
+ * type.
+ */
+typedef unsigned int md5_uint32;
+#define MAX_MD5_UINT32 ((md5_uint32)4294967295U)
+
+/*
+ * The MD5 algorithm works on blocks of characters of 64 bytes. This
+ * is an internal value only and is not necessary for external use.
+ */
+#define MD5_BLOCK_SIZE 64
+
+/*
+ * Structure to save state of computation between the single steps.
+ */
+typedef struct
+{
+ md5_uint32 md_A; /* accumulater 1 */
+ md5_uint32 md_B; /* accumulater 2 */
+ md5_uint32 md_C; /* accumulater 3 */
+ md5_uint32 md_D; /* accumulater 4 */
+
+ md5_uint32 md_total[2]; /* totaling storage */
+ md5_uint32 md_buf_len; /* length of the storage buffer */
+ char md_buffer[MD5_BLOCK_SIZE * 2]; /* character storage buffer */
+} md5_t;
+
+/*<<<<<<<<<< The below prototypes are auto-generated by fillproto */
+
+/*
+ * md5_init
+ *
+ * DESCRIPTION:
+ *
+ * Initialize structure containing state of MD5 computation. (RFC 1321,
+ * 3.3: Step 3). This is for progressive MD5 calculations only. If
+ * you have the complete string available, md5_buffer should be used.
+ * md5_process should be called for each bunch of bytes and after the
+ * last process call, md5_finish should be called to get the
+ * signature.
+ *
+ * RETURNS:
+ *
+ * None.
+ *
+ * ARGUMENTS:
+ *
+ * md5_p - Pointer to md5 structure that we are initializing.
+ */
+extern
+void md5_init(md5_t *md5_p);
+
+/*
+ * md5_process
+ *
+ * DESCRIPTION:
+ *
+ * This function is used to progressively calculate a MD5 signature some
+ * number of bytes at a time. If you have the complete string
+ * available, md5_buffer should be used. The MD5 structure should
+ * have been initialized with md5_init and after the last process
+ * call, md5_finish should be called to get the results.
+ *
+ * RETURNS:
+ *
+ * None.
+ *
+ * ARGUMENTS:
+ *
+ * md5_p - Pointer to MD5 structure which we are progressively updating.
+ *
+ * buffer - A buffer of bytes whose MD5 signature we are calculating.
+ *
+ * buf_len - The length of the buffer.
+ */
+extern
+void md5_process(md5_t *md5_p, const void *buffer,
+ const unsigned int buf_len);
+
+/*
+ * md5_finish
+ *
+ * DESCRIPTION:
+ *
+ * Finish a progressing MD5 calculation and copy the resulting MD5
+ * signature into the result buffer which should be 16 bytes
+ * (MD5_SIZE). After this call, the MD5 structure is invalid.
+ *
+ * RETURNS:
+ *
+ * None.
+ *
+ * ARGUMENTS:
+ *
+ * md5_p - Pointer to MD5 structure which we are finishing.
+ *
+ * signature - A 16 byte buffer that will contain the MD5 signature.
+ */
+extern
+void md5_finish(md5_t *md5_p, void *signature);
+
+/*
+ * md5_buffer
+ *
+ * DESCRIPTION:
+ *
+ * This function is used to calculate a MD5 signature for a buffer of
+ * bytes. If you only have part of a buffer that you want to process
+ * then md5_init, md5_process, and md5_finish should be used.
+ *
+ * RETURNS:
+ *
+ * None.
+ *
+ * ARGUMENTS:
+ *
+ * buffer - A buffer of bytes whose MD5 signature we are calculating.
+ *
+ * buf_len - The length of the buffer.
+ *
+ * signature - A 16 byte buffer that will contain the MD5 signature.
+ */
+extern
+void md5_buffer(const char *buffer, const unsigned int buf_len,
+ void *signature);
+
+/*
+ * md5_sig_to_string
+ *
+ * DESCRIPTION:
+ *
+ * Convert a MD5 signature in a 16 byte buffer into a hexadecimal string
+ * representation.
+ *
+ * RETURNS:
+ *
+ * None.
+ *
+ * ARGUMENTS:
+ *
+ * signature - a 16 byte buffer that contains the MD5 signature.
+ *
+ * str - a string of charactes which should be at least 33 bytes long (2
+ * characters per MD5 byte and 1 for the \0).
+ *
+ * str_len - the length of the string.
+ */
+extern
+void md5_sig_to_string(void *signature, char *str, const int str_len);
+
+/*
+ * md5_sig_from_string
+ *
+ * DESCRIPTION:
+ *
+ * Convert a MD5 signature from a hexadecimal string representation into
+ * a 16 byte buffer.
+ *
+ * RETURNS:
+ *
+ * None.
+ *
+ * ARGUMENTS:
+ *
+ * signature - A 16 byte buffer that will contain the MD5 signature.
+ *
+ * str - A string of charactes which _must_ be at least 32 bytes long (2
+ * characters per MD5 byte).
+ */
+extern
+void md5_sig_from_string(void *signature, const char *str);
+
+/*<<<<<<<<<< This is end of the auto-generated output from fillproto. */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* ! __MD5_H__ */