StormByte-Crypto 3.1.0
C++26 cryptography module of the StormByte suite
Loading...
Searching...
No Matches
password.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
43#include <StormByte/byte_size.hxx>
45#include <StormByte/safe/pointers.hxx>
46#include <StormByte/safe/string.hxx>
47#include <StormByte/type_traits/safe.hxx>
48
49#include <string_view>
50#include <utility>
51
56namespace StormByte {
61 namespace Crypto {
66 namespace Helpers {
70 class SecureContent;
71
75 struct PasswordAccess;
76 }
77
82 namespace Secure {
109 public:
117 Password() noexcept;
118
124 explicit Password(std::string_view value);
125
131 explicit Password(StormByte::Safe::String& value);
132
137 explicit Password(const char* value);
138
144 Password(const void* data, StormByte::ByteSize size);
145
150 Password(const Password& other);
151
156 Password(Password&& other) noexcept;
157
162
168 Password& operator=(const Password& other);
169
175 Password& operator=(Password&& other) noexcept;
177
182 StormByte::ByteSize Size() const noexcept;
183
188 bool Empty() const noexcept;
189
194 explicit operator bool() const noexcept;
195
201 bool operator==(const Password& other) const noexcept;
202
208 bool operator!=(const Password& other) const noexcept;
209
210 private:
211 friend struct Helpers::PasswordAccess;
212
213 StormByte::Safe::Shared<Helpers::SecureContent> m_data;
214 };
215 }
216 }
217}
218
Password() noexcept
Empty password, suitable for Safe collections.
StormByte::ByteSize Size() const noexcept
Stored size in bytes.
bool Empty() const noexcept
Whether Size() is 0.
friend struct Helpers::PasswordAccess
Definition password.hxx:211
STORMBYTE_DECLARE_MAYBE_SAFE(class StormByte::System::Device::Access)
Private helpers of the Crypto module.
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