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
64 public:
73 Symmetric(const Symmetric& other) = default;
74
79 Symmetric(Symmetric&& other) noexcept = default;
80
84 virtual ~Symmetric() noexcept override;
85
91 Symmetric& operator=(const Symmetric& other) = default;
92
98 Symmetric& operator=(Symmetric&& other) noexcept = default;
100
106 inline const Secure::Password& Password() const noexcept {
107 return m_password;
108 }
109
115 static Secure::Password RandomPassword(size_t length = 32) noexcept;
116
117 protected:
119
125 inline Symmetric(enum Type type, Secure::Password password):
126 Generic(type), m_password(std::move(password)) {}
127 };
128
136}
137
Generic(const Generic &other)=default
Copy constructor.
Password-based symmetric crypter.
Definition generic.hxx:63
Symmetric(Symmetric &&other) noexcept=default
Move constructor.
Symmetric(const Symmetric &other)=default
Copy constructor.
Secure::Password m_password
Shared password.
Definition generic.hxx:118
const Secure::Password & Password() const noexcept
Password used by this crypter.
Definition generic.hxx:106
virtual ~Symmetric() noexcept override
Destructor.
static Secure::Password RandomPassword(size_t length=32) noexcept
Random password of raw bytes (not text).
Shared, wiped container for passwords and raw key material.
Definition password.hxx:108
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.
Wiped secrets of the Crypto module (Password, Vault).
STL namespace.
#define STORMBYTE_CRYPTO_PUBLIC
Definition visibility.h:53