openbmc/phosphor-net-ipmid/integrity_algo.hpp

12 namespace integrity  namespace
16  * @enum Integrity Algorithms
18  * The Integrity Algorithm Number specifies the algorithm used to generate the
21  * Integrity Algorithm is none the AuthCode value is not calculated and the
37  * Interface is the base class for the Integrity Algorithms.
38  * Unless otherwise specified, the integrity algorithm is applied to the packet
60      * @brief Verify the integrity data of the packet
69      *         using integrity algorithm on the packet data, false otherwise
77      * @brief Generate integrity data for the outgoing IPMI packet
88      * @brief Check if the Integrity algorithm is supported
90      * @param[in] algo - integrity algorithm
113      * state whether this is the integrity algorithm or the authentication
117      * integrity and authentication algorithms are both based on the same
118      * digest method (integrity::Algorithms::HMAC_SHA1_96 uses SHA1 and
120      * defined cipher suites mix and match digests for integrity and
121      * authentication. Generating Kn belongs in either the integrity or
122      * authentication classes, so in this implementation, integrity has
125      * @param[in] sik - session integrity key
128      * @return on success returns the Kn based on this integrity class
136      *  AuthCode field length varies based on the integrity algorithm, for
143     /** @brief K1 key used to generated the integrity data. */
150  * @brief Implementation of the HMAC-SHA1-96 Integrity algorithm
152  * HMAC-SHA1-96 take the Session Integrity Key and use it to generate K1. K1 is
155  * the Session Integrity Key. When the HMAC-SHA1-96 Integrity Algorithm is used
166      * @param[in] - Session Integrity Key
178      * @brief Verify the integrity data of the packet
182      *                     the integrity data
188      *         using integrity algorithm on the packet data, false otherwise
196      * @brief Generate integrity data for the outgoing IPMI packet
200      * @return on success return the integrity data for the outgoing IPMI
209      * @param[in] sik - session integrity key
235  * @brief Implementation of the HMAC-SHA256-128 Integrity algorithm
237  * HMAC-SHA256-128 take the Session Integrity Key and use it to generate K1. K1
240  * Session Integrity Key. When the HMAC-SHA256-128 Integrity Algorithm is used
251      * @param[in] - Session Integrity Key
263      * @brief Verify the integrity data of the packet
267      *                     the integrity data
273      *         using integrity algorithm on the packet data, false otherwise
281      * @brief Generate integrity data for the outgoing IPMI packet
285      * @return on success return the integrity data for the outgoing IPMI
294      * @param[in] sik - session integrity key
317 } // namespace integrity