1 /* 2 * Copyright (c) 2023, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * This file includes definitions for performing SHA-256 computations. 32 */ 33 34 #ifndef SHA256_HPP_ 35 #define SHA256_HPP_ 36 37 #include <openthread/crypto.h> 38 #include <openthread/platform/crypto.h> 39 #include "common/code_utils.hpp" 40 41 #include <mbedtls/sha256.h> 42 43 namespace otbr { 44 /** 45 * @addtogroup core-security 46 * 47 * @{ 48 * 49 */ 50 51 /** 52 * This class implements SHA-256 computation. 53 * 54 */ 55 class Sha256 56 { 57 public: 58 /** 59 * This type represents a SHA-256 hash. 60 * 61 */ 62 class Hash : public otCryptoSha256Hash 63 { 64 public: 65 static const uint8_t kSize = OT_CRYPTO_SHA256_HASH_SIZE; ///< SHA-256 hash size (bytes) 66 67 /** 68 * This method returns a pointer to a byte array containing the hash value. 69 * 70 * @returns A pointer to a byte array containing the hash. 71 * 72 */ GetBytes(void) const73 const uint8_t *GetBytes(void) const { return m8; } 74 }; 75 76 /** 77 * Constructor for `Sha256` object. 78 * 79 */ 80 Sha256(void); 81 82 /** 83 * Destructor for `Sha256` object. 84 * 85 */ 86 ~Sha256(void); 87 88 /** 89 * This method starts the SHA-256 computation. 90 * 91 */ 92 void Start(void); 93 94 /** 95 * This method inputs bytes into the SHA-256 computation. 96 * 97 * @param[in] aBuf A pointer to the input buffer. 98 * @param[in] aBufLength The length of @p aBuf in bytes. 99 * 100 */ 101 void Update(const void *aBuf, uint16_t aBufLength); 102 103 /** 104 * This method finalizes the hash computation. 105 * 106 * @param[out] aHash A reference to a `Hash` to output the calculated hash. 107 * 108 */ 109 void Finish(Hash &aHash); 110 111 private: 112 otCryptoContext mContext; 113 const static uint16_t kSha256ContextSize = sizeof(mbedtls_sha256_context); 114 OT_DEFINE_ALIGNED_VAR(mContextStorage, kSha256ContextSize, uint64_t); 115 }; 116 } // namespace otbr 117 118 #endif // SHA256_HPP_ 119