api.h File Reference

Public Header. More...

#include <botan/build.h>

Go to the source code of this file.

Macros
#define	BOTAN_DEPRECATED(msg)
#define	BOTAN_DEPRECATED_API(msg)
#define	BOTAN_DEPRECATED_HEADER(hdr)
#define	BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS
#define	BOTAN_DIAGNOSTIC_IGNORE_INHERITED_VIA_DOMINANCE
#define	BOTAN_DIAGNOSTIC_POP
#define	BOTAN_DIAGNOSTIC_PUSH
#define	BOTAN_FUTURE_EXPLICIT
#define	BOTAN_FUTURE_INTERNAL_HEADER(hdr)
#define	BOTAN_FUZZER_API
#define	BOTAN_PUBLIC_API(maj, min)
#define	BOTAN_TEST_API   BOTAN_DLL
#define	BOTAN_UNSTABLE_API   BOTAN_DLL

Detailed Description

Public Header.

Definition in file api.h.

Macro Definition Documentation

BOTAN_DEPRECATED

#define BOTAN_DEPRECATED

(

msg

)

Value:

[[deprecated(msg)]]

Definition at line 73 of file api.h.

Referenced by Botan::EC_Group::a_is_minus_3(), Botan::EC_Group::a_is_zero(), Botan::OIDS::add_oid(), Botan::OIDS::add_oidstr(), Botan::Cert_Extension::Authority_Information_Access::Authority_Information_Access(), Botan::BigInt::binary_decode(), Botan::BigInt::binary_decode(), Botan::BigInt::binary_encode(), Botan::ECIES_KA_Params::compression_type(), Botan::BigInt::const_time_poison(), Botan::BigInt::const_time_unpoison(), Botan::EC_Group::cube_mod_order(), Botan::BigInt::data(), Botan::BigInt::decode(), Botan::BigInt::decode(), Botan::BlockCipher::decrypt_n(), Botan::Public_Key::default_x509_signature_format(), Botan::DL_Group::DL_Group(), Botan::DL_Group::DL_Group_from_PEM(), Botan::ECIES_KA_Params::domain(), Botan::EC_Group::EC_Group(), Botan::EC_Group::EC_Group(), Botan::EC_Group::EC_Group_from_PEM(), Botan::EC_Point::EC_Point(), Botan::BigInt::encode(), Botan::BigInt::encode_1363(), Botan::BigInt::encode_locked(), Botan::NameConstraints::excluded(), Botan::BigInt::flip_sign(), Botan::GeneralName::GeneralName(), Botan::GeneralSubtree::GeneralSubtree(), Botan::get_aead(), Botan::EC_Point::get_curve(), Botan::SM2_PrivateKey::get_da_inv(), Botan::Cert_Extension::Basic_Constraints::get_is_ca(), Botan::AlgorithmIdentifier::get_oid(), Botan::Public_Key::get_oid(), Botan::AlternativeName::get_othernames(), Botan::AlgorithmIdentifier::get_parameters(), Botan::Ed25519_PrivateKey::get_private_key(), Botan::Ed25519_PublicKey::get_public_key(), Botan::get_s2k(), Botan::BigInt::get_word_vector(), Botan::BigInt::get_word_vector(), Botan::EC_Point::get_x(), Botan::X25519_PrivateKey::get_x(), Botan::EC_Point::get_y(), Botan::EC_Point::get_z(), Botan::BigInt::grow_to(), Botan::EC_Group::inverse_mod_order(), Botan::BigInt::is_negative(), Botan::BigInt::is_nonzero(), Botan::BigInt::is_positive(), Botan::ECIES_KA_Params::kdf_spec(), Botan::OIDS::lookup(), Botan::OIDS::lookup(), Botan::BigInt::mask_bits(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::EC_Group::mod_order(), Botan::Modular_Reducer::Modular_Reducer(), Botan::EC_Group::multiply_mod_order(), Botan::BigInt::mutable_data(), Botan::KDF::name(), Botan::TLS::NSA_Suite_B_128::NSA_Suite_B_128(), Botan::Cert_Extension::Authority_Information_Access::ocsp_responder(), Botan::OIDS::oid2str_or_empty(), Botan::OIDS::oid2str_or_throw(), Botan::PKCS10_Request::path_limit(), Botan::NameConstraints::permitted(), Botan::EC_Group::point_size(), Botan::DL_Group::power_g_p(), Botan::DH_PublicKey::public_value(), Botan::X25519_PublicKey::public_value(), Botan::X448_PublicKey::public_value(), Botan::BigInt::resize(), Botan::AEAD_Mode::set_ad(), Botan::set_mem(), Botan::BigInt::set_word_at(), Botan::BigInt::set_words(), Botan::EC_Group::square_mod_order(), Botan::OIDS::str2oid_or_empty(), Botan::BigInt::swap_reg(), Botan::Credentials_Manager::~Credentials_Manager(), Botan::EC_Point::~EC_Point(), and Botan::EC_PublicKey::~EC_PublicKey().

BOTAN_DEPRECATED_API

#define BOTAN_DEPRECATED_API

(

msg

)

Value:

BOTAN_DEPRECATED(msg) BOTAN_DLL

Used to annotate API exports which are public, but are now deprecated and which will be removed in a future major release.

Definition at line 27 of file api.h.

BOTAN_DEPRECATED_HEADER

#define BOTAN_DEPRECATED_HEADER

(

hdr

)

Definition at line 94 of file api.h.

BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS

#define BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS

Definition at line 120 of file api.h.

Referenced by Botan::TLS::Group_Params::is_kem(), and Botan::TLS::Group_Params::is_post_quantum().

BOTAN_DIAGNOSTIC_IGNORE_INHERITED_VIA_DOMINANCE

#define BOTAN_DIAGNOSTIC_IGNORE_INHERITED_VIA_DOMINANCE

Definition at line 121 of file api.h.

BOTAN_DIAGNOSTIC_POP

#define BOTAN_DIAGNOSTIC_POP

Definition at line 122 of file api.h.

Referenced by Botan::TLS::Group_Params::is_kem(), Botan::TLS::Group_Params::is_post_quantum(), and Botan::XMSS_PrivateKey::XMSS_Signature_Operation.

BOTAN_DIAGNOSTIC_PUSH

#define BOTAN_DIAGNOSTIC_PUSH

Definition at line 119 of file api.h.

Referenced by Botan::TLS::Group_Params::is_kem(), and Botan::TLS::Group_Params::is_post_quantum().

BOTAN_FUTURE_EXPLICIT

#define BOTAN_FUTURE_EXPLICIT

This is used to mark constructors which are currently not explicit but which in a future major release be modified as such.

TODO(Botan4) remove this macro and replace with explicit

Definition at line 52 of file api.h.

Referenced by Botan::ASN1_Time::ASN1_Time(), Botan::PKCS11::AttributeContainer::AttributeContainer(), Botan::BER_Decoder::BER_Decoder(), Botan::BER_Decoder::BER_Decoder(), Botan::CRL_Entry::CRL_Entry(), Botan::Cert_Extension::CRL_Number::CRL_Number(), Botan::DER_Encoder::DER_Encoder(), Botan::DER_Encoder::DER_Encoder(), Botan::CurveGFp::EC_Group_Data, Botan::Ed25519_PublicKey::Ed25519_PublicKey(), Botan::AlternativeName::get_othernames(), Botan::HOTP::HOTP(), Botan::Cert_Extension::Name_Constraints::Name_Constraints(), Botan::PBKDF2_Family::PBKDF2_Family(), Botan::OCSP::Response::Response(), Botan::RFC4880_S2K_Family::RFC4880_S2K_Family(), Botan::TLS::Server_Information::Server_Information(), Botan::TOTP::TOTP(), Botan::UUID::UUID(), and Botan::X509_CRL::X509_CRL().

BOTAN_FUTURE_INTERNAL_HEADER

#define BOTAN_FUTURE_INTERNAL_HEADER

(

hdr

)

Definition at line 98 of file api.h.

BOTAN_FUZZER_API

#define BOTAN_FUZZER_API

Used to annotate API exports which are exported but only for the purposes of fuzzing. They should not be used by applications and may be removed or changed without notice.

They are only exported if the fuzzers are being built

Definition at line 65 of file api.h.

BOTAN_PUBLIC_API

#define BOTAN_PUBLIC_API	(		maj,
			min )

Value:

BOTAN_DLL

Used to annotate API exports which are public and supported. These APIs will not be broken/removed unless strictly required for functionality or security, and only in new major versions.

Parameters

maj	The major version this public API was released in
min	The minor version this public API was released in

Definition at line 21 of file api.h.

Referenced by Botan::Pipe::operator=(), and Botan::TPM2::supports_botan_crypto_backend().

BOTAN_TEST_API

#define BOTAN_TEST_API   BOTAN_DLL

Used to annotate API exports which are exported but only for the purposes of testing. They should not be used by applications and may be removed or changed without notice.

Definition at line 41 of file api.h.

BOTAN_UNSTABLE_API

#define BOTAN_UNSTABLE_API   BOTAN_DLL

Used to annotate API exports which are public and can be used by applications if needed, but which are intentionally not documented, and which may change incompatibly in a future major version.

Definition at line 34 of file api.h.

Referenced by Botan::Extensions::~Extensions().