src/modules/m_sha256.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2006 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 /* m_sha256 - Based on m_opersha256 written by Special <john@yarbbles.com>
  24  * Modified and improved by Craig Edwards, December 2006.
  25  *
  26  *
  27  * FIPS 180-2 SHA-224/256/384/512 implementation
  28  * Last update: 05/23/2005
  29  * Issue date:  04/30/2005
  30  *
  31  * Copyright (C) 2005 Olivier Gay <olivier.gay@a3.epfl.ch>
  32  * All rights reserved.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  * 3. Neither the name of the project nor the names of its contributors
  43  *    may be used to endorse or promote products derived from this software
  44  *    without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  */
  58
  59 #include "inspircd.h"
  60 #ifdef HAS_STDINT
  61 #include <stdint.h>
  62 #endif
  63 #include "modules/hash.h"
  64
  65 #ifndef HAS_STDINT
  66 typedef unsigned int uint32_t;
  67 #endif
  68
  69 #define SHA256_DIGEST_SIZE (256 / 8)
  70 #define SHA256_BLOCK_SIZE  (512 / 8)
  71
  72 /** An sha 256 context, used by m_opersha256
  73  */
  74 class SHA256Context
  75 {
  76  public:
  77         unsigned int tot_len;
  78         unsigned int len;
  79         unsigned char block[2 * SHA256_BLOCK_SIZE];
  80         uint32_t h[8];
  81 };
  82
  83 #define SHFR(x, n)    (x >> n)
  84 #define ROTR(x, n)   ((x >> n) | (x << ((sizeof(x) << 3) - n)))
  85 #define ROTL(x, n)   ((x << n) | (x >> ((sizeof(x) << 3) - n)))
  86 #define CH(x, y, z)  ((x & y) ^ (~x & z))
  87 #define MAJ(x, y, z) ((x & y) ^ (x & z) ^ (y & z))
  88
  89 #define SHA256_F1(x) (ROTR(x,  2) ^ ROTR(x, 13) ^ ROTR(x, 22))
  90 #define SHA256_F2(x) (ROTR(x,  6) ^ ROTR(x, 11) ^ ROTR(x, 25))
  91 #define SHA256_F3(x) (ROTR(x,  7) ^ ROTR(x, 18) ^ SHFR(x,  3))
  92 #define SHA256_F4(x) (ROTR(x, 17) ^ ROTR(x, 19) ^ SHFR(x, 10))
  93
  94 #define UNPACK32(x, str)                       \
  95 {                                             \
  96         *((str) + 3) = (uint8_t) ((x)      );      \
  97         *((str) + 2) = (uint8_t) ((x) >>  8);      \
  98         *((str) + 1) = (uint8_t) ((x) >> 16);      \
  99         *((str) + 0) = (uint8_t) ((x) >> 24);      \
 100 }
 101
 102 #define PACK32(str, x)                   \
 103 {                                             \
 104         *(x) = ((uint32_t) *((str) + 3)      )     \
 105         | ((uint32_t) *((str) + 2) <<  8)     \
 106         | ((uint32_t) *((str) + 1) << 16)     \
 107         | ((uint32_t) *((str) + 0) << 24);    \
 108 }
 109
 110 /* Macros used for loops unrolling */
 111
 112 #define SHA256_SCR(i)                     \
 113 {                                             \
 114         w[i] =  SHA256_F4(w[i - 2]) + w[i - 7]     \
 115         + SHA256_F3(w[i - 15]) + w[i - 16];  \
 116 }
 117
 118 const unsigned int sha256_h0[8] =
 119 {
 120         0x6a09e667, 0xbb67ae85, 0x3c6ef372, 0xa54ff53a,
 121         0x510e527f, 0x9b05688c, 0x1f83d9ab, 0x5be0cd19
 122 };
 123
 124 uint32_t sha256_k[64] =
 125 {
 126         0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5,
 127         0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,
 128         0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3,
 129         0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,
 130         0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc,
 131         0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,
 132         0x983e5152, 0xa831c66d, 0xb00327c8, 0xbf597fc7,
 133         0xc6e00bf3, 0xd5a79147, 0x06ca6351, 0x14292967,
 134         0x27b70a85, 0x2e1b2138, 0x4d2c6dfc, 0x53380d13,
 135         0x650a7354, 0x766a0abb, 0x81c2c92e, 0x92722c85,
 136         0xa2bfe8a1, 0xa81a664b, 0xc24b8b70, 0xc76c51a3,
 137         0xd192e819, 0xd6990624, 0xf40e3585, 0x106aa070,
 138         0x19a4c116, 0x1e376c08, 0x2748774c, 0x34b0bcb5,
 139         0x391c0cb3, 0x4ed8aa4a, 0x5b9cca4f, 0x682e6ff3,
 140         0x748f82ee, 0x78a5636f, 0x84c87814, 0x8cc70208,
 141         0x90befffa, 0xa4506ceb, 0xbef9a3f7, 0xc67178f2
 142 };
 143
 144 class HashSHA256 : public HashProvider
 145 {
 146         void SHA256Init(SHA256Context *ctx, const unsigned int* ikey)
 147         {
 148                 if (ikey)
 149                 {
 150                         for (int i = 0; i < 8; i++)
 151                                 ctx->h[i] = ikey[i];
 152                 }
 153                 else
 154                 {
 155                         for (int i = 0; i < 8; i++)
 156                                 ctx->h[i] = sha256_h0[i];
 157                 }
 158                 ctx->len = 0;
 159                 ctx->tot_len = 0;
 160         }
 161
 162         void SHA256Transform(SHA256Context *ctx, unsigned char *message, unsigned int block_nb)
 163         {
 164                 uint32_t w[64];
 165                 uint32_t wv[8];
 166                 unsigned char *sub_block;
 167                 for (unsigned int i = 1; i <= block_nb; i++)
 168                 {
 169                         int j;
 170                         sub_block = message + ((i - 1) << 6);
 171
 172                         for (j = 0; j < 16; j++)
 173                                 PACK32(&sub_block[j << 2], &w[j]);
 174                         for (j = 16; j < 64; j++)
 175                                 SHA256_SCR(j);
 176                         for (j = 0; j < 8; j++)
 177                                 wv[j] = ctx->h[j];
 178                         for (j = 0; j < 64; j++)
 179                         {
 180                                 uint32_t t1 = wv[7] + SHA256_F2(wv[4]) + CH(wv[4], wv[5], wv[6]) + sha256_k[j] + w[j];
 181                                 uint32_t t2 = SHA256_F1(wv[0]) + MAJ(wv[0], wv[1], wv[2]);
 182                                 wv[7] = wv[6];
 183                                 wv[6] = wv[5];
 184                                 wv[5] = wv[4];
 185                                 wv[4] = wv[3] + t1;
 186                                 wv[3] = wv[2];
 187                                 wv[2] = wv[1];
 188                                 wv[1] = wv[0];
 189                                 wv[0] = t1 + t2;
 190                         }
 191                         for (j = 0; j < 8; j++)
 192                                 ctx->h[j] += wv[j];
 193                 }
 194         }
 195
 196         void SHA256Update(SHA256Context *ctx, unsigned char *message, unsigned int len)
 197         {
 198                 /*
 199                  * XXX here be dragons!
 200                  * After many hours of pouring over this, I think I've found the problem.
 201                  * When Special created our module from the reference one, he used:
 202                  *
 203                  *     unsigned int rem_len = SHA256_BLOCK_SIZE - ctx->len;
 204                  *
 205                  * instead of the reference's version of:
 206                  *
 207                  *     unsigned int tmp_len = SHA256_BLOCK_SIZE - ctx->len;
 208                  *     unsigned int rem_len = len < tmp_len ? len : tmp_len;
 209                  *
 210                  * I've changed back to the reference version of this code, and it seems to work with no errors.
 211                  * So I'm inclined to believe this was the problem..
 212                  *             -- w00t (January 06, 2008)
 213                  */
 214                 unsigned int tmp_len = SHA256_BLOCK_SIZE - ctx->len;
 215                 unsigned int rem_len = len < tmp_len ? len : tmp_len;
 216
 217
 218                 memcpy(&ctx->block[ctx->len], message, rem_len);
 219                 if (ctx->len + len < SHA256_BLOCK_SIZE)
 220                 {
 221                         ctx->len += len;
 222                         return;
 223                 }
 224                 unsigned int new_len = len - rem_len;
 225                 unsigned int block_nb = new_len / SHA256_BLOCK_SIZE;
 226                 unsigned char *shifted_message = message + rem_len;
 227                 SHA256Transform(ctx, ctx->block, 1);
 228                 SHA256Transform(ctx, shifted_message, block_nb);
 229                 rem_len = new_len % SHA256_BLOCK_SIZE;
 230                 memcpy(ctx->block, &shifted_message[block_nb << 6],rem_len);
 231                 ctx->len = rem_len;
 232                 ctx->tot_len += (block_nb + 1) << 6;
 233         }
 234
 235         void SHA256Final(SHA256Context *ctx, unsigned char *digest)
 236         {
 237                 unsigned int block_nb = (1 + ((SHA256_BLOCK_SIZE - 9) < (ctx->len % SHA256_BLOCK_SIZE)));
 238                 unsigned int len_b = (ctx->tot_len + ctx->len) << 3;
 239                 unsigned int pm_len = block_nb << 6;
 240                 memset(ctx->block + ctx->len, 0, pm_len - ctx->len);
 241                 ctx->block[ctx->len] = 0x80;
 242                 UNPACK32(len_b, ctx->block + pm_len - 4);
 243                 SHA256Transform(ctx, ctx->block, block_nb);
 244                 for (int i = 0 ; i < 8; i++)
 245                         UNPACK32(ctx->h[i], &digest[i << 2]);
 246         }
 247
 248         void SHA256(const char *src, unsigned char *dest, unsigned int len)
 249         {
 250                 SHA256Context ctx;
 251                 SHA256Init(&ctx, NULL);
 252                 SHA256Update(&ctx, (unsigned char *)src, len);
 253                 SHA256Final(&ctx, dest);
 254         }
 255
 256  public:
 257         std::string sum(const std::string& data)
 258         {
 259                 unsigned char bytes[SHA256_DIGEST_SIZE];
 260                 SHA256(data.data(), bytes, data.length());
 261                 return std::string((char*)bytes, SHA256_DIGEST_SIZE);
 262         }
 263
 264         HashSHA256(Module* parent) : HashProvider(parent, "hash/sha256", 32, 64) {}
 265 };
 266
 267 class ModuleSHA256 : public Module
 268 {
 269         HashSHA256 sha;
 270  public:
 271         ModuleSHA256() : sha(this)
 272         {
 273                 ServerInstance->Modules->AddService(sha);
 274         }
 275
 276         Version GetVersion() CXX11_OVERRIDE
 277         {
 278                 return Version("Implements SHA-256 hashing", VF_VENDOR);
 279         }
 280 };
 281
 282 MODULE_INIT(ModuleSHA256)