Botan 3.14.1
Crypto and TLS for C&
elgamal.h
Go to the documentation of this file.
1/*
2* ElGamal
3* (C) 1999-2007,2023 Jack Lloyd
4*
5* Botan is released under the Simplified BSD License (see license.txt)
6*/
7
8#ifndef BOTAN_ELGAMAL_H_
9#define BOTAN_ELGAMAL_H_
10
11#include <botan/pk_keys.h>
12#include <memory>
13
14namespace Botan {
15
16class BigInt;
17class DL_Group;
18class DL_PublicKey;
19class DL_PrivateKey;
20
21/**
22* ElGamal Public Key
23*/
24class BOTAN_PUBLIC_API(2, 0) ElGamal_PublicKey : public virtual Public_Key {
25 public:
26 bool supports_operation(PublicKeyOperation op) const override { return (op == PublicKeyOperation::Encryption); }
27
28 /**
29 * Load a public key from the ASN.1 encoding
30 * @param alg_id the X.509 algorithm identifier
31 * @param key_bits DER encoded public key bits
32 */
33 ElGamal_PublicKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits);
34
35 /**
36 * Create a public key.
37 * @param group the underlying DL group
38 * @param y the public value y = g^x mod p
39 */
40 ElGamal_PublicKey(const DL_Group& group, const BigInt& y);
41
42 AlgorithmIdentifier algorithm_identifier() const override;
43 std::vector<uint8_t> raw_public_key_bits() const override;
44 std::vector<uint8_t> public_key_bits() const override;
45
46 bool check_key(RandomNumberGenerator& rng, bool strong) const override;
47
48 size_t estimated_strength() const override;
49 size_t key_length() const override;
50
51 std::string algo_name() const override { return "ElGamal"; }
52
53 const BigInt& get_int_field(std::string_view field) const override;
54
55 std::unique_ptr<Private_Key> generate_another(RandomNumberGenerator& rng) const final;
56
57 std::unique_ptr<PK_Ops::Encryption> _create_encryption_op(
58 RandomNumberGenerator& rng, const PK_Encryption_Options_Reader& options) const override;
59
60 private:
61 friend class ElGamal_PrivateKey;
62
63 ElGamal_PublicKey() = default;
64
65 explicit ElGamal_PublicKey(std::shared_ptr<const DL_PublicKey> key) : m_public_key(std::move(key)) {}
66
67 std::shared_ptr<const DL_PublicKey> m_public_key;
68};
69
70/**
71* ElGamal Private Key
72*/
73
76
78 public virtual Private_Key {
79 public:
80 /**
81 * Load a private key from the ASN.1 encoding
82 * @param alg_id the X.509 algorithm identifier
83 * @param key_bits DER encoded key bits in ANSI X9.42 format
84 */
85 ElGamal_PrivateKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits);
86
87 /**
88 * Create a new random private key.
89 * @param rng random number generator to use
90 * @param group the group to be used in the key
91 */
93
94 /**
95 * Load a private key from the integer encoding
96 * @param group the group to be used in the key
97 * @param private_key the key's secret value
98 */
99 ElGamal_PrivateKey(const DL_Group& group, const BigInt& private_key);
100
101 bool check_key(RandomNumberGenerator& rng, bool strong) const override;
102
103 std::unique_ptr<Public_Key> public_key() const override;
104
106
108
109 const BigInt& get_int_field(std::string_view field) const override;
110
111 std::unique_ptr<PK_Ops::Decryption> _create_decryption_op(
112 RandomNumberGenerator& rng, const PK_Encryption_Options_Reader& options) const override;
113
114 private:
115 std::shared_ptr<const DL_PrivateKey> m_private_key;
116};
117
119
120} // namespace Botan
121
122#endif
#define BOTAN_DIAGNOSTIC_POP
Definition api.h:128
#define BOTAN_DIAGNOSTIC_PUSH
Definition api.h:125
#define BOTAN_DIAGNOSTIC_IGNORE_INHERITED_VIA_DOMINANCE
Definition api.h:127
#define BOTAN_PUBLIC_API(maj, min)
Definition api.h:21
std::unique_ptr< PK_Ops::Decryption > _create_decryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const override
Definition elgamal.cpp:244
secure_vector< uint8_t > private_key_bits() const override
Definition elgamal.cpp:84
const BigInt & get_int_field(std::string_view field) const override
Definition elgamal.cpp:80
bool check_key(RandomNumberGenerator &rng, bool strong) const override
Definition elgamal.cpp:92
std::unique_ptr< Public_Key > public_key() const override
Definition elgamal.cpp:76
ElGamal_PrivateKey(const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
Definition elgamal.cpp:71
secure_vector< uint8_t > raw_private_key_bits() const override
Definition elgamal.cpp:88
friend class ElGamal_PrivateKey
Definition elgamal.h:61
std::string algo_name() const override
Definition elgamal.h:51
ElGamal_PublicKey(const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
Definition elgamal.cpp:25
bool supports_operation(PublicKeyOperation op) const override
Definition elgamal.h:26
PublicKeyOperation
Definition pk_keys.h:50
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:128