mbed TLS library
Dependents: HTTPClient-SSL WS_SERVER
include/polarssl/sha1.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?
User | Revision | Line number | New contents of line |
---|---|---|---|
ansond | 0:137634ff4186 | 1 | /** |
ansond | 0:137634ff4186 | 2 | * \file sha1.h |
ansond | 0:137634ff4186 | 3 | * |
ansond | 0:137634ff4186 | 4 | * \brief SHA-1 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_SHA1_H |
ansond | 0:137634ff4186 | 25 | #define POLARSSL_SHA1_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(EFIX64) && !defined(EFI32) |
ansond | 0:137634ff4186 | 36 | #include <basetsd.h> |
ansond | 0:137634ff4186 | 37 | typedef UINT32 uint32_t; |
ansond | 0:137634ff4186 | 38 | #else |
ansond | 0:137634ff4186 | 39 | #include <inttypes.h> |
ansond | 0:137634ff4186 | 40 | #endif |
ansond | 0:137634ff4186 | 41 | |
ansond | 0:137634ff4186 | 42 | #define POLARSSL_ERR_SHA1_FILE_IO_ERROR -0x0076 /**< Read/write error in file. */ |
ansond | 0:137634ff4186 | 43 | |
ansond | 0:137634ff4186 | 44 | #if !defined(POLARSSL_SHA1_ALT) |
ansond | 0:137634ff4186 | 45 | // Regular implementation |
ansond | 0:137634ff4186 | 46 | // |
ansond | 0:137634ff4186 | 47 | |
ansond | 0:137634ff4186 | 48 | #ifdef __cplusplus |
ansond | 0:137634ff4186 | 49 | extern "C" { |
ansond | 0:137634ff4186 | 50 | #endif |
ansond | 0:137634ff4186 | 51 | |
ansond | 0:137634ff4186 | 52 | /** |
ansond | 0:137634ff4186 | 53 | * \brief SHA-1 context structure |
ansond | 0:137634ff4186 | 54 | */ |
ansond | 0:137634ff4186 | 55 | typedef struct |
ansond | 0:137634ff4186 | 56 | { |
ansond | 0:137634ff4186 | 57 | uint32_t total[2]; /*!< number of bytes processed */ |
ansond | 0:137634ff4186 | 58 | uint32_t state[5]; /*!< intermediate digest state */ |
ansond | 0:137634ff4186 | 59 | unsigned char buffer[64]; /*!< data block being processed */ |
ansond | 0:137634ff4186 | 60 | |
ansond | 0:137634ff4186 | 61 | unsigned char ipad[64]; /*!< HMAC: inner padding */ |
ansond | 0:137634ff4186 | 62 | unsigned char opad[64]; /*!< HMAC: outer padding */ |
ansond | 0:137634ff4186 | 63 | } |
ansond | 0:137634ff4186 | 64 | sha1_context; |
ansond | 0:137634ff4186 | 65 | |
ansond | 0:137634ff4186 | 66 | /** |
ansond | 0:137634ff4186 | 67 | * \brief Initialize SHA-1 context |
ansond | 0:137634ff4186 | 68 | * |
ansond | 0:137634ff4186 | 69 | * \param ctx SHA-1 context to be initialized |
ansond | 0:137634ff4186 | 70 | */ |
ansond | 0:137634ff4186 | 71 | void sha1_init( sha1_context *ctx ); |
ansond | 0:137634ff4186 | 72 | |
ansond | 0:137634ff4186 | 73 | /** |
ansond | 0:137634ff4186 | 74 | * \brief Clear SHA-1 context |
ansond | 0:137634ff4186 | 75 | * |
ansond | 0:137634ff4186 | 76 | * \param ctx SHA-1 context to be cleared |
ansond | 0:137634ff4186 | 77 | */ |
ansond | 0:137634ff4186 | 78 | void sha1_free( sha1_context *ctx ); |
ansond | 0:137634ff4186 | 79 | |
ansond | 0:137634ff4186 | 80 | /** |
ansond | 0:137634ff4186 | 81 | * \brief SHA-1 context setup |
ansond | 0:137634ff4186 | 82 | * |
ansond | 0:137634ff4186 | 83 | * \param ctx context to be initialized |
ansond | 0:137634ff4186 | 84 | */ |
ansond | 0:137634ff4186 | 85 | void sha1_starts( sha1_context *ctx ); |
ansond | 0:137634ff4186 | 86 | |
ansond | 0:137634ff4186 | 87 | /** |
ansond | 0:137634ff4186 | 88 | * \brief SHA-1 process buffer |
ansond | 0:137634ff4186 | 89 | * |
ansond | 0:137634ff4186 | 90 | * \param ctx SHA-1 context |
ansond | 0:137634ff4186 | 91 | * \param input buffer holding the data |
ansond | 0:137634ff4186 | 92 | * \param ilen length of the input data |
ansond | 0:137634ff4186 | 93 | */ |
ansond | 0:137634ff4186 | 94 | void sha1_update( sha1_context *ctx, const unsigned char *input, size_t ilen ); |
ansond | 0:137634ff4186 | 95 | |
ansond | 0:137634ff4186 | 96 | /** |
ansond | 0:137634ff4186 | 97 | * \brief SHA-1 final digest |
ansond | 0:137634ff4186 | 98 | * |
ansond | 0:137634ff4186 | 99 | * \param ctx SHA-1 context |
ansond | 0:137634ff4186 | 100 | * \param output SHA-1 checksum result |
ansond | 0:137634ff4186 | 101 | */ |
ansond | 0:137634ff4186 | 102 | void sha1_finish( sha1_context *ctx, unsigned char output[20] ); |
ansond | 0:137634ff4186 | 103 | |
ansond | 0:137634ff4186 | 104 | /* Internal use */ |
ansond | 0:137634ff4186 | 105 | void sha1_process( sha1_context *ctx, const unsigned char data[64] ); |
ansond | 0:137634ff4186 | 106 | |
ansond | 0:137634ff4186 | 107 | #ifdef __cplusplus |
ansond | 0:137634ff4186 | 108 | } |
ansond | 0:137634ff4186 | 109 | #endif |
ansond | 0:137634ff4186 | 110 | |
ansond | 0:137634ff4186 | 111 | #else /* POLARSSL_SHA1_ALT */ |
ansond | 0:137634ff4186 | 112 | #include "sha1_alt.h" |
ansond | 0:137634ff4186 | 113 | #endif /* POLARSSL_SHA1_ALT */ |
ansond | 0:137634ff4186 | 114 | |
ansond | 0:137634ff4186 | 115 | #ifdef __cplusplus |
ansond | 0:137634ff4186 | 116 | extern "C" { |
ansond | 0:137634ff4186 | 117 | #endif |
ansond | 0:137634ff4186 | 118 | |
ansond | 0:137634ff4186 | 119 | /** |
ansond | 0:137634ff4186 | 120 | * \brief Output = SHA-1( input buffer ) |
ansond | 0:137634ff4186 | 121 | * |
ansond | 0:137634ff4186 | 122 | * \param input buffer holding the data |
ansond | 0:137634ff4186 | 123 | * \param ilen length of the input data |
ansond | 0:137634ff4186 | 124 | * \param output SHA-1 checksum result |
ansond | 0:137634ff4186 | 125 | */ |
ansond | 0:137634ff4186 | 126 | void sha1( const unsigned char *input, size_t ilen, unsigned char output[20] ); |
ansond | 0:137634ff4186 | 127 | |
ansond | 0:137634ff4186 | 128 | /** |
ansond | 0:137634ff4186 | 129 | * \brief Output = SHA-1( file contents ) |
ansond | 0:137634ff4186 | 130 | * |
ansond | 0:137634ff4186 | 131 | * \param path input file name |
ansond | 0:137634ff4186 | 132 | * \param output SHA-1 checksum result |
ansond | 0:137634ff4186 | 133 | * |
ansond | 0:137634ff4186 | 134 | * \return 0 if successful, or POLARSSL_ERR_SHA1_FILE_IO_ERROR |
ansond | 0:137634ff4186 | 135 | */ |
ansond | 0:137634ff4186 | 136 | int sha1_file( const char *path, unsigned char output[20] ); |
ansond | 0:137634ff4186 | 137 | |
ansond | 0:137634ff4186 | 138 | /** |
ansond | 0:137634ff4186 | 139 | * \brief SHA-1 HMAC context setup |
ansond | 0:137634ff4186 | 140 | * |
ansond | 0:137634ff4186 | 141 | * \param ctx HMAC context to be initialized |
ansond | 0:137634ff4186 | 142 | * \param key HMAC secret key |
ansond | 0:137634ff4186 | 143 | * \param keylen length of the HMAC key |
ansond | 0:137634ff4186 | 144 | */ |
ansond | 0:137634ff4186 | 145 | void sha1_hmac_starts( sha1_context *ctx, const unsigned char *key, |
ansond | 0:137634ff4186 | 146 | size_t keylen ); |
ansond | 0:137634ff4186 | 147 | |
ansond | 0:137634ff4186 | 148 | /** |
ansond | 0:137634ff4186 | 149 | * \brief SHA-1 HMAC process buffer |
ansond | 0:137634ff4186 | 150 | * |
ansond | 0:137634ff4186 | 151 | * \param ctx HMAC context |
ansond | 0:137634ff4186 | 152 | * \param input buffer holding the data |
ansond | 0:137634ff4186 | 153 | * \param ilen length of the input data |
ansond | 0:137634ff4186 | 154 | */ |
ansond | 0:137634ff4186 | 155 | void sha1_hmac_update( sha1_context *ctx, const unsigned char *input, |
ansond | 0:137634ff4186 | 156 | size_t ilen ); |
ansond | 0:137634ff4186 | 157 | |
ansond | 0:137634ff4186 | 158 | /** |
ansond | 0:137634ff4186 | 159 | * \brief SHA-1 HMAC final digest |
ansond | 0:137634ff4186 | 160 | * |
ansond | 0:137634ff4186 | 161 | * \param ctx HMAC context |
ansond | 0:137634ff4186 | 162 | * \param output SHA-1 HMAC checksum result |
ansond | 0:137634ff4186 | 163 | */ |
ansond | 0:137634ff4186 | 164 | void sha1_hmac_finish( sha1_context *ctx, unsigned char output[20] ); |
ansond | 0:137634ff4186 | 165 | |
ansond | 0:137634ff4186 | 166 | /** |
ansond | 0:137634ff4186 | 167 | * \brief SHA-1 HMAC context reset |
ansond | 0:137634ff4186 | 168 | * |
ansond | 0:137634ff4186 | 169 | * \param ctx HMAC context to be reset |
ansond | 0:137634ff4186 | 170 | */ |
ansond | 0:137634ff4186 | 171 | void sha1_hmac_reset( sha1_context *ctx ); |
ansond | 0:137634ff4186 | 172 | |
ansond | 0:137634ff4186 | 173 | /** |
ansond | 0:137634ff4186 | 174 | * \brief Output = HMAC-SHA-1( hmac key, input buffer ) |
ansond | 0:137634ff4186 | 175 | * |
ansond | 0:137634ff4186 | 176 | * \param key HMAC secret key |
ansond | 0:137634ff4186 | 177 | * \param keylen length of the HMAC key |
ansond | 0:137634ff4186 | 178 | * \param input buffer holding the data |
ansond | 0:137634ff4186 | 179 | * \param ilen length of the input data |
ansond | 0:137634ff4186 | 180 | * \param output HMAC-SHA-1 result |
ansond | 0:137634ff4186 | 181 | */ |
ansond | 0:137634ff4186 | 182 | void sha1_hmac( const unsigned char *key, size_t keylen, |
ansond | 0:137634ff4186 | 183 | const unsigned char *input, size_t ilen, |
ansond | 0:137634ff4186 | 184 | unsigned char output[20] ); |
ansond | 0:137634ff4186 | 185 | |
ansond | 0:137634ff4186 | 186 | /** |
ansond | 0:137634ff4186 | 187 | * \brief Checkup routine |
ansond | 0:137634ff4186 | 188 | * |
ansond | 0:137634ff4186 | 189 | * \return 0 if successful, or 1 if the test failed |
ansond | 0:137634ff4186 | 190 | */ |
ansond | 0:137634ff4186 | 191 | int sha1_self_test( int verbose ); |
ansond | 0:137634ff4186 | 192 | |
ansond | 0:137634ff4186 | 193 | #ifdef __cplusplus |
ansond | 0:137634ff4186 | 194 | } |
ansond | 0:137634ff4186 | 195 | #endif |
ansond | 0:137634ff4186 | 196 | |
ansond | 0:137634ff4186 | 197 | #endif /* sha1.h */ |
ansond | 0:137634ff4186 | 198 |