| 1 | /*
|
|---|
| 2 | * Copyright 1999-2022 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 3 | *
|
|---|
| 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 5 | * this file except in compliance with the License. You can obtain a copy
|
|---|
| 6 | * in the file LICENSE in the source distribution or at
|
|---|
| 7 | * https://www.openssl.org/source/license.html
|
|---|
| 8 | */
|
|---|
| 9 |
|
|---|
| 10 | /*-
|
|---|
| 11 | * This is a generic 32 bit "collector" for message digest algorithms.
|
|---|
| 12 | * Whenever needed it collects input character stream into chunks of
|
|---|
| 13 | * 32 bit values and invokes a block function that performs actual hash
|
|---|
| 14 | * calculations.
|
|---|
| 15 | *
|
|---|
| 16 | * Porting guide.
|
|---|
| 17 | *
|
|---|
| 18 | * Obligatory macros:
|
|---|
| 19 | *
|
|---|
| 20 | * DATA_ORDER_IS_BIG_ENDIAN or DATA_ORDER_IS_LITTLE_ENDIAN
|
|---|
| 21 | * this macro defines byte order of input stream.
|
|---|
| 22 | * HASH_CBLOCK
|
|---|
| 23 | * size of a unit chunk HASH_BLOCK operates on.
|
|---|
| 24 | * HASH_LONG
|
|---|
| 25 | * has to be at least 32 bit wide.
|
|---|
| 26 | * HASH_CTX
|
|---|
| 27 | * context structure that at least contains following
|
|---|
| 28 | * members:
|
|---|
| 29 | * typedef struct {
|
|---|
| 30 | * ...
|
|---|
| 31 | * HASH_LONG Nl,Nh;
|
|---|
| 32 | * either {
|
|---|
| 33 | * HASH_LONG data[HASH_LBLOCK];
|
|---|
| 34 | * unsigned char data[HASH_CBLOCK];
|
|---|
| 35 | * };
|
|---|
| 36 | * unsigned int num;
|
|---|
| 37 | * ...
|
|---|
| 38 | * } HASH_CTX;
|
|---|
| 39 | * data[] vector is expected to be zeroed upon first call to
|
|---|
| 40 | * HASH_UPDATE.
|
|---|
| 41 | * HASH_UPDATE
|
|---|
| 42 | * name of "Update" function, implemented here.
|
|---|
| 43 | * HASH_TRANSFORM
|
|---|
| 44 | * name of "Transform" function, implemented here.
|
|---|
| 45 | * HASH_FINAL
|
|---|
| 46 | * name of "Final" function, implemented here.
|
|---|
| 47 | * HASH_BLOCK_DATA_ORDER
|
|---|
| 48 | * name of "block" function capable of treating *unaligned* input
|
|---|
| 49 | * message in original (data) byte order, implemented externally.
|
|---|
| 50 | * HASH_MAKE_STRING
|
|---|
| 51 | * macro converting context variables to an ASCII hash string.
|
|---|
| 52 | *
|
|---|
| 53 | * MD5 example:
|
|---|
| 54 | *
|
|---|
| 55 | * #define DATA_ORDER_IS_LITTLE_ENDIAN
|
|---|
| 56 | *
|
|---|
| 57 | * #define HASH_LONG MD5_LONG
|
|---|
| 58 | * #define HASH_CTX MD5_CTX
|
|---|
| 59 | * #define HASH_CBLOCK MD5_CBLOCK
|
|---|
| 60 | * #define HASH_UPDATE MD5_Update
|
|---|
| 61 | * #define HASH_TRANSFORM MD5_Transform
|
|---|
| 62 | * #define HASH_FINAL MD5_Final
|
|---|
| 63 | * #define HASH_BLOCK_DATA_ORDER md5_block_data_order
|
|---|
| 64 | */
|
|---|
| 65 |
|
|---|
| 66 | #include <openssl/crypto.h>
|
|---|
| 67 |
|
|---|
| 68 | #if !defined(DATA_ORDER_IS_BIG_ENDIAN) && !defined(DATA_ORDER_IS_LITTLE_ENDIAN)
|
|---|
| 69 | # error "DATA_ORDER must be defined!"
|
|---|
| 70 | #endif
|
|---|
| 71 |
|
|---|
| 72 | #ifndef HASH_CBLOCK
|
|---|
| 73 | # error "HASH_CBLOCK must be defined!"
|
|---|
| 74 | #endif
|
|---|
| 75 | #ifndef HASH_LONG
|
|---|
| 76 | # error "HASH_LONG must be defined!"
|
|---|
| 77 | #endif
|
|---|
| 78 | #ifndef HASH_CTX
|
|---|
| 79 | # error "HASH_CTX must be defined!"
|
|---|
| 80 | #endif
|
|---|
| 81 |
|
|---|
| 82 | #ifndef HASH_UPDATE
|
|---|
| 83 | # error "HASH_UPDATE must be defined!"
|
|---|
| 84 | #endif
|
|---|
| 85 | #ifndef HASH_TRANSFORM
|
|---|
| 86 | # error "HASH_TRANSFORM must be defined!"
|
|---|
| 87 | #endif
|
|---|
| 88 | #ifndef HASH_FINAL
|
|---|
| 89 | # error "HASH_FINAL must be defined!"
|
|---|
| 90 | #endif
|
|---|
| 91 |
|
|---|
| 92 | #ifndef HASH_BLOCK_DATA_ORDER
|
|---|
| 93 | # error "HASH_BLOCK_DATA_ORDER must be defined!"
|
|---|
| 94 | #endif
|
|---|
| 95 |
|
|---|
| 96 | #define ROTATE(a,n) (((a)<<(n))|(((a)&0xffffffff)>>(32-(n))))
|
|---|
| 97 |
|
|---|
| 98 | #ifndef PEDANTIC
|
|---|
| 99 | # if defined(__GNUC__) && __GNUC__>=2 && \
|
|---|
| 100 | !defined(OPENSSL_NO_ASM) && !defined(OPENSSL_NO_INLINE_ASM)
|
|---|
| 101 | # if defined(__riscv_zbb) || defined(__riscv_zbkb)
|
|---|
| 102 | # if __riscv_xlen == 64
|
|---|
| 103 | # undef ROTATE
|
|---|
| 104 | # define ROTATE(x, n) ({ MD32_REG_T ret; \
|
|---|
| 105 | asm ("roriw %0, %1, %2" \
|
|---|
| 106 | : "=r"(ret) \
|
|---|
| 107 | : "r"(x), "i"(32 - (n))); ret;})
|
|---|
| 108 | # endif
|
|---|
| 109 | # if __riscv_xlen == 32
|
|---|
| 110 | # undef ROTATE
|
|---|
| 111 | # define ROTATE(x, n) ({ MD32_REG_T ret; \
|
|---|
| 112 | asm ("rori %0, %1, %2" \
|
|---|
| 113 | : "=r"(ret) \
|
|---|
| 114 | : "r"(x), "i"(32 - (n))); ret;})
|
|---|
| 115 | # endif
|
|---|
| 116 | # endif
|
|---|
| 117 | # endif
|
|---|
| 118 | #endif
|
|---|
| 119 |
|
|---|
| 120 | #if defined(DATA_ORDER_IS_BIG_ENDIAN)
|
|---|
| 121 |
|
|---|
| 122 | # define HOST_c2l(c,l) (l =(((unsigned long)(*((c)++)))<<24), \
|
|---|
| 123 | l|=(((unsigned long)(*((c)++)))<<16), \
|
|---|
| 124 | l|=(((unsigned long)(*((c)++)))<< 8), \
|
|---|
| 125 | l|=(((unsigned long)(*((c)++))) ) )
|
|---|
| 126 | # define HOST_l2c(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
|
|---|
| 127 | *((c)++)=(unsigned char)(((l)>>16)&0xff), \
|
|---|
| 128 | *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
|
|---|
| 129 | *((c)++)=(unsigned char)(((l) )&0xff), \
|
|---|
| 130 | l)
|
|---|
| 131 |
|
|---|
| 132 | #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
|
|---|
| 133 |
|
|---|
| 134 | # define HOST_c2l(c,l) (l =(((unsigned long)(*((c)++))) ), \
|
|---|
| 135 | l|=(((unsigned long)(*((c)++)))<< 8), \
|
|---|
| 136 | l|=(((unsigned long)(*((c)++)))<<16), \
|
|---|
| 137 | l|=(((unsigned long)(*((c)++)))<<24) )
|
|---|
| 138 | # define HOST_l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
|
|---|
| 139 | *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
|
|---|
| 140 | *((c)++)=(unsigned char)(((l)>>16)&0xff), \
|
|---|
| 141 | *((c)++)=(unsigned char)(((l)>>24)&0xff), \
|
|---|
| 142 | l)
|
|---|
| 143 |
|
|---|
| 144 | #endif
|
|---|
| 145 |
|
|---|
| 146 | /*
|
|---|
| 147 | * Time for some action :-)
|
|---|
| 148 | */
|
|---|
| 149 |
|
|---|
| 150 | int HASH_UPDATE(HASH_CTX *c, const void *data_, size_t len)
|
|---|
| 151 | {
|
|---|
| 152 | const unsigned char *data = data_;
|
|---|
| 153 | unsigned char *p;
|
|---|
| 154 | HASH_LONG l;
|
|---|
| 155 | size_t n;
|
|---|
| 156 |
|
|---|
| 157 | if (len == 0)
|
|---|
| 158 | return 1;
|
|---|
| 159 |
|
|---|
| 160 | l = (c->Nl + (((HASH_LONG) len) << 3)) & 0xffffffffUL;
|
|---|
| 161 | if (l < c->Nl) /* overflow */
|
|---|
| 162 | c->Nh++;
|
|---|
| 163 | c->Nh += (HASH_LONG) (len >> 29); /* might cause compiler warning on
|
|---|
| 164 | * 16-bit */
|
|---|
| 165 | c->Nl = l;
|
|---|
| 166 |
|
|---|
| 167 | n = c->num;
|
|---|
| 168 | if (n != 0) {
|
|---|
| 169 | p = (unsigned char *)c->data;
|
|---|
| 170 |
|
|---|
| 171 | if (len >= HASH_CBLOCK || len + n >= HASH_CBLOCK) {
|
|---|
| 172 | memcpy(p + n, data, HASH_CBLOCK - n);
|
|---|
| 173 | HASH_BLOCK_DATA_ORDER(c, p, 1);
|
|---|
| 174 | n = HASH_CBLOCK - n;
|
|---|
| 175 | data += n;
|
|---|
| 176 | len -= n;
|
|---|
| 177 | c->num = 0;
|
|---|
| 178 | /*
|
|---|
| 179 | * We use memset rather than OPENSSL_cleanse() here deliberately.
|
|---|
| 180 | * Using OPENSSL_cleanse() here could be a performance issue. It
|
|---|
| 181 | * will get properly cleansed on finalisation so this isn't a
|
|---|
| 182 | * security problem.
|
|---|
| 183 | */
|
|---|
| 184 | memset(p, 0, HASH_CBLOCK); /* keep it zeroed */
|
|---|
| 185 | } else {
|
|---|
| 186 | memcpy(p + n, data, len);
|
|---|
| 187 | c->num += (unsigned int)len;
|
|---|
| 188 | return 1;
|
|---|
| 189 | }
|
|---|
| 190 | }
|
|---|
| 191 |
|
|---|
| 192 | n = len / HASH_CBLOCK;
|
|---|
| 193 | if (n > 0) {
|
|---|
| 194 | HASH_BLOCK_DATA_ORDER(c, data, n);
|
|---|
| 195 | n *= HASH_CBLOCK;
|
|---|
| 196 | data += n;
|
|---|
| 197 | len -= n;
|
|---|
| 198 | }
|
|---|
| 199 |
|
|---|
| 200 | if (len != 0) {
|
|---|
| 201 | p = (unsigned char *)c->data;
|
|---|
| 202 | c->num = (unsigned int)len;
|
|---|
| 203 | memcpy(p, data, len);
|
|---|
| 204 | }
|
|---|
| 205 | return 1;
|
|---|
| 206 | }
|
|---|
| 207 |
|
|---|
| 208 | void HASH_TRANSFORM(HASH_CTX *c, const unsigned char *data)
|
|---|
| 209 | {
|
|---|
| 210 | HASH_BLOCK_DATA_ORDER(c, data, 1);
|
|---|
| 211 | }
|
|---|
| 212 |
|
|---|
| 213 | int HASH_FINAL(unsigned char *md, HASH_CTX *c)
|
|---|
| 214 | {
|
|---|
| 215 | unsigned char *p = (unsigned char *)c->data;
|
|---|
| 216 | size_t n = c->num;
|
|---|
| 217 |
|
|---|
| 218 | p[n] = 0x80; /* there is always room for one */
|
|---|
| 219 | n++;
|
|---|
| 220 |
|
|---|
| 221 | if (n > (HASH_CBLOCK - 8)) {
|
|---|
| 222 | memset(p + n, 0, HASH_CBLOCK - n);
|
|---|
| 223 | n = 0;
|
|---|
| 224 | HASH_BLOCK_DATA_ORDER(c, p, 1);
|
|---|
| 225 | }
|
|---|
| 226 | memset(p + n, 0, HASH_CBLOCK - 8 - n);
|
|---|
| 227 |
|
|---|
| 228 | p += HASH_CBLOCK - 8;
|
|---|
| 229 | #if defined(DATA_ORDER_IS_BIG_ENDIAN)
|
|---|
| 230 | (void)HOST_l2c(c->Nh, p);
|
|---|
| 231 | (void)HOST_l2c(c->Nl, p);
|
|---|
| 232 | #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
|
|---|
| 233 | (void)HOST_l2c(c->Nl, p);
|
|---|
| 234 | (void)HOST_l2c(c->Nh, p);
|
|---|
| 235 | #endif
|
|---|
| 236 | p -= HASH_CBLOCK;
|
|---|
| 237 | HASH_BLOCK_DATA_ORDER(c, p, 1);
|
|---|
| 238 | c->num = 0;
|
|---|
| 239 | OPENSSL_cleanse(p, HASH_CBLOCK);
|
|---|
| 240 |
|
|---|
| 241 | #ifndef HASH_MAKE_STRING
|
|---|
| 242 | # error "HASH_MAKE_STRING must be defined!"
|
|---|
| 243 | #else
|
|---|
| 244 | HASH_MAKE_STRING(c, md);
|
|---|
| 245 | #endif
|
|---|
| 246 |
|
|---|
| 247 | return 1;
|
|---|
| 248 | }
|
|---|
| 249 |
|
|---|
| 250 | #ifndef MD32_REG_T
|
|---|
| 251 | # if defined(__alpha) || defined(__sparcv9) || defined(__mips)
|
|---|
| 252 | # define MD32_REG_T long
|
|---|
| 253 | /*
|
|---|
| 254 | * This comment was originally written for MD5, which is why it
|
|---|
| 255 | * discusses A-D. But it basically applies to all 32-bit digests,
|
|---|
| 256 | * which is why it was moved to common header file.
|
|---|
| 257 | *
|
|---|
| 258 | * In case you wonder why A-D are declared as long and not
|
|---|
| 259 | * as MD5_LONG. Doing so results in slight performance
|
|---|
| 260 | * boost on LP64 architectures. The catch is we don't
|
|---|
| 261 | * really care if 32 MSBs of a 64-bit register get polluted
|
|---|
| 262 | * with eventual overflows as we *save* only 32 LSBs in
|
|---|
| 263 | * *either* case. Now declaring 'em long excuses the compiler
|
|---|
| 264 | * from keeping 32 MSBs zeroed resulting in 13% performance
|
|---|
| 265 | * improvement under SPARC Solaris7/64 and 5% under AlphaLinux.
|
|---|
| 266 | * Well, to be honest it should say that this *prevents*
|
|---|
| 267 | * performance degradation.
|
|---|
| 268 | */
|
|---|
| 269 | # else
|
|---|
| 270 | /*
|
|---|
| 271 | * Above is not absolute and there are LP64 compilers that
|
|---|
| 272 | * generate better code if MD32_REG_T is defined int. The above
|
|---|
| 273 | * pre-processor condition reflects the circumstances under which
|
|---|
| 274 | * the conclusion was made and is subject to further extension.
|
|---|
| 275 | */
|
|---|
| 276 | # define MD32_REG_T int
|
|---|
| 277 | # endif
|
|---|
| 278 | #endif
|
|---|
