Doug Anson / mbedTLSLibrary

mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

include/polarssl/sha512.h@0:137634ff4186, 2015-06-11 (annotated)

Committer:
ansond
Date:
Thu Jun 11 03:27:03 2015 +0000
Revision:
0:137634ff4186
initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:137634ff4186 1 /**
ansond 0:137634ff4186 2 * \file sha512.h
ansond 0:137634ff4186 3 *
ansond 0:137634ff4186 4 * \brief SHA-384 and SHA-512 cryptographic hash function
ansond 0:137634ff4186 5 *
ansond 0:137634ff4186 6 * Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
ansond 0:137634ff4186 7 *
ansond 0:137634ff4186 8 * This file is part of mbed TLS (https://tls.mbed.org)
ansond 0:137634ff4186 9 *
ansond 0:137634ff4186 10 * This program is free software; you can redistribute it and/or modify
ansond 0:137634ff4186 11 * it under the terms of the GNU General Public License as published by
ansond 0:137634ff4186 12 * the Free Software Foundation; either version 2 of the License, or
ansond 0:137634ff4186 13 * (at your option) any later version.
ansond 0:137634ff4186 14 *
ansond 0:137634ff4186 15 * This program is distributed in the hope that it will be useful,
ansond 0:137634ff4186 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ansond 0:137634ff4186 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ansond 0:137634ff4186 18 * GNU General Public License for more details.
ansond 0:137634ff4186 19 *
ansond 0:137634ff4186 20 * You should have received a copy of the GNU General Public License along
ansond 0:137634ff4186 21 * with this program; if not, write to the Free Software Foundation, Inc.,
ansond 0:137634ff4186 22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
ansond 0:137634ff4186 23 */
ansond 0:137634ff4186 24 #ifndef POLARSSL_SHA512_H
ansond 0:137634ff4186 25 #define POLARSSL_SHA512_H
ansond 0:137634ff4186 26
ansond 0:137634ff4186 27 #if !defined(POLARSSL_CONFIG_FILE)
ansond 0:137634ff4186 28 #include "config.h"
ansond 0:137634ff4186 29 #else
ansond 0:137634ff4186 30 #include POLARSSL_CONFIG_FILE
ansond 0:137634ff4186 31 #endif
ansond 0:137634ff4186 32
ansond 0:137634ff4186 33 #include <stddef.h>
ansond 0:137634ff4186 34
ansond 0:137634ff4186 35 #if defined(_MSC_VER) || defined(__WATCOMC__)
ansond 0:137634ff4186 36 typedef unsigned __int64 uint64_t;
ansond 0:137634ff4186 37 #else
ansond 0:137634ff4186 38 #include <inttypes.h>
ansond 0:137634ff4186 39 #endif
ansond 0:137634ff4186 40
ansond 0:137634ff4186 41 #define POLARSSL_ERR_SHA512_FILE_IO_ERROR -0x007A /**< Read/write error in file. */
ansond 0:137634ff4186 42
ansond 0:137634ff4186 43 #if !defined(POLARSSL_SHA512_ALT)
ansond 0:137634ff4186 44 // Regular implementation
ansond 0:137634ff4186 45 //
ansond 0:137634ff4186 46
ansond 0:137634ff4186 47 #ifdef __cplusplus
ansond 0:137634ff4186 48 extern "C" {
ansond 0:137634ff4186 49 #endif
ansond 0:137634ff4186 50
ansond 0:137634ff4186 51 /**
ansond 0:137634ff4186 52 * \brief SHA-512 context structure
ansond 0:137634ff4186 53 */
ansond 0:137634ff4186 54 typedef struct
ansond 0:137634ff4186 55 {
ansond 0:137634ff4186 56 uint64_t total[2]; /*!< number of bytes processed */
ansond 0:137634ff4186 57 uint64_t state[8]; /*!< intermediate digest state */
ansond 0:137634ff4186 58 unsigned char buffer[128]; /*!< data block being processed */
ansond 0:137634ff4186 59
ansond 0:137634ff4186 60 unsigned char ipad[128]; /*!< HMAC: inner padding */
ansond 0:137634ff4186 61 unsigned char opad[128]; /*!< HMAC: outer padding */
ansond 0:137634ff4186 62 int is384; /*!< 0 => SHA-512, else SHA-384 */
ansond 0:137634ff4186 63 }
ansond 0:137634ff4186 64 sha512_context;
ansond 0:137634ff4186 65
ansond 0:137634ff4186 66 /**
ansond 0:137634ff4186 67 * \brief Initialize SHA-512 context
ansond 0:137634ff4186 68 *
ansond 0:137634ff4186 69 * \param ctx SHA-512 context to be initialized
ansond 0:137634ff4186 70 */
ansond 0:137634ff4186 71 void sha512_init( sha512_context *ctx );
ansond 0:137634ff4186 72
ansond 0:137634ff4186 73 /**
ansond 0:137634ff4186 74 * \brief Clear SHA-512 context
ansond 0:137634ff4186 75 *
ansond 0:137634ff4186 76 * \param ctx SHA-512 context to be cleared
ansond 0:137634ff4186 77 */
ansond 0:137634ff4186 78 void sha512_free( sha512_context *ctx );
ansond 0:137634ff4186 79
ansond 0:137634ff4186 80 /**
ansond 0:137634ff4186 81 * \brief SHA-512 context setup
ansond 0:137634ff4186 82 *
ansond 0:137634ff4186 83 * \param ctx context to be initialized
ansond 0:137634ff4186 84 * \param is384 0 = use SHA512, 1 = use SHA384
ansond 0:137634ff4186 85 */
ansond 0:137634ff4186 86 void sha512_starts( sha512_context *ctx, int is384 );
ansond 0:137634ff4186 87
ansond 0:137634ff4186 88 /**
ansond 0:137634ff4186 89 * \brief SHA-512 process buffer
ansond 0:137634ff4186 90 *
ansond 0:137634ff4186 91 * \param ctx SHA-512 context
ansond 0:137634ff4186 92 * \param input buffer holding the data
ansond 0:137634ff4186 93 * \param ilen length of the input data
ansond 0:137634ff4186 94 */
ansond 0:137634ff4186 95 void sha512_update( sha512_context *ctx, const unsigned char *input,
ansond 0:137634ff4186 96 size_t ilen );
ansond 0:137634ff4186 97
ansond 0:137634ff4186 98 /**
ansond 0:137634ff4186 99 * \brief SHA-512 final digest
ansond 0:137634ff4186 100 *
ansond 0:137634ff4186 101 * \param ctx SHA-512 context
ansond 0:137634ff4186 102 * \param output SHA-384/512 checksum result
ansond 0:137634ff4186 103 */
ansond 0:137634ff4186 104 void sha512_finish( sha512_context *ctx, unsigned char output[64] );
ansond 0:137634ff4186 105
ansond 0:137634ff4186 106 #ifdef __cplusplus
ansond 0:137634ff4186 107 }
ansond 0:137634ff4186 108 #endif
ansond 0:137634ff4186 109
ansond 0:137634ff4186 110 #else /* POLARSSL_SHA512_ALT */
ansond 0:137634ff4186 111 #include "sha512_alt.h"
ansond 0:137634ff4186 112 #endif /* POLARSSL_SHA512_ALT */
ansond 0:137634ff4186 113
ansond 0:137634ff4186 114 #ifdef __cplusplus
ansond 0:137634ff4186 115 extern "C" {
ansond 0:137634ff4186 116 #endif
ansond 0:137634ff4186 117
ansond 0:137634ff4186 118 /**
ansond 0:137634ff4186 119 * \brief Output = SHA-512( input buffer )
ansond 0:137634ff4186 120 *
ansond 0:137634ff4186 121 * \param input buffer holding the data
ansond 0:137634ff4186 122 * \param ilen length of the input data
ansond 0:137634ff4186 123 * \param output SHA-384/512 checksum result
ansond 0:137634ff4186 124 * \param is384 0 = use SHA512, 1 = use SHA384
ansond 0:137634ff4186 125 */
ansond 0:137634ff4186 126 void sha512( const unsigned char *input, size_t ilen,
ansond 0:137634ff4186 127 unsigned char output[64], int is384 );
ansond 0:137634ff4186 128
ansond 0:137634ff4186 129 /**
ansond 0:137634ff4186 130 * \brief Output = SHA-512( file contents )
ansond 0:137634ff4186 131 *
ansond 0:137634ff4186 132 * \param path input file name
ansond 0:137634ff4186 133 * \param output SHA-384/512 checksum result
ansond 0:137634ff4186 134 * \param is384 0 = use SHA512, 1 = use SHA384
ansond 0:137634ff4186 135 *
ansond 0:137634ff4186 136 * \return 0 if successful, or POLARSSL_ERR_SHA512_FILE_IO_ERROR
ansond 0:137634ff4186 137 */
ansond 0:137634ff4186 138 int sha512_file( const char *path, unsigned char output[64], int is384 );
ansond 0:137634ff4186 139
ansond 0:137634ff4186 140 /**
ansond 0:137634ff4186 141 * \brief SHA-512 HMAC context setup
ansond 0:137634ff4186 142 *
ansond 0:137634ff4186 143 * \param ctx HMAC context to be initialized
ansond 0:137634ff4186 144 * \param is384 0 = use SHA512, 1 = use SHA384
ansond 0:137634ff4186 145 * \param key HMAC secret key
ansond 0:137634ff4186 146 * \param keylen length of the HMAC key
ansond 0:137634ff4186 147 */
ansond 0:137634ff4186 148 void sha512_hmac_starts( sha512_context *ctx, const unsigned char *key,
ansond 0:137634ff4186 149 size_t keylen, int is384 );
ansond 0:137634ff4186 150
ansond 0:137634ff4186 151 /**
ansond 0:137634ff4186 152 * \brief SHA-512 HMAC process buffer
ansond 0:137634ff4186 153 *
ansond 0:137634ff4186 154 * \param ctx HMAC context
ansond 0:137634ff4186 155 * \param input buffer holding the data
ansond 0:137634ff4186 156 * \param ilen length of the input data
ansond 0:137634ff4186 157 */
ansond 0:137634ff4186 158 void sha512_hmac_update( sha512_context *ctx, const unsigned char *input,
ansond 0:137634ff4186 159 size_t ilen );
ansond 0:137634ff4186 160
ansond 0:137634ff4186 161 /**
ansond 0:137634ff4186 162 * \brief SHA-512 HMAC final digest
ansond 0:137634ff4186 163 *
ansond 0:137634ff4186 164 * \param ctx HMAC context
ansond 0:137634ff4186 165 * \param output SHA-384/512 HMAC checksum result
ansond 0:137634ff4186 166 */
ansond 0:137634ff4186 167 void sha512_hmac_finish( sha512_context *ctx, unsigned char output[64] );
ansond 0:137634ff4186 168
ansond 0:137634ff4186 169 /**
ansond 0:137634ff4186 170 * \brief SHA-512 HMAC context reset
ansond 0:137634ff4186 171 *
ansond 0:137634ff4186 172 * \param ctx HMAC context to be reset
ansond 0:137634ff4186 173 */
ansond 0:137634ff4186 174 void sha512_hmac_reset( sha512_context *ctx );
ansond 0:137634ff4186 175
ansond 0:137634ff4186 176 /**
ansond 0:137634ff4186 177 * \brief Output = HMAC-SHA-512( hmac key, input buffer )
ansond 0:137634ff4186 178 *
ansond 0:137634ff4186 179 * \param key HMAC secret key
ansond 0:137634ff4186 180 * \param keylen length of the HMAC key
ansond 0:137634ff4186 181 * \param input buffer holding the data
ansond 0:137634ff4186 182 * \param ilen length of the input data
ansond 0:137634ff4186 183 * \param output HMAC-SHA-384/512 result
ansond 0:137634ff4186 184 * \param is384 0 = use SHA512, 1 = use SHA384
ansond 0:137634ff4186 185 */
ansond 0:137634ff4186 186 void sha512_hmac( const unsigned char *key, size_t keylen,
ansond 0:137634ff4186 187 const unsigned char *input, size_t ilen,
ansond 0:137634ff4186 188 unsigned char output[64], int is384 );
ansond 0:137634ff4186 189
ansond 0:137634ff4186 190 /**
ansond 0:137634ff4186 191 * \brief Checkup routine
ansond 0:137634ff4186 192 *
ansond 0:137634ff4186 193 * \return 0 if successful, or 1 if the test failed
ansond 0:137634ff4186 194 */
ansond 0:137634ff4186 195 int sha512_self_test( int verbose );
ansond 0:137634ff4186 196
ansond 0:137634ff4186 197 /* Internal use */
ansond 0:137634ff4186 198 void sha512_process( sha512_context *ctx, const unsigned char data[128] );
ansond 0:137634ff4186 199
ansond 0:137634ff4186 200 #ifdef __cplusplus
ansond 0:137634ff4186 201 }
ansond 0:137634ff4186 202 #endif
ansond 0:137634ff4186 203
ansond 0:137634ff4186 204 #endif /* sha512.h */
ansond 0:137634ff4186 205