StormByte-Crypto 3.1.0
C++26 cryptography module of the StormByte suite
Loading...
Searching...
No Matches
exception.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/safe/string.hxx>
46
47#include <string>
48#include <string_view>
49#include <utility>
50
55namespace StormByte {
60 namespace Crypto {
65 namespace Secure {
73 public:
84 template<typename... Args>
85 requires (sizeof...(Args) >= 1)
86 explicit Exception(std::string_view pattern, Args&&... args)
87 : Crypto::Exception(StormByte::Exception::Path{"Secure"}, pattern, std::forward<Args>(args)...) {}
88
93 explicit Exception(std::string_view message)
94 : Crypto::Exception(Path{"Secure"}, message) {}
95
100 Exception(const Exception& other);
101
106 Exception(Exception&& other) noexcept;
107
111 ~Exception() noexcept override;
112
118 Exception& operator=(const Exception& other);
119
125 Exception& operator=(Exception&& other) noexcept;
127
128 protected:
136 template<typename... Args>
137 requires (sizeof...(Args) >= 1)
138 explicit Exception(StormByte::Exception::Path child, std::string_view pattern, Args&&... args)
139 : Crypto::Exception(
140 StormByte::Exception::Path{std::string("Secure.").append(child.text)},
141 pattern,
142 std::forward<Args>(args)...) {}
143
149 explicit Exception(StormByte::Exception::Path child, std::string_view message)
150 : Crypto::Exception(
151 StormByte::Exception::Path{std::string("Secure.").append(child.text)},
152 message) {}
153 };
154
160 public:
171 template<typename... Args>
172 requires (sizeof...(Args) >= 1)
173 explicit VaultException(std::string_view pattern, Args&&... args)
174 : Exception(StormByte::Exception::Path{"Vault"}, pattern, std::forward<Args>(args)...) {}
175
180 explicit VaultException(std::string_view message)
181 : Exception(Path{"Vault"}, message) {}
182
188
194
198 ~VaultException() noexcept override;
199
205 VaultException& operator=(const VaultException& other);
206
212 VaultException& operator=(VaultException&& other) noexcept;
214 };
215 }
216 }
217}
218
Root exception for Crypto.
Definition exception.hxx:67
Exception(const Exception &other)
Copy constructor.
Exception(std::string_view message)
Plain message under StormByte.Crypto.Secure.
Definition exception.hxx:93
~Exception() noexcept override
Destructor.
Exception(Exception &&other) noexcept
Move constructor.
Exception(std::string_view pattern, Args &&... args)
Replace literal {} under StormByte.Crypto.Secure.
Definition exception.hxx:86
Exception(StormByte::Exception::Path child, std::string_view message)
Plain message under StormByte.Crypto.Secure plus the child segment.
Definition exception.hxx:149
~VaultException() noexcept override
Destructor.
VaultException(std::string_view message)
Plain message under StormByte.Crypto.Secure.Vault.
Definition exception.hxx:180
VaultException(const VaultException &other)
Copy constructor.
VaultException(std::string_view pattern, Args &&... args)
Replace literal {} under StormByte.Crypto.Secure.Vault.
Definition exception.hxx:173
VaultException(VaultException &&other) noexcept
Move constructor.
STORMBYTE_DECLARE_MAYBE_SAFE(class StormByte::System::Device::Access)
Wiped secrets of the Crypto module (Password, Vault).
Crypto module of the StormByte suite.
Definition aead.hxx:53
Root namespace of the StormByte suite.
STL namespace.
#define STORMBYTE_CRYPTO_PUBLIC
Definition visibility.h:53