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