Blame include/crypto/md32_common.h

Packit c4476c
/*
Packit c4476c
 * Copyright 1999-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
 *
Packit c4476c
 * Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
 * this file except in compliance with the License.  You can obtain a copy
Packit c4476c
 * in the file LICENSE in the source distribution or at
Packit c4476c
 * https://www.openssl.org/source/license.html
Packit c4476c
 */
Packit c4476c
Packit c4476c
/*-
Packit c4476c
 * This is a generic 32 bit "collector" for message digest algorithms.
Packit c4476c
 * Whenever needed it collects input character stream into chunks of
Packit c4476c
 * 32 bit values and invokes a block function that performs actual hash
Packit c4476c
 * calculations.
Packit c4476c
 *
Packit c4476c
 * Porting guide.
Packit c4476c
 *
Packit c4476c
 * Obligatory macros:
Packit c4476c
 *
Packit c4476c
 * DATA_ORDER_IS_BIG_ENDIAN or DATA_ORDER_IS_LITTLE_ENDIAN
Packit c4476c
 *      this macro defines byte order of input stream.
Packit c4476c
 * HASH_CBLOCK
Packit c4476c
 *      size of a unit chunk HASH_BLOCK operates on.
Packit c4476c
 * HASH_LONG
Packit c4476c
 *      has to be at least 32 bit wide.
Packit c4476c
 * HASH_CTX
Packit c4476c
 *      context structure that at least contains following
Packit c4476c
 *      members:
Packit c4476c
 *              typedef struct {
Packit c4476c
 *                      ...
Packit c4476c
 *                      HASH_LONG       Nl,Nh;
Packit c4476c
 *                      either {
Packit c4476c
 *                      HASH_LONG       data[HASH_LBLOCK];
Packit c4476c
 *                      unsigned char   data[HASH_CBLOCK];
Packit c4476c
 *                      };
Packit c4476c
 *                      unsigned int    num;
Packit c4476c
 *                      ...
Packit c4476c
 *                      } HASH_CTX;
Packit c4476c
 *      data[] vector is expected to be zeroed upon first call to
Packit c4476c
 *      HASH_UPDATE.
Packit c4476c
 * HASH_UPDATE
Packit c4476c
 *      name of "Update" function, implemented here.
Packit c4476c
 * HASH_TRANSFORM
Packit c4476c
 *      name of "Transform" function, implemented here.
Packit c4476c
 * HASH_FINAL
Packit c4476c
 *      name of "Final" function, implemented here.
Packit c4476c
 * HASH_BLOCK_DATA_ORDER
Packit c4476c
 *      name of "block" function capable of treating *unaligned* input
Packit c4476c
 *      message in original (data) byte order, implemented externally.
Packit c4476c
 * HASH_MAKE_STRING
Packit c4476c
 *      macro converting context variables to an ASCII hash string.
Packit c4476c
 *
Packit c4476c
 * MD5 example:
Packit c4476c
 *
Packit c4476c
 *      #define DATA_ORDER_IS_LITTLE_ENDIAN
Packit c4476c
 *
Packit c4476c
 *      #define HASH_LONG               MD5_LONG
Packit c4476c
 *      #define HASH_CTX                MD5_CTX
Packit c4476c
 *      #define HASH_CBLOCK             MD5_CBLOCK
Packit c4476c
 *      #define HASH_UPDATE             MD5_Update
Packit c4476c
 *      #define HASH_TRANSFORM          MD5_Transform
Packit c4476c
 *      #define HASH_FINAL              MD5_Final
Packit c4476c
 *      #define HASH_BLOCK_DATA_ORDER   md5_block_data_order
Packit c4476c
 */
Packit c4476c
Packit c4476c
#include <openssl/crypto.h>
Packit c4476c
Packit c4476c
#if !defined(DATA_ORDER_IS_BIG_ENDIAN) && !defined(DATA_ORDER_IS_LITTLE_ENDIAN)
Packit c4476c
# error "DATA_ORDER must be defined!"
Packit c4476c
#endif
Packit c4476c
Packit c4476c
#ifndef HASH_CBLOCK
Packit c4476c
# error "HASH_CBLOCK must be defined!"
Packit c4476c
#endif
Packit c4476c
#ifndef HASH_LONG
Packit c4476c
# error "HASH_LONG must be defined!"
Packit c4476c
#endif
Packit c4476c
#ifndef HASH_CTX
Packit c4476c
# error "HASH_CTX must be defined!"
Packit c4476c
#endif
Packit c4476c
Packit c4476c
#ifndef HASH_UPDATE
Packit c4476c
# error "HASH_UPDATE must be defined!"
Packit c4476c
#endif
Packit c4476c
#ifndef HASH_TRANSFORM
Packit c4476c
# error "HASH_TRANSFORM must be defined!"
Packit c4476c
#endif
Packit c4476c
#ifndef HASH_FINAL
Packit c4476c
# error "HASH_FINAL must be defined!"
Packit c4476c
#endif
Packit c4476c
Packit c4476c
#ifndef HASH_BLOCK_DATA_ORDER
Packit c4476c
# error "HASH_BLOCK_DATA_ORDER must be defined!"
Packit c4476c
#endif
Packit c4476c
Packit c4476c
#define ROTATE(a,n)     (((a)<<(n))|(((a)&0xffffffff)>>(32-(n))))
Packit c4476c
Packit c4476c
#if defined(DATA_ORDER_IS_BIG_ENDIAN)
Packit c4476c
Packit c4476c
# define HOST_c2l(c,l)  (l =(((unsigned long)(*((c)++)))<<24),          \
Packit c4476c
                         l|=(((unsigned long)(*((c)++)))<<16),          \
Packit c4476c
                         l|=(((unsigned long)(*((c)++)))<< 8),          \
Packit c4476c
                         l|=(((unsigned long)(*((c)++)))    )           )
Packit c4476c
# define HOST_l2c(l,c)  (*((c)++)=(unsigned char)(((l)>>24)&0xff),      \
Packit c4476c
                         *((c)++)=(unsigned char)(((l)>>16)&0xff),      \
Packit c4476c
                         *((c)++)=(unsigned char)(((l)>> 8)&0xff),      \
Packit c4476c
                         *((c)++)=(unsigned char)(((l)    )&0xff),      \
Packit c4476c
                         l)
Packit c4476c
Packit c4476c
#elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
Packit c4476c
Packit c4476c
# define HOST_c2l(c,l)  (l =(((unsigned long)(*((c)++)))    ),          \
Packit c4476c
                         l|=(((unsigned long)(*((c)++)))<< 8),          \
Packit c4476c
                         l|=(((unsigned long)(*((c)++)))<<16),          \
Packit c4476c
                         l|=(((unsigned long)(*((c)++)))<<24)           )
Packit c4476c
# define HOST_l2c(l,c)  (*((c)++)=(unsigned char)(((l)    )&0xff),      \
Packit c4476c
                         *((c)++)=(unsigned char)(((l)>> 8)&0xff),      \
Packit c4476c
                         *((c)++)=(unsigned char)(((l)>>16)&0xff),      \
Packit c4476c
                         *((c)++)=(unsigned char)(((l)>>24)&0xff),      \
Packit c4476c
                         l)
Packit c4476c
Packit c4476c
#endif
Packit c4476c
Packit c4476c
/*
Packit c4476c
 * Time for some action :-)
Packit c4476c
 */
Packit c4476c
Packit c4476c
int HASH_UPDATE(HASH_CTX *c, const void *data_, size_t len)
Packit c4476c
{
Packit c4476c
    const unsigned char *data = data_;
Packit c4476c
    unsigned char *p;
Packit c4476c
    HASH_LONG l;
Packit c4476c
    size_t n;
Packit c4476c
Packit c4476c
    if (len == 0)
Packit c4476c
        return 1;
Packit c4476c
Packit c4476c
    l = (c->Nl + (((HASH_LONG) len) << 3)) & 0xffffffffUL;
Packit c4476c
    if (l < c->Nl)              /* overflow */
Packit c4476c
        c->Nh++;
Packit c4476c
    c->Nh += (HASH_LONG) (len >> 29); /* might cause compiler warning on
Packit c4476c
                                       * 16-bit */
Packit c4476c
    c->Nl = l;
Packit c4476c
Packit c4476c
    n = c->num;
Packit c4476c
    if (n != 0) {
Packit c4476c
        p = (unsigned char *)c->data;
Packit c4476c
Packit c4476c
        if (len >= HASH_CBLOCK || len + n >= HASH_CBLOCK) {
Packit c4476c
            memcpy(p + n, data, HASH_CBLOCK - n);
Packit c4476c
            HASH_BLOCK_DATA_ORDER(c, p, 1);
Packit c4476c
            n = HASH_CBLOCK - n;
Packit c4476c
            data += n;
Packit c4476c
            len -= n;
Packit c4476c
            c->num = 0;
Packit c4476c
            /*
Packit c4476c
             * We use memset rather than OPENSSL_cleanse() here deliberately.
Packit c4476c
             * Using OPENSSL_cleanse() here could be a performance issue. It
Packit c4476c
             * will get properly cleansed on finalisation so this isn't a
Packit c4476c
             * security problem.
Packit c4476c
             */
Packit c4476c
            memset(p, 0, HASH_CBLOCK); /* keep it zeroed */
Packit c4476c
        } else {
Packit c4476c
            memcpy(p + n, data, len);
Packit c4476c
            c->num += (unsigned int)len;
Packit c4476c
            return 1;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    n = len / HASH_CBLOCK;
Packit c4476c
    if (n > 0) {
Packit c4476c
        HASH_BLOCK_DATA_ORDER(c, data, n);
Packit c4476c
        n *= HASH_CBLOCK;
Packit c4476c
        data += n;
Packit c4476c
        len -= n;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (len != 0) {
Packit c4476c
        p = (unsigned char *)c->data;
Packit c4476c
        c->num = (unsigned int)len;
Packit c4476c
        memcpy(p, data, len);
Packit c4476c
    }
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
void HASH_TRANSFORM(HASH_CTX *c, const unsigned char *data)
Packit c4476c
{
Packit c4476c
    HASH_BLOCK_DATA_ORDER(c, data, 1);
Packit c4476c
}
Packit c4476c
Packit c4476c
int HASH_FINAL(unsigned char *md, HASH_CTX *c)
Packit c4476c
{
Packit c4476c
    unsigned char *p = (unsigned char *)c->data;
Packit c4476c
    size_t n = c->num;
Packit c4476c
Packit c4476c
    p[n] = 0x80;                /* there is always room for one */
Packit c4476c
    n++;
Packit c4476c
Packit c4476c
    if (n > (HASH_CBLOCK - 8)) {
Packit c4476c
        memset(p + n, 0, HASH_CBLOCK - n);
Packit c4476c
        n = 0;
Packit c4476c
        HASH_BLOCK_DATA_ORDER(c, p, 1);
Packit c4476c
    }
Packit c4476c
    memset(p + n, 0, HASH_CBLOCK - 8 - n);
Packit c4476c
Packit c4476c
    p += HASH_CBLOCK - 8;
Packit c4476c
#if   defined(DATA_ORDER_IS_BIG_ENDIAN)
Packit c4476c
    (void)HOST_l2c(c->Nh, p);
Packit c4476c
    (void)HOST_l2c(c->Nl, p);
Packit c4476c
#elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
Packit c4476c
    (void)HOST_l2c(c->Nl, p);
Packit c4476c
    (void)HOST_l2c(c->Nh, p);
Packit c4476c
#endif
Packit c4476c
    p -= HASH_CBLOCK;
Packit c4476c
    HASH_BLOCK_DATA_ORDER(c, p, 1);
Packit c4476c
    c->num = 0;
Packit c4476c
    OPENSSL_cleanse(p, HASH_CBLOCK);
Packit c4476c
Packit c4476c
#ifndef HASH_MAKE_STRING
Packit c4476c
# error "HASH_MAKE_STRING must be defined!"
Packit c4476c
#else
Packit c4476c
    HASH_MAKE_STRING(c, md);
Packit c4476c
#endif
Packit c4476c
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
#ifndef MD32_REG_T
Packit c4476c
# if defined(__alpha) || defined(__sparcv9) || defined(__mips)
Packit c4476c
#  define MD32_REG_T long
Packit c4476c
/*
Packit c4476c
 * This comment was originally written for MD5, which is why it
Packit c4476c
 * discusses A-D. But it basically applies to all 32-bit digests,
Packit c4476c
 * which is why it was moved to common header file.
Packit c4476c
 *
Packit c4476c
 * In case you wonder why A-D are declared as long and not
Packit c4476c
 * as MD5_LONG. Doing so results in slight performance
Packit c4476c
 * boost on LP64 architectures. The catch is we don't
Packit c4476c
 * really care if 32 MSBs of a 64-bit register get polluted
Packit c4476c
 * with eventual overflows as we *save* only 32 LSBs in
Packit c4476c
 * *either* case. Now declaring 'em long excuses the compiler
Packit c4476c
 * from keeping 32 MSBs zeroed resulting in 13% performance
Packit c4476c
 * improvement under SPARC Solaris7/64 and 5% under AlphaLinux.
Packit c4476c
 * Well, to be honest it should say that this *prevents*
Packit c4476c
 * performance degradation.
Packit c4476c
 */
Packit c4476c
# else
Packit c4476c
/*
Packit c4476c
 * Above is not absolute and there are LP64 compilers that
Packit c4476c
 * generate better code if MD32_REG_T is defined int. The above
Packit c4476c
 * pre-processor condition reflects the circumstances under which
Packit c4476c
 * the conclusion was made and is subject to further extension.
Packit c4476c
 */
Packit c4476c
#  define MD32_REG_T int
Packit c4476c
# endif
Packit c4476c
#endif