C++ Essence Library 0.1.0
A Utility Library for Modern C++ Programming
Loading...
Searching...
No Matches
ecdh_param.hpp
1/*
2 * Copyright (c) 2024 The RefValue Project
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
21 */
22
23#pragma once
24
25#include "../../compat.hpp"
26#include "../common_types.hpp"
27
28#include <cstddef>
29#include <cstdint>
30#include <memory>
31#include <span>
32
33namespace essence::crypto {
34 class pubkey_param_impl;
35
36 class ecdh_param {
37 public:
38 ES_API(CPPESSENCE) explicit ecdh_param(std::shared_ptr<void> context);
39 ES_API(CPPESSENCE) ecdh_param(ecdh_param&&) noexcept;
40 ES_API(CPPESSENCE) ~ecdh_param();
41 ES_API(CPPESSENCE) ecdh_param& operator=(ecdh_param&&) noexcept;
42
43 [[nodiscard]] ES_API(CPPESSENCE) dh_cofactor_mode cofactor_mode() const;
44 [[nodiscard]] ES_API(CPPESSENCE) dh_kdf_type kdf_mode() const;
45 [[nodiscard]] ES_API(CPPESSENCE) digest_mode kdf_digest_mode() const;
46 [[nodiscard]] ES_API(CPPESSENCE) std::int32_t kdf_digest_outlen() const;
47
48 ES_API(CPPESSENCE) void set_cofactor_mode(dh_cofactor_mode value) const;
49 ES_API(CPPESSENCE) void set_kdf_type(dh_kdf_type value) const;
50 ES_API(CPPESSENCE) void set_kdf_digest_mode(digest_mode value) const;
51 ES_API(CPPESSENCE) void set_kdf_digest_outlen(std::int32_t value) const;
52 ES_API(CPPESSENCE) void set_kdf_ukm(std::span<const std::byte> value) const;
53
54 private:
55 std::unique_ptr<pubkey_param_impl> impl_;
56 };
57} // namespace essence::crypto
Definition ecdh_param.hpp:36