module/icp/include/sha2/sha2.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25 /* Copyright 2013 Saso Kiselkov.  All rights reserved. */
  26
  27 #ifndef _SYS_SHA2_H
  28 #define _SYS_SHA2_H
  29
  30 #include <sys/types.h>          /* for uint_* */
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #define SHA2_HMAC_MIN_KEY_LEN   1       /* SHA2-HMAC min key length in bytes */
  37 #define SHA2_HMAC_MAX_KEY_LEN   INT_MAX /* SHA2-HMAC max key length in bytes */
  38
  39 #define SHA256_DIGEST_LENGTH    32      /* SHA256 digest length in bytes */
  40
  41 #define SHA256_HMAC_BLOCK_SIZE  64      /* SHA256-HMAC block size */
  42
  43 #define SHA256                  0
  44 #define SHA256_HMAC             1
  45 #define SHA256_HMAC_GEN         2
  46
  47 /*
  48  * SHA2 context.
  49  * The contents of this structure are a private interface between the
  50  * Init/Update/Final calls of the functions defined below.
  51  * Callers must never attempt to read or write any of the fields
  52  * in this structure directly.
  53  */
  54 typedef struct  {
  55         uint32_t algotype;              /* Algorithm Type */
  56
  57         /* state (ABCDEFGH) */
  58         union {
  59                 uint32_t s32[8];        /* for SHA256 */
  60                 uint64_t s64[8];        /* for SHA384/512 */
  61         } state;
  62         /* number of bits */
  63         union {
  64                 uint32_t c32[2];        /* for SHA256 , modulo 2^64 */
  65                 uint64_t c64[2];        /* for SHA384/512, modulo 2^128 */
  66         } count;
  67         union {
  68                 uint8_t         buf8[128];      /* undigested input */
  69                 uint32_t        buf32[32];      /* realigned input */
  70                 uint64_t        buf64[16];      /* realigned input */
  71         } buf_un;
  72 } SHA2_CTX;
  73
  74 typedef SHA2_CTX SHA256_CTX;
  75 typedef SHA2_CTX SHA384_CTX;
  76 typedef SHA2_CTX SHA512_CTX;
  77
  78 extern void SHA2Init(uint64_t mech, SHA2_CTX *);
  79
  80 extern void SHA2Update(SHA2_CTX *, const void *, size_t);
  81
  82 extern void SHA2Final(void *, SHA2_CTX *);
  83
  84 extern void SHA256Init(SHA256_CTX *);
  85
  86 extern void SHA256Update(SHA256_CTX *, const void *, size_t);
  87
  88 extern void SHA256Final(void *, SHA256_CTX *);
  89
  90 #ifdef _SHA2_IMPL
  91 /*
  92  * The following types/functions are all private to the implementation
  93  * of the SHA2 functions and must not be used by consumers of the interface
  94  */
  95
  96 /*
  97  * List of support mechanisms in this module.
  98  *
  99  * It is important to note that in the module, division or modulus calculations
 100  * are used on the enumerated type to determine which mechanism is being used;
 101  * therefore, changing the order or additional mechanisms should be done
 102  * carefully
 103  */
 104 typedef enum sha2_mech_type {
 105         SHA256_MECH_INFO_TYPE,          /* SUN_CKM_SHA256 */
 106         SHA256_HMAC_MECH_INFO_TYPE,     /* SUN_CKM_SHA256_HMAC */
 107         SHA256_HMAC_GEN_MECH_INFO_TYPE, /* SUN_CKM_SHA256_HMAC_GENERAL */
 108 } sha2_mech_type_t;
 109
 110 #endif /* _SHA2_IMPL */
 111
 112 #ifdef  __cplusplus
 113 }
 114 #endif
 115
 116 #endif /* _SYS_SHA2_H */