StormByte-Crypto 3.1.0
C++26 cryptography module of the StormByte suite
Loading...
Searching...
No Matches
hmac.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Crypto.
5 *
6 * StormByte-Crypto original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Crypto source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, in particular Crypto++, bundled libbzip2, the StormByte-Buffer
23 * tree and the StormByte suite it vendors), which remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-Crypto is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-Crypto. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
45#include <StormByte/expected.hxx>
46#include <StormByte/safe/binary.hxx>
47
48#include <cstddef>
49#include <span>
50
55namespace StormByte {
60 namespace Crypto {
65 namespace HMAC {
70 enum class Algorithm {
73 };
74
84
89
94
105 Algorithm algorithm,
106 const Secure::Password& key,
107 std::span<const std::byte> message
108 );
109
119 Algorithm algorithm,
120 const Secure::Password& key,
121 std::span<const std::byte> message,
122 std::span<const std::byte> tag
123 );
124 }
125 }
126}
Shared, wiped container for passwords and raw key material.
Definition password.hxx:108
One-shot message authentication codes.
StormByte::Expected< StormByte::Safe::Binary, Error > ExpectedTag
Expected full-length binary HMAC tag or a typed error.
Definition hmac.hxx:88
ExpectedTag Compute(Algorithm algorithm, const Secure::Password &key, std::span< const std::byte > message)
Compute a full-length HMAC over binary input.
Error
Errors returned by HMAC operations.
Definition hmac.hxx:79
@ BackendFailure
The cryptographic backend could not complete the operation.
Definition hmac.hxx:82
@ UnsupportedAlgorithm
The supplied algorithm value is not supported.
Definition hmac.hxx:80
@ InvalidTagSize
The supplied verification tag is not full length.
Definition hmac.hxx:81
StormByte::Expected< bool, Error > ExpectedVerification
Expected verification result or a typed error.
Definition hmac.hxx:93
Algorithm
Supported HMAC hash functions.
Definition hmac.hxx:70
@ SHA256
HMAC-SHA-256 (32-byte tag).
Definition hmac.hxx:71
@ SHA384
HMAC-SHA-384 (48-byte tag).
Definition hmac.hxx:72
ExpectedVerification Verify(Algorithm algorithm, const Secure::Password &key, std::span< const std::byte > message, std::span< const std::byte > tag)
Verify a full-length binary HMAC in constant time with respect to tag bytes.
Crypto module of the StormByte suite.
Definition aead.hxx:53
Root namespace of the StormByte suite.
std::conditional_t< Type::Reference< T >, std::expected< std::reference_wrapper< std::remove_reference_t< T > >, Safe::Shared< E > >, std::expected< T, Safe::Shared< E > > > Expected
#define STORMBYTE_CRYPTO_PUBLIC
Definition visibility.h:53