StormByte-Crypto 3.1.0
C++26 cryptography module of the StormByte suite
Loading...
Searching...
No Matches
hkdf.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
47#include <cstddef>
48#include <span>
49
54 enum class Algorithm {
57 };
58
68
73
83 Algorithm algorithm,
84 std::span<const std::byte> salt,
85 const Secure::Password& inputKeyMaterial
86 );
87
99 Algorithm algorithm,
100 const Secure::Password& pseudorandomKey,
101 std::span<const std::byte> info,
102 std::size_t outputSize
103 );
104}
Shared, wiped container for passwords and raw key material.
Definition password.hxx:108
Definition hkdf.hxx:50
StormByte::Expected< Secure::Password, Error > ExpectedKey
Expected secret key material or a typed HKDF error.
Definition hkdf.hxx:72
ExpectedKey Extract(Algorithm algorithm, std::span< const std::byte > salt, const Secure::Password &inputKeyMaterial)
HKDF-Extract: derive a pseudorandom key from binary salt and input key material.
ExpectedKey Expand(Algorithm algorithm, const Secure::Password &pseudorandomKey, std::span< const std::byte > info, std::size_t outputSize)
HKDF-Expand: derive binary secret output from a PRK and context information.
Algorithm
Supported HKDF hash functions.
Definition hkdf.hxx:54
@ SHA256
HKDF-SHA-256 (32-byte PRK).
Definition hkdf.hxx:55
@ SHA384
HKDF-SHA-384 (48-byte PRK).
Definition hkdf.hxx:56
Error
Errors returned by HKDF operations.
Definition hkdf.hxx:62
@ OutputTooLong
The output exceeds 255 times the hash output size.
Definition hkdf.hxx:65
@ BackendFailure
The cryptographic backend could not complete the operation.
Definition hkdf.hxx:66
@ InvalidPseudorandomKeySize
The PRK is shorter than the hash output size.
Definition hkdf.hxx:64
@ UnsupportedAlgorithm
The supplied algorithm value is not supported.
Definition hkdf.hxx:63
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