src/gromacs/fileio/md5.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2014,2018 by the GROMACS development team.
   5  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /* This software has been altered by GROMACS for its use, including
  37  * the renaming of the functions md5_init, md5_append and md5_finish
  38  * to have a gmx_ prefix, and the #include guard md5_INCLUDED to have
  39  * a GMX_ prefix (both to avoid name clashes). */
  40 /*
  41    Copyright (C) 1999, 2000, 2002 Aladdin Enterprises.  All rights reserved.
  42
  43    This software is provided 'as-is', without any express or implied
  44    warranty.  In no event will the authors be held liable for any damages
  45    arising from the use of this software.
  46
  47    Permission is granted to anyone to use this software for any purpose,
  48    including commercial applications, and to alter it and redistribute it
  49    freely, subject to the following restrictions:
  50
  51    1. The origin of this software must not be misrepresented; you must not
  52      claim that you wrote the original software. If you use this software
  53      in a product, an acknowledgment in the product documentation would be
  54      appreciated but is not required.
  55    2. Altered source versions must be plainly marked as such, and must not be
  56      misrepresented as being the original software.
  57    3. This notice may not be removed or altered from any source distribution.
  58
  59    L. Peter Deutsch
  60    ghost@aladdin.com
  61
  62  */
  63 /*
  64    Independent implementation of MD5 (RFC 1321).
  65
  66    This code implements the MD5 Algorithm defined in RFC 1321, whose
  67    text is available at
  68     http://www.ietf.org/rfc/rfc1321.txt
  69    The code is derived from the text of the RFC, including the test suite
  70    (section A.5) but excluding the rest of Appendix A.  It does not include
  71    any code or documentation that is identified in the RFC as being
  72    copyrighted.
  73
  74    The original and principal author of md5.h is L. Peter Deutsch
  75    <ghost@aladdin.com>.  Other authors are noted in the change history
  76    that follows (in reverse chronological order):
  77
  78    2002-04-13 lpd Removed support for non-ANSI compilers; removed
  79     references to Ghostscript; clarified derivation from RFC 1321;
  80     now handles byte order either statically or dynamically.
  81    1999-11-04 lpd Edited comments slightly for automatic TOC extraction.
  82    1999-10-18 lpd Fixed typo in header comment (ansi2knr rather than md5);
  83     added conditionalization for C++ compilation from Martin
  84     Purschke <purschke@bnl.gov>.
  85    1999-05-03 lpd Original version.
  86  */
  87
  88 #ifndef GMX_md5_INCLUDED
  89 #define GMX_md5_INCLUDED
  90
  91 #include <array>
  92
  93 /*
  94  * This package supports both compile-time and run-time determination of CPU
  95  * byte order.  If ARCH_IS_BIG_ENDIAN is defined as 0, the code will be
  96  * compiled to run only on little-endian CPUs; if ARCH_IS_BIG_ENDIAN is
  97  * defined as non-zero, the code will be compiled to run only on big-endian
  98  * CPUs; if ARCH_IS_BIG_ENDIAN is not defined, the code will be compiled to
  99  * run on either big- or little-endian CPUs, but will run slightly less
 100  * efficiently on either one than if ARCH_IS_BIG_ENDIAN is defined.
 101  */
 102
 103 typedef unsigned char md5_byte_t; /* 8-bit byte */
 104 typedef unsigned int  md5_word_t; /* 32-bit word */
 105
 106 /* Define the state of the MD5 Algorithm. */
 107 typedef struct md5_state_s
 108 {
 109     md5_word_t count[2]; /* message length in bits, lsw first */
 110     md5_word_t abcd[4];  /* digest buffer */
 111     md5_byte_t buf[64];  /* accumulate block */
 112 } md5_state_t;
 113
 114 /* Initialize the algorithm. */
 115 void gmx_md5_init(md5_state_t* pms);
 116
 117 /* Append a string to the message. */
 118 void gmx_md5_append(md5_state_t* pms, const md5_byte_t* data, int nbytes);
 119
 120 /* Finish the message and return the digest. */
 121 std::array<unsigned char, 16> gmx_md5_finish(md5_state_t* pms);
 122
 123 #endif