StormByte-Crypto 3.1.0
C++26 cryptography module of the StormByte suite
Loading...
Searching...
No Matches
generic.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
50namespace StormByte {
55 namespace Crypto {
60 namespace Crypter {
72 public:
77 enum class Strategy {
78 Hybrid,
79 Native,
80 };
81
90 Asymmetric(const Asymmetric& other) = default;
91
96 Asymmetric(Asymmetric&& other) noexcept = default;
97
101 virtual ~Asymmetric() noexcept override;
102
108 Asymmetric& operator=(const Asymmetric& other) = default;
109
115 Asymmetric& operator=(Asymmetric&& other) noexcept = default;
117
122 KeyPair::Generic::PointerType KeyPair() const noexcept {
123 return m_keypair;
124 }
125
137 bool Encrypt(std::span<const std::byte> input, Buffer::WriteOnly& output, Strategy strategy = Strategy::Native) const noexcept;
138
146 bool Encrypt(const Buffer::ReadOnly& input, Buffer::WriteOnly& output, Strategy strategy = Strategy::Native) const noexcept;
147
155 bool Encrypt(Buffer::ReadOnly& input, Buffer::WriteOnly& output, Strategy strategy = Strategy::Native) const noexcept;
156
166
177 bool Decrypt(std::span<const std::byte> input, Buffer::WriteOnly& output) const noexcept;
178
185 bool Decrypt(const Buffer::ReadOnly& input, Buffer::WriteOnly& output) const noexcept;
186
193 bool Decrypt(Buffer::ReadOnly& input, Buffer::WriteOnly& output) const noexcept;
194
203
204 protected:
206
213 Generic(type), m_keypair(keypair) {}
214
220 inline Asymmetric(enum Type type, const KeyPair::Generic& keypair):
221 Generic(type), m_keypair(keypair.Clone()) {}
222
228 inline Asymmetric(enum Type type, KeyPair::Generic&& keypair):
229 Generic(type), m_keypair(keypair.Move()) {}
230 };
231
239
247
255 }
256 }
257}
258
Keypair-based asymmetric crypter.
Definition generic.hxx:71
bool Encrypt(const Buffer::ReadOnly &input, Buffer::WriteOnly &output, Strategy strategy=Strategy::Native) const noexcept
Encrypt a read-only buffer (copy).
bool Encrypt(Buffer::ReadOnly &input, Buffer::WriteOnly &output, Strategy strategy=Strategy::Native) const noexcept
Encrypt a buffer, consuming it.
Asymmetric(enum Type type, const KeyPair::Generic &keypair)
Construct by cloning a keypair.
Definition generic.hxx:220
Asymmetric(Asymmetric &&other) noexcept=default
Move constructor.
bool Decrypt(const Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
Decrypt a read-only buffer (copy).
bool Encrypt(std::span< const std::byte > input, Buffer::WriteOnly &output, Strategy strategy=Strategy::Native) const noexcept
Encrypt a byte span.
Buffer::Consumer Decrypt(Buffer::Consumer consumer, ReadMode mode=ReadMode::Move) const noexcept
Decrypt a Consumer.
Buffer::Consumer Encrypt(Buffer::Consumer consumer, Strategy strategy=Strategy::Native, ReadMode mode=ReadMode::Move) const noexcept
Encrypt a Consumer.
Asymmetric(const Asymmetric &other)=default
Copy constructor.
Strategy
How payload bytes are sealed.
Definition generic.hxx:77
@ Native
Pure asymmetric encryption.
Definition generic.hxx:79
Asymmetric(enum Type type, KeyPair::Generic &&keypair)
Construct by moving a keypair.
Definition generic.hxx:228
virtual ~Asymmetric() noexcept override
Destructor.
KeyPair::Generic::PointerType KeyPair() const noexcept
Keypair used by this crypter.
Definition generic.hxx:122
KeyPair::Generic::PointerType m_keypair
Shared keypair.
Definition generic.hxx:205
Asymmetric(enum Type type, KeyPair::Generic::PointerType keypair)
Construct from a keypair pointer.
Definition generic.hxx:212
bool Decrypt(Buffer::ReadOnly &input, Buffer::WriteOnly &output) const noexcept
Decrypt a buffer, consuming it.
bool Decrypt(std::span< const std::byte > input, Buffer::WriteOnly &output) const noexcept
Decrypt a byte span.
Generic(const Generic &other)=default
Copy constructor.
Abstract keypair.
Definition generic.hxx:113
virtual PointerType Clone() const =0
virtual PointerType Move()=0
STORMBYTE_DECLARE_MAYBE_SAFE(class StormByte::System::Device::Access)
Ciphers of the Crypto module.
Generic::PointerType Create(enum Type type, KeyPair::Generic::PointerType keypair) noexcept
Factory from a keypair pointer.
Crypto module of the StormByte suite.
Definition aead.hxx:53
ReadMode
How a source buffer is consumed.
Definition typedefs.hxx:57
@ Move
Consume the input.
Definition typedefs.hxx:59
Root namespace of the StormByte suite.
#define STORMBYTE_CRYPTO_PUBLIC
Definition visibility.h:53