src/OpenFOAM/primitives/hashes/SHA1/SHA1.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::SHA1
  27
  28 Description
  29     Functions to compute SHA1 message digest according to the NIST
  30     specification FIPS-180-1.
  31
  32     Adapted from the gnulib implementation.
  33
  34 SeeAlso
  35     Foam::SHA1Digest
  36
  37 SourceFiles
  38     SHA1I.H
  39     SHA1.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef SHA1_H
  44 #define SHA1_H
  45
  46 #include <string>
  47 #include <cstddef>
  48 #include <stdint.h>    // C++0x uses <cstdint>
  49
  50 #include "SHA1Digest.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56
  57 // Forward declaration of classes
  58 class Ostream;
  59
  60 // Forward declaration of friend functions and operators
  61 class SHA1;
  62 class SHA1Digest;
  63 Ostream& operator<<(Ostream&, const SHA1&);
  64
  65
  66 /*---------------------------------------------------------------------------*\
  67                             Class SHA1 Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 class SHA1
  71 {
  72     // Private data
  73
  74         //- Track if the hashsum has been finalized (added count, etc)
  75         bool finalized_;
  76
  77         //- The hash sums
  78         uint32_t hashsumA_;
  79         uint32_t hashsumB_;
  80         uint32_t hashsumC_;
  81         uint32_t hashsumD_;
  82         uint32_t hashsumE_;
  83
  84         //- The total number processed, saved as 64-bit
  85         uint32_t bufTotal_[2];
  86
  87         //- The number of elements pending in the buffer
  88         uint32_t bufLen_;
  89
  90         //- The input processing buffer
  91         uint32_t buffer_[32];
  92
  93     // Private Member Functions
  94
  95         //- Swap bytes from internal to network (big-endian) order
  96         static inline uint32_t swapBytes(uint32_t);
  97
  98         //- Copy the 4-byte value into the memory location pointed to by *dst.
  99         //  If the architecture allows unaligned access this is equivalent to
 100         //  *(uint32_t *) cp = val
 101         static inline void set_uint32(unsigned char *cp, uint32_t);
 102
 103         //- Process data block-wise, LEN must be a multiple of 64!
 104         void processBlock(const void *data, size_t len);
 105
 106         //- Process for the next LEN bytes, LEN need not be a multiple of 64.
 107         void processBytes(const void *data, size_t len);
 108
 109         //- Calculate current digest from appended data.
 110         void calcDigest(SHA1Digest&) const;
 111
 112 public:
 113
 114     // Constructors
 115
 116         //- Construct null
 117         inline SHA1();
 118
 119         //- Construct and append initial std::string
 120         explicit inline SHA1(const std::string&);
 121
 122         //- Construct and append initial string
 123         explicit inline SHA1(const char*);
 124
 125     // Member Functions
 126
 127         //- Reset the hashed data before appending more
 128         void clear();
 129
 130         //- Append data for processing
 131         inline SHA1& append(const char* data, size_t len);
 132
 133         //- Append string for processing
 134         inline SHA1& append(const std::string&);
 135
 136         //- Append string for processing
 137         inline SHA1& append(const char* str);
 138
 139         //- Finalized the calculations (normally not needed directly).
 140         //  Returns false if no bytes were passed for processing
 141         bool finalize();
 142
 143         //- Calculate current digest from appended data.
 144         SHA1Digest digest() const;
 145
 146
 147     // Member Operators
 148
 149         //- Equality operator
 150         inline bool operator==(const SHA1Digest&) const;
 151
 152         //- Inequality operator
 153         inline bool operator!=(const SHA1Digest&) const;
 154
 155         //- Equality operator
 156         inline bool operator==(const SHA1&) const;
 157
 158         //- Inequality operator
 159         inline bool operator!=(const SHA1&) const;
 160
 161         //- Convert to a digest, calculate current digest from appended data.
 162         inline operator SHA1Digest() const;
 163
 164     // Friend Functions
 165
 166     // Friend Operators
 167
 168         inline friend Ostream& operator<<(Ostream&, const SHA1&);
 169
 170 };
 171
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 } // End namespace Foam
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 #include "SHA1I.H"
 180
 181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 182
 183 #endif
 184
 185 // ************************************************************************* //