sha1.h

00001 /**
00002  * \file sha1.h
00003  *
00004  * \brief SHA-1 cryptographic hash function
00005  *
00006  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
00007  *  SPDX-License-Identifier: Apache-2.0
00008  *
00009  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
00010  *  not use this file except in compliance with the License.
00011  *  You may obtain a copy of the License at
00012  *
00013  *  http://www.apache.org/licenses/LICENSE-2.0
00014  *
00015  *  Unless required by applicable law or agreed to in writing, software
00016  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
00017  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00018  *  See the License for the specific language governing permissions and
00019  *  limitations under the License.
00020  *
00021  *  This file is part of mbed TLS (https://tls.mbed.org)
00022  */
00023 #ifndef MBEDTLS_SHA1_H
00024 #define MBEDTLS_SHA1_H
00025 
00026 #if !defined(MBEDTLS_CONFIG_FILE)
00027 #include "config.h"
00028 #else
00029 #include MBEDTLS_CONFIG_FILE
00030 #endif
00031 
00032 #include <stddef.h>
00033 #include <stdint.h>
00034 
00035 #if !defined(MBEDTLS_SHA1_ALT)
00036 // Regular implementation
00037 //
00038 
00039 #ifdef __cplusplus
00040 extern "C" {
00041 #endif
00042 
00043 /**
00044  * \brief          SHA-1 context structure
00045  */
00046 typedef struct
00047 {
00048     uint32_t total[2];          /*!< number of bytes processed  */
00049     uint32_t state[5];          /*!< intermediate digest state  */
00050     unsigned char buffer[64];   /*!< data block being processed */
00051 }
00052 mbedtls_sha1_context;
00053 
00054 /**
00055  * \brief          Initialize SHA-1 context
00056  *
00057  * \param ctx      SHA-1 context to be initialized
00058  */
00059 void mbedtls_sha1_init( mbedtls_sha1_context *ctx );
00060 
00061 /**
00062  * \brief          Clear SHA-1 context
00063  *
00064  * \param ctx      SHA-1 context to be cleared
00065  */
00066 void mbedtls_sha1_free( mbedtls_sha1_context *ctx );
00067 
00068 /**
00069  * \brief          Clone (the state of) a SHA-1 context
00070  *
00071  * \param dst      The destination context
00072  * \param src      The context to be cloned
00073  */
00074 void mbedtls_sha1_clone( mbedtls_sha1_context *dst,
00075                          const mbedtls_sha1_context *src );
00076 
00077 /**
00078  * \brief          SHA-1 context setup
00079  *
00080  * \param ctx      context to be initialized
00081  */
00082 void mbedtls_sha1_starts( mbedtls_sha1_context *ctx );
00083 
00084 /**
00085  * \brief          SHA-1 process buffer
00086  *
00087  * \param ctx      SHA-1 context
00088  * \param input    buffer holding the  data
00089  * \param ilen     length of the input data
00090  */
00091 void mbedtls_sha1_update( mbedtls_sha1_context *ctx, const unsigned char *input, size_t ilen );
00092 
00093 /**
00094  * \brief          SHA-1 final digest
00095  *
00096  * \param ctx      SHA-1 context
00097  * \param output   SHA-1 checksum result
00098  */
00099 void mbedtls_sha1_finish( mbedtls_sha1_context *ctx, unsigned char output[20] );
00100 
00101 /* Internal use */
00102 void mbedtls_sha1_process( mbedtls_sha1_context *ctx, const unsigned char data[64] );
00103 
00104 #ifdef __cplusplus
00105 }
00106 #endif
00107 
00108 #else  /* MBEDTLS_SHA1_ALT */
00109 #include "sha1_alt.h"
00110 #endif /* MBEDTLS_SHA1_ALT */
00111 
00112 #ifdef __cplusplus
00113 extern "C" {
00114 #endif
00115 
00116 /**
00117  * \brief          Output = SHA-1( input buffer )
00118  *
00119  * \param input    buffer holding the  data
00120  * \param ilen     length of the input data
00121  * \param output   SHA-1 checksum result
00122  */
00123 void mbedtls_sha1( const unsigned char *input, size_t ilen, unsigned char output[20] );
00124 
00125 /**
00126  * \brief          Checkup routine
00127  *
00128  * \return         0 if successful, or 1 if the test failed
00129  */
00130 int mbedtls_sha1_self_test( int verbose );
00131 
00132 #ifdef __cplusplus
00133 }
00134 #endif
00135 
00136 #endif /* mbedtls_sha1.h */