Botan 3.13.0
Crypto and TLS for C&
Botan::TPM2::RSA_PublicKey Class Referencefinal

#include <tpm2_rsa.h>

Inheritance diagram for Botan::TPM2::RSA_PublicKey:
Botan::TPM2::PublicKey Botan::RSA_PublicKey Botan::Public_Key Botan::Public_Key Botan::Asymmetric_Key Botan::Asymmetric_Key

Public Member Functions

virtual Signature_Format _default_x509_signature_format () const
virtual std::optional< size_t > _signature_element_size_for_DER_encoding () const
std::string algo_name () const override
AlgorithmIdentifier algorithm_identifier () const override
bool check_key (RandomNumberGenerator &rng, bool strong) const override
std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (Botan::RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const override
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (std::string_view params, std::string_view provider) const override
std::unique_ptr< PK_Ops::Verificationcreate_x509_verification_op (const AlgorithmIdentifier &alg_id, std::string_view provider) const override
Signature_Format default_x509_signature_format () const
size_t estimated_strength () const override
std::string fingerprint_public (std::string_view alg="SHA-256") const
std::unique_ptr< Private_Keygenerate_another (Botan::RandomNumberGenerator &rng) const override
const BigIntget_e () const
const BigIntget_int_field (std::string_view field) const override
const BigIntget_n () const
OID get_oid () const
const Objecthandles () const
size_t key_length () const override
size_t message_part_size () const
size_t message_parts () const
virtual OID object_identifier () const
std::shared_ptr< const RSA_Public_Data > public_data () const
std::vector< uint8_t > public_key_bits () const override
std::vector< uint8_t > raw_public_key_bits () const override
const SessionBundlesessions () const
std::vector< uint8_t > subject_public_key () const
bool supports_operation (PublicKeyOperation op) const override

Static Public Member Functions

static std::unique_ptr< PublicKeyload_persistent (const std::shared_ptr< Context > &ctx, TPM2_HANDLE persistent_object_handle, const SessionBundle &sessions={})
static std::unique_ptr< PublicKeyload_transient (const std::shared_ptr< Context > &ctx, std::span< const uint8_t > public_blob, const SessionBundle &sessions)

Protected Member Functions

void init (BigInt &&n, BigInt &&e)
 RSA_PublicKey (Object handle, SessionBundle sessions, const TPM2B_PUBLIC *public_blob)

Static Protected Member Functions

static std::unique_ptr< PublicKeycreate (Object handles, const SessionBundle &sessions)

Protected Attributes

std::shared_ptr< const RSA_Public_Data > m_public

Friends

class TPM2::PublicKey

Detailed Description

Definition at line 19 of file tpm2_rsa.h.

Constructor & Destructor Documentation

◆ RSA_PublicKey()

Botan::TPM2::RSA_PublicKey::RSA_PublicKey ( Object handle,
SessionBundle sessions,
const TPM2B_PUBLIC * public_blob )
protected

Definition at line 29 of file tpm2_rsa.cpp.

29 :
30 Botan::TPM2::RSA_PublicKey(
31 std::move(handle), std::move(session_bundle), rsa_pubkey_components_from_tss2_public(public_blob)) {}

References RSA_PublicKey().

Referenced by RSA_PublicKey(), and TPM2::PublicKey.

Member Function Documentation

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const
virtualinherited

◆ _signature_element_size_for_DER_encoding()

virtual std::optional< size_t > Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding ( ) const
inlinevirtualinherited

Certain signatures schemes such as ECDSA have more than one element, and certain unfortunate protocols decided the thing to do was not concatenate them as normally done, but instead DER encode each of the elements as independent values.

If this returns a value x then the signature is checked to be exactly 2*x bytes and split in half for DER encoding.

Reimplemented in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 144 of file pk_keys.h.

144{ return {}; }

Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ algo_name()

std::string Botan::RSA_PublicKey::algo_name ( ) const
inlineoverridevirtualinherited

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 41 of file rsa.h.

41{ return "RSA"; }

Referenced by Botan::RSA_PrivateKey::create_decryption_op(), create_encryption_op(), Botan::RSA_PrivateKey::create_kem_decryption_op(), create_kem_encryption_op(), Botan::RSA_PrivateKey::create_signature_op(), create_verification_op(), and create_x509_verification_op().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::RSA_PublicKey::algorithm_identifier ( ) const
overridevirtualinherited

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 201 of file rsa.cpp.

201 {
202 return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_NULL_PARAM);
203}
virtual OID object_identifier() const
Definition pk_keys.cpp:22

References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

Referenced by Botan::TPM2::RSA_PrivateKey::public_key().

◆ check_key()

bool Botan::RSA_PublicKey::check_key ( RandomNumberGenerator & rng,
bool strong ) const
overridevirtualinherited

Test the key values for consistency.

Note this function is always "best effort"; for many algorithms it is not computationally possible to ensure the key is correctly formed in all respects. There is always the possibility a malformed key will be accepted; this is especially the case for public keys.

Parameters
Random Number Generatorsrng to use for randomized testing (may be ignored)
strongwhether to perform strong and lengthy version of the test, however for many algorithms this has no effect
Returns
true if the tests passed

Implements Botan::Asymmetric_Key.

Definition at line 220 of file rsa.cpp.

220 {
221 if(get_n() < 35 || get_n().is_even() || get_e() < 3 || get_e().is_even()) {
222 return false;
223 }
224 return true;
225}
const BigInt & get_n() const
Definition rsa.cpp:148
const BigInt & get_e() const
Definition rsa.cpp:152

References get_e(), and get_n().

◆ create()

std::unique_ptr< PublicKey > Botan::TPM2::PublicKey::create ( Object handles,
const SessionBundle & sessions )
staticprotectedinherited

Definition at line 166 of file tpm2_key.cpp.

166 {
167 [[maybe_unused]] const auto* pubinfo = handles._public_info(sessions).pub.get();
168#if defined(BOTAN_HAS_TPM2_RSA_ADAPTER)
169 if(pubinfo->publicArea.type == TPM2_ALG_RSA) {
170 return std::unique_ptr<PublicKey>(new RSA_PublicKey(std::move(handles), sessions, pubinfo));
171 }
172#endif
173#if defined(BOTAN_HAS_TPM2_ECC_ADAPTER)
174 if(pubinfo->publicArea.type == TPM2_ALG_ECC) {
175 return std::unique_ptr<PublicKey>(new EC_PublicKey(std::move(handles), sessions, pubinfo));
176 }
177#endif
178
179 throw Not_Implemented(Botan::fmt("Loaded a {} public key of an unsupported type",
180 handles.has_persistent_handle() ? "persistent" : "transient"));
181}
const Object & handles() const
Definition tpm2_key.h:99
const SessionBundle & sessions() const
Definition tpm2_key.h:101
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

References Botan::fmt(), handles(), and sessions().

Referenced by load_persistent(), and load_transient().

◆ create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::TPM2::RSA_PublicKey::create_encryption_op ( Botan::RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
overridevirtual

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return an encryption operation for this key/params or throw

Parameters
Random Number Generatorsa random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 409 of file tpm2_rsa.cpp.

411 {
412 BOTAN_UNUSED(rng, provider);
413 return std::make_unique<RSA_Encryption_Operation>(handles(), sessions(), params);
414}
#define BOTAN_UNUSED
Definition assert.h:144

References BOTAN_UNUSED, Botan::TPM2::PublicKey::handles(), and Botan::TPM2::PublicKey::sessions().

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::RSA_PublicKey::create_kem_encryption_op ( std::string_view params,
std::string_view provider ) const
overridevirtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a KEM encryption operation for this key/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 857 of file rsa.cpp.

858 {
859 if(provider == "base" || provider.empty()) {
860 return std::make_unique<RSA_KEM_Encryption_Operation>(*this, params);
861 }
862 throw Provider_Not_Found(algo_name(), provider);
863}
std::string algo_name() const override
Definition rsa.h:41

References algo_name().

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::TPM2::RSA_PublicKey::create_verification_op ( std::string_view params,
std::string_view provider ) const
overridevirtual

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a verification operation for this key/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 396 of file tpm2_rsa.cpp.

397 {
398 BOTAN_UNUSED(provider);
399 return std::make_unique<RSA_Verification_Operation>(handles(), sessions(), params);
400}

References BOTAN_UNUSED, Botan::TPM2::PublicKey::handles(), and Botan::TPM2::PublicKey::sessions().

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::RSA_PublicKey::create_x509_verification_op ( const AlgorithmIdentifier & signature_algorithm,
std::string_view provider ) const
overridevirtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a verification operation for this combination of key and signature algorithm or throw.

Parameters
signature_algorithmis the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 935 of file rsa.cpp.

936 {
937 if(provider == "base" || provider.empty()) {
938 return std::make_unique<RSA_Verify_Operation>(*this, parse_rsa_signature_algorithm(alg_id));
939 }
940
941 throw Provider_Not_Found(algo_name(), provider);
942}

References algo_name().

◆ default_x509_signature_format()

Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const
inlineinherited

Definition at line 241 of file pk_keys.h.

241 {
243 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:30

References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().

Referenced by default_x509_signature_format().

◆ estimated_strength()

size_t Botan::RSA_PublicKey::estimated_strength ( ) const
overridevirtualinherited

Return the estimated strength of the underlying key against the best currently known attack. Note that this ignores anything but pure attacks against the key itself and do not take into account padding schemes, usage mistakes, etc which might reduce the strength. However it does suffice to provide an upper bound.

Returns
estimated strength in bits

Implements Botan::Asymmetric_Key.

Definition at line 197 of file rsa.cpp.

197 {
198 return if_work_factor(key_length());
199}
size_t key_length() const override
Definition rsa.cpp:193
size_t if_work_factor(size_t bits)

References Botan::if_work_factor(), and key_length().

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( std::string_view alg = "SHA-256") const
inherited
Returns
Hash of the subject public key

Definition at line 94 of file pk_keys.cpp.

94 {
95 return create_hex_fingerprint(subject_public_key(), hash_algo);
96}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:63
std::string create_hex_fingerprint(std::span< const uint8_t > bits, std::string_view hash_name)
Definition pk_keys.cpp:38

References Botan::create_hex_fingerprint(), and subject_public_key().

Referenced by public_key_bits().

◆ generate_another()

std::unique_ptr< Private_Key > Botan::TPM2::RSA_PublicKey::generate_another ( Botan::RandomNumberGenerator & rng) const
inlineoverridevirtual

Generate another (cryptographically independent) key pair using the same algorithm parameters as this key. This is most useful for algorithms that support PublicKeyOperation::KeyAgreement to generate a fitting ephemeral key pair. For other key types it might throw Not_Implemented.

Reimplemented from Botan::TPM2::PublicKey.

Definition at line 22 of file tpm2_rsa.h.

22 {
24 }
std::unique_ptr< Private_Key > generate_another(Botan::RandomNumberGenerator &) const override
Definition tpm2_key.h:90

References Botan::TPM2::PublicKey::generate_another().

◆ get_e()

const BigInt & Botan::RSA_PublicKey::get_e ( ) const
inherited
Returns
public exponent

Definition at line 152 of file rsa.cpp.

152 {
153 return m_public->get_e();
154}
std::shared_ptr< const RSA_Public_Data > m_public
Definition rsa.h:91

References m_public.

Referenced by Botan::RSA_PrivateKey::check_key(), check_key(), Botan::RSA_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::public_key(), and public_key_bits().

◆ get_int_field()

const BigInt & Botan::RSA_PublicKey::get_int_field ( std::string_view field) const
overridevirtualinherited

Access an algorithm specific field

If the field is not known for this algorithm, an Invalid_Argument is thrown. The interpretation of the result requires knowledge of which algorithm is involved. For instance for RSA "p" represents one of the secret primes, while for DSA "p" is the public prime.

Some algorithms may not implement this method at all.

This is primarily used to implement the FFI botan_pubkey_get_field and botan_privkey_get_field functions.

TODO(Botan4) Change this to return by value

Reimplemented from Botan::Asymmetric_Key.

Definition at line 134 of file rsa.cpp.

134 {
135 if(field == "n") {
136 return m_public->get_n();
137 } else if(field == "e") {
138 return m_public->get_e();
139 } else {
140 return Public_Key::get_int_field(field);
141 }
142}
virtual const BigInt & get_int_field(std::string_view field) const
Definition pk_keys.cpp:18

References Botan::Asymmetric_Key::get_int_field(), and m_public.

Referenced by Botan::RSA_PrivateKey::get_int_field().

◆ get_n()

const BigInt & Botan::RSA_PublicKey::get_n ( ) const
inherited
Returns
public modulus

Definition at line 148 of file rsa.cpp.

148 {
149 return m_public->get_n();
150}

References m_public.

Referenced by Botan::RSA_PrivateKey::check_key(), check_key(), Botan::RSA_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::public_key(), and public_key_bits().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const
inlineinherited

Deprecated version of object_identifier

Definition at line 168 of file pk_keys.h.

168{ return this->object_identifier(); }

References get_oid(), and Botan::Asymmetric_Key::object_identifier().

Referenced by get_oid().

◆ handles()

const Object & Botan::TPM2::PublicKey::handles ( ) const
inlineinherited

◆ init()

void Botan::RSA_PublicKey::init ( BigInt && n,
BigInt && e )
protectedinherited

Definition at line 156 of file rsa.cpp.

156 {
157 if(n.signum() <= 0 || n.is_even() || n.bits() < 384 || n.bits() > 16384) {
158 throw Decoding_Error("Invalid RSA public key modulus");
159 }
160 if(e.is_even() || e <= 1 || e >= n || e.bits() > 256) {
161 throw Decoding_Error("Invalid RSA public key exponent");
162 }
163 m_public = std::make_shared<RSA_Public_Data>(std::move(n), std::move(e));
164}

References m_public.

Referenced by Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PrivateKey::RSA_PrivateKey(), RSA_PublicKey(), RSA_PublicKey(), and RSA_PublicKey().

◆ key_length()

size_t Botan::RSA_PublicKey::key_length ( ) const
overridevirtualinherited

Return an integer value best approximating the length of the primary security parameter. For example for RSA this will be the size of the modulus, for ECDSA the size of the ECC group, and for McEliece the size of the code will be returned.

Implements Botan::Public_Key.

Definition at line 193 of file rsa.cpp.

193 {
194 return m_public->public_modulus_bits();
195}

References m_public.

Referenced by estimated_strength().

◆ load_persistent()

std::unique_ptr< PublicKey > Botan::TPM2::PublicKey::load_persistent ( const std::shared_ptr< Context > & ctx,
TPM2_HANDLE persistent_object_handle,
const SessionBundle & sessions = {} )
staticinherited

Load a public key that resides in the TPM's persistent storage.

Parameters
ctxThe TPM context to use
persistent_object_handleThe handle of the persistent object to load
sessionsThe session bundle to use for loading

Definition at line 136 of file tpm2_key.cpp.

138 {
139 return create(load_persistent_object(ctx, persistent_object_handle, {}, sessions), sessions);
140}
static std::unique_ptr< PublicKey > create(Object handles, const SessionBundle &sessions)
Definition tpm2_key.cpp:166

References create(), and sessions().

◆ load_transient()

std::unique_ptr< PublicKey > Botan::TPM2::PublicKey::load_transient ( const std::shared_ptr< Context > & ctx,
std::span< const uint8_t > public_blob,
const SessionBundle & sessions )
staticinherited

Load a public key from the public blob obtained by a TPM key creation.

Transient keys don't reside inside the TPM but must be loaded by the application as required. Once this object is destructed, the transient memory on the TPM is cleared.

Parameters
ctxThe TPM context to use
public_blobThe public blob of the key to load
sessionsThe session bundle to use for loading

Definition at line 142 of file tpm2_key.cpp.

144 {
145 const auto public_data = unmarshal_public_blob(public_blob);
146
148
149 Object handle(ctx);
150 check_rc("Esys_LoadExternal",
151 Esys_LoadExternal(ctx->esys_context(),
152 sessions[0],
153 sessions[1],
154 sessions[2],
155 nullptr /* no private data to be loaded */,
156 &public_data,
157 TPM2_RH_NULL,
158 out_transient_handle(handle)));
159 return create(std::move(handle), sessions);
160}
#define BOTAN_ASSERT_NONNULL(ptr)
Definition assert.h:114
constexpr void check_rc(std::string_view location, TSS2_RC rc)
Definition tpm2_util.h:55
constexpr auto out_transient_handle(Object &object)
Definition tpm2_util.h:219

References BOTAN_ASSERT_NONNULL, Botan::TPM2::check_rc(), create(), Botan::TPM2::out_transient_handle(), and sessions().

◆ message_part_size()

size_t Botan::Public_Key::message_part_size ( ) const
inlineinherited

Returns how large each of the message parts referred to by message_parts() is

This function is public but applications should have few reasons to ever call this.

Returns
size of the message parts in bits

Definition at line 232 of file pk_keys.h.

232 {
233 return _signature_element_size_for_DER_encoding().value_or(0);
234 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().

Referenced by message_part_size().

◆ message_parts()

size_t Botan::Public_Key::message_parts ( ) const
inlineinherited

Returns more than 1 if the output of this algorithm (ciphertext, signature) should be treated as more than one value. This is used for algorithms like DSA and ECDSA, where the (r,s) output pair can be encoded as either a plain binary list or a TLV tagged DER encoding depending on the protocol.

This function is public but applications should have few reasons to ever call this.

Returns
number of message parts

Definition at line 219 of file pk_keys.h.

219 {
221 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().

Referenced by message_parts().

◆ object_identifier()

OID Botan::Asymmetric_Key::object_identifier ( ) const
virtualinherited

◆ public_data()

std::shared_ptr< const RSA_Public_Data > Botan::RSA_PublicKey::public_data ( ) const
inherited

Definition at line 130 of file rsa.cpp.

130 {
131 return m_public;
132}

References m_public.

◆ public_key_bits()

std::vector< uint8_t > Botan::RSA_PublicKey::public_key_bits ( ) const
overridevirtualinherited

Return the subject public key encoding of this public key

Note
this excludes the parameters field and may not be reliably decodable

Implements Botan::Public_Key.

Definition at line 209 of file rsa.cpp.

209 {
210 std::vector<uint8_t> output;
211 DER_Encoder der(output);
212 der.start_sequence().encode(get_n()).encode(get_e()).end_cons();
213
214 return output;
215}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_e(), get_n(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::TPM2::RSA_PrivateKey::public_key().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::TPM2::RSA_PublicKey::raw_public_key_bits ( ) const
inlineoverridevirtual
Returns
a TPM2-specific marshalled representation of the public key

Reimplemented from Botan::TPM2::PublicKey.

Definition at line 26 of file tpm2_rsa.h.

std::vector< uint8_t > raw_public_key_bits() const override
Definition tpm2_key.cpp:162

References Botan::TPM2::PublicKey::raw_public_key_bits().

◆ sessions()

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited

Return the SubjectPublicKeyInfo encoding of this public key

This is the subjectPublicKey field plus the algorithm-specific parameters

Definition at line 63 of file pk_keys.cpp.

63 {
64 std::vector<uint8_t> output;
65
66 DER_Encoder(output)
67 .start_sequence()
68 .encode(algorithm_identifier())
69 .encode_octet_aligned_bitstring(public_key_bits())
70 .end_cons();
71
72 return output;
73}
virtual AlgorithmIdentifier algorithm_identifier() const =0
virtual std::vector< uint8_t > public_key_bits() const =0

References algorithm_identifier(), Botan::DER_Encoder::encode(), Botan::DER_Encoder::encode_octet_aligned_bitstring(), Botan::DER_Encoder::end_cons(), public_key_bits(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), fingerprint_public(), Botan::X509::PEM_encode(), and public_key_bits().

◆ supports_operation()

bool Botan::TPM2::RSA_PublicKey::supports_operation ( PublicKeyOperation op) const
inlineoverridevirtual

Return true if this key could be used for the specified type of operation.

Implements Botan::Asymmetric_Key.

Definition at line 28 of file tpm2_rsa.h.

28 {
29 // TODO: Support RSA-KEM
31 }

References Botan::Encryption, and Botan::Signature.

◆ TPM2::PublicKey

friend class TPM2::PublicKey
friend

Definition at line 41 of file tpm2_rsa.h.

References RSA_PublicKey(), and Botan::TPM2::PublicKey::sessions().

Member Data Documentation

◆ m_public

std::shared_ptr<const RSA_Public_Data> Botan::RSA_PublicKey::m_public
protectedinherited

Definition at line 91 of file rsa.h.

Referenced by generate_another(), get_e(), get_int_field(), get_n(), init(), key_length(), and public_data().


The documentation for this class was generated from the following files: