初始版本

external/nrf_oberon/include/ocrypto_sha512.h

@@ -0,0 +1,155 @@
+/**
+ * Copyright (c) 2019 - 2020, Nordic Semiconductor ASA
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form, except as embedded into a Nordic
+ *    Semiconductor ASA integrated circuit in a product or a software update for
+ *    such product, must reproduce the above copyright notice, this list of
+ *    conditions and the following disclaimer in the documentation and/or other
+ *    materials provided with the distribution.
+ *
+ * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ *    Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ *    engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+/**@file
+ * @defgroup nrf_oberon_sha_512 SHA-512 APIs
+ * @ingroup nrf_oberon
+ * @{
+ * @brief Type declarations and APIs for the SHA-512 algorithm.
+ *
+ * SHA-512 is part of the SHA-2 family that is a set of cryptographic hash
+ * functions designed by the NSA. It is the successor of the SHA-1 algorithm.
+ *
+ * A fixed-sized message digest is computed from variable length input data.
+ * The function is practically impossible to revert, and small changes in the
+ * input message lead to major changes in the message digest.
+ */
+
+#ifndef OCRYPTO_SHA512_H
+#define OCRYPTO_SHA512_H
+
+#include <stddef.h>
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * Length of SHA-512 hash.
+ */
+#define ocrypto_sha512_BYTES (64)
+
+
+/**@cond */
+typedef struct {
+    uint64_t h[8];
+    uint8_t  padded[128];
+    uint32_t length;
+    size_t   bytes;
+} ocrypto_sha512_ctx;
+/**@endcond */
+
+
+/**@name Incremental SHA-512 generator
+ *
+ * This group of functions can be used to incrementally compute the SHA-512
+ * hash for a given message.
+ */
+/**@{*/
+/**
+ * SHA-512 initialization.
+ *
+ * The generator state @p ctx is initialized by this function.
+ *
+ * @param[out] ctx Generator state.
+ */
+void ocrypto_sha512_init(
+    ocrypto_sha512_ctx *ctx);
+
+/**
+ * SHA-512 incremental data input.
+ *
+ * The generator state @p ctx is updated to hash a message chunk @p in.
+ *
+ * This function can be called repeatedly until the whole message is processed.
+ *
+ * @param      ctx    Generator state.
+ * @param      in     Input data.
+ * @param      in_len Length of @p in.
+ *
+ * @remark Initialization of the generator state @p ctx through
+ *         @c ocrypto_sha512_init is required before this function can be called.
+ */
+void ocrypto_sha512_update(
+    ocrypto_sha512_ctx *ctx,
+    const uint8_t *in, size_t in_len);
+
+/**
+ * SHA-512 output.
+ *
+ * The generator state @p ctx is updated to finalize the hash for the previously
+ * processed message chunks. The hash is put into @p r.
+ *
+ * @param      ctx Generator state.
+ * @param[out] r   Generated hash value.
+ *
+ * @remark Initialization of the generator state @p ctx through
+ *         @c ocrypto_sha512_init is required before this function can be called.
+ *
+ * @remark After return, the generator state @p ctx must no longer be used with
+ *         @c ocrypto_sha512_update and @c ocrypto_sha512_final unless it is
+ *         reinitialized using @c ocrypto_sha512_init.
+ */
+void ocrypto_sha512_final(
+    ocrypto_sha512_ctx *ctx,
+    uint8_t r[ocrypto_sha512_BYTES]);
+/**@}*/
+
+/**
+ * SHA-512 hash.
+ *
+ * The SHA-512 hash of a given input message @p in is computed and put into @p r.
+ *
+ * @param[out] r      Generated hash.
+ * @param      in     Input data.
+ * @param      in_len Length of @p in.
+ */
+void ocrypto_sha512(
+    uint8_t r[ocrypto_sha512_BYTES],
+    const uint8_t *in, size_t in_len);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* #ifndef OCRYPTO_SHA512_H */
+
+/** @} */