cpukit/doxygen/hash-algorithms.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplDoxygen
0007  *
0008  * @brief This header file contains Doxygen items related to hash algorithms.
0009  */
0010
0011 /*
0012  * Copyright (C) 2023 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 /**
0037  * @defgroup RTEMSAPIHashAlgorithms Hash Algorithms
0038  *
0039  * @ingroup RTEMSAPI
0040  *
0041  * @brief This group contains interfaces to hash algorithms.
0042  */
0043
0044 /**
0045  * @file cpukit/include/md4.h
0046  *
0047  * @ingroup RTEMSAPIHashAlgorithms
0048  *
0049  * @brief This header file contains interfaces of the HD4 hash algorithm
0050  *   support.
0051  */
0052
0053 /**
0054  * @file cpukit/include/md5.h
0055  *
0056  * @ingroup RTEMSAPIHashAlgorithms
0057  *
0058  * @brief This header file contains interfaces of the HD5 hash algorithm
0059  *   support.
0060  */
0061
0062 /**
0063  * @file cpukit/include/sha224.h
0064  *
0065  * @ingroup RTEMSAPIHashAlgorithms
0066  *
0067  * @brief This header file contains interfaces of the SHA224 hash algorithm
0068  *   support.
0069  */
0070
0071 /**
0072  * @file cpukit/include/sha256.h
0073  *
0074  * @ingroup RTEMSAPIHashAlgorithms
0075  *
0076  * @brief This header file contains interfaces of the SHA256 hash algorithm
0077  *   support.
0078  */
0079
0080 /**
0081  * @file cpukit/include/sha384.h
0082  *
0083  * @ingroup RTEMSAPIHashAlgorithms
0084  *
0085  * @brief This header file contains interfaces of the SHA384 hash algorithm
0086  *   support.
0087  */
0088
0089 /**
0090  * @file cpukit/include/sha512.h
0091  *
0092  * @ingroup RTEMSAPIHashAlgorithms
0093  *
0094  * @brief This header file contains interfaces of the SHA512 hash algorithm
0095  *   support.
0096  */
0097
0098 /**
0099  * @file cpukit/include/sha512t.h
0100  *
0101  * @ingroup RTEMSAPIHashAlgorithms
0102  *
0103  * @brief This header file contains interfaces of the trucated SHA512 hash
0104  *   algorithm support.
0105  */
0106
0107
0108 /**
0109  * @defgroup RTEMSImplHashAlgorithms Hash Algorithms
0110  *
0111  * @ingroup RTEMSImpl
0112  *
0113  * @brief This group contains items related to the implementation of hash
0114  *   algorithms.
0115  */
0116
0117 /**
0118  * @file cpukit/libmd/md4.c
0119  *
0120  * @ingroup RTEMSImplHashAlgorithms
0121  *
0122  * @brief This source file contains the implemention of the MD4 hash algorithm.
0123  */
0124
0125 /**
0126  * @file cpukit/libmd/md5.c
0127  *
0128  * @ingroup RTEMSImplHashAlgorithms
0129  *
0130  * @brief This source file contains the implemention of the MD5 hash algorithm.
0131  */
0132
0133 /**
0134  * @file cpukit/libmd/sha256c.c
0135  *
0136  * @ingroup RTEMSImplHashAlgorithms
0137  *
0138  * @brief This source file contains the implemention of the SHA256 hash
0139  *   algorithm and variants.
0140  */
0141
0142 /**
0143  * @file cpukit/libmd/sha512c.c
0144  *
0145  * @ingroup RTEMSImplHashAlgorithms
0146  *
0147  * @brief This source file contains the implemention of the SHA512 hash
0148  *   algorithm and variants.
0149  */