StormByte-Crypto 3.1.0
C++26 cryptography module of the StormByte suite
Loading...
Searching...
No Matches
ecdh.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 Secret {
68 class STORMBYTE_CRYPTO_PUBLIC ECDH final: public Generic {
69 public:
79 inline ECDH(KeyPair::Generic::PointerType keypair, unsigned short bits = 256) noexcept:
80 Generic(Type::ECDH, keypair), m_bits(bits) {}
81
87 explicit ECDH(const KeyPair::ECDH& keypair, unsigned short bits = 256):
88 Generic(Type::ECDH, keypair.Clone()), m_bits(bits) {}
89
95 explicit ECDH(KeyPair::ECDH&& keypair, unsigned short bits = 256):
96 Generic(Type::ECDH, keypair.Move()), m_bits(bits) {}
97
102 ECDH(const ECDH& other) = default;
103
108 ECDH(ECDH&& other) noexcept = default;
109
113 ~ECDH() noexcept;
114
120 ECDH& operator=(const ECDH& other) = default;
121
127 ECDH& operator=(ECDH&& other) noexcept = default;
129
134 PointerType Clone() const override;
135
140 PointerType Move() override;
141
148 StormByte::Safe::Optional<Secure::Password> Share(const StormByte::Safe::String& peerPublicKey) const override;
149
150 private:
151 unsigned short m_bits;
152 };
153 }
154 }
155}
156
ECDH keypair.
Definition ecdh.hxx:71
PointerType Clone() const override
Clone this object.
StormByte::Safe::Optional< Secure::Password > Share(const StormByte::Safe::String &peerPublicKey) const override
Derive a shared secret.
~ECDH() noexcept
Destructor.
ECDH(const ECDH &other)=default
Copy constructor.
ECDH(const KeyPair::ECDH &keypair, unsigned short bits=256)
Construct by cloning an ECDH keypair.
Definition ecdh.hxx:87
PointerType Move() override
Move this object into a new instance.
ECDH(KeyPair::Generic::PointerType keypair, unsigned short bits=256) noexcept
Construct from a keypair pointer.
Definition ecdh.hxx:79
ECDH(KeyPair::ECDH &&keypair, unsigned short bits=256)
Construct by moving an ECDH keypair.
Definition ecdh.hxx:95
ECDH(ECDH &&other) noexcept=default
Move constructor.
Generic(const Generic &other)=default
Copy constructor.
STORMBYTE_DECLARE_MAYBE_SAFE(class StormByte::System::Device::Access)
Key agreement 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.
#define STORMBYTE_CRYPTO_PUBLIC
Definition visibility.h:53