Botan 3.8.1
Crypto and TLS for C&
Macros | Typedefs | Enumerations | Functions
ffi.h File Reference
Foreign Function Interface

Public Header. More...

#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Macros

#define BOTAN_CHECK_KEY_EXPENSIVE_TESTS   1
 
#define BOTAN_CIPHER_INIT_FLAG_DECRYPT   1
 
#define BOTAN_CIPHER_INIT_FLAG_ENCRYPT   0
 
#define BOTAN_CIPHER_INIT_FLAG_MASK_DIRECTION   1
 
#define BOTAN_CIPHER_UPDATE_FLAG_FINAL   (1U << 0)
 
#define BOTAN_FFI_API_VERSION   20250506
 
#define BOTAN_FFI_DEPRECATED(msg)
 
#define BOTAN_FFI_EXPORT(maj, min)
 
#define BOTAN_FFI_HEX_LOWER_CASE   1
 
#define BOTAN_FPE_FLAG_FE1_COMPAT_MODE   1
 
#define BOTAN_PRIVKEY_EXPORT_FLAG_DER   0
 
#define BOTAN_PRIVKEY_EXPORT_FLAG_PEM   1
 
#define BOTAN_PRIVKEY_EXPORT_FLAG_RAW   2
 
#define BOTAN_PUBKEY_DER_FORMAT_SIGNATURE   1
 

Typedefs

typedef struct botan_asn1_oid_struct * botan_asn1_oid_t
 
typedef struct botan_block_cipher_struct * botan_block_cipher_t
 
typedef struct botan_cipher_struct * botan_cipher_t
 
typedef struct botan_ec_group_struct * botan_ec_group_t
 
typedef struct botan_fpe_struct * botan_fpe_t
 
typedef struct botan_hash_struct * botan_hash_t
 
typedef struct botan_hotp_struct * botan_hotp_t
 
typedef struct botan_mac_struct * botan_mac_t
 
typedef struct botan_mp_struct * botan_mp_t
 
typedef struct botan_pk_op_decrypt_struct * botan_pk_op_decrypt_t
 
typedef struct botan_pk_op_encrypt_struct * botan_pk_op_encrypt_t
 
typedef struct botan_pk_op_ka_struct * botan_pk_op_ka_t
 
typedef struct botan_pk_op_kem_decrypt_struct * botan_pk_op_kem_decrypt_t
 
typedef struct botan_pk_op_kem_encrypt_struct * botan_pk_op_kem_encrypt_t
 
typedef struct botan_pk_op_sign_struct * botan_pk_op_sign_t
 
typedef struct botan_pk_op_verify_struct * botan_pk_op_verify_t
 
typedef struct botan_privkey_struct * botan_privkey_t
 
typedef struct botan_pubkey_struct * botan_pubkey_t
 
typedef struct botan_rng_struct * botan_rng_t
 
typedef struct botan_srp6_server_session_struct * botan_srp6_server_session_t
 
typedef struct botan_totp_struct * botan_totp_t
 
typedef struct botan_tpm2_crypto_backend_state_struct * botan_tpm2_crypto_backend_state_t
 
typedef struct botan_tpm2_ctx_struct * botan_tpm2_ctx_t
 
typedef struct botan_tpm2_session_struct * botan_tpm2_session_t
 
typedef int(* botan_view_bin_fn) (botan_view_ctx view_ctx, const uint8_t *data, size_t len)
 
typedef void * botan_view_ctx
 
typedef int(* botan_view_str_fn) (botan_view_ctx view_ctx, const char *str, size_t len)
 
typedef struct botan_x509_cert_struct * botan_x509_cert_t
 
typedef struct botan_x509_crl_struct * botan_x509_crl_t
 

Enumerations

enum  BOTAN_FFI_ERROR {
  BOTAN_FFI_SUCCESS = 0 , BOTAN_FFI_INVALID_VERIFIER = 1 , BOTAN_FFI_ERROR_INVALID_INPUT = -1 , BOTAN_FFI_ERROR_BAD_MAC = -2 ,
  BOTAN_FFI_ERROR_NO_VALUE = -3 , BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE = -10 , BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR = -11 , BOTAN_FFI_ERROR_EXCEPTION_THROWN = -20 ,
  BOTAN_FFI_ERROR_OUT_OF_MEMORY = -21 , BOTAN_FFI_ERROR_SYSTEM_ERROR = -22 , BOTAN_FFI_ERROR_INTERNAL_ERROR = -23 , BOTAN_FFI_ERROR_BAD_FLAG = -30 ,
  BOTAN_FFI_ERROR_NULL_POINTER = -31 , BOTAN_FFI_ERROR_BAD_PARAMETER = -32 , BOTAN_FFI_ERROR_KEY_NOT_SET = -33 , BOTAN_FFI_ERROR_INVALID_KEY_LENGTH = -34 ,
  BOTAN_FFI_ERROR_INVALID_OBJECT_STATE = -35 , BOTAN_FFI_ERROR_NOT_IMPLEMENTED = -40 , BOTAN_FFI_ERROR_INVALID_OBJECT = -50 , BOTAN_FFI_ERROR_TLS_ERROR = -75 ,
  BOTAN_FFI_ERROR_HTTP_ERROR = -76 , BOTAN_FFI_ERROR_ROUGHTIME_ERROR = -77 , BOTAN_FFI_ERROR_TPM_ERROR = -78 , BOTAN_FFI_ERROR_UNKNOWN_ERROR = -100
}
 
enum  botan_x509_cert_key_constraints {
  NO_CONSTRAINTS = 0 , DIGITAL_SIGNATURE = 32768 , NON_REPUDIATION = 16384 , KEY_ENCIPHERMENT = 8192 ,
  DATA_ENCIPHERMENT = 4096 , KEY_AGREEMENT = 2048 , KEY_CERT_SIGN = 1024 , CRL_SIGN = 512 ,
  ENCIPHER_ONLY = 256 , DECIPHER_ONLY = 128
}
 

Functions

int botan_base64_decode (const char *base64_str, size_t in_len, uint8_t *out, size_t *out_len)
 
int botan_base64_encode (const uint8_t *x, size_t len, char *out, size_t *out_len)
 
int botan_bcrypt_generate (uint8_t *out, size_t *out_len, const char *password, botan_rng_t rng, size_t work_factor, uint32_t flags)
 
int botan_bcrypt_is_valid (const char *pass, const char *hash)
 
int botan_block_cipher_block_size (botan_block_cipher_t bc)
 
int botan_block_cipher_clear (botan_block_cipher_t bc)
 
int botan_block_cipher_decrypt_blocks (botan_block_cipher_t bc, const uint8_t in[], uint8_t out[], size_t blocks)
 
int botan_block_cipher_destroy (botan_block_cipher_t bc)
 
int botan_block_cipher_encrypt_blocks (botan_block_cipher_t bc, const uint8_t in[], uint8_t out[], size_t blocks)
 
int botan_block_cipher_get_keyspec (botan_block_cipher_t cipher, size_t *out_minimum_keylength, size_t *out_maximum_keylength, size_t *out_keylength_modulo)
 
int botan_block_cipher_init (botan_block_cipher_t *bc, const char *cipher_name)
 
int botan_block_cipher_name (botan_block_cipher_t cipher, char *name, size_t *name_len)
 
int botan_block_cipher_set_key (botan_block_cipher_t bc, const uint8_t key[], size_t len)
 
int botan_cipher_clear (botan_cipher_t hash)
 
int botan_cipher_destroy (botan_cipher_t cipher)
 
int botan_cipher_get_default_nonce_length (botan_cipher_t cipher, size_t *nl)
 
int botan_cipher_get_ideal_update_granularity (botan_cipher_t cipher, size_t *ug)
 
int botan_cipher_get_keyspec (botan_cipher_t, size_t *min_keylen, size_t *max_keylen, size_t *mod_keylen)
 
int botan_cipher_get_tag_length (botan_cipher_t cipher, size_t *tag_size)
 
int botan_cipher_get_update_granularity (botan_cipher_t cipher, size_t *ug)
 
int botan_cipher_init (botan_cipher_t *cipher, const char *name, uint32_t flags)
 
int botan_cipher_is_authenticated (botan_cipher_t cipher)
 
int botan_cipher_name (botan_cipher_t cipher, char *name, size_t *name_len)
 
int botan_cipher_output_length (botan_cipher_t cipher, size_t in_len, size_t *out_len)
 
int botan_cipher_query_keylen (botan_cipher_t, size_t *out_minimum_keylength, size_t *out_maximum_keylength)
 
int botan_cipher_requires_entire_message (botan_cipher_t cipher)
 
int botan_cipher_reset (botan_cipher_t cipher)
 
int botan_cipher_set_associated_data (botan_cipher_t cipher, const uint8_t *ad, size_t ad_len)
 
int botan_cipher_set_key (botan_cipher_t cipher, const uint8_t *key, size_t key_len)
 
int botan_cipher_start (botan_cipher_t cipher, const uint8_t *nonce, size_t nonce_len)
 
int botan_cipher_update (botan_cipher_t cipher, uint32_t flags, uint8_t output[], size_t output_size, size_t *output_written, const uint8_t input_bytes[], size_t input_size, size_t *input_consumed)
 Encrypt/Decrypt some data and/or finalize the encryption/decryption.
 
int botan_cipher_valid_nonce_length (botan_cipher_t cipher, size_t nl)
 
int botan_constant_time_compare (const uint8_t *x, const uint8_t *y, size_t len)
 
int botan_ec_group_destroy (botan_ec_group_t ec_group)
 
int botan_ec_group_equal (botan_ec_group_t curve1, botan_ec_group_t curve2)
 
int botan_ec_group_from_ber (botan_ec_group_t *ec_group, const uint8_t *ber, size_t ber_len)
 
int botan_ec_group_from_name (botan_ec_group_t *ec_group, const char *name)
 
int botan_ec_group_from_oid (botan_ec_group_t *ec_group, botan_asn1_oid_t oid)
 
int botan_ec_group_from_params (botan_ec_group_t *ec_group, botan_asn1_oid_t oid, botan_mp_t p, botan_mp_t a, botan_mp_t b, botan_mp_t base_x, botan_mp_t base_y, botan_mp_t order)
 
int botan_ec_group_from_pem (botan_ec_group_t *ec_group, const char *pem)
 
int botan_ec_group_get_a (botan_mp_t *a, botan_ec_group_t ec_group)
 
int botan_ec_group_get_b (botan_mp_t *b, botan_ec_group_t ec_group)
 
int botan_ec_group_get_curve_oid (botan_asn1_oid_t *oid, botan_ec_group_t ec_group)
 
int botan_ec_group_get_g_x (botan_mp_t *g_x, botan_ec_group_t ec_group)
 
int botan_ec_group_get_g_y (botan_mp_t *g_y, botan_ec_group_t ec_group)
 
int botan_ec_group_get_order (botan_mp_t *order, botan_ec_group_t ec_group)
 
int botan_ec_group_get_p (botan_mp_t *p, botan_ec_group_t ec_group)
 
int botan_ec_group_supports_application_specific_group (int *out)
 
int botan_ec_group_supports_named_group (const char *name, int *out)
 
int botan_ec_group_view_der (botan_ec_group_t ec_group, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_ec_group_view_pem (botan_ec_group_t ec_group, botan_view_ctx ctx, botan_view_str_fn view)
 
int botan_ec_privkey_create (botan_privkey_t *key, const char *algo_name, botan_ec_group_t ec_group, botan_rng_t rng)
 
const char * botan_error_description (int err)
 
const char * botan_error_last_exception_message (void)
 
uint32_t botan_ffi_api_version (void)
 
int botan_ffi_supports_api (uint32_t api_version)
 
int botan_fpe_decrypt (botan_fpe_t fpe, botan_mp_t x, const uint8_t tweak[], size_t tweak_len)
 
int botan_fpe_destroy (botan_fpe_t fpe)
 
int botan_fpe_encrypt (botan_fpe_t fpe, botan_mp_t x, const uint8_t tweak[], size_t tweak_len)
 
int botan_fpe_fe1_init (botan_fpe_t *fpe, botan_mp_t n, const uint8_t key[], size_t key_len, size_t rounds, uint32_t flags)
 
int botan_hash_block_size (botan_hash_t hash, size_t *block_size)
 
int botan_hash_clear (botan_hash_t hash)
 
int botan_hash_copy_state (botan_hash_t *dest, botan_hash_t source)
 
int botan_hash_destroy (botan_hash_t hash)
 
int botan_hash_final (botan_hash_t hash, uint8_t out[])
 
int botan_hash_init (botan_hash_t *hash, const char *hash_name, uint32_t flags)
 
int botan_hash_name (botan_hash_t hash, char *name, size_t *name_len)
 
int botan_hash_output_length (botan_hash_t hash, size_t *output_length)
 
int botan_hash_update (botan_hash_t hash, const uint8_t *in, size_t in_len)
 
int botan_hex_decode (const char *hex_str, size_t in_len, uint8_t *out, size_t *out_len)
 
int botan_hex_encode (const uint8_t *x, size_t len, char *out, uint32_t flags)
 
int botan_hotp_check (botan_hotp_t hotp, uint64_t *next_hotp_counter, uint32_t hotp_code, uint64_t hotp_counter, size_t resync_range)
 
int botan_hotp_destroy (botan_hotp_t hotp)
 
int botan_hotp_generate (botan_hotp_t hotp, uint32_t *hotp_code, uint64_t hotp_counter)
 
int botan_hotp_init (botan_hotp_t *hotp, const uint8_t key[], size_t key_len, const char *hash_algo, size_t digits)
 
int botan_kdf (const char *kdf_algo, uint8_t out[], size_t out_len, const uint8_t secret[], size_t secret_len, const uint8_t salt[], size_t salt_len, const uint8_t label[], size_t label_len)
 
int botan_key_unwrap3394 (const uint8_t wrapped_key[], size_t wrapped_key_len, const uint8_t kek[], size_t kek_len, uint8_t key[], size_t *key_len)
 
int botan_key_wrap3394 (const uint8_t key[], size_t key_len, const uint8_t kek[], size_t kek_len, uint8_t wrapped_key[], size_t *wrapped_key_len)
 
int botan_mac_clear (botan_mac_t mac)
 
int botan_mac_destroy (botan_mac_t mac)
 
int botan_mac_final (botan_mac_t mac, uint8_t out[])
 
int botan_mac_get_keyspec (botan_mac_t mac, size_t *out_minimum_keylength, size_t *out_maximum_keylength, size_t *out_keylength_modulo)
 
int botan_mac_init (botan_mac_t *mac, const char *mac_name, uint32_t flags)
 
int botan_mac_name (botan_mac_t mac, char *name, size_t *name_len)
 
int botan_mac_output_length (botan_mac_t mac, size_t *output_length)
 
int botan_mac_set_key (botan_mac_t mac, const uint8_t *key, size_t key_len)
 
int botan_mac_set_nonce (botan_mac_t mac, const uint8_t *nonce, size_t nonce_len)
 
int botan_mac_update (botan_mac_t mac, const uint8_t *buf, size_t len)
 
int botan_mceies_decrypt (botan_privkey_t mce_key, const char *aead, const uint8_t ct[], size_t ct_len, const uint8_t ad[], size_t ad_len, uint8_t pt[], size_t *pt_len)
 
int botan_mceies_encrypt (botan_pubkey_t mce_key, botan_rng_t rng, const char *aead, const uint8_t pt[], size_t pt_len, const uint8_t ad[], size_t ad_len, uint8_t ct[], size_t *ct_len)
 
int botan_mp_add (botan_mp_t result, botan_mp_t x, botan_mp_t y)
 
int botan_mp_add_u32 (botan_mp_t result, botan_mp_t x, uint32_t y)
 
int botan_mp_clear (botan_mp_t mp)
 
int botan_mp_clear_bit (botan_mp_t n, size_t bit)
 
int botan_mp_cmp (int *result, botan_mp_t x, botan_mp_t y)
 
int botan_mp_destroy (botan_mp_t mp)
 
int botan_mp_div (botan_mp_t quotient, botan_mp_t remainder, botan_mp_t x, botan_mp_t y)
 
int botan_mp_equal (botan_mp_t x, botan_mp_t y)
 
int botan_mp_flip_sign (botan_mp_t mp)
 
int botan_mp_from_bin (botan_mp_t mp, const uint8_t vec[], size_t vec_len)
 
int botan_mp_gcd (botan_mp_t out, botan_mp_t x, botan_mp_t y)
 
int botan_mp_get_bit (botan_mp_t n, size_t bit)
 
int botan_mp_init (botan_mp_t *mp)
 
int botan_mp_is_even (botan_mp_t mp)
 
int botan_mp_is_negative (botan_mp_t mp)
 
int botan_mp_is_odd (botan_mp_t mp)
 
int botan_mp_is_positive (botan_mp_t mp)
 
int botan_mp_is_prime (botan_mp_t n, botan_rng_t rng, size_t test_prob)
 
int botan_mp_is_zero (botan_mp_t mp)
 
int botan_mp_lshift (botan_mp_t out, botan_mp_t in, size_t shift)
 
int botan_mp_mod_inverse (botan_mp_t out, botan_mp_t in, botan_mp_t modulus)
 
int botan_mp_mod_mul (botan_mp_t result, botan_mp_t x, botan_mp_t y, botan_mp_t mod)
 
int botan_mp_mul (botan_mp_t result, botan_mp_t x, botan_mp_t y)
 
int botan_mp_num_bits (botan_mp_t n, size_t *bits)
 
int botan_mp_num_bytes (botan_mp_t n, size_t *bytes)
 
int botan_mp_powmod (botan_mp_t out, botan_mp_t base, botan_mp_t exponent, botan_mp_t modulus)
 
int botan_mp_rand_bits (botan_mp_t rand_out, botan_rng_t rng, size_t bits)
 
int botan_mp_rand_range (botan_mp_t rand_out, botan_rng_t rng, botan_mp_t lower_bound, botan_mp_t upper_bound)
 
int botan_mp_rshift (botan_mp_t out, botan_mp_t in, size_t shift)
 
int botan_mp_set_bit (botan_mp_t n, size_t bit)
 
int botan_mp_set_from_int (botan_mp_t mp, int initial_value)
 
int botan_mp_set_from_mp (botan_mp_t dest, botan_mp_t source)
 
int botan_mp_set_from_radix_str (botan_mp_t dest, const char *str, size_t radix)
 
int botan_mp_set_from_str (botan_mp_t dest, const char *str)
 
int botan_mp_sub (botan_mp_t result, botan_mp_t x, botan_mp_t y)
 
int botan_mp_sub_u32 (botan_mp_t result, botan_mp_t x, uint32_t y)
 
int botan_mp_swap (botan_mp_t x, botan_mp_t y)
 
int botan_mp_to_bin (botan_mp_t mp, uint8_t vec[])
 
int botan_mp_to_hex (botan_mp_t mp, char *out)
 
int botan_mp_to_str (botan_mp_t mp, uint8_t base, char *out, size_t *out_len)
 
int botan_mp_to_uint32 (botan_mp_t mp, uint32_t *val)
 
int botan_nist_kw_dec (const char *cipher_algo, int padded, const uint8_t wrapped_key[], size_t wrapped_key_len, const uint8_t kek[], size_t kek_len, uint8_t key[], size_t *key_len)
 
int botan_nist_kw_enc (const char *cipher_algo, int padded, const uint8_t key[], size_t key_len, const uint8_t kek[], size_t kek_len, uint8_t wrapped_key[], size_t *wrapped_key_len)
 
int botan_oid_cmp (int *result, botan_asn1_oid_t a, botan_asn1_oid_t b)
 
int botan_oid_destroy (botan_asn1_oid_t oid)
 
int botan_oid_equal (botan_asn1_oid_t a, botan_asn1_oid_t b)
 
int botan_oid_from_string (botan_asn1_oid_t *oid, const char *oid_str)
 
int botan_oid_register (botan_asn1_oid_t oid, const char *name)
 
int botan_oid_view_name (botan_asn1_oid_t oid, botan_view_ctx ctx, botan_view_str_fn view)
 
int botan_oid_view_string (botan_asn1_oid_t oid, botan_view_ctx ctx, botan_view_str_fn view)
 
int botan_pbkdf (const char *pbkdf_algo, uint8_t out[], size_t out_len, const char *passphrase, const uint8_t salt[], size_t salt_len, size_t iterations)
 
int botan_pbkdf_timed (const char *pbkdf_algo, uint8_t out[], size_t out_len, const char *passphrase, const uint8_t salt[], size_t salt_len, size_t milliseconds_to_run, size_t *out_iterations_used)
 
int botan_pk_op_decrypt (botan_pk_op_decrypt_t op, uint8_t out[], size_t *out_len, const uint8_t ciphertext[], size_t ciphertext_len)
 
int botan_pk_op_decrypt_create (botan_pk_op_decrypt_t *op, botan_privkey_t key, const char *padding, uint32_t flags)
 
int botan_pk_op_decrypt_destroy (botan_pk_op_decrypt_t op)
 
int botan_pk_op_decrypt_output_length (botan_pk_op_decrypt_t op, size_t ctext_len, size_t *ptext_len)
 
int botan_pk_op_encrypt (botan_pk_op_encrypt_t op, botan_rng_t rng, uint8_t out[], size_t *out_len, const uint8_t plaintext[], size_t plaintext_len)
 
int botan_pk_op_encrypt_create (botan_pk_op_encrypt_t *op, botan_pubkey_t key, const char *padding, uint32_t flags)
 
int botan_pk_op_encrypt_destroy (botan_pk_op_encrypt_t op)
 
int botan_pk_op_encrypt_output_length (botan_pk_op_encrypt_t op, size_t ptext_len, size_t *ctext_len)
 
int botan_pk_op_kem_decrypt_create (botan_pk_op_kem_decrypt_t *op, botan_privkey_t key, const char *kdf)
 
int botan_pk_op_kem_decrypt_destroy (botan_pk_op_kem_decrypt_t op)
 
int botan_pk_op_kem_decrypt_shared_key (botan_pk_op_kem_decrypt_t op, const uint8_t salt[], size_t salt_len, const uint8_t encapsulated_key[], size_t encapsulated_key_len, size_t desired_shared_key_len, uint8_t shared_key[], size_t *shared_key_len)
 
int botan_pk_op_kem_decrypt_shared_key_length (botan_pk_op_kem_decrypt_t op, size_t desired_shared_key_length, size_t *output_shared_key_length)
 
int botan_pk_op_kem_encrypt_create (botan_pk_op_kem_encrypt_t *op, botan_pubkey_t key, const char *kdf)
 
int botan_pk_op_kem_encrypt_create_shared_key (botan_pk_op_kem_encrypt_t op, botan_rng_t rng, const uint8_t salt[], size_t salt_len, size_t desired_shared_key_len, uint8_t shared_key[], size_t *shared_key_len, uint8_t encapsulated_key[], size_t *encapsulated_key_len)
 
int botan_pk_op_kem_encrypt_destroy (botan_pk_op_kem_encrypt_t op)
 
int botan_pk_op_kem_encrypt_encapsulated_key_length (botan_pk_op_kem_encrypt_t op, size_t *output_encapsulated_key_length)
 
int botan_pk_op_kem_encrypt_shared_key_length (botan_pk_op_kem_encrypt_t op, size_t desired_shared_key_length, size_t *output_shared_key_length)
 
int botan_pk_op_key_agreement (botan_pk_op_ka_t op, uint8_t out[], size_t *out_len, const uint8_t other_key[], size_t other_key_len, const uint8_t salt[], size_t salt_len)
 
int botan_pk_op_key_agreement_create (botan_pk_op_ka_t *op, botan_privkey_t key, const char *kdf, uint32_t flags)
 
int botan_pk_op_key_agreement_destroy (botan_pk_op_ka_t op)
 
int botan_pk_op_key_agreement_export_public (botan_privkey_t key, uint8_t out[], size_t *out_len)
 
int botan_pk_op_key_agreement_size (botan_pk_op_ka_t op, size_t *out_len)
 
int botan_pk_op_key_agreement_view_public (botan_privkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_pk_op_sign_create (botan_pk_op_sign_t *op, botan_privkey_t key, const char *hash_and_padding, uint32_t flags)
 
int botan_pk_op_sign_destroy (botan_pk_op_sign_t op)
 
int botan_pk_op_sign_finish (botan_pk_op_sign_t op, botan_rng_t rng, uint8_t sig[], size_t *sig_len)
 
int botan_pk_op_sign_output_length (botan_pk_op_sign_t op, size_t *olen)
 
int botan_pk_op_sign_update (botan_pk_op_sign_t op, const uint8_t in[], size_t in_len)
 
int botan_pk_op_verify_create (botan_pk_op_verify_t *op, botan_pubkey_t key, const char *hash_and_padding, uint32_t flags)
 
int botan_pk_op_verify_destroy (botan_pk_op_verify_t op)
 
int botan_pk_op_verify_finish (botan_pk_op_verify_t op, const uint8_t sig[], size_t sig_len)
 
int botan_pk_op_verify_update (botan_pk_op_verify_t op, const uint8_t in[], size_t in_len)
 
int botan_pkcs_hash_id (const char *hash_name, uint8_t pkcs_id[], size_t *pkcs_id_len)
 
int botan_privkey_algo_name (botan_privkey_t key, char out[], size_t *out_len)
 
int botan_privkey_check_key (botan_privkey_t key, botan_rng_t rng, uint32_t flags)
 
int botan_privkey_create (botan_privkey_t *key, const char *algo_name, const char *algo_params, botan_rng_t rng)
 
int botan_privkey_create_dh (botan_privkey_t *key, botan_rng_t rng, const char *param)
 
int botan_privkey_create_dsa (botan_privkey_t *key, botan_rng_t rng, size_t pbits, size_t qbits)
 
int botan_privkey_create_ecdh (botan_privkey_t *key, botan_rng_t rng, const char *params)
 
int botan_privkey_create_ecdsa (botan_privkey_t *key, botan_rng_t rng, const char *params)
 
int botan_privkey_create_elgamal (botan_privkey_t *key, botan_rng_t rng, size_t pbits, size_t qbits)
 
int botan_privkey_create_mceliece (botan_privkey_t *key, botan_rng_t rng, size_t n, size_t t)
 
int botan_privkey_create_rsa (botan_privkey_t *key, botan_rng_t rng, size_t n_bits)
 
int botan_privkey_destroy (botan_privkey_t key)
 
int botan_privkey_dsa_get_x (botan_mp_t n, botan_privkey_t key)
 
int botan_privkey_ed25519_get_privkey (botan_privkey_t key, uint8_t output[64])
 
int botan_privkey_ed448_get_privkey (botan_privkey_t key, uint8_t output[57])
 
int botan_privkey_export (botan_privkey_t key, uint8_t out[], size_t *out_len, uint32_t flags)
 
int botan_privkey_export_encrypted (botan_privkey_t key, uint8_t out[], size_t *out_len, botan_rng_t rng, const char *passphrase, const char *encryption_algo, uint32_t flags)
 
int botan_privkey_export_encrypted_pbkdf_iter (botan_privkey_t key, uint8_t out[], size_t *out_len, botan_rng_t rng, const char *passphrase, size_t pbkdf_iterations, const char *cipher_algo, const char *pbkdf_algo, uint32_t flags)
 
int botan_privkey_export_encrypted_pbkdf_msec (botan_privkey_t key, uint8_t out[], size_t *out_len, botan_rng_t rng, const char *passphrase, uint32_t pbkdf_msec_runtime, size_t *pbkdf_iterations_out, const char *cipher_algo, const char *pbkdf_algo, uint32_t flags)
 
int botan_privkey_export_pubkey (botan_pubkey_t *out, botan_privkey_t in)
 
int botan_privkey_get_field (botan_mp_t output, botan_privkey_t key, const char *field_name)
 
int botan_privkey_load (botan_privkey_t *key, botan_rng_t rng, const uint8_t bits[], size_t len, const char *password)
 
int botan_privkey_load_classic_mceliece (botan_privkey_t *key, const uint8_t privkey[], size_t key_len, const char *cmce_mode)
 
int botan_privkey_load_dh (botan_privkey_t *key, botan_mp_t p, botan_mp_t g, botan_mp_t x)
 
int botan_privkey_load_dsa (botan_privkey_t *key, botan_mp_t p, botan_mp_t q, botan_mp_t g, botan_mp_t x)
 
int botan_privkey_load_ecdh (botan_privkey_t *key, botan_mp_t scalar, const char *curve_name)
 
int botan_privkey_load_ecdsa (botan_privkey_t *key, botan_mp_t scalar, const char *curve_name)
 
int botan_privkey_load_ed25519 (botan_privkey_t *key, const uint8_t privkey[32])
 
int botan_privkey_load_ed448 (botan_privkey_t *key, const uint8_t privkey[57])
 
int botan_privkey_load_elgamal (botan_privkey_t *key, botan_mp_t p, botan_mp_t g, botan_mp_t x)
 
int botan_privkey_load_frodokem (botan_privkey_t *key, const uint8_t privkey[], size_t key_len, const char *frodo_mode)
 
int botan_privkey_load_kyber (botan_privkey_t *key, const uint8_t privkey[], size_t key_len)
 
int botan_privkey_load_ml_dsa (botan_privkey_t *key, const uint8_t privkey[], size_t key_len, const char *mldsa_mode)
 
int botan_privkey_load_ml_kem (botan_privkey_t *key, const uint8_t privkey[], size_t key_len, const char *mlkem_mode)
 
int botan_privkey_load_rsa (botan_privkey_t *key, botan_mp_t p, botan_mp_t q, botan_mp_t e)
 
int botan_privkey_load_rsa_pkcs1 (botan_privkey_t *key, const uint8_t bits[], size_t len)
 
int botan_privkey_load_slh_dsa (botan_privkey_t *key, const uint8_t privkey[], size_t key_len, const char *slhdsa_mode)
 
int botan_privkey_load_sm2 (botan_privkey_t *key, botan_mp_t scalar, const char *curve_name)
 
int botan_privkey_load_sm2_enc (botan_privkey_t *key, botan_mp_t scalar, const char *curve_name)
 
int botan_privkey_load_x25519 (botan_privkey_t *key, const uint8_t privkey[32])
 
int botan_privkey_load_x448 (botan_privkey_t *key, const uint8_t privkey[56])
 
int botan_privkey_oid (botan_asn1_oid_t *oid, botan_privkey_t key)
 
int botan_privkey_remaining_operations (botan_privkey_t key, uint64_t *out)
 
int botan_privkey_rsa_get_d (botan_mp_t d, botan_privkey_t rsa_key)
 
int botan_privkey_rsa_get_e (botan_mp_t e, botan_privkey_t rsa_key)
 
int botan_privkey_rsa_get_n (botan_mp_t n, botan_privkey_t rsa_key)
 
int botan_privkey_rsa_get_p (botan_mp_t p, botan_privkey_t rsa_key)
 
int botan_privkey_rsa_get_privkey (botan_privkey_t rsa_key, uint8_t out[], size_t *out_len, uint32_t flags)
 
int botan_privkey_rsa_get_q (botan_mp_t q, botan_privkey_t rsa_key)
 
int botan_privkey_stateful_operation (botan_privkey_t key, int *out)
 
int botan_privkey_view_der (botan_privkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_privkey_view_encrypted_der (botan_privkey_t key, botan_rng_t rng, const char *passphrase, const char *cipher_algo, const char *pbkdf_algo, size_t pbkdf_iterations, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_privkey_view_encrypted_der_timed (botan_privkey_t key, botan_rng_t rng, const char *passphrase, const char *cipher_algo, const char *pbkdf_algo, size_t pbkdf_runtime_msec, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_privkey_view_encrypted_pem (botan_privkey_t key, botan_rng_t rng, const char *passphrase, const char *cipher_algo, const char *pbkdf_algo, size_t pbkdf_iterations, botan_view_ctx ctx, botan_view_str_fn view)
 
int botan_privkey_view_encrypted_pem_timed (botan_privkey_t key, botan_rng_t rng, const char *passphrase, const char *cipher_algo, const char *pbkdf_algo, size_t pbkdf_runtime_msec, botan_view_ctx ctx, botan_view_str_fn view)
 
int botan_privkey_view_kyber_raw_key (botan_privkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_privkey_view_pem (botan_privkey_t key, botan_view_ctx ctx, botan_view_str_fn view)
 
int botan_privkey_view_raw (botan_privkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_privkey_x25519_get_privkey (botan_privkey_t key, uint8_t output[32])
 
int botan_privkey_x448_get_privkey (botan_privkey_t key, uint8_t output[56])
 
int botan_pubkey_algo_name (botan_pubkey_t key, char out[], size_t *out_len)
 
int botan_pubkey_check_key (botan_pubkey_t key, botan_rng_t rng, uint32_t flags)
 
int botan_pubkey_destroy (botan_pubkey_t key)
 
int botan_pubkey_dsa_get_g (botan_mp_t d, botan_pubkey_t key)
 
int botan_pubkey_dsa_get_p (botan_mp_t p, botan_pubkey_t key)
 
int botan_pubkey_dsa_get_q (botan_mp_t q, botan_pubkey_t key)
 
int botan_pubkey_dsa_get_y (botan_mp_t y, botan_pubkey_t key)
 
int botan_pubkey_ecc_key_used_explicit_encoding (botan_pubkey_t key)
 
int botan_pubkey_ed25519_get_pubkey (botan_pubkey_t key, uint8_t pubkey[32])
 
int botan_pubkey_ed448_get_pubkey (botan_pubkey_t key, uint8_t pubkey[57])
 
int botan_pubkey_estimated_strength (botan_pubkey_t key, size_t *estimate)
 
int botan_pubkey_export (botan_pubkey_t key, uint8_t out[], size_t *out_len, uint32_t flags)
 
int botan_pubkey_fingerprint (botan_pubkey_t key, const char *hash, uint8_t out[], size_t *out_len)
 
int botan_pubkey_get_field (botan_mp_t output, botan_pubkey_t key, const char *field_name)
 
int botan_pubkey_load (botan_pubkey_t *key, const uint8_t bits[], size_t len)
 
int botan_pubkey_load_classic_mceliece (botan_pubkey_t *key, const uint8_t pubkey[], size_t key_len, const char *cmce_mode)
 
int botan_pubkey_load_dh (botan_pubkey_t *key, botan_mp_t p, botan_mp_t g, botan_mp_t y)
 
int botan_pubkey_load_dsa (botan_pubkey_t *key, botan_mp_t p, botan_mp_t q, botan_mp_t g, botan_mp_t y)
 
int botan_pubkey_load_ecdh (botan_pubkey_t *key, botan_mp_t public_x, botan_mp_t public_y, const char *curve_name)
 
int botan_pubkey_load_ecdsa (botan_pubkey_t *key, botan_mp_t public_x, botan_mp_t public_y, const char *curve_name)
 
int botan_pubkey_load_ed25519 (botan_pubkey_t *key, const uint8_t pubkey[32])
 
int botan_pubkey_load_ed448 (botan_pubkey_t *key, const uint8_t pubkey[57])
 
int botan_pubkey_load_elgamal (botan_pubkey_t *key, botan_mp_t p, botan_mp_t g, botan_mp_t y)
 
int botan_pubkey_load_frodokem (botan_pubkey_t *key, const uint8_t pubkey[], size_t key_len, const char *frodo_mode)
 
int botan_pubkey_load_kyber (botan_pubkey_t *key, const uint8_t pubkey[], size_t key_len)
 
int botan_pubkey_load_ml_dsa (botan_pubkey_t *key, const uint8_t pubkey[], size_t key_len, const char *mldsa_mode)
 
int botan_pubkey_load_ml_kem (botan_pubkey_t *key, const uint8_t pubkey[], size_t key_len, const char *mlkem_mode)
 
int botan_pubkey_load_rsa (botan_pubkey_t *key, botan_mp_t n, botan_mp_t e)
 
int botan_pubkey_load_slh_dsa (botan_pubkey_t *key, const uint8_t pubkey[], size_t key_len, const char *slhdsa_mode)
 
int botan_pubkey_load_sm2 (botan_pubkey_t *key, botan_mp_t public_x, botan_mp_t public_y, const char *curve_name)
 
int botan_pubkey_load_sm2_enc (botan_pubkey_t *key, botan_mp_t public_x, botan_mp_t public_y, const char *curve_name)
 
int botan_pubkey_load_x25519 (botan_pubkey_t *key, const uint8_t pubkey[32])
 
int botan_pubkey_load_x448 (botan_pubkey_t *key, const uint8_t pubkey[56])
 
int botan_pubkey_oid (botan_asn1_oid_t *oid, botan_pubkey_t key)
 
int botan_pubkey_rsa_get_e (botan_mp_t e, botan_pubkey_t rsa_key)
 
int botan_pubkey_rsa_get_n (botan_mp_t n, botan_pubkey_t rsa_key)
 
int botan_pubkey_sm2_compute_za (uint8_t out[], size_t *out_len, const char *ident, const char *hash_algo, botan_pubkey_t key)
 
int botan_pubkey_view_der (botan_pubkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_pubkey_view_ec_public_point (botan_pubkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_pubkey_view_kyber_raw_key (botan_pubkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_pubkey_view_pem (botan_pubkey_t key, botan_view_ctx ctx, botan_view_str_fn view)
 
int botan_pubkey_view_raw (botan_pubkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_pubkey_x25519_get_pubkey (botan_pubkey_t key, uint8_t pubkey[32])
 
int botan_pubkey_x448_get_pubkey (botan_pubkey_t key, uint8_t pubkey[56])
 
int botan_pwdhash (const char *algo, size_t param1, size_t param2, size_t param3, uint8_t out[], size_t out_len, const char *passphrase, size_t passphrase_len, const uint8_t salt[], size_t salt_len)
 
int botan_pwdhash_timed (const char *algo, uint32_t msec, size_t *param1, size_t *param2, size_t *param3, uint8_t out[], size_t out_len, const char *passphrase, size_t passphrase_len, const uint8_t salt[], size_t salt_len)
 
int botan_rng_add_entropy (botan_rng_t rng, const uint8_t *entropy, size_t entropy_len)
 
int botan_rng_destroy (botan_rng_t rng)
 
int botan_rng_get (botan_rng_t rng, uint8_t *out, size_t out_len)
 
int botan_rng_init (botan_rng_t *rng, const char *rng_type)
 
int botan_rng_init_custom (botan_rng_t *rng_out, const char *rng_name, void *context, int(*get_cb)(void *context, uint8_t *out, size_t out_len), int(*add_entropy_cb)(void *context, const uint8_t input[], size_t length), void(*destroy_cb)(void *context))
 
int botan_rng_reseed (botan_rng_t rng, size_t bits)
 
int botan_rng_reseed_from_rng (botan_rng_t rng, botan_rng_t source_rng, size_t bits)
 
int botan_same_mem (const uint8_t *x, const uint8_t *y, size_t len)
 
int botan_scrub_mem (void *mem, size_t bytes)
 
int botan_scrypt (uint8_t out[], size_t out_len, const char *passphrase, const uint8_t salt[], size_t salt_len, size_t N, size_t r, size_t p)
 
int botan_srp6_client_agree (const char *username, const char *password, const char *group_id, const char *hash_id, const uint8_t salt[], size_t salt_len, const uint8_t B[], size_t B_len, botan_rng_t rng_obj, uint8_t A[], size_t *A_len, uint8_t K[], size_t *K_len)
 
int botan_srp6_generate_verifier (const char *identifier, const char *password, const uint8_t salt[], size_t salt_len, const char *group_id, const char *hash_id, uint8_t verifier[], size_t *verifier_len)
 
int botan_srp6_group_size (const char *group_id, size_t *group_p_bytes)
 
int botan_srp6_server_session_destroy (botan_srp6_server_session_t srp6)
 
int botan_srp6_server_session_init (botan_srp6_server_session_t *srp6)
 
int botan_srp6_server_session_step1 (botan_srp6_server_session_t srp6, const uint8_t verifier[], size_t verifier_len, const char *group_id, const char *hash_id, botan_rng_t rng_obj, uint8_t B_pub[], size_t *B_pub_len)
 
int botan_srp6_server_session_step2 (botan_srp6_server_session_t srp6, const uint8_t A[], size_t A_len, uint8_t key[], size_t *key_len)
 
int botan_system_rng_get (uint8_t *out, size_t out_len)
 
int botan_totp_check (botan_totp_t totp, uint32_t totp_code, uint64_t timestamp, size_t acceptable_clock_drift)
 
int botan_totp_destroy (botan_totp_t totp)
 
int botan_totp_generate (botan_totp_t totp, uint32_t *totp_code, uint64_t timestamp)
 
int botan_totp_init (botan_totp_t *totp, const uint8_t key[], size_t key_len, const char *hash_algo, size_t digits, size_t time_step)
 
int botan_tpm2_crypto_backend_state_destroy (botan_tpm2_crypto_backend_state_t cbs)
 
int botan_tpm2_ctx_destroy (botan_tpm2_ctx_t ctx)
 
int botan_tpm2_ctx_enable_crypto_backend (botan_tpm2_ctx_t ctx, botan_rng_t rng)
 
int botan_tpm2_ctx_from_esys (botan_tpm2_ctx_t *ctx_out, struct ESYS_CONTEXT *esys_ctx)
 
int botan_tpm2_ctx_init (botan_tpm2_ctx_t *ctx_out, const char *tcti_nameconf)
 
int botan_tpm2_ctx_init_ex (botan_tpm2_ctx_t *ctx_out, const char *tcti_name, const char *tcti_conf)
 
int botan_tpm2_enable_crypto_backend (botan_tpm2_crypto_backend_state_t *cbs_out, struct ESYS_CONTEXT *esys_ctx, botan_rng_t rng)
 
int botan_tpm2_rng_init (botan_rng_t *rng_out, botan_tpm2_ctx_t ctx, botan_tpm2_session_t s1, botan_tpm2_session_t s2, botan_tpm2_session_t s3)
 
int botan_tpm2_session_destroy (botan_tpm2_session_t session)
 
int botan_tpm2_supports_crypto_backend (void)
 
int botan_tpm2_unauthenticated_session_init (botan_tpm2_session_t *session_out, botan_tpm2_ctx_t ctx)
 
uint32_t botan_version_datestamp (void)
 
uint32_t botan_version_major (void)
 
uint32_t botan_version_minor (void)
 
uint32_t botan_version_patch (void)
 
const char * botan_version_string (void)
 
int botan_x509_cert_allowed_usage (botan_x509_cert_t cert, unsigned int key_usage)
 
int botan_x509_cert_destroy (botan_x509_cert_t cert)
 
int botan_x509_cert_dup (botan_x509_cert_t *new_cert, botan_x509_cert_t cert)
 
int botan_x509_cert_get_authority_key_id (botan_x509_cert_t cert, uint8_t out[], size_t *out_len)
 
int botan_x509_cert_get_fingerprint (botan_x509_cert_t cert, const char *hash, uint8_t out[], size_t *out_len)
 
int botan_x509_cert_get_issuer_dn (botan_x509_cert_t cert, const char *key, size_t index, uint8_t out[], size_t *out_len)
 
int botan_x509_cert_get_public_key (botan_x509_cert_t cert, botan_pubkey_t *key)
 
int botan_x509_cert_get_public_key_bits (botan_x509_cert_t cert, uint8_t out[], size_t *out_len)
 
int botan_x509_cert_get_serial_number (botan_x509_cert_t cert, uint8_t out[], size_t *out_len)
 
int botan_x509_cert_get_subject_dn (botan_x509_cert_t cert, const char *key, size_t index, uint8_t out[], size_t *out_len)
 
int botan_x509_cert_get_subject_key_id (botan_x509_cert_t cert, uint8_t out[], size_t *out_len)
 
int botan_x509_cert_get_time_expires (botan_x509_cert_t cert, char out[], size_t *out_len)
 
int botan_x509_cert_get_time_starts (botan_x509_cert_t cert, char out[], size_t *out_len)
 
int botan_x509_cert_hostname_match (botan_x509_cert_t cert, const char *hostname)
 
int botan_x509_cert_load (botan_x509_cert_t *cert_obj, const uint8_t cert[], size_t cert_len)
 
int botan_x509_cert_load_file (botan_x509_cert_t *cert_obj, const char *filename)
 
int botan_x509_cert_not_after (botan_x509_cert_t cert, uint64_t *time_since_epoch)
 
int botan_x509_cert_not_before (botan_x509_cert_t cert, uint64_t *time_since_epoch)
 
int botan_x509_cert_to_string (botan_x509_cert_t cert, char out[], size_t *out_len)
 
const char * botan_x509_cert_validation_status (int code)
 
int botan_x509_cert_verify (int *validation_result, botan_x509_cert_t cert, const botan_x509_cert_t *intermediates, size_t intermediates_len, const botan_x509_cert_t *trusted, size_t trusted_len, const char *trusted_path, size_t required_strength, const char *hostname, uint64_t reference_time)
 
int botan_x509_cert_verify_with_crl (int *validation_result, botan_x509_cert_t cert, const botan_x509_cert_t *intermediates, size_t intermediates_len, const botan_x509_cert_t *trusted, size_t trusted_len, const botan_x509_crl_t *crls, size_t crls_len, const char *trusted_path, size_t required_strength, const char *hostname, uint64_t reference_time)
 
int botan_x509_cert_view_as_string (botan_x509_cert_t cert, botan_view_ctx ctx, botan_view_str_fn view)
 
int botan_x509_cert_view_public_key_bits (botan_x509_cert_t cert, botan_view_ctx ctx, botan_view_bin_fn view)
 
int botan_x509_crl_destroy (botan_x509_crl_t crl)
 
int botan_x509_crl_load (botan_x509_crl_t *crl_obj, const uint8_t crl_bits[], size_t crl_bits_len)
 
int botan_x509_crl_load_file (botan_x509_crl_t *crl_obj, const char *crl_path)
 
int botan_x509_is_revoked (botan_x509_crl_t crl, botan_x509_cert_t cert)
 
int botan_zfec_decode (size_t K, size_t N, const size_t *indexes, uint8_t *const *inputs, size_t shareSize, uint8_t **outputs)
 
int botan_zfec_encode (size_t K, size_t N, const uint8_t *input, size_t size, uint8_t **outputs)
 

Detailed Description

Public Header.

Definition in file ffi.h.

Macro Definition Documentation

◆ BOTAN_CHECK_KEY_EXPENSIVE_TESTS

#define BOTAN_CHECK_KEY_EXPENSIVE_TESTS   1

Definition at line 1323 of file ffi.h.

Referenced by botan_privkey_check_key(), and botan_pubkey_check_key().

◆ BOTAN_CIPHER_INIT_FLAG_DECRYPT

#define BOTAN_CIPHER_INIT_FLAG_DECRYPT   1

Definition at line 559 of file ffi.h.

◆ BOTAN_CIPHER_INIT_FLAG_ENCRYPT

#define BOTAN_CIPHER_INIT_FLAG_ENCRYPT   0

Definition at line 558 of file ffi.h.

Referenced by botan_cipher_init().

◆ BOTAN_CIPHER_INIT_FLAG_MASK_DIRECTION

#define BOTAN_CIPHER_INIT_FLAG_MASK_DIRECTION   1

Definition at line 557 of file ffi.h.

Referenced by botan_cipher_init().

◆ BOTAN_CIPHER_UPDATE_FLAG_FINAL

#define BOTAN_CIPHER_UPDATE_FLAG_FINAL   (1U << 0)

Definition at line 652 of file ffi.h.

Referenced by botan_cipher_update().

◆ BOTAN_FFI_API_VERSION

#define BOTAN_FFI_API_VERSION   20250506

The compile time API version. This matches the value of botan_ffi_api_version. This can be used for compile-time checking if a particular feature is available.

Note this same value is also reflected in BOTAN_HAS_FFI in build.h, however that declaration is not visible here since this header is intentionally free-standing, depending only on a few C standard library headers.

Definition at line 70 of file ffi.h.

◆ BOTAN_FFI_DEPRECATED

#define BOTAN_FFI_DEPRECATED ( msg)

Definition at line 103 of file ffi.h.

◆ BOTAN_FFI_EXPORT

#define BOTAN_FFI_EXPORT ( maj,
min )

BOTAN_FFI_EXPORT indicates public FFI functions.

The arguments to the macro are to indicate the version that that particular FFI function was first available

Definition at line 88 of file ffi.h.

Referenced by botan_srp6_server_session_step1().

◆ BOTAN_FFI_HEX_LOWER_CASE

#define BOTAN_FFI_HEX_LOWER_CASE   1

Flag that can be provided to botan_hex_encode to request lower case hex

Definition at line 245 of file ffi.h.

Referenced by botan_hex_encode().

◆ BOTAN_FPE_FLAG_FE1_COMPAT_MODE

#define BOTAN_FPE_FLAG_FE1_COMPAT_MODE   1

Definition at line 2352 of file ffi.h.

Referenced by botan_fpe_fe1_init().

◆ BOTAN_PRIVKEY_EXPORT_FLAG_DER

#define BOTAN_PRIVKEY_EXPORT_FLAG_DER   0

Definition at line 1393 of file ffi.h.

Referenced by botan_privkey_export(), botan_privkey_export_encrypted_pbkdf_iter(), botan_privkey_export_encrypted_pbkdf_msec(), botan_privkey_rsa_get_privkey(), and botan_pubkey_export().

◆ BOTAN_PRIVKEY_EXPORT_FLAG_PEM

#define BOTAN_PRIVKEY_EXPORT_FLAG_PEM   1

Definition at line 1394 of file ffi.h.

Referenced by botan_privkey_export(), botan_privkey_export_encrypted_pbkdf_iter(), botan_privkey_export_encrypted_pbkdf_msec(), botan_privkey_rsa_get_privkey(), and botan_pubkey_export().

◆ BOTAN_PRIVKEY_EXPORT_FLAG_RAW

#define BOTAN_PRIVKEY_EXPORT_FLAG_RAW   2

Definition at line 1395 of file ffi.h.

Referenced by botan_privkey_export(), and botan_pubkey_export().

◆ BOTAN_PUBKEY_DER_FORMAT_SIGNATURE

#define BOTAN_PUBKEY_DER_FORMAT_SIGNATURE   1

Definition at line 1939 of file ffi.h.

Referenced by botan_pk_op_encrypt_create(), botan_pk_op_sign_create(), and botan_pk_op_verify_create().

Typedef Documentation

◆ botan_asn1_oid_t

typedef struct botan_asn1_oid_struct* botan_asn1_oid_t

Definition at line 1117 of file ffi.h.

◆ botan_block_cipher_t

typedef struct botan_block_cipher_struct* botan_block_cipher_t

Definition at line 853 of file ffi.h.

◆ botan_cipher_t

typedef struct botan_cipher_struct* botan_cipher_t

Definition at line 555 of file ffi.h.

◆ botan_ec_group_t

typedef struct botan_ec_group_struct* botan_ec_group_t

Definition at line 1166 of file ffi.h.

◆ botan_fpe_t

typedef struct botan_fpe_struct* botan_fpe_t

Format Preserving Encryption

Definition at line 2350 of file ffi.h.

◆ botan_hash_t

typedef struct botan_hash_struct* botan_hash_t

Definition at line 379 of file ffi.h.

◆ botan_hotp_t

typedef struct botan_hotp_struct* botan_hotp_t

HOTP

Definition at line 2278 of file ffi.h.

◆ botan_mac_t

typedef struct botan_mac_struct* botan_mac_t

Definition at line 459 of file ffi.h.

◆ botan_mp_t

typedef struct botan_mp_struct* botan_mp_t

Definition at line 919 of file ffi.h.

◆ botan_pk_op_decrypt_t

typedef struct botan_pk_op_decrypt_struct* botan_pk_op_decrypt_t

Definition at line 1918 of file ffi.h.

◆ botan_pk_op_encrypt_t

typedef struct botan_pk_op_encrypt_struct* botan_pk_op_encrypt_t

Definition at line 1894 of file ffi.h.

◆ botan_pk_op_ka_t

typedef struct botan_pk_op_ka_struct* botan_pk_op_ka_t

Definition at line 1980 of file ffi.h.

◆ botan_pk_op_kem_decrypt_t

typedef struct botan_pk_op_kem_decrypt_struct* botan_pk_op_kem_decrypt_t

Definition at line 2039 of file ffi.h.

◆ botan_pk_op_kem_encrypt_t

typedef struct botan_pk_op_kem_encrypt_struct* botan_pk_op_kem_encrypt_t

Definition at line 2009 of file ffi.h.

◆ botan_pk_op_sign_t

typedef struct botan_pk_op_sign_struct* botan_pk_op_sign_t

Definition at line 1941 of file ffi.h.

◆ botan_pk_op_verify_t

typedef struct botan_pk_op_verify_struct* botan_pk_op_verify_t

Definition at line 1961 of file ffi.h.

◆ botan_privkey_t

typedef struct botan_privkey_struct* botan_privkey_t

Definition at line 1300 of file ffi.h.

◆ botan_pubkey_t

typedef struct botan_pubkey_struct* botan_pubkey_t

Definition at line 1533 of file ffi.h.

◆ botan_rng_t

typedef struct botan_rng_struct* botan_rng_t

RNG type

Definition at line 287 of file ffi.h.

◆ botan_srp6_server_session_t

typedef struct botan_srp6_server_session_struct* botan_srp6_server_session_t

SRP-6 Server Session type

Definition at line 2373 of file ffi.h.

◆ botan_totp_t

typedef struct botan_totp_struct* botan_totp_t

TOTP

Definition at line 2310 of file ffi.h.

◆ botan_tpm2_crypto_backend_state_t

typedef struct botan_tpm2_crypto_backend_state_struct* botan_tpm2_crypto_backend_state_t

TPM2 crypto backend state object

Definition at line 2541 of file ffi.h.

◆ botan_tpm2_ctx_t

typedef struct botan_tpm2_ctx_struct* botan_tpm2_ctx_t

TPM2 context

Definition at line 2531 of file ffi.h.

◆ botan_tpm2_session_t

typedef struct botan_tpm2_session_struct* botan_tpm2_session_t

TPM2 session

Definition at line 2536 of file ffi.h.

◆ botan_view_bin_fn

typedef int(* botan_view_bin_fn) (botan_view_ctx view_ctx, const uint8_t *data, size_t len)

Viewer function for binary data

Parameters
view_ctxsome application context
datathe binary data
lenthe length of data in bytes

Definition at line 159 of file ffi.h.

◆ botan_view_ctx

typedef void* botan_view_ctx

The application provided context for a view function

Definition at line 150 of file ffi.h.

◆ botan_view_str_fn

typedef int(* botan_view_str_fn) (botan_view_ctx view_ctx, const char *str, size_t len)

Viewer function for string data

Parameters
view_ctxsome application context
strthe null terminated string
lenthe length of string including the null terminator

Definition at line 168 of file ffi.h.

◆ botan_x509_cert_t

typedef struct botan_x509_cert_struct* botan_x509_cert_t

Definition at line 2103 of file ffi.h.

◆ botan_x509_crl_t

typedef struct botan_x509_crl_struct* botan_x509_crl_t

Definition at line 2201 of file ffi.h.

Enumeration Type Documentation

◆ BOTAN_FFI_ERROR

enum BOTAN_FFI_ERROR

Error codes

If you add a new value here be sure to also add it in botan_error_description

Enumerator
BOTAN_FFI_SUCCESS 
BOTAN_FFI_INVALID_VERIFIER 
BOTAN_FFI_ERROR_INVALID_INPUT 
BOTAN_FFI_ERROR_BAD_MAC 
BOTAN_FFI_ERROR_NO_VALUE 
BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE 
BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR 
BOTAN_FFI_ERROR_EXCEPTION_THROWN 
BOTAN_FFI_ERROR_OUT_OF_MEMORY 
BOTAN_FFI_ERROR_SYSTEM_ERROR 
BOTAN_FFI_ERROR_INTERNAL_ERROR 
BOTAN_FFI_ERROR_BAD_FLAG 
BOTAN_FFI_ERROR_NULL_POINTER 
BOTAN_FFI_ERROR_BAD_PARAMETER 
BOTAN_FFI_ERROR_KEY_NOT_SET 
BOTAN_FFI_ERROR_INVALID_KEY_LENGTH 
BOTAN_FFI_ERROR_INVALID_OBJECT_STATE 
BOTAN_FFI_ERROR_NOT_IMPLEMENTED 
BOTAN_FFI_ERROR_INVALID_OBJECT 
BOTAN_FFI_ERROR_TLS_ERROR 
BOTAN_FFI_ERROR_HTTP_ERROR 
BOTAN_FFI_ERROR_ROUGHTIME_ERROR 
BOTAN_FFI_ERROR_TPM_ERROR 
BOTAN_FFI_ERROR_UNKNOWN_ERROR 

Definition at line 112 of file ffi.h.

112 {
113 BOTAN_FFI_SUCCESS = 0,
114
115 BOTAN_FFI_INVALID_VERIFIER = 1,
116
117 BOTAN_FFI_ERROR_INVALID_INPUT = -1,
118 BOTAN_FFI_ERROR_BAD_MAC = -2,
119 BOTAN_FFI_ERROR_NO_VALUE = -3,
120
121 BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE = -10,
122 BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR = -11,
123
124 BOTAN_FFI_ERROR_EXCEPTION_THROWN = -20,
125 BOTAN_FFI_ERROR_OUT_OF_MEMORY = -21,
126 BOTAN_FFI_ERROR_SYSTEM_ERROR = -22,
127 BOTAN_FFI_ERROR_INTERNAL_ERROR = -23,
128
129 BOTAN_FFI_ERROR_BAD_FLAG = -30,
130 BOTAN_FFI_ERROR_NULL_POINTER = -31,
131 BOTAN_FFI_ERROR_BAD_PARAMETER = -32,
132 BOTAN_FFI_ERROR_KEY_NOT_SET = -33,
133 BOTAN_FFI_ERROR_INVALID_KEY_LENGTH = -34,
134 BOTAN_FFI_ERROR_INVALID_OBJECT_STATE = -35,
135
136 BOTAN_FFI_ERROR_NOT_IMPLEMENTED = -40,
137 BOTAN_FFI_ERROR_INVALID_OBJECT = -50,
138
139 BOTAN_FFI_ERROR_TLS_ERROR = -75,
140 BOTAN_FFI_ERROR_HTTP_ERROR = -76,
141 BOTAN_FFI_ERROR_ROUGHTIME_ERROR = -77,
142 BOTAN_FFI_ERROR_TPM_ERROR = -78,
143
144 BOTAN_FFI_ERROR_UNKNOWN_ERROR = -100,
145};
BOTAN_FFI_ERROR_TPM_ERROR
@ BOTAN_FFI_ERROR_TPM_ERROR
Definition ffi.h:142
BOTAN_FFI_ERROR_NOT_IMPLEMENTED
@ BOTAN_FFI_ERROR_NOT_IMPLEMENTED
Definition ffi.h:136
BOTAN_FFI_ERROR_INVALID_KEY_LENGTH
@ BOTAN_FFI_ERROR_INVALID_KEY_LENGTH
Definition ffi.h:133
BOTAN_FFI_ERROR_KEY_NOT_SET
@ BOTAN_FFI_ERROR_KEY_NOT_SET
Definition ffi.h:132
BOTAN_FFI_ERROR_TLS_ERROR
@ BOTAN_FFI_ERROR_TLS_ERROR
Definition ffi.h:139
BOTAN_FFI_ERROR_EXCEPTION_THROWN
@ BOTAN_FFI_ERROR_EXCEPTION_THROWN
Definition ffi.h:124
BOTAN_FFI_ERROR_OUT_OF_MEMORY
@ BOTAN_FFI_ERROR_OUT_OF_MEMORY
Definition ffi.h:125
BOTAN_FFI_ERROR_INTERNAL_ERROR
@ BOTAN_FFI_ERROR_INTERNAL_ERROR
Definition ffi.h:127
BOTAN_FFI_INVALID_VERIFIER
@ BOTAN_FFI_INVALID_VERIFIER
Definition ffi.h:115
BOTAN_FFI_ERROR_INVALID_OBJECT
@ BOTAN_FFI_ERROR_INVALID_OBJECT
Definition ffi.h:137
BOTAN_FFI_ERROR_UNKNOWN_ERROR
@ BOTAN_FFI_ERROR_UNKNOWN_ERROR
Definition ffi.h:144
BOTAN_FFI_ERROR_HTTP_ERROR
@ BOTAN_FFI_ERROR_HTTP_ERROR
Definition ffi.h:140
BOTAN_FFI_ERROR_BAD_FLAG
@ BOTAN_FFI_ERROR_BAD_FLAG
Definition ffi.h:129
BOTAN_FFI_ERROR_INVALID_INPUT
@ BOTAN_FFI_ERROR_INVALID_INPUT
Definition ffi.h:117
BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR
@ BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR
Definition ffi.h:122
BOTAN_FFI_ERROR_NULL_POINTER
@ BOTAN_FFI_ERROR_NULL_POINTER
Definition ffi.h:130
BOTAN_FFI_SUCCESS
@ BOTAN_FFI_SUCCESS
Definition ffi.h:113
BOTAN_FFI_ERROR_SYSTEM_ERROR
@ BOTAN_FFI_ERROR_SYSTEM_ERROR
Definition ffi.h:126
BOTAN_FFI_ERROR_ROUGHTIME_ERROR
@ BOTAN_FFI_ERROR_ROUGHTIME_ERROR
Definition ffi.h:141
BOTAN_FFI_ERROR_NO_VALUE
@ BOTAN_FFI_ERROR_NO_VALUE
Definition ffi.h:119
BOTAN_FFI_ERROR_INVALID_OBJECT_STATE
@ BOTAN_FFI_ERROR_INVALID_OBJECT_STATE
Definition ffi.h:134
BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE
@ BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE
Definition ffi.h:121
BOTAN_FFI_ERROR_BAD_MAC
@ BOTAN_FFI_ERROR_BAD_MAC
Definition ffi.h:118
BOTAN_FFI_ERROR_BAD_PARAMETER
@ BOTAN_FFI_ERROR_BAD_PARAMETER
Definition ffi.h:131

◆ botan_x509_cert_key_constraints

enum botan_x509_cert_key_constraints
Enumerator
NO_CONSTRAINTS 
DIGITAL_SIGNATURE 
NON_REPUDIATION 
KEY_ENCIPHERMENT 
DATA_ENCIPHERMENT 
KEY_AGREEMENT 
KEY_CERT_SIGN 
CRL_SIGN 
ENCIPHER_ONLY 
DECIPHER_ONLY 

Definition at line 2150 of file ffi.h.

2150 {
2151 NO_CONSTRAINTS = 0,
2152 DIGITAL_SIGNATURE = 32768,
2153 NON_REPUDIATION = 16384,
2154 KEY_ENCIPHERMENT = 8192,
2155 DATA_ENCIPHERMENT = 4096,
2156 KEY_AGREEMENT = 2048,
2157 KEY_CERT_SIGN = 1024,
2158 CRL_SIGN = 512,
2159 ENCIPHER_ONLY = 256,
2160 DECIPHER_ONLY = 128
2161};
KEY_ENCIPHERMENT
@ KEY_ENCIPHERMENT
Definition ffi.h:2154
NO_CONSTRAINTS
@ NO_CONSTRAINTS
Definition ffi.h:2151
CRL_SIGN
@ CRL_SIGN
Definition ffi.h:2158
DIGITAL_SIGNATURE
@ DIGITAL_SIGNATURE
Definition ffi.h:2152
KEY_AGREEMENT
@ KEY_AGREEMENT
Definition ffi.h:2156
DATA_ENCIPHERMENT
@ DATA_ENCIPHERMENT
Definition ffi.h:2155
KEY_CERT_SIGN
@ KEY_CERT_SIGN
Definition ffi.h:2157
ENCIPHER_ONLY
@ ENCIPHER_ONLY
Definition ffi.h:2159
NON_REPUDIATION
@ NON_REPUDIATION
Definition ffi.h:2153
DECIPHER_ONLY
@ DECIPHER_ONLY
Definition ffi.h:2160

Function Documentation

◆ botan_base64_decode()

int botan_base64_decode ( const char * base64_str,
size_t in_len,
uint8_t * out,
size_t * out_len )

Perform base64 decoding

Definition at line 339 of file ffi.cpp.

339 {
340 return ffi_guard_thunk(__func__, [=]() -> int {
341 if(*out_len < Botan::base64_decode_max_output(in_len)) {
342 *out_len = Botan::base64_decode_max_output(in_len);
343 return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
344 }
345
346 *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
347 return BOTAN_FFI_SUCCESS;
348 });
349}
Botan_FFI::ffi_guard_thunk
int ffi_guard_thunk(const char *func_name, T thunk)
Definition ffi_util.h:83
Botan::base64_decode
size_t base64_decode(uint8_t out[], const char in[], size_t input_length, size_t &input_consumed, bool final_inputs, bool ignore_ws)
Definition base64.cpp:168
Botan::base64_decode_max_output
size_t base64_decode_max_output(size_t input_length)
Definition base64.cpp:200

References Botan::base64_decode(), Botan::base64_decode_max_output(), BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_SUCCESS, and Botan_FFI::ffi_guard_thunk().

◆ botan_base64_encode()

int botan_base64_encode ( const uint8_t * x,
size_t len,
char * out,
size_t * out_len )

Perform base64 encoding

Parameters
xthe input data
lenthe length of x
outthe output buffer
out_lenthe size of the output buffer on input, set to the number of bytes written
Returns
0 on success, a negative value on failure

Definition at line 332 of file ffi.cpp.

332 {
333 return ffi_guard_thunk(__func__, [=]() -> int {
334 const std::string base64 = Botan::base64_encode(in, len);
335 return Botan_FFI::write_str_output(out, out_len, base64);
336 });
337}
Botan_FFI::write_str_output
int write_str_output(uint8_t out[], size_t *out_len, std::string_view str)
Definition ffi_util.h:230
Botan::base64_encode
size_t base64_encode(char out[], const uint8_t in[], size_t input_length, size_t &input_consumed, bool final_inputs)
Definition base64.cpp:160

References Botan::base64_encode(), Botan_FFI::ffi_guard_thunk(), and Botan_FFI::write_str_output().

◆ botan_bcrypt_generate()

int botan_bcrypt_generate ( uint8_t * out,
size_t * out_len,
const char * password,
botan_rng_t rng,
size_t work_factor,
uint32_t flags )

Create a password hash using Bcrypt

Parameters
outbuffer holding the password hash, should be of length 64 bytes
out_lenthe desired output length in bytes
passwordthe password
rnga random number generator
work_factorhow much work to do to slow down guessing attacks
flagsshould be 0 in current API revision, all other uses are reserved and return BOTAN_FFI_ERROR_BAD_FLAG
Returns
0 on success, a negative value on failure

Output is formatted bcrypt $2a$...

Definition at line 157 of file ffi_kdf.cpp.

158 {
159#if defined(BOTAN_HAS_BCRYPT)
160 return ffi_guard_thunk(__func__, [=]() -> int {
161 if(out == nullptr || out_len == nullptr || pass == nullptr) {
162 return BOTAN_FFI_ERROR_NULL_POINTER;
163 }
164
165 if(flags != 0) {
166 return BOTAN_FFI_ERROR_BAD_FLAG;
167 }
168
169 if(wf < 4 || wf > 18) {
170 return BOTAN_FFI_ERROR_BAD_PARAMETER;
171 }
172
173 if(*out_len < 61) {
174 *out_len = 61;
175 return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
176 }
177
178 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
179 const std::string bcrypt = Botan::generate_bcrypt(pass, rng, static_cast<uint16_t>(wf));
180 return write_str_output(out, out_len, bcrypt);
181 });
182#else
183 BOTAN_UNUSED(out, out_len, pass, rng_obj, wf, flags);
184 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
185#endif
186}
BOTAN_UNUSED
#define BOTAN_UNUSED
Definition assert.h:120
Botan_FFI::safe_get
T & safe_get(botan_struct< T, M > *p)
Definition ffi_util.h:67
Botan::generate_bcrypt
std::string generate_bcrypt(std::string_view pass, RandomNumberGenerator &rng, uint16_t work_factor, char version)
Definition bcrypt.cpp:145

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan::generate_bcrypt(), Botan_FFI::safe_get(), and Botan_FFI::write_str_output().

◆ botan_bcrypt_is_valid()

int botan_bcrypt_is_valid ( const char * pass,
const char * hash )

Check a previously created password hash

Parameters
passthe password to check against
hashthe stored hash to check against
Returns
0 if if this password/hash combination is valid, 1 if the combination is not valid (but otherwise well formed), negative on error

Definition at line 188 of file ffi_kdf.cpp.

188 {
189#if defined(BOTAN_HAS_BCRYPT)
190 return ffi_guard_thunk(__func__, [=]() -> int {
191 return Botan::check_bcrypt(pass, hash) ? BOTAN_FFI_SUCCESS : BOTAN_FFI_INVALID_VERIFIER;
192 });
193#else
194 BOTAN_UNUSED(pass, hash);
195 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
196#endif
197}
Botan::check_bcrypt
bool check_bcrypt(std::string_view pass, std::string_view hash)
Definition bcrypt.cpp:160

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_INVALID_VERIFIER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan::check_bcrypt(), and Botan_FFI::ffi_guard_thunk().

◆ botan_block_cipher_block_size()

int botan_block_cipher_block_size ( botan_block_cipher_t bc)

Return the positive block size of this block cipher, or negative to indicate an error

Definition at line 61 of file ffi_block.cpp.

61 {
62 return BOTAN_FFI_VISIT(bc, [](const auto& b) { return static_cast<int>(b.block_size()); });
63}
BOTAN_FFI_VISIT
#define BOTAN_FFI_VISIT(obj, lambda)
Definition ffi_util.h:145

References BOTAN_FFI_VISIT.

◆ botan_block_cipher_clear()

int botan_block_cipher_clear ( botan_block_cipher_t bc)

Reinitializes the block cipher

Returns
0 on success, a negative value on failure

Definition at line 43 of file ffi_block.cpp.

43 {
44 return BOTAN_FFI_VISIT(bc, [](auto& b) { b.clear(); });
45}

References BOTAN_FFI_VISIT.

◆ botan_block_cipher_decrypt_blocks()

int botan_block_cipher_decrypt_blocks ( botan_block_cipher_t bc,
const uint8_t in[],
uint8_t out[],
size_t blocks )

Decrypt one or more blocks with the cipher

Definition at line 72 of file ffi_block.cpp.

72 {
73 if(in == nullptr || out == nullptr) {
74 return BOTAN_FFI_ERROR_NULL_POINTER;
75 }
76 return BOTAN_FFI_VISIT(bc, [=](const auto& b) { b.decrypt_n(in, out, blocks); });
77}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_block_cipher_destroy()

int botan_block_cipher_destroy ( botan_block_cipher_t bc)

Destroy a block cipher object

Returns
0 if success, error if invalid object handle

Destroy a block cipher object

Definition at line 39 of file ffi_block.cpp.

39 {
40 return BOTAN_FFI_CHECKED_DELETE(bc);
41}
BOTAN_FFI_CHECKED_DELETE
#define BOTAN_FFI_CHECKED_DELETE(o)
Definition ffi_util.h:164

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_block_cipher_encrypt_blocks()

int botan_block_cipher_encrypt_blocks ( botan_block_cipher_t bc,
const uint8_t in[],
uint8_t out[],
size_t blocks )

Encrypt one or more blocks with the cipher

Definition at line 65 of file ffi_block.cpp.

65 {
66 if(in == nullptr || out == nullptr) {
67 return BOTAN_FFI_ERROR_NULL_POINTER;
68 }
69 return BOTAN_FFI_VISIT(bc, [=](const auto& b) { b.encrypt_n(in, out, blocks); });
70}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_block_cipher_get_keyspec()

int botan_block_cipher_get_keyspec ( botan_block_cipher_t cipher,
size_t * out_minimum_keylength,
size_t * out_maximum_keylength,
size_t * out_keylength_modulo )

Get the key length limits of this block cipher

Parameters
cipherthe object to read
out_minimum_keylengthif non-NULL, will be set to minimum keylength of cipher
out_maximum_keylengthif non-NULL, will be set to maximum keylength of cipher
out_keylength_moduloif non-NULL will be set to byte multiple of valid keys

Definition at line 87 of file ffi_block.cpp.

90 {
91 return BOTAN_FFI_VISIT(cipher, [=](const auto& bc) {
92 if(out_minimum_keylength) {
93 *out_minimum_keylength = bc.minimum_keylength();
94 }
95 if(out_maximum_keylength) {
96 *out_maximum_keylength = bc.maximum_keylength();
97 }
98 if(out_keylength_modulo) {
99 *out_keylength_modulo = bc.key_spec().keylength_multiple();
100 }
101 });
102}

References BOTAN_FFI_VISIT.

◆ botan_block_cipher_init()

int botan_block_cipher_init ( botan_block_cipher_t * bc,
const char * cipher_name )

Initialize a block cipher object

Definition at line 18 of file ffi_block.cpp.

18 {
19 return ffi_guard_thunk(__func__, [=]() -> int {
20 if(bc == nullptr || bc_name == nullptr || *bc_name == 0) {
21 return BOTAN_FFI_ERROR_NULL_POINTER;
22 }
23
24 *bc = nullptr;
25
26 auto cipher = Botan::BlockCipher::create(bc_name);
27 if(cipher == nullptr) {
28 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
29 }
30
31 *bc = new botan_block_cipher_struct(std::move(cipher));
32 return BOTAN_FFI_SUCCESS;
33 });
34}
Botan::BlockCipher::create
static std::unique_ptr< BlockCipher > create(std::string_view algo_spec, std::string_view provider="")
Definition block_cipher.cpp:92

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::BlockCipher::create(), and Botan_FFI::ffi_guard_thunk().

◆ botan_block_cipher_name()

int botan_block_cipher_name ( botan_block_cipher_t cipher,
char * name,
size_t * name_len )

Get the name of this block cipher

Parameters
cipherthe object to read
nameoutput buffer
name_lenon input, the length of buffer, on success the number of bytes written

Definition at line 79 of file ffi_block.cpp.

79 {
80 if(name_len == nullptr) {
81 return BOTAN_FFI_ERROR_NULL_POINTER;
82 }
83
84 return BOTAN_FFI_VISIT(cipher, [=](const auto& bc) { return write_str_output(name, name_len, bc.name()); });
85}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and Botan_FFI::write_str_output().

◆ botan_block_cipher_set_key()

int botan_block_cipher_set_key ( botan_block_cipher_t bc,
const uint8_t key[],
size_t len )

Set the key for a block cipher instance

Definition at line 50 of file ffi_block.cpp.

50 {
51 if(key == nullptr) {
52 return BOTAN_FFI_ERROR_NULL_POINTER;
53 }
54 return BOTAN_FFI_VISIT(bc, [=](auto& b) { b.set_key(key, len); });
55}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_cipher_clear()

int botan_cipher_clear ( botan_cipher_t hash)

Reset the key, nonce, AD and all other state on this cipher object

Definition at line 118 of file ffi_cipher.cpp.

118 {
119 return BOTAN_FFI_VISIT(cipher, [](auto& c) { c.clear(); });
120}

References BOTAN_FFI_VISIT.

◆ botan_cipher_destroy()

int botan_cipher_destroy ( botan_cipher_t cipher)

Destroy the cipher object

Returns
0 if success, error if invalid object handle

Definition at line 114 of file ffi_cipher.cpp.

114 {
115 return BOTAN_FFI_CHECKED_DELETE(cipher);
116}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_cipher_get_default_nonce_length()

int botan_cipher_get_default_nonce_length ( botan_cipher_t cipher,
size_t * nl )

Get the default nonce length of this cipher

Definition at line 302 of file ffi_cipher.cpp.

302 {
303 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) { *nl = c.default_nonce_length(); });
304}

References BOTAN_FFI_VISIT.

◆ botan_cipher_get_ideal_update_granularity()

int botan_cipher_get_ideal_update_granularity ( botan_cipher_t cipher,
size_t * ug )

Return the ideal update granularity of the cipher. This is some multiple of the update granularity, reflecting possibilities for optimization.

Definition at line 310 of file ffi_cipher.cpp.

310 {
311 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) { *ug = c.ideal_granularity(); });
312}

References BOTAN_FFI_VISIT.

◆ botan_cipher_get_keyspec()

int botan_cipher_get_keyspec ( botan_cipher_t cipher,
size_t * min_keylen,
size_t * max_keylen,
size_t * mod_keylen )

Get information about the supported key lengths.

Definition at line 141 of file ffi_cipher.cpp.

144 {
145 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) {
146 if(out_minimum_keylength) {
147 *out_minimum_keylength = c.key_spec().minimum_keylength();
148 }
149 if(out_maximum_keylength) {
150 *out_maximum_keylength = c.key_spec().maximum_keylength();
151 }
152 if(out_keylength_modulo) {
153 *out_keylength_modulo = c.key_spec().keylength_multiple();
154 }
155 });
156}

References BOTAN_FFI_VISIT.

◆ botan_cipher_get_tag_length()

int botan_cipher_get_tag_length ( botan_cipher_t cipher,
size_t * tag_size )

Get the tag length of the cipher (0 for non-AEAD modes)

Definition at line 314 of file ffi_cipher.cpp.

314 {
315 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) { *tl = c.tag_size(); });
316}

References BOTAN_FFI_VISIT.

◆ botan_cipher_get_update_granularity()

int botan_cipher_get_update_granularity ( botan_cipher_t cipher,
size_t * ug )

Return the update granularity of the cipher; botan_cipher_update must be called with blocks of this size, except for the final.

Definition at line 306 of file ffi_cipher.cpp.

306 {
307 return BOTAN_FFI_VISIT(cipher, [=](const auto& /*c*/) { *ug = cipher->update_size(); });
308}

References BOTAN_FFI_VISIT.

◆ botan_cipher_init()

int botan_cipher_init ( botan_cipher_t * cipher,
const char * name,
uint32_t flags )

Initialize a cipher object

Definition at line 96 of file ffi_cipher.cpp.

96 {
97 return ffi_guard_thunk(__func__, [=]() -> int {
98 const bool encrypt_p = ((flags & BOTAN_CIPHER_INIT_FLAG_MASK_DIRECTION) == BOTAN_CIPHER_INIT_FLAG_ENCRYPT);
99 const Botan::Cipher_Dir dir = encrypt_p ? Botan::Cipher_Dir::Encryption : Botan::Cipher_Dir::Decryption;
100
101 std::unique_ptr<Botan::Cipher_Mode> mode(Botan::Cipher_Mode::create(cipher_name, dir));
102 if(!mode) {
103 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
104 }
105
106 const size_t update_size = ffi_choose_update_size(*mode);
107 const size_t ideal_update_size = std::max(mode->ideal_granularity(), update_size);
108
109 *cipher = new botan_cipher_struct(std::move(mode), update_size, ideal_update_size);
110 return BOTAN_FFI_SUCCESS;
111 });
112}
Botan::Cipher_Mode::create
static std::unique_ptr< Cipher_Mode > create(std::string_view algo, Cipher_Dir direction, std::string_view provider="")
Definition cipher_mode.cpp:51
BOTAN_CIPHER_INIT_FLAG_ENCRYPT
#define BOTAN_CIPHER_INIT_FLAG_ENCRYPT
Definition ffi.h:558
BOTAN_CIPHER_INIT_FLAG_MASK_DIRECTION
#define BOTAN_CIPHER_INIT_FLAG_MASK_DIRECTION
Definition ffi.h:557
Botan::PKCS11::flags
Flags flags(Flag flags)
Definition p11.h:838

References BOTAN_CIPHER_INIT_FLAG_ENCRYPT, BOTAN_CIPHER_INIT_FLAG_MASK_DIRECTION, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, Botan::Cipher_Mode::create(), Botan::Decryption, Botan::Encryption, and Botan_FFI::ffi_guard_thunk().

◆ botan_cipher_is_authenticated()

int botan_cipher_is_authenticated ( botan_cipher_t cipher)

Returns 1 iff the cipher provides authentication as well as confidentiality.

Definition at line 318 of file ffi_cipher.cpp.

318 {
319 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) { return c.authenticated() ? 1 : 0; });
320}

References BOTAN_FFI_VISIT.

◆ botan_cipher_name()

int botan_cipher_name ( botan_cipher_t cipher,
char * name,
size_t * name_len )

Return the name of the cipher object

Definition at line 326 of file ffi_cipher.cpp.

326 {
327 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) { return write_str_output(name, name_len, c.name()); });
328}

References BOTAN_FFI_VISIT, and Botan_FFI::write_str_output().

◆ botan_cipher_output_length()

int botan_cipher_output_length ( botan_cipher_t cipher,
size_t in_len,
size_t * out_len )

Return the output length of this cipher, for a particular input length.

Definition at line 126 of file ffi_cipher.cpp.

126 {
127 if(out_len == nullptr) {
128 return BOTAN_FFI_ERROR_NULL_POINTER;
129 }
130
131 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) { *out_len = c.output_length(in_len); });
132}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_cipher_query_keylen()

int botan_cipher_query_keylen ( botan_cipher_t cipher,
size_t * out_minimum_keylength,
size_t * out_maximum_keylength )

Get information about the key lengths. Prefer botan_cipher_get_keyspec

Definition at line 134 of file ffi_cipher.cpp.

134 {
135 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) {
136 *out_minimum_keylength = c.key_spec().minimum_keylength();
137 *out_maximum_keylength = c.key_spec().maximum_keylength();
138 });
139}

References BOTAN_FFI_VISIT.

◆ botan_cipher_requires_entire_message()

int botan_cipher_requires_entire_message ( botan_cipher_t cipher)

Returns 1 iff the cipher requires the entire message before any encryption or decryption can be performed. No output data will be produced in botan_cipher_update() until the final flag is set.

Definition at line 322 of file ffi_cipher.cpp.

322 {
323 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) { return c.requires_entire_message() ? 1 : 0; });
324}

References BOTAN_FFI_VISIT.

◆ botan_cipher_reset()

int botan_cipher_reset ( botan_cipher_t cipher)

Reset the message specific state for this cipher. Without resetting the keys, this resets the nonce, and any state associated with any message bits that have been processed so far.

It is conceptually equivalent to calling botan_cipher_clear followed by botan_cipher_set_key with the original key.

Definition at line 122 of file ffi_cipher.cpp.

122 {
123 return BOTAN_FFI_VISIT(cipher, [](auto& c) { c.reset(); });
124}

References BOTAN_FFI_VISIT.

◆ botan_cipher_set_associated_data()

int botan_cipher_set_associated_data ( botan_cipher_t cipher,
const uint8_t * ad,
size_t ad_len )

Set the associated data. Will fail if cipher is not an AEAD

Definition at line 288 of file ffi_cipher.cpp.

288 {
289 return BOTAN_FFI_VISIT(cipher, [=](auto& c) {
290 if(Botan::AEAD_Mode* aead = dynamic_cast<Botan::AEAD_Mode*>(&c)) {
291 aead->set_associated_data(ad, ad_len);
292 return BOTAN_FFI_SUCCESS;
293 }
294 return BOTAN_FFI_ERROR_BAD_PARAMETER;
295 });
296}
Botan::AEAD_Mode
Definition aead.h:24

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_cipher_set_key()

int botan_cipher_set_key ( botan_cipher_t cipher,
const uint8_t * key,
size_t key_len )

Set the key for this cipher object

Definition at line 158 of file ffi_cipher.cpp.

158 {
159 return BOTAN_FFI_VISIT(cipher, [=](auto& c) { c.set_key(key, key_len); });
160}

References BOTAN_FFI_VISIT.

◆ botan_cipher_start()

int botan_cipher_start ( botan_cipher_t cipher,
const uint8_t * nonce,
size_t nonce_len )

Begin processing a new message using the provided nonce

Definition at line 162 of file ffi_cipher.cpp.

162 {
163 return ffi_guard_thunk(__func__, [=]() -> int {
164 Botan::Cipher_Mode& cipher = safe_get(cipher_obj);
165 cipher.start(nonce, nonce_len);
166 return BOTAN_FFI_SUCCESS;
167 });
168}
Botan::Cipher_Mode
Definition cipher_mode.h:37
Botan::Cipher_Mode::start
void start(std::span< const uint8_t > nonce)
Definition cipher_mode.h:98

References BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), and Botan::Cipher_Mode::start().

◆ botan_cipher_update()

int botan_cipher_update ( botan_cipher_t cipher,
uint32_t flags,
uint8_t output[],
size_t output_size,
size_t * output_written,
const uint8_t input_bytes[],
size_t input_size,
size_t * input_consumed )

Encrypt/Decrypt some data and/or finalize the encryption/decryption.

This encrypts as many bytes from input_bytes into output_bytes as possible. Unless BOTAN_CIPHER_UPDATE_FLAG_FINAL is set, this function will consume bytes in multiples of botan_cipher_get_update_granularity(). input_consumed and output_written will be set accordingly and it is the caller's responsibility to adapt their buffers accordingly before calling this function again. Note that, unless BOTAN_CIPHER_UPDATE_FLAG_FINAL is set, the cipher will at most generate input_size output bytes.

Eventually, the caller must set the BOTAN_CIPHER_UPDATE_FLAG_FINAL flag to indicate that no more input will be provided. This will cause the cipher to consume all given input bytes and produce the final output; or return a BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE error if the given output buffer was too small. In the latter case, output_written will be set to the required buffer size. Calling again with BOTAN_CIPHER_UPDATE_FLAG_FINAL, a big enough buffer and no further input will then produce the final output.

Note that some ciphers require the entire message to be provided before any output is produced.

See also
botan_cipher_requires_entire_message().

Definition at line 170 of file ffi_cipher.cpp.

177 {
178 return ffi_guard_thunk(__func__, [=]() -> int {
179 using namespace Botan;
180 Cipher_Mode& cipher = safe_get(cipher_obj);
181 secure_vector<uint8_t>& mbuf = cipher_obj->buf();
182
183 // If the cipher object's internal buffer contains residual data from
184 // a previous invocation, we can be sure that botan_cipher_update() was
185 // called with the final flag set but not enough buffer space was provided
186 // to accommodate the final output.
187 const bool was_finished_before = !mbuf.empty();
188 const bool final_input = (flags & BOTAN_CIPHER_UPDATE_FLAG_FINAL);
189
190 // Bring the output variables into a defined state.
191 *output_written = 0;
192 *input_consumed = 0;
193
194 // Once the final flag was set once, it must always be set for
195 // consecutive invocations.
196 if(was_finished_before && !final_input) {
197 return BOTAN_FFI_ERROR_INVALID_OBJECT_STATE;
198 }
199
200 // If the final flag was set in a previous invocation, no more input
201 // data can be processed.
202 if(was_finished_before && input_size > 0) {
203 return BOTAN_FFI_ERROR_BAD_PARAMETER;
204 }
205
206 // Make sure that we always clear the internal buffer before returning
207 // or aborting this invocation due to an exception.
208 auto clean_buffer = scoped_cleanup([&mbuf] { mbuf.clear(); });
209
210 if(final_input) {
211 // If the final flag is set for the first time, we need to process the
212 // remaining input data and then finalize the cipher object.
213 if(!was_finished_before) {
214 *input_consumed = input_size;
215 mbuf.resize(input_size);
216 copy_mem(mbuf, std::span(input, input_size));
217
218 try {
219 cipher.finish(mbuf);
220 } catch(Invalid_Authentication_Tag&) {
221 return BOTAN_FFI_ERROR_BAD_MAC;
222 }
223 }
224
225 // At this point, the cipher object is finalized (potentially in a
226 // previous invocation) and we can copy the final output to the caller.
227 *output_written = mbuf.size();
228
229 // Not enough space to copy the final output out to the caller.
230 // Inform them how much space we need for a successful operation.
231 if(output_size < mbuf.size()) {
232 // This is the only place where mbuf is not cleared before returning.
233 clean_buffer.disengage();
234 return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
235 }
236
237 // Copy the final output to the caller, mbuf is cleared afterwards.
238 copy_mem(std::span(output, mbuf.size()), mbuf);
239 } else {
240 // Process data in a streamed fashion without finalizing. No data is
241 // ever retained in the cipher object's internal buffer. If we run out
242 // of either input data or output capacity, we stop and report that not
243 // all bytes were processed via *output_written and *input_consumed.
244
245 BufferSlicer in({input, input_size});
246 BufferStuffer out({output, output_size});
247
248 // Helper function to do blockwise processing of data.
249 auto blockwise_update = [&](const size_t granularity) {
250 if(granularity == 0) {
251 return;
252 }
253
254 const size_t expected_output_per_iteration = cipher.requires_entire_message() ? 0 : granularity;
255 mbuf.resize(granularity);
256
257 while(in.remaining() >= granularity && out.remaining_capacity() >= expected_output_per_iteration) {
258 copy_mem(mbuf, in.take(granularity));
259 const auto written_bytes = cipher.process(mbuf);
260 BOTAN_DEBUG_ASSERT(written_bytes == expected_output_per_iteration);
261 if(written_bytes > 0) {
262 BOTAN_ASSERT_NOMSG(written_bytes <= granularity);
263 copy_mem(out.next(written_bytes), std::span(mbuf).first(written_bytes));
264 }
265 }
266 };
267
268 // First, process as much data as possible in chunks of ideal granularity
269 blockwise_update(cipher_obj->ideal_update_size());
270
271 // Then process the remaining bytes in chunks of update_size() or, in one go
272 // if update_size() is equal to 1 --> i.e. likely a stream cipher.
273 const bool is_stream_cipher = (cipher_obj->update_size() == 1);
274 const size_t tail_granularity =
275 is_stream_cipher ? std::min(in.remaining(), out.remaining_capacity()) : cipher_obj->update_size();
276 BOTAN_DEBUG_ASSERT(tail_granularity < cipher_obj->ideal_update_size());
277 blockwise_update(tail_granularity);
278
279 // Inform the caller about the amount of data processed.
280 *output_written = output_size - out.remaining_capacity();
281 *input_consumed = input_size - in.remaining();
282 }
283
284 return BOTAN_FFI_SUCCESS;
285 });
286}
BOTAN_ASSERT_NOMSG
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:61
BOTAN_DEBUG_ASSERT
#define BOTAN_DEBUG_ASSERT(expr)
Definition assert.h:100
Botan::BufferStuffer
Helper class to ease in-place marshalling of concatenated fixed-length values.
Definition stl_util.h:143
Botan::Cipher_Mode::finish
void finish(secure_vector< uint8_t > &final_block, size_t offset=0)
Definition cipher_mode.h:179
Botan::Cipher_Mode::requires_entire_message
virtual bool requires_entire_message() const
Definition cipher_mode.h:233
Botan::Cipher_Mode::process
size_t process(std::span< uint8_t > msg)
Definition cipher_mode.h:132
Botan::Invalid_Authentication_Tag
Definition exceptn.h:273
Botan::scoped_cleanup
Helper class to create a RAII-style cleanup callback.
Definition stl_util.h:355
BOTAN_CIPHER_UPDATE_FLAG_FINAL
#define BOTAN_CIPHER_UPDATE_FLAG_FINAL
Definition ffi.h:652
Botan::secure_vector
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:65
Botan::copy_mem
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition mem_ops.h:149

References BOTAN_ASSERT_NOMSG, BOTAN_CIPHER_UPDATE_FLAG_FINAL, BOTAN_DEBUG_ASSERT, BOTAN_FFI_ERROR_BAD_MAC, BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_ERROR_INVALID_OBJECT_STATE, BOTAN_FFI_SUCCESS, Botan::copy_mem(), Botan_FFI::ffi_guard_thunk(), Botan::Cipher_Mode::finish(), Botan::Cipher_Mode::process(), Botan::Cipher_Mode::requires_entire_message(), and Botan_FFI::safe_get().

◆ botan_cipher_valid_nonce_length()

int botan_cipher_valid_nonce_length ( botan_cipher_t cipher,
size_t nl )

Return if the specified nonce length is valid for this cipher

Definition at line 298 of file ffi_cipher.cpp.

298 {
299 return BOTAN_FFI_VISIT(cipher, [=](const auto& c) { return c.valid_nonce_length(nl) ? 1 : 0; });
300}

References BOTAN_FFI_VISIT.

◆ botan_constant_time_compare()

int botan_constant_time_compare ( const uint8_t * x,
const uint8_t * y,
size_t len )

Returns 0 if x[0..len] == y[0..len], or otherwise -1

Definition at line 302 of file ffi.cpp.

302 {
303 auto same = Botan::CT::is_equal(x, y, len);
304 // Return 0 if same or -1 otherwise
305 return static_cast<int>(same.select(1, 0)) - 1;
306}
Botan::CT::is_equal
constexpr CT::Mask< T > is_equal(const T x[], const T y[], size_t len)
Definition ct_utils.h:789

References Botan::CT::is_equal().

Referenced by botan_same_mem().

◆ botan_ec_group_destroy()

int botan_ec_group_destroy ( botan_ec_group_t ec_group)
Returns
negative number on error, or zero on success

Definition at line 20 of file ffi_ec.cpp.

20 {
21 return BOTAN_FFI_CHECKED_DELETE(ec_group);
22}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_ec_group_equal()

int botan_ec_group_equal ( botan_ec_group_t curve1,
botan_ec_group_t curve2 )
Returns
0 if curve1 != curve2
1 if curve1 == curve2
negative number on error

Definition at line 198 of file ffi_ec.cpp.

198 {
199 return BOTAN_FFI_VISIT(curve1_w, [=](const auto& curve1) -> int { return curve1 == safe_get(curve2_w); });
200}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_ec_group_from_ber()

int botan_ec_group_from_ber ( botan_ec_group_t * ec_group,
const uint8_t * ber,
size_t ber_len )

Decode a BER encoded ECC domain parameter set

Parameters
ec_groupthe new object will be placed here
berencoding
ber_lensize of the encoding in bytes
Returns
negative number on error, or zero on success

Definition at line 73 of file ffi_ec.cpp.

73 {
74 return ffi_guard_thunk(__func__, [=]() -> int {
75 if(ec_group == nullptr || ber == nullptr) {
76 return BOTAN_FFI_ERROR_NULL_POINTER;
77 }
78
79 Botan::EC_Group group(ber, ber_len);
80
81 auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
82 *ec_group = new botan_ec_group_struct(std::move(group_ptr));
83
84 return BOTAN_FFI_SUCCESS;
85 });
86}
Botan::EC_Group
Definition ec_group.h:87

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and Botan_FFI::ffi_guard_thunk().

◆ botan_ec_group_from_name()

int botan_ec_group_from_name ( botan_ec_group_t * ec_group,
const char * name )

Initialize an EC Group from a common group name (eg "secp256r1")

Parameters
ec_groupthe new object will be placed here
namea known group name
Returns
negative number on error, or zero on success

Definition at line 118 of file ffi_ec.cpp.

118 {
119 return ffi_guard_thunk(__func__, [=]() -> int {
120 if(ec_group == nullptr || name == nullptr) {
121 return BOTAN_FFI_ERROR_NULL_POINTER;
122 }
123
124 Botan::EC_Group group = Botan::EC_Group::from_name(name);
125
126 auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
127 *ec_group = new botan_ec_group_struct(std::move(group_ptr));
128
129 return BOTAN_FFI_SUCCESS;
130 });
131}
Botan::EC_Group::from_name
static EC_Group from_name(std::string_view name)
Definition ec_group.cpp:371

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan::EC_Group::from_name().

◆ botan_ec_group_from_oid()

int botan_ec_group_from_oid ( botan_ec_group_t * ec_group,
botan_asn1_oid_t oid )

Initialize an EC Group from a group named by an object identifier

Parameters
ec_groupthe new object will be placed here
oida known OID
Returns
negative number on error, or zero on success

Definition at line 103 of file ffi_ec.cpp.

103 {
104 return ffi_guard_thunk(__func__, [=]() -> int {
105 if(ec_group == nullptr) {
106 return BOTAN_FFI_ERROR_NULL_POINTER;
107 }
108
109 Botan::EC_Group group = Botan::EC_Group::from_OID(safe_get(oid));
110
111 auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
112 *ec_group = new botan_ec_group_struct(std::move(group_ptr));
113
114 return BOTAN_FFI_SUCCESS;
115 });
116}
Botan::EC_Group::from_OID
static EC_Group from_OID(const OID &oid)
Definition ec_group.cpp:360

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), Botan::EC_Group::from_OID(), and Botan_FFI::safe_get().

◆ botan_ec_group_from_params()

int botan_ec_group_from_params ( botan_ec_group_t * ec_group,
botan_asn1_oid_t oid,
botan_mp_t p,
botan_mp_t a,
botan_mp_t b,
botan_mp_t base_x,
botan_mp_t base_y,
botan_mp_t order )

Create a new EC Group from parameters

Warning
use only elliptic curve parameters that you trust
Parameters
ec_groupthe new object will be placed here
pthe elliptic curve prime (at most 521 bits)
athe elliptic curve a param
bthe elliptic curve b param
base_xthe x coordinate of the group generator
base_ythe y coordinate of the group generator
orderthe order of the group
Returns
negative number on error, or zero on success

Definition at line 50 of file ffi_ec.cpp.

57 {
58 return ffi_guard_thunk(__func__, [=]() -> int {
59 if(ec_group == nullptr) {
60 return BOTAN_FFI_ERROR_NULL_POINTER;
61 }
62
63 Botan::EC_Group group(
64 safe_get(oid), safe_get(p), safe_get(a), safe_get(b), safe_get(base_x), safe_get(base_y), safe_get(order));
65
66 auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
67 *ec_group = new botan_ec_group_struct(std::move(group_ptr));
68
69 return BOTAN_FFI_SUCCESS;
70 });
71}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_ec_group_from_pem()

int botan_ec_group_from_pem ( botan_ec_group_t * ec_group,
const char * pem )

Initialize an EC Group from the PEM/ASN.1 encoding

Parameters
ec_groupthe new object will be placed here
pemencoding
Returns
negative number on error, or zero on success

Definition at line 88 of file ffi_ec.cpp.

88 {
89 return ffi_guard_thunk(__func__, [=]() -> int {
90 if(ec_group == nullptr || pem == nullptr) {
91 return BOTAN_FFI_ERROR_NULL_POINTER;
92 }
93
94 Botan::EC_Group group = Botan::EC_Group::from_PEM(pem);
95
96 auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
97 *ec_group = new botan_ec_group_struct(std::move(group_ptr));
98
99 return BOTAN_FFI_SUCCESS;
100 });
101}
Botan::EC_Group::from_PEM
static EC_Group from_PEM(std::string_view pem)
Definition ec_group.cpp:414

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan::EC_Group::from_PEM().

◆ botan_ec_group_get_a()

int botan_ec_group_get_a ( botan_mp_t * a,
botan_ec_group_t ec_group )

Get the a parameter of the elliptic curve equation

Definition at line 175 of file ffi_ec.cpp.

175 {
176 return botan_ec_group_get_component(a, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_a(); });
177}

◆ botan_ec_group_get_b()

int botan_ec_group_get_b ( botan_mp_t * b,
botan_ec_group_t ec_group )

Get the b parameter of the elliptic curve equation

Definition at line 179 of file ffi_ec.cpp.

179 {
180 return botan_ec_group_get_component(b, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_b(); });
181}

◆ botan_ec_group_get_curve_oid()

int botan_ec_group_get_curve_oid ( botan_asn1_oid_t * oid,
botan_ec_group_t ec_group )

Get the curve OID of an EC Group

Definition at line 144 of file ffi_ec.cpp.

144 {
145 return BOTAN_FFI_VISIT(ec_group, [=](const auto& g) -> int {
146 if(oid == nullptr) {
147 return BOTAN_FFI_ERROR_NULL_POINTER;
148 }
149 auto oid_ptr = std::make_unique<Botan::OID>(g.get_curve_oid());
150 *oid = new botan_asn1_oid_struct(std::move(oid_ptr));
151
152 return BOTAN_FFI_SUCCESS;
153 });
154}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_ec_group_get_g_x()

int botan_ec_group_get_g_x ( botan_mp_t * g_x,
botan_ec_group_t ec_group )

Get the x coordinate of the base point

Definition at line 183 of file ffi_ec.cpp.

183 {
184 return botan_ec_group_get_component(
185 g_x, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_g_x(); });
186}

◆ botan_ec_group_get_g_y()

int botan_ec_group_get_g_y ( botan_mp_t * g_y,
botan_ec_group_t ec_group )

Get the y coordinate of the base point

Definition at line 188 of file ffi_ec.cpp.

188 {
189 return botan_ec_group_get_component(
190 g_y, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_g_y(); });
191}

◆ botan_ec_group_get_order()

int botan_ec_group_get_order ( botan_mp_t * order,
botan_ec_group_t ec_group )

Get the order of the base point

Definition at line 193 of file ffi_ec.cpp.

193 {
194 return botan_ec_group_get_component(
195 order, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_order(); });
196}

◆ botan_ec_group_get_p()

int botan_ec_group_get_p ( botan_mp_t * p,
botan_ec_group_t ec_group )

Get the prime modulus of the field

Definition at line 171 of file ffi_ec.cpp.

171 {
172 return botan_ec_group_get_component(p, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_p(); });
173}

◆ botan_ec_group_supports_application_specific_group()

int botan_ec_group_supports_application_specific_group ( int * out)

Checks if in this build configuration it is possible to register an application specific elliptic curve and sets

Parameters
outto 1 if so, 0 otherwise
Returns
0 on success, a negative value on failure

Definition at line 24 of file ffi_ec.cpp.

24 {
25 if(out == nullptr) {
26 return BOTAN_FFI_ERROR_NULL_POINTER;
27 }
28 if(Botan::EC_Group::supports_application_specific_group()) {
29 *out = 1;
30 } else {
31 *out = 0;
32 }
33 return BOTAN_FFI_SUCCESS;
34}
Botan::EC_Group::supports_application_specific_group
static bool supports_application_specific_group()
Definition ec_group.cpp:351

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and Botan::EC_Group::supports_application_specific_group().

◆ botan_ec_group_supports_named_group()

int botan_ec_group_supports_named_group ( const char * name,
int * out )

Checks if in this build configuration botan_ec_group_from_name(group_ptr, name) will succeed and sets

Parameters
outto 1 if so, 0 otherwise.
Returns
negative number on error, or zero on success

Definition at line 36 of file ffi_ec.cpp.

36 {
37 return ffi_guard_thunk(__func__, [=]() -> int {
38 if(name == nullptr || out == nullptr) {
39 return BOTAN_FFI_ERROR_NULL_POINTER;
40 }
41 if(Botan::EC_Group::supports_named_group(name)) {
42 *out = 1;
43 } else {
44 *out = 0;
45 }
46 return BOTAN_FFI_SUCCESS;
47 });
48}
Botan::EC_Group::supports_named_group
static bool supports_named_group(std::string_view name)
Definition ec_group.cpp:346

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan::EC_Group::supports_named_group().

◆ botan_ec_group_view_der()

int botan_ec_group_view_der ( botan_ec_group_t ec_group,
botan_view_ctx ctx,
botan_view_bin_fn view )

View an EC Group in DER encoding

Definition at line 133 of file ffi_ec.cpp.

133 {
134 return BOTAN_FFI_VISIT(ec_group,
135 [=](const auto& g) -> int { return invoke_view_callback(view, ctx, g.DER_encode()); });
136}
Botan_FFI::invoke_view_callback
int invoke_view_callback(botan_view_bin_fn view, botan_view_ctx ctx, std::span< const uint8_t > buf)
Definition ffi_util.h:166

References BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

◆ botan_ec_group_view_pem()

int botan_ec_group_view_pem ( botan_ec_group_t ec_group,
botan_view_ctx ctx,
botan_view_str_fn view )

View an EC Group in PEM encoding

Definition at line 138 of file ffi_ec.cpp.

138 {
139 return BOTAN_FFI_VISIT(ec_group, [=](const auto& g) -> int {
140 return invoke_view_callback(view, ctx, g.PEM_encode(Botan::EC_Group_Encoding::NamedCurve));
141 });
142}

References BOTAN_FFI_VISIT, Botan_FFI::invoke_view_callback(), and Botan::NamedCurve.

◆ botan_ec_privkey_create()

int botan_ec_privkey_create ( botan_privkey_t * key,
const char * algo_name,
botan_ec_group_t ec_group,
botan_rng_t rng )

Create a new ec private key

Parameters
keythe new object will be placed here
algo_namesomething like "ECDSA" or "ECDH"
ec_groupa (possibly application specific) elliptic curve
rnga random number generator

Definition at line 56 of file ffi_pkey.cpp.

59 {
60 return ffi_guard_thunk(__func__, [=]() -> int {
61 if(key_obj == nullptr) {
62 return BOTAN_FFI_ERROR_NULL_POINTER;
63 }
64 *key_obj = nullptr;
65
66 Botan::EC_Group ec_group = safe_get(ec_group_obj);
67 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
68 std::unique_ptr<Botan::Private_Key> key(
69 Botan::create_ec_private_key(algo_name ? algo_name : "ECDSA", ec_group, rng));
70
71 if(key) {
72 *key_obj = new botan_privkey_struct(std::move(key));
73 return BOTAN_FFI_SUCCESS;
74 } else {
75 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
76 }
77 });
78}
Botan::create_ec_private_key
std::unique_ptr< Private_Key > create_ec_private_key(std::string_view alg_name, const EC_Group &ec_group, RandomNumberGenerator &rng)
Definition pk_algs.cpp:442

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::create_ec_private_key(), Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_error_description()

const char * botan_error_description ( int err)

Convert an error code into a string. Returns "Unknown error" if the error code is not a known one.

Definition at line 142 of file ffi.cpp.

142 {
143 switch(err) {
144 case BOTAN_FFI_SUCCESS:
145 return "OK";
146
147 case BOTAN_FFI_INVALID_VERIFIER:
148 return "Invalid verifier";
149
150 case BOTAN_FFI_ERROR_INVALID_INPUT:
151 return "Invalid input";
152
153 case BOTAN_FFI_ERROR_BAD_MAC:
154 return "Invalid authentication code";
155
156 case BOTAN_FFI_ERROR_NO_VALUE:
157 return "No value available";
158
159 case BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE:
160 return "Insufficient buffer space";
161
162 case BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR:
163 return "String conversion error";
164
165 case BOTAN_FFI_ERROR_EXCEPTION_THROWN:
166 return "Exception thrown";
167
168 case BOTAN_FFI_ERROR_OUT_OF_MEMORY:
169 return "Out of memory";
170
171 case BOTAN_FFI_ERROR_SYSTEM_ERROR:
172 return "Error while calling system API";
173
174 case BOTAN_FFI_ERROR_INTERNAL_ERROR:
175 return "Internal error";
176
177 case BOTAN_FFI_ERROR_BAD_FLAG:
178 return "Bad flag";
179
180 case BOTAN_FFI_ERROR_NULL_POINTER:
181 return "Null pointer argument";
182
183 case BOTAN_FFI_ERROR_BAD_PARAMETER:
184 return "Bad parameter";
185
186 case BOTAN_FFI_ERROR_KEY_NOT_SET:
187 return "Key not set on object";
188
189 case BOTAN_FFI_ERROR_INVALID_KEY_LENGTH:
190 return "Invalid key length";
191
192 case BOTAN_FFI_ERROR_INVALID_OBJECT_STATE:
193 return "Invalid object state";
194
195 case BOTAN_FFI_ERROR_NOT_IMPLEMENTED:
196 return "Not implemented";
197
198 case BOTAN_FFI_ERROR_INVALID_OBJECT:
199 return "Invalid object handle";
200
201 case BOTAN_FFI_ERROR_TLS_ERROR:
202 return "TLS error";
203
204 case BOTAN_FFI_ERROR_HTTP_ERROR:
205 return "HTTP error";
206
207 case BOTAN_FFI_ERROR_UNKNOWN_ERROR:
208 return "Unknown error";
209
210 default:
211 return "Unknown error";
212 }
213}

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_BAD_MAC, BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_EXCEPTION_THROWN, BOTAN_FFI_ERROR_HTTP_ERROR, BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_ERROR_INTERNAL_ERROR, BOTAN_FFI_ERROR_INVALID_INPUT, BOTAN_FFI_ERROR_INVALID_KEY_LENGTH, BOTAN_FFI_ERROR_INVALID_OBJECT, BOTAN_FFI_ERROR_INVALID_OBJECT_STATE, BOTAN_FFI_ERROR_KEY_NOT_SET, BOTAN_FFI_ERROR_NO_VALUE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_ERROR_OUT_OF_MEMORY, BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR, BOTAN_FFI_ERROR_SYSTEM_ERROR, BOTAN_FFI_ERROR_TLS_ERROR, BOTAN_FFI_ERROR_UNKNOWN_ERROR, BOTAN_FFI_INVALID_VERIFIER, and BOTAN_FFI_SUCCESS.

◆ botan_error_last_exception_message()

const char * botan_error_last_exception_message ( void )

Return the message of the last exception caught in this thread.

This pointer can/will be reallocated or overwritten the next time this thread calls any other Botan FFI function and must be copied to persistent storage first.

Definition at line 138 of file ffi.cpp.

138 {
139 return g_last_exception_what.c_str();
140}

◆ botan_ffi_api_version()

uint32_t botan_ffi_api_version ( void )

Return the version of the currently supported FFI API. This is expressed in the form YYYYMMDD of the release date of this version of the API.

Definition at line 218 of file ffi.cpp.

218 {
219 return BOTAN_HAS_FFI;
220}
BOTAN_HAS_FFI
#define BOTAN_HAS_FFI
Definition build.h:211

References BOTAN_HAS_FFI.

◆ botan_ffi_supports_api()

int botan_ffi_supports_api ( uint32_t api_version)

Return 0 (ok) if the version given is one this library supports. botan_ffi_supports_api(botan_ffi_api_version()) will always return 0.

Definition at line 222 of file ffi.cpp.

222 {
223 // This is the API introduced in 3.8
224 if(api_version == 20250506) {
225 return BOTAN_FFI_SUCCESS;
226 }
227
228 // This is the API introduced in 3.4
229 if(api_version == 20240408) {
230 return BOTAN_FFI_SUCCESS;
231 }
232
233 // This is the API introduced in 3.2
234 if(api_version == 20231009) {
235 return BOTAN_FFI_SUCCESS;
236 }
237
238 // This is the API introduced in 3.1
239 if(api_version == 20230711) {
240 return BOTAN_FFI_SUCCESS;
241 }
242
243 // This is the API introduced in 3.0
244 if(api_version == 20230403) {
245 return BOTAN_FFI_SUCCESS;
246 }
247
248 // This is the API introduced in 2.18
249 if(api_version == 20210220) {
250 return BOTAN_FFI_SUCCESS;
251 }
252
253 // This is the API introduced in 2.13
254 if(api_version == 20191214) {
255 return BOTAN_FFI_SUCCESS;
256 }
257
258 // This is the API introduced in 2.8
259 if(api_version == 20180713) {
260 return BOTAN_FFI_SUCCESS;
261 }
262
263 // This is the API introduced in 2.3
264 if(api_version == 20170815) {
265 return BOTAN_FFI_SUCCESS;
266 }
267
268 // This is the API introduced in 2.1
269 if(api_version == 20170327) {
270 return BOTAN_FFI_SUCCESS;
271 }
272
273 // This is the API introduced in 2.0
274 if(api_version == 20150515) {
275 return BOTAN_FFI_SUCCESS;
276 }
277
278 // Something else:
279 return -1;
280}

References BOTAN_FFI_SUCCESS.

◆ botan_fpe_decrypt()

int botan_fpe_decrypt ( botan_fpe_t fpe,
botan_mp_t x,
const uint8_t tweak[],
size_t tweak_len )

Definition at line 78 of file ffi_fpe.cpp.

78 {
79#if defined(BOTAN_HAS_FPE_FE1)
80 return ffi_guard_thunk(__func__, [=]() {
81 Botan::BigInt r = safe_get(fpe).decrypt(safe_get(x), tweak, tweak_len);
82 safe_get(x) = r;
83 return BOTAN_FFI_SUCCESS;
84 });
85
86#else
87 BOTAN_UNUSED(fpe, x, tweak, tweak_len);
88 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
89#endif
90}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_fpe_destroy()

int botan_fpe_destroy ( botan_fpe_t fpe)
Returns
0 if success, error if invalid object handle

Definition at line 56 of file ffi_fpe.cpp.

56 {
57#if defined(BOTAN_HAS_FPE_FE1)
58 return BOTAN_FFI_CHECKED_DELETE(fpe);
59#else
60 BOTAN_UNUSED(fpe);
61 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
62#endif
63}

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_fpe_encrypt()

int botan_fpe_encrypt ( botan_fpe_t fpe,
botan_mp_t x,
const uint8_t tweak[],
size_t tweak_len )

Definition at line 65 of file ffi_fpe.cpp.

65 {
66#if defined(BOTAN_HAS_FPE_FE1)
67 return ffi_guard_thunk(__func__, [=]() {
68 Botan::BigInt r = safe_get(fpe).encrypt(safe_get(x), tweak, tweak_len);
69 safe_get(x) = r;
70 return BOTAN_FFI_SUCCESS;
71 });
72#else
73 BOTAN_UNUSED(fpe, x, tweak, tweak_len);
74 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
75#endif
76}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_fpe_fe1_init()

int botan_fpe_fe1_init ( botan_fpe_t * fpe,
botan_mp_t n,
const uint8_t key[],
size_t key_len,
size_t rounds,
uint32_t flags )

Definition at line 27 of file ffi_fpe.cpp.

28 {
29#if defined(BOTAN_HAS_FPE_FE1)
30 return ffi_guard_thunk(__func__, [=]() {
31 if(fpe == nullptr || key == nullptr) {
32 return BOTAN_FFI_ERROR_NULL_POINTER;
33 }
34
35 *fpe = nullptr;
36
37 if(flags != 0 && flags != BOTAN_FPE_FLAG_FE1_COMPAT_MODE) {
38 return BOTAN_FFI_ERROR_BAD_FLAG;
39 }
40
41 const bool compat_mode = (flags & BOTAN_FPE_FLAG_FE1_COMPAT_MODE);
42
43 std::unique_ptr<Botan::FPE_FE1> fpe_obj(new Botan::FPE_FE1(safe_get(n), rounds, compat_mode));
44
45 fpe_obj->set_key(key, key_len);
46
47 *fpe = new botan_fpe_struct(std::move(fpe_obj));
48 return BOTAN_FFI_SUCCESS;
49 });
50#else
51 BOTAN_UNUSED(fpe, n, key, key_len, rounds, flags);
52 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
53#endif
54}
Botan::FPE_FE1
Definition fpe_fe1.h:25
BOTAN_FPE_FLAG_FE1_COMPAT_MODE
#define BOTAN_FPE_FLAG_FE1_COMPAT_MODE
Definition ffi.h:2352

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_FPE_FLAG_FE1_COMPAT_MODE, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_hash_block_size()

int botan_hash_block_size ( botan_hash_t hash,
size_t * block_size )

Writes the block size of the hash function to *block_size

Parameters
hashhash object
block_sizeoutput buffer to hold the hash function output length
Returns
0 on success, a negative value on failure

Definition at line 48 of file ffi_hash.cpp.

48 {
49 if(out == nullptr) {
50 return BOTAN_FFI_ERROR_NULL_POINTER;
51 }
52 return BOTAN_FFI_VISIT(hash, [=](const auto& h) { *out = h.hash_block_size(); });
53}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_hash_clear()

int botan_hash_clear ( botan_hash_t hash)

Reinitializes the state of the hash computation. A hash can be computed (with update/final) immediately.

Parameters
hashhash object
Returns
0 on success, a negative value on failure

Definition at line 55 of file ffi_hash.cpp.

55 {
56 return BOTAN_FFI_VISIT(hash, [](auto& h) { h.clear(); });
57}

References BOTAN_FFI_VISIT.

◆ botan_hash_copy_state()

int botan_hash_copy_state ( botan_hash_t * dest,
botan_hash_t source )

Copy the state of a hash function object

Parameters
destdestination hash object
sourcesource hash object
Returns
0 on success, a negative value on failure

Definition at line 78 of file ffi_hash.cpp.

78 {
79 return BOTAN_FFI_VISIT(source, [=](const auto& src) { *dest = new botan_hash_struct(src.copy_state()); });
80}

References BOTAN_FFI_VISIT.

◆ botan_hash_destroy()

int botan_hash_destroy ( botan_hash_t hash)

Frees all resources of the hash object

Parameters
hashhash object
Returns
0 if success, error if invalid object handle

Definition at line 37 of file ffi_hash.cpp.

37 {
38 return BOTAN_FFI_CHECKED_DELETE(hash);
39}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_hash_final()

int botan_hash_final ( botan_hash_t hash,
uint8_t out[] )

Finalizes the hash computation and writes the output to out[0:botan_hash_output_length()] then reinitializes for computing another digest as if botan_hash_clear had been called.

Parameters
hashhash object
outoutput buffer
Returns
0 on success, a negative value on failure

Definition at line 71 of file ffi_hash.cpp.

71 {
72 if(out == nullptr) {
73 return BOTAN_FFI_ERROR_NULL_POINTER;
74 }
75 return BOTAN_FFI_VISIT(hash, [=](auto& h) { h.final(out); });
76}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_hash_init()

int botan_hash_init ( botan_hash_t * hash,
const char * hash_name,
uint32_t flags )

Initialize a hash function object

Parameters
hashhash object
hash_namename of the hash function, e.g., "SHA-384"
flagsshould be 0 in current API revision, all other uses are reserved and return BOTAN_FFI_ERROR_BAD_FLAG

Definition at line 18 of file ffi_hash.cpp.

18 {
19 return ffi_guard_thunk(__func__, [=]() -> int {
20 if(hash == nullptr || hash_name == nullptr || *hash_name == 0) {
21 return BOTAN_FFI_ERROR_NULL_POINTER;
22 }
23 if(flags != 0) {
24 return BOTAN_FFI_ERROR_BAD_FLAG;
25 }
26
27 auto h = Botan::HashFunction::create(hash_name);
28 if(h == nullptr) {
29 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
30 }
31
32 *hash = new botan_hash_struct(std::move(h));
33 return BOTAN_FFI_SUCCESS;
34 });
35}
Botan::HashFunction::create
static std::unique_ptr< HashFunction > create(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:107

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::HashFunction::create(), and Botan_FFI::ffi_guard_thunk().

◆ botan_hash_name()

int botan_hash_name ( botan_hash_t hash,
char * name,
size_t * name_len )

Get the name of this hash function

Parameters
hashthe object to read
nameoutput buffer
name_lenon input, the length of buffer, on success the number of bytes written

Definition at line 82 of file ffi_hash.cpp.

82 {
83 if(name_len == nullptr) {
84 return BOTAN_FFI_ERROR_NULL_POINTER;
85 }
86
87 return BOTAN_FFI_VISIT(hash, [=](const auto& h) { return write_str_output(name, name_len, h.name()); });
88}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and Botan_FFI::write_str_output().

◆ botan_hash_output_length()

int botan_hash_output_length ( botan_hash_t hash,
size_t * output_length )

Writes the output length of the hash function to *output_length

Parameters
hashhash object
output_lengthoutput buffer to hold the hash function output length
Returns
0 on success, a negative value on failure

Definition at line 41 of file ffi_hash.cpp.

41 {
42 if(out == nullptr) {
43 return BOTAN_FFI_ERROR_NULL_POINTER;
44 }
45 return BOTAN_FFI_VISIT(hash, [=](const auto& h) { *out = h.output_length(); });
46}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_hash_update()

int botan_hash_update ( botan_hash_t hash,
const uint8_t * in,
size_t in_len )

Send more input to the hash function

Parameters
hashhash object
ininput buffer
in_lennumber of bytes to read from the input buffer
Returns
0 on success, a negative value on failure

Definition at line 59 of file ffi_hash.cpp.

59 {
60 if(len == 0) {
61 return 0;
62 }
63
64 if(buf == nullptr) {
65 return BOTAN_FFI_ERROR_NULL_POINTER;
66 }
67
68 return BOTAN_FFI_VISIT(hash, [=](auto& h) { h.update(buf, len); });
69}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_hex_decode()

int botan_hex_decode ( const char * hex_str,
size_t in_len,
uint8_t * out,
size_t * out_len )

Perform hex decoding

Parameters
hex_stra string of hex chars (whitespace is ignored)
in_lenthe length of hex_str
outthe output buffer should be at least strlen(hex_str)/2 bytes
out_lenthe size of the output buffer on input, set to the number of bytes written
Returns
0 on success, a negative value on failure

Definition at line 325 of file ffi.cpp.

325 {
326 return ffi_guard_thunk(__func__, [=]() -> int {
327 const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
328 return Botan_FFI::write_vec_output(out, out_len, bin);
329 });
330}
Botan_FFI::write_vec_output
int write_vec_output(uint8_t out[], size_t *out_len, std::span< const uint8_t > buf)
Definition ffi_util.h:226
Botan::hex_decode
size_t hex_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool ignore_ws)
Definition hex.cpp:73

References Botan_FFI::ffi_guard_thunk(), Botan::hex_decode(), and Botan_FFI::write_vec_output().

◆ botan_hex_encode()

int botan_hex_encode ( const uint8_t * x,
size_t len,
char * out,
uint32_t flags )

Perform hex encoding

Parameters
xis some binary data
lenlength of x in bytes
outan array of at least x*2 bytes
flagsflags out be upper or lower case?
Returns
0 on success, a negative value on failure

Definition at line 317 of file ffi.cpp.

317 {
318 return ffi_guard_thunk(__func__, [=]() -> int {
319 const bool uppercase = (flags & BOTAN_FFI_HEX_LOWER_CASE) == 0;
320 Botan::hex_encode(out, in, len, uppercase);
321 return BOTAN_FFI_SUCCESS;
322 });
323}
BOTAN_FFI_HEX_LOWER_CASE
#define BOTAN_FFI_HEX_LOWER_CASE
Definition ffi.h:245
Botan::hex_encode
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition hex.cpp:35

References BOTAN_FFI_HEX_LOWER_CASE, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan::hex_encode().

◆ botan_hotp_check()

int botan_hotp_check ( botan_hotp_t hotp,
uint64_t * next_hotp_counter,
uint32_t hotp_code,
uint64_t hotp_counter,
size_t resync_range )

Verify a HOTP code

Definition at line 68 of file ffi_hotp.cpp.

69 {
70#if defined(BOTAN_HAS_HOTP)
71 return BOTAN_FFI_VISIT(hotp, [=](auto& h) {
72 auto resp = h.verify_hotp(hotp_code, hotp_counter, resync_range);
73
74 if(next_hotp_counter) {
75 *next_hotp_counter = resp.second;
76 }
77
78 return (resp.first == true) ? BOTAN_FFI_SUCCESS : BOTAN_FFI_INVALID_VERIFIER;
79 });
80
81#else
82 BOTAN_UNUSED(hotp, next_hotp_counter, hotp_code, hotp_counter, resync_range);
83 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
84#endif
85}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_INVALID_VERIFIER, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

◆ botan_hotp_destroy()

int botan_hotp_destroy ( botan_hotp_t hotp)

Destroy a HOTP instance

Returns
0 if success, error if invalid object handle

Definition at line 45 of file ffi_hotp.cpp.

45 {
46#if defined(BOTAN_HAS_HOTP)
47 return BOTAN_FFI_CHECKED_DELETE(hotp);
48#else
49 BOTAN_UNUSED(hotp);
50 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
51#endif
52}

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_hotp_generate()

int botan_hotp_generate ( botan_hotp_t hotp,
uint32_t * hotp_code,
uint64_t hotp_counter )

Generate a HOTP code for the provided counter

Definition at line 54 of file ffi_hotp.cpp.

54 {
55#if defined(BOTAN_HAS_HOTP)
56 if(hotp == nullptr || hotp_code == nullptr) {
57 return BOTAN_FFI_ERROR_NULL_POINTER;
58 }
59
60 return BOTAN_FFI_VISIT(hotp, [=](auto& h) { *hotp_code = h.generate_hotp(hotp_counter); });
61
62#else
63 BOTAN_UNUSED(hotp, hotp_code, hotp_counter);
64 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
65#endif
66}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

◆ botan_hotp_init()

int botan_hotp_init ( botan_hotp_t * hotp,
const uint8_t key[],
size_t key_len,
const char * hash_algo,
size_t digits )

Initialize a HOTP instance

Definition at line 25 of file ffi_hotp.cpp.

25 {
26 if(hotp == nullptr || key == nullptr || hash_algo == nullptr) {
27 return BOTAN_FFI_ERROR_NULL_POINTER;
28 }
29
30 *hotp = nullptr;
31
32#if defined(BOTAN_HAS_HOTP)
33 return ffi_guard_thunk(__func__, [=]() -> int {
34 auto otp = std::make_unique<Botan::HOTP>(key, key_len, hash_algo, digits);
35 *hotp = new botan_hotp_struct(std::move(otp));
36
37 return BOTAN_FFI_SUCCESS;
38 });
39#else
40 BOTAN_UNUSED(hotp, key, key_len, hash_algo, digits);
41 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
42#endif
43}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_kdf()

int botan_kdf ( const char * kdf_algo,
uint8_t out[],
size_t out_len,
const uint8_t secret[],
size_t secret_len,
const uint8_t salt[],
size_t salt_len,
const uint8_t label[],
size_t label_len )

Derive a key

Parameters
kdf_algoKDF algorithm, e.g., "SP800-56C"
outbuffer holding the derived key, must be of length out_len
out_lenthe desired output length in bytes
secretthe secret input
secret_lensize of secret in bytes
salta diversifier
salt_lensize of salt in bytes
labelpurpose for the derived keying material
label_lensize of label in bytes
Returns
0 on success, a negative value on failure

Definition at line 130 of file ffi_kdf.cpp.

138 {
139 return ffi_guard_thunk(__func__, [=]() -> int {
140 auto kdf = Botan::KDF::create_or_throw(kdf_algo);
141 kdf->kdf(out, out_len, secret, secret_len, salt, salt_len, label, label_len);
142 return BOTAN_FFI_SUCCESS;
143 });
144}
Botan::KDF::create_or_throw
static std::unique_ptr< KDF > create_or_throw(std::string_view algo_spec, std::string_view provider="")
Definition kdf.cpp:203

References BOTAN_FFI_SUCCESS, Botan::KDF::create_or_throw(), and Botan_FFI::ffi_guard_thunk().

◆ botan_key_unwrap3394()

int botan_key_unwrap3394 ( const uint8_t wrapped_key[],
size_t wrapped_key_len,
const uint8_t kek[],
size_t kek_len,
uint8_t key[],
size_t * key_len )

Definition at line 97 of file ffi_keywrap.cpp.

102 {
103 std::string cipher_name = "AES-" + std::to_string(8 * kek_len);
104
105 return botan_nist_kw_dec(cipher_name.c_str(), 0, wrapped_key, wrapped_key_len, kek, kek_len, key, key_len);
106}
botan_nist_kw_dec
int botan_nist_kw_dec(const char *cipher_algo, int padded, const uint8_t wrapped_key[], size_t wrapped_key_len, const uint8_t kek[], size_t kek_len, uint8_t key[], size_t *key_len)
Definition ffi_keywrap.cpp:53

References botan_nist_kw_dec().

◆ botan_key_wrap3394()

int botan_key_wrap3394 ( const uint8_t key[],
size_t key_len,
const uint8_t kek[],
size_t kek_len,
uint8_t wrapped_key[],
size_t * wrapped_key_len )

Key wrapping as per RFC 3394

Definition at line 86 of file ffi_keywrap.cpp.

91 {
92 std::string cipher_name = "AES-" + std::to_string(8 * kek_len);
93
94 return botan_nist_kw_enc(cipher_name.c_str(), 0, key, key_len, kek, kek_len, wrapped_key, wrapped_key_len);
95}
botan_nist_kw_enc
int botan_nist_kw_enc(const char *cipher_algo, int padded, const uint8_t key[], size_t key_len, const uint8_t kek[], size_t kek_len, uint8_t wrapped_key[], size_t *wrapped_key_len)
Definition ffi_keywrap.cpp:21

References botan_nist_kw_enc().

◆ botan_mac_clear()

int botan_mac_clear ( botan_mac_t mac)

Reinitializes the state of the MAC computation. A MAC can be computed (with update/final) immediately.

Parameters
macmac object
Returns
0 on success, a negative value on failure

Definition at line 51 of file ffi_mac.cpp.

51 {
52 return BOTAN_FFI_VISIT(mac, [](auto& m) { m.clear(); });
53}

References BOTAN_FFI_VISIT.

◆ botan_mac_destroy()

int botan_mac_destroy ( botan_mac_t mac)

Frees all resources of the MAC object

Parameters
macmac object
Returns
0 if success, error if invalid object handle

Definition at line 35 of file ffi_mac.cpp.

35 {
36 return BOTAN_FFI_CHECKED_DELETE(mac);
37}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_mac_final()

int botan_mac_final ( botan_mac_t mac,
uint8_t out[] )

Finalizes the MAC computation and writes the output to out[0:botan_mac_output_length()] then reinitializes for computing another MAC as if botan_mac_clear had been called.

Parameters
macmac object
outoutput buffer
Returns
0 on success, a negative value on failure

Definition at line 59 of file ffi_mac.cpp.

59 {
60 return BOTAN_FFI_VISIT(mac, [=](auto& m) { m.final(out); });
61}

References BOTAN_FFI_VISIT.

◆ botan_mac_get_keyspec()

int botan_mac_get_keyspec ( botan_mac_t mac,
size_t * out_minimum_keylength,
size_t * out_maximum_keylength,
size_t * out_keylength_modulo )

Get the key length limits of this auth code

Parameters
macthe object to read
out_minimum_keylengthif non-NULL, will be set to minimum keylength of MAC
out_maximum_keylengthif non-NULL, will be set to maximum keylength of MAC
out_keylength_moduloif non-NULL will be set to byte multiple of valid keys

Definition at line 67 of file ffi_mac.cpp.

70 {
71 return BOTAN_FFI_VISIT(mac, [=](auto& m) {
72 if(out_minimum_keylength) {
73 *out_minimum_keylength = m.minimum_keylength();
74 }
75 if(out_maximum_keylength) {
76 *out_maximum_keylength = m.maximum_keylength();
77 }
78 if(out_keylength_modulo) {
79 *out_keylength_modulo = m.key_spec().keylength_multiple();
80 }
81 });
82}

References BOTAN_FFI_VISIT.

◆ botan_mac_init()

int botan_mac_init ( botan_mac_t * mac,
const char * mac_name,
uint32_t flags )

Initialize a message authentication code object

Parameters
macmac object
mac_namename of the hash function, e.g., "HMAC(SHA-384)"
flagsshould be 0 in current API revision, all other uses are reserved and return a negative value (error code)
Returns
0 on success, a negative value on failure

Definition at line 18 of file ffi_mac.cpp.

18 {
19 return ffi_guard_thunk(__func__, [=]() -> int {
20 if(!mac || !mac_name || flags != 0) {
21 return BOTAN_FFI_ERROR_NULL_POINTER;
22 }
23
24 std::unique_ptr<Botan::MessageAuthenticationCode> m = Botan::MessageAuthenticationCode::create(mac_name);
25
26 if(m == nullptr) {
27 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
28 }
29
30 *mac = new botan_mac_struct(std::move(m));
31 return BOTAN_FFI_SUCCESS;
32 });
33}
Botan::MessageAuthenticationCode::create
static std::unique_ptr< MessageAuthenticationCode > create(std::string_view algo_spec, std::string_view provider="")
Definition mac.cpp:51

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::MessageAuthenticationCode::create(), and Botan_FFI::ffi_guard_thunk().

◆ botan_mac_name()

int botan_mac_name ( botan_mac_t mac,
char * name,
size_t * name_len )

Get the name of this MAC

Parameters
macthe object to read
nameoutput buffer
name_lenon input, the length of buffer, on success the number of bytes written

Definition at line 63 of file ffi_mac.cpp.

63 {
64 return BOTAN_FFI_VISIT(mac, [=](const auto& m) { return write_str_output(name, name_len, m.name()); });
65}

References BOTAN_FFI_VISIT, and Botan_FFI::write_str_output().

◆ botan_mac_output_length()

int botan_mac_output_length ( botan_mac_t mac,
size_t * output_length )

Writes the output length of the message authentication code to *output_length

Parameters
macmac object
output_lengthoutput buffer to hold the MAC output length
Returns
0 on success, a negative value on failure

Definition at line 47 of file ffi_mac.cpp.

47 {
48 return BOTAN_FFI_VISIT(mac, [=](const auto& m) { *out = m.output_length(); });
49}

References BOTAN_FFI_VISIT.

◆ botan_mac_set_key()

int botan_mac_set_key ( botan_mac_t mac,
const uint8_t * key,
size_t key_len )

Sets the key on the MAC

Parameters
macmac object
keybuffer holding the key
key_lensize of the key buffer in bytes
Returns
0 on success, a negative value on failure

Definition at line 39 of file ffi_mac.cpp.

39 {
40 return BOTAN_FFI_VISIT(mac, [=](auto& m) { m.set_key(key, key_len); });
41}

References BOTAN_FFI_VISIT.

◆ botan_mac_set_nonce()

int botan_mac_set_nonce ( botan_mac_t mac,
const uint8_t * nonce,
size_t nonce_len )

Sets the nonce on the MAC

Parameters
macmac object
noncebuffer holding the key
nonce_lensize of the key buffer in bytes
Returns
0 on success, a negative value on failure

Definition at line 43 of file ffi_mac.cpp.

43 {
44 return BOTAN_FFI_VISIT(mac, [=](auto& m) { m.start(nonce, nonce_len); });
45}

References BOTAN_FFI_VISIT.

◆ botan_mac_update()

int botan_mac_update ( botan_mac_t mac,
const uint8_t * buf,
size_t len )

Send more input to the message authentication code

Parameters
macmac object
bufinput buffer
lennumber of bytes to read from the input buffer
Returns
0 on success, a negative value on failure

Definition at line 55 of file ffi_mac.cpp.

55 {
56 return BOTAN_FFI_VISIT(mac, [=](auto& m) { m.update(buf, len); });
57}

References BOTAN_FFI_VISIT.

◆ botan_mceies_decrypt()

int botan_mceies_decrypt ( botan_privkey_t mce_key,
const char * aead,
const uint8_t ct[],
size_t ct_len,
const uint8_t ad[],
size_t ad_len,
uint8_t pt[],
size_t * pt_len )

Definition at line 1400 of file ffi_pkey_algs.cpp.

1407 {
1408 BOTAN_UNUSED(mce_key_obj, aead, ct, ct_len, ad, ad_len, out, out_len);
1409 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1410}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_mceies_encrypt()

int botan_mceies_encrypt ( botan_pubkey_t mce_key,
botan_rng_t rng,
const char * aead,
const uint8_t pt[],
size_t pt_len,
const uint8_t ad[],
size_t ad_len,
uint8_t ct[],
size_t * ct_len )

Definition at line 1412 of file ffi_pkey_algs.cpp.

1420 {
1421 BOTAN_UNUSED(mce_key_obj, rng_obj, aead, pt, pt_len, ad, ad_len, out, out_len);
1422 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1423}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_mp_add()

int botan_mp_add ( botan_mp_t result,
botan_mp_t x,
botan_mp_t y )

Definition at line 119 of file ffi_mp.cpp.

119 {
120 return BOTAN_FFI_VISIT(result, [=](auto& res) {
121 if(result == x) {
122 res += safe_get(y);
123 } else {
124 res = safe_get(x) + safe_get(y);
125 }
126 });
127}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_add_u32()

int botan_mp_add_u32 ( botan_mp_t result,
botan_mp_t x,
uint32_t y )

Definition at line 139 of file ffi_mp.cpp.

139 {
140 return BOTAN_FFI_VISIT(result, [=](auto& res) {
141 if(result == x) {
142 res += static_cast<Botan::word>(y);
143 } else {
144 res = safe_get(x) + static_cast<Botan::word>(y);
145 }
146 });
147}
Botan::word
std::conditional_t< HasNative64BitRegisters, std::uint64_t, uint32_t > word
Definition types.h:119

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_clear()

int botan_mp_clear ( botan_mp_t mp)

Set the MPI to zero

Definition at line 34 of file ffi_mp.cpp.

34 {
35 return BOTAN_FFI_VISIT(mp, [](auto& bn) { bn.clear(); });
36}

References BOTAN_FFI_VISIT.

◆ botan_mp_clear_bit()

int botan_mp_clear_bit ( botan_mp_t n,
size_t bit )

Clear the specified bit

Definition at line 253 of file ffi_mp.cpp.

253 {
254 return BOTAN_FFI_VISIT(mp, [=](auto& n) { n.clear_bit(bit); });
255}

References BOTAN_FFI_VISIT.

◆ botan_mp_cmp()

int botan_mp_cmp ( int * result,
botan_mp_t x,
botan_mp_t y )

Definition at line 193 of file ffi_mp.cpp.

193 {
194 return BOTAN_FFI_VISIT(x_w, [=](auto& x) { *result = x.cmp(safe_get(y_w)); });
195}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_destroy()

int botan_mp_destroy ( botan_mp_t mp)

Destroy (deallocate) an MPI

Returns
0 if success, error if invalid object handle

Definition at line 115 of file ffi_mp.cpp.

115 {
116 return BOTAN_FFI_CHECKED_DELETE(mp);
117}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_mp_div()

int botan_mp_div ( botan_mp_t quotient,
botan_mp_t remainder,
botan_mp_t x,
botan_mp_t y )

Definition at line 169 of file ffi_mp.cpp.

169 {
170 return BOTAN_FFI_VISIT(quotient, [=](auto& q) {
171 Botan::BigInt r;
172 Botan::vartime_divide(safe_get(x), safe_get(y), q, r);
173 safe_get(remainder) = r;
174 });
175}
Botan::vartime_divide
void vartime_divide(const BigInt &x, const BigInt &y_arg, BigInt &q_out, BigInt &r_out)
Definition divide.cpp:230

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), and Botan::vartime_divide().

◆ botan_mp_equal()

int botan_mp_equal ( botan_mp_t x,
botan_mp_t y )

Definition at line 177 of file ffi_mp.cpp.

177 {
178 return BOTAN_FFI_VISIT(x_w, [=](const auto& x) -> int { return x == safe_get(y_w); });
179}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_flip_sign()

int botan_mp_flip_sign ( botan_mp_t mp)

Definition at line 77 of file ffi_mp.cpp.

77 {
78 return BOTAN_FFI_VISIT(mp, [](auto& bn) { bn.flip_sign(); });
79}

References BOTAN_FFI_VISIT.

◆ botan_mp_from_bin()

int botan_mp_from_bin ( botan_mp_t mp,
const uint8_t vec[],
size_t vec_len )

Definition at line 81 of file ffi_mp.cpp.

81 {
82 return BOTAN_FFI_VISIT(mp, [=](auto& bn) { bn._assign_from_bytes({bin, bin_len}); });
83}

References BOTAN_FFI_VISIT.

◆ botan_mp_gcd()

int botan_mp_gcd ( botan_mp_t out,
botan_mp_t x,
botan_mp_t y )

Definition at line 237 of file ffi_mp.cpp.

237 {
238 return BOTAN_FFI_VISIT(out, [=](auto& o) { o = Botan::gcd(safe_get(x), safe_get(y)); });
239}
Botan::gcd
BigInt gcd(const BigInt &a, const BigInt &b)
Definition numthry.cpp:193

References BOTAN_FFI_VISIT, Botan::gcd(), and Botan_FFI::safe_get().

◆ botan_mp_get_bit()

int botan_mp_get_bit ( botan_mp_t n,
size_t bit )

Returns 0 if specified bit of n is not set Returns 1 if specified bit of n is set Returns negative number on error

Definition at line 245 of file ffi_mp.cpp.

245 {
246 return BOTAN_FFI_VISIT(mp, [=](const auto& n) -> int { return n.get_bit(bit); });
247}

References BOTAN_FFI_VISIT.

◆ botan_mp_init()

int botan_mp_init ( botan_mp_t * mp)

Initialize an MPI

Definition at line 22 of file ffi_mp.cpp.

22 {
23 return ffi_guard_thunk(__func__, [=]() -> int {
24 if(mp_out == nullptr) {
25 return BOTAN_FFI_ERROR_NULL_POINTER;
26 }
27
28 auto mp = std::make_unique<Botan::BigInt>();
29 *mp_out = new botan_mp_struct(std::move(mp));
30 return BOTAN_FFI_SUCCESS;
31 });
32}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and Botan_FFI::ffi_guard_thunk().

◆ botan_mp_is_even()

int botan_mp_is_even ( botan_mp_t mp)

Definition at line 189 of file ffi_mp.cpp.

189 {
190 return BOTAN_FFI_VISIT(mp, [](const auto& bn) -> int { return bn.is_even(); });
191}

References BOTAN_FFI_VISIT.

◆ botan_mp_is_negative()

int botan_mp_is_negative ( botan_mp_t mp)

Return 1 iff mp is less than 0

Definition at line 69 of file ffi_mp.cpp.

69 {
70 return BOTAN_FFI_VISIT(mp, [](const auto& bn) { return bn.is_negative() ? 1 : 0; });
71}

References BOTAN_FFI_VISIT.

◆ botan_mp_is_odd()

int botan_mp_is_odd ( botan_mp_t mp)

Definition at line 185 of file ffi_mp.cpp.

185 {
186 return BOTAN_FFI_VISIT(mp, [](const auto& bn) -> int { return bn.is_odd(); });
187}

References BOTAN_FFI_VISIT.

◆ botan_mp_is_positive()

int botan_mp_is_positive ( botan_mp_t mp)

This function should have been named mp_is_non_negative. Returns 1 iff mp is greater than or equal to zero. Use botan_mp_is_negative to detect negative numbers, botan_mp_is_zero to check for zero.

Definition at line 73 of file ffi_mp.cpp.

73 {
74 return BOTAN_FFI_VISIT(mp, [](const auto& bn) { return bn.is_positive() ? 1 : 0; });
75}

References BOTAN_FFI_VISIT.

◆ botan_mp_is_prime()

int botan_mp_is_prime ( botan_mp_t n,
botan_rng_t rng,
size_t test_prob )

Returns 0 if n is not prime Returns 1 if n is prime Returns negative number on error

Definition at line 241 of file ffi_mp.cpp.

241 {
242 return BOTAN_FFI_VISIT(mp, [=](const auto& n) { return (Botan::is_prime(n, safe_get(rng), test_prob)) ? 1 : 0; });
243}
Botan::is_prime
bool is_prime(const BigInt &n, RandomNumberGenerator &rng, size_t prob, bool is_random)
Definition numthry.cpp:355

References BOTAN_FFI_VISIT, Botan::is_prime(), and Botan_FFI::safe_get().

◆ botan_mp_is_zero()

int botan_mp_is_zero ( botan_mp_t mp)

Definition at line 181 of file ffi_mp.cpp.

181 {
182 return BOTAN_FFI_VISIT(mp, [](const auto& bn) -> int { return bn.is_zero(); });
183}

References BOTAN_FFI_VISIT.

◆ botan_mp_lshift()

int botan_mp_lshift ( botan_mp_t out,
botan_mp_t in,
size_t shift )

Definition at line 207 of file ffi_mp.cpp.

207 {
208 return BOTAN_FFI_VISIT(out, [=](auto& o) { o = safe_get(in) << shift; });
209}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_mod_inverse()

int botan_mp_mod_inverse ( botan_mp_t out,
botan_mp_t in,
botan_mp_t modulus )

Definition at line 215 of file ffi_mp.cpp.

215 {
216 return BOTAN_FFI_VISIT(out, [=](auto& o) {
217 o = Botan::inverse_mod_general(safe_get(in), safe_get(modulus)).value_or(Botan::BigInt::zero());
218 });
219}
Botan::BigInt::zero
static BigInt zero()
Definition bigint.h:49
Botan::inverse_mod_general
std::optional< BigInt > inverse_mod_general(const BigInt &x, const BigInt &mod)
Definition mod_inv.cpp:177

References BOTAN_FFI_VISIT, Botan::inverse_mod_general(), Botan_FFI::safe_get(), and Botan::BigInt::zero().

◆ botan_mp_mod_mul()

int botan_mp_mod_mul ( botan_mp_t result,
botan_mp_t x,
botan_mp_t y,
botan_mp_t mod )

Definition at line 221 of file ffi_mp.cpp.

221 {
222 return BOTAN_FFI_VISIT(out, [=](auto& o) {
223 auto reducer = Botan::Barrett_Reduction::for_secret_modulus(safe_get(modulus));
224 o = reducer.multiply(safe_get(x), safe_get(y));
225 });
226}
Botan::Barrett_Reduction::for_secret_modulus
static Barrett_Reduction for_secret_modulus(const BigInt &m)
Definition barrett.cpp:22

References BOTAN_FFI_VISIT, Botan::Barrett_Reduction::for_secret_modulus(), and Botan_FFI::safe_get().

◆ botan_mp_mul()

int botan_mp_mul ( botan_mp_t result,
botan_mp_t x,
botan_mp_t y )

Definition at line 159 of file ffi_mp.cpp.

159 {
160 return BOTAN_FFI_VISIT(result, [=](auto& res) {
161 if(result == x) {
162 res *= safe_get(y);
163 } else {
164 res = safe_get(x) * safe_get(y);
165 }
166 });
167}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_num_bits()

int botan_mp_num_bits ( botan_mp_t n,
size_t * bits )

Return the number of significant bits in the MPI

Definition at line 257 of file ffi_mp.cpp.

257 {
258 return BOTAN_FFI_VISIT(mp, [=](const auto& n) { *bits = n.bits(); });
259}

References BOTAN_FFI_VISIT.

◆ botan_mp_num_bytes()

int botan_mp_num_bytes ( botan_mp_t n,
size_t * bytes )

Return the number of significant bytes in the MPI

Definition at line 261 of file ffi_mp.cpp.

261 {
262 return BOTAN_FFI_VISIT(mp, [=](const auto& n) { *bytes = n.bytes(); });
263}

References BOTAN_FFI_VISIT.

◆ botan_mp_powmod()

int botan_mp_powmod ( botan_mp_t out,
botan_mp_t base,
botan_mp_t exponent,
botan_mp_t modulus )

Definition at line 202 of file ffi_mp.cpp.

202 {
203 return BOTAN_FFI_VISIT(
204 out, [=](auto& o) { o = Botan::power_mod(safe_get(base), safe_get(exponent), safe_get(modulus)); });
205}
Botan::power_mod
BigInt power_mod(const BigInt &base, const BigInt &exp, const BigInt &mod)
Definition numthry.cpp:284

References BOTAN_FFI_VISIT, Botan::power_mod(), and Botan_FFI::safe_get().

◆ botan_mp_rand_bits()

int botan_mp_rand_bits ( botan_mp_t rand_out,
botan_rng_t rng,
size_t bits )

Definition at line 228 of file ffi_mp.cpp.

228 {
229 return BOTAN_FFI_VISIT(rng, [=](auto& r) { safe_get(rand_out).randomize(r, bits); });
230}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_rand_range()

int botan_mp_rand_range ( botan_mp_t rand_out,
botan_rng_t rng,
botan_mp_t lower_bound,
botan_mp_t upper_bound )

Definition at line 232 of file ffi_mp.cpp.

232 {
233 return BOTAN_FFI_VISIT(
234 rng, [=](auto& r) { safe_get(rand_out) = Botan::BigInt::random_integer(r, safe_get(lower), safe_get(upper)); });
235}
Botan::BigInt::random_integer
static BigInt random_integer(RandomNumberGenerator &rng, const BigInt &min, const BigInt &max)
Definition big_rand.cpp:43

References BOTAN_FFI_VISIT, Botan::BigInt::random_integer(), and Botan_FFI::safe_get().

◆ botan_mp_rshift()

int botan_mp_rshift ( botan_mp_t out,
botan_mp_t in,
size_t shift )

Definition at line 211 of file ffi_mp.cpp.

211 {
212 return BOTAN_FFI_VISIT(out, [=](auto& o) { o = safe_get(in) >> shift; });
213}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_set_bit()

int botan_mp_set_bit ( botan_mp_t n,
size_t bit )

Set the specified bit

Definition at line 249 of file ffi_mp.cpp.

249 {
250 return BOTAN_FFI_VISIT(mp, [=](auto& n) { n.set_bit(bit); });
251}

References BOTAN_FFI_VISIT.

◆ botan_mp_set_from_int()

int botan_mp_set_from_int ( botan_mp_t mp,
int initial_value )

Set the MPI value from an int

Definition at line 38 of file ffi_mp.cpp.

38 {
39 return BOTAN_FFI_VISIT(mp, [=](auto& bn) { bn = Botan::BigInt::from_s32(initial_value); });
40}
Botan::BigInt::from_s32
static BigInt from_s32(int32_t n)
Definition bigint.cpp:40

References BOTAN_FFI_VISIT, and Botan::BigInt::from_s32().

◆ botan_mp_set_from_mp()

int botan_mp_set_from_mp ( botan_mp_t dest,
botan_mp_t source )

Set the MPI value from another MP object

Definition at line 65 of file ffi_mp.cpp.

65 {
66 return BOTAN_FFI_VISIT(dest, [=](auto& bn) { bn = safe_get(source); });
67}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_set_from_radix_str()

int botan_mp_set_from_radix_str ( botan_mp_t dest,
const char * str,
size_t radix )

Set the MPI value from a string with arbitrary radix. For arbitrary being 10 or 16.

Definition at line 46 of file ffi_mp.cpp.

46 {
47 return BOTAN_FFI_VISIT(mp, [=](auto& bn) {
48 Botan::BigInt::Base base;
49 if(radix == 10) {
50 base = Botan::BigInt::Decimal;
51 } else if(radix == 16) {
52 base = Botan::BigInt::Hexadecimal;
53 } else {
54 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
55 }
56
57 const uint8_t* bytes = Botan::cast_char_ptr_to_uint8(str);
58 const size_t len = strlen(str);
59
60 bn = Botan::BigInt(bytes, len, base);
61 return BOTAN_FFI_SUCCESS;
62 });
63}
Botan::cast_char_ptr_to_uint8
const uint8_t * cast_char_ptr_to_uint8(const char *s)
Definition mem_ops.h:276

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, Botan::cast_char_ptr_to_uint8(), Botan::BigInt::Decimal, and Botan::BigInt::Hexadecimal.

◆ botan_mp_set_from_str()

int botan_mp_set_from_str ( botan_mp_t dest,
const char * str )

Set the MPI value from a string

Definition at line 42 of file ffi_mp.cpp.

42 {
43 return BOTAN_FFI_VISIT(mp, [=](auto& bn) { bn = Botan::BigInt(str); });
44}

References BOTAN_FFI_VISIT.

◆ botan_mp_sub()

int botan_mp_sub ( botan_mp_t result,
botan_mp_t x,
botan_mp_t y )

Definition at line 129 of file ffi_mp.cpp.

129 {
130 return BOTAN_FFI_VISIT(result, [=](auto& res) {
131 if(result == x) {
132 res -= safe_get(y);
133 } else {
134 res = safe_get(x) - safe_get(y);
135 }
136 });
137}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_sub_u32()

int botan_mp_sub_u32 ( botan_mp_t result,
botan_mp_t x,
uint32_t y )

Definition at line 149 of file ffi_mp.cpp.

149 {
150 return BOTAN_FFI_VISIT(result, [=](auto& res) {
151 if(result == x) {
152 res -= static_cast<Botan::word>(y);
153 } else {
154 res = safe_get(x) - static_cast<Botan::word>(y);
155 }
156 });
157}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_swap()

int botan_mp_swap ( botan_mp_t x,
botan_mp_t y )

Definition at line 197 of file ffi_mp.cpp.

197 {
198 return BOTAN_FFI_VISIT(x_w, [=](auto& x) { x.swap(safe_get(y_w)); });
199}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_mp_to_bin()

int botan_mp_to_bin ( botan_mp_t mp,
uint8_t vec[] )

Definition at line 104 of file ffi_mp.cpp.

104 {
105 return BOTAN_FFI_VISIT(mp, [=](const auto& bn) { bn.serialize_to(std::span{vec, bn.bytes()}); });
106}

References BOTAN_FFI_VISIT.

◆ botan_mp_to_hex()

int botan_mp_to_hex ( botan_mp_t mp,
char * out )

Convert the MPI to a hex string. Writes botan_mp_num_bytes(mp)*2 + 1 bytes

Definition at line 85 of file ffi_mp.cpp.

85 {
86 return BOTAN_FFI_VISIT(mp, [=](const auto& bn) {
87 const std::string hex = bn.to_hex_string();
88 std::memcpy(out, hex.c_str(), 1 + hex.size());
89 });
90}

References BOTAN_FFI_VISIT.

◆ botan_mp_to_str()

int botan_mp_to_str ( botan_mp_t mp,
uint8_t base,
char * out,
size_t * out_len )

Convert the MPI to a string. Currently base == 10 and base == 16 are supported.

Definition at line 92 of file ffi_mp.cpp.

92 {
93 return BOTAN_FFI_VISIT(mp, [=](const auto& bn) -> int {
94 if(digit_base == 0 || digit_base == 10) {
95 return write_str_output(out, out_len, bn.to_dec_string());
96 } else if(digit_base == 16) {
97 return write_str_output(out, out_len, bn.to_hex_string());
98 } else {
99 return BOTAN_FFI_ERROR_BAD_PARAMETER;
100 }
101 });
102}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_VISIT, and Botan_FFI::write_str_output().

◆ botan_mp_to_uint32()

int botan_mp_to_uint32 ( botan_mp_t mp,
uint32_t * val )

Definition at line 108 of file ffi_mp.cpp.

108 {
109 if(val == nullptr) {
110 return BOTAN_FFI_ERROR_NULL_POINTER;
111 }
112 return BOTAN_FFI_VISIT(mp, [=](const auto& bn) { *val = bn.to_u32bit(); });
113}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_nist_kw_dec()

int botan_nist_kw_dec ( const char * cipher_algo,
int padded,
const uint8_t wrapped_key[],
size_t wrapped_key_len,
const uint8_t kek[],
size_t kek_len,
uint8_t key[],
size_t * key_len )

Definition at line 53 of file ffi_keywrap.cpp.

60 {
61#if defined(BOTAN_HAS_NIST_KEYWRAP)
62 return ffi_guard_thunk(__func__, [=]() -> int {
63 if(padded != 0 && padded != 1) {
64 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
65 }
66
67 auto bc = Botan::BlockCipher::create_or_throw(cipher_algo);
68 bc->set_key(kek, kek_len);
69
70 Botan::secure_vector<uint8_t> output;
71
72 if(padded == 0) {
73 output = Botan::nist_key_unwrap(wrapped_key, wrapped_key_len, *bc);
74 } else {
75 output = Botan::nist_key_unwrap_padded(wrapped_key, wrapped_key_len, *bc);
76 }
77
78 return write_vec_output(key, key_len, output);
79 });
80#else
81 BOTAN_UNUSED(cipher_algo, padded, key, key_len, kek, kek_len, wrapped_key, wrapped_key_len);
82 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
83#endif
84}
Botan::BlockCipher::create_or_throw
static std::unique_ptr< BlockCipher > create_or_throw(std::string_view algo_spec, std::string_view provider="")
Definition block_cipher.cpp:267
Botan::nist_key_unwrap_padded
secure_vector< uint8_t > nist_key_unwrap_padded(const uint8_t input[], size_t input_len, const BlockCipher &bc)
Definition nist_keywrap.cpp:169
Botan::nist_key_unwrap
secure_vector< uint8_t > nist_key_unwrap(const uint8_t input[], size_t input_len, const BlockCipher &bc)
Definition nist_keywrap.cpp:116

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_UNUSED, Botan::BlockCipher::create_or_throw(), Botan_FFI::ffi_guard_thunk(), Botan::nist_key_unwrap(), Botan::nist_key_unwrap_padded(), and Botan_FFI::write_vec_output().

Referenced by botan_key_unwrap3394().

◆ botan_nist_kw_enc()

int botan_nist_kw_enc ( const char * cipher_algo,
int padded,
const uint8_t key[],
size_t key_len,
const uint8_t kek[],
size_t kek_len,
uint8_t wrapped_key[],
size_t * wrapped_key_len )

Definition at line 21 of file ffi_keywrap.cpp.

28 {
29#if defined(BOTAN_HAS_NIST_KEYWRAP)
30 return ffi_guard_thunk(__func__, [=]() -> int {
31 if(padded != 0 && padded != 1) {
32 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
33 }
34 auto bc = Botan::BlockCipher::create_or_throw(cipher_algo);
35 bc->set_key(kek, kek_len);
36
37 std::vector<uint8_t> output;
38
39 if(padded == 0) {
40 output = Botan::nist_key_wrap(key, key_len, *bc);
41 } else {
42 output = Botan::nist_key_wrap_padded(key, key_len, *bc);
43 }
44
45 return write_vec_output(wrapped_key, wrapped_key_len, output);
46 });
47#else
48 BOTAN_UNUSED(cipher_algo, padded, key, key_len, kek, kek_len, wrapped_key, wrapped_key_len);
49 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
50#endif
51}
Botan::nist_key_wrap
std::vector< uint8_t > nist_key_wrap(const uint8_t input[], size_t input_len, const BlockCipher &bc)
Definition nist_keywrap.cpp:90
Botan::nist_key_wrap_padded
std::vector< uint8_t > nist_key_wrap_padded(const uint8_t input[], size_t input_len, const BlockCipher &bc)
Definition nist_keywrap.cpp:148

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_UNUSED, Botan::BlockCipher::create_or_throw(), Botan_FFI::ffi_guard_thunk(), Botan::nist_key_wrap(), Botan::nist_key_wrap_padded(), and Botan_FFI::write_vec_output().

Referenced by botan_key_wrap3394().

◆ botan_oid_cmp()

int botan_oid_cmp ( int * result,
botan_asn1_oid_t a,
botan_asn1_oid_t b )

Sets

Parameters
resultto comparison result: -1 if a < b, 0 if a == b, 1 if a > b
Returns
negative number on error or zero on success

Definition at line 65 of file ffi_oid.cpp.

65 {
66 return BOTAN_FFI_VISIT(a_w, [=](auto& a) {
67 if(result == nullptr) {
68 return BOTAN_FFI_ERROR_NULL_POINTER;
69 }
70 Botan::OID b = safe_get(b_w);
71 // we don't have .cmp for OID
72 if(a == b) {
73 *result = 0;
74 } else if(a < b) {
75 *result = -1;
76 } else {
77 *result = 1;
78 }
79 return BOTAN_FFI_SUCCESS;
80 });
81}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_oid_destroy()

int botan_oid_destroy ( botan_asn1_oid_t oid)
Returns
negative number on error, or zero on success

Definition at line 19 of file ffi_oid.cpp.

19 {
20 return BOTAN_FFI_CHECKED_DELETE(oid);
21}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_oid_equal()

int botan_oid_equal ( botan_asn1_oid_t a,
botan_asn1_oid_t b )
Returns
0 if a != b
1 if a == b
negative number on error

Definition at line 61 of file ffi_oid.cpp.

61 {
62 return BOTAN_FFI_VISIT(a_w, [=](const auto& a) -> int { return a == safe_get(b_w); });
63}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_oid_from_string()

int botan_oid_from_string ( botan_asn1_oid_t * oid,
const char * oid_str )

Create an OID from a string, either dot notation (e.g. '1.2.3.4') or a registered name (e.g. 'RSA')

Parameters
oidhanlder to the resulting OID
oid_strthe name of the OID to create
Returns
negative number on error, or zero on success

Definition at line 23 of file ffi_oid.cpp.

23 {
24 return ffi_guard_thunk(__func__, [=]() -> int {
25 if(oid_obj == nullptr || oid_str == nullptr) {
26 return BOTAN_FFI_ERROR_NULL_POINTER;
27 }
28 Botan::OID oid;
29 // This returns a Lookup_Error if an unknown name is passed,
30 // which would get turned into NOT_IMPLEMENTED
31 try {
32 oid = Botan::OID::from_string(oid_str);
33 } catch(Botan::Lookup_Error&) {
34 return BOTAN_FFI_ERROR_BAD_PARAMETER;
35 }
36 auto oid_ptr = std::make_unique<Botan::OID>(std::move(oid));
37 *oid_obj = new botan_asn1_oid_struct(std::move(oid_ptr));
38 return BOTAN_FFI_SUCCESS;
39 });
40}
Botan::Lookup_Error
Definition exceptn.h:235
Botan::OID::from_string
static OID from_string(std::string_view str)
Definition asn1_oid.cpp:86

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan::OID::from_string().

◆ botan_oid_register()

int botan_oid_register ( botan_asn1_oid_t oid,
const char * name )

Registers an OID so that it may later be retrieved by name

Returns
negative number on error, or zero on success

Definition at line 42 of file ffi_oid.cpp.

42 {
43 return BOTAN_FFI_VISIT(oid, [=](const auto& o) -> int {
44 if(name == nullptr) {
45 return BOTAN_FFI_ERROR_NULL_POINTER;
46 }
47 Botan::OID::register_oid(o, name);
48 return BOTAN_FFI_SUCCESS;
49 });
50}
Botan::OID::register_oid
static void register_oid(const OID &oid, std::string_view name)
Definition asn1_oid.cpp:67

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, and Botan::OID::register_oid().

◆ botan_oid_view_name()

int botan_oid_view_name ( botan_asn1_oid_t oid,
botan_view_ctx ctx,
botan_view_str_fn view )

View an OIDs registered name if it exists, else its dot notation

Definition at line 56 of file ffi_oid.cpp.

56 {
57 return BOTAN_FFI_VISIT(
58 oid, [=](const auto& o) -> int { return invoke_view_callback(view, ctx, o.to_formatted_string()); });
59}

References BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

◆ botan_oid_view_string()

int botan_oid_view_string ( botan_asn1_oid_t oid,
botan_view_ctx ctx,
botan_view_str_fn view )

View an OID in dot notation

Definition at line 52 of file ffi_oid.cpp.

52 {
53 return BOTAN_FFI_VISIT(oid, [=](const auto& o) -> int { return invoke_view_callback(view, ctx, o.to_string()); });
54}

References BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

◆ botan_pbkdf()

int botan_pbkdf ( const char * pbkdf_algo,
uint8_t out[],
size_t out_len,
const char * passphrase,
const uint8_t salt[],
size_t salt_len,
size_t iterations )

Definition at line 22 of file ffi_kdf.cpp.

28 {
29 return botan_pwdhash(algo, iterations, 0, 0, out, out_len, pass, 0, salt, salt_len);
30}
botan_pwdhash
int botan_pwdhash(const char *algo, size_t param1, size_t param2, size_t param3, uint8_t out[], size_t out_len, const char *password, size_t password_len, const uint8_t salt[], size_t salt_len)
Definition ffi_kdf.cpp:53

References botan_pwdhash().

◆ botan_pbkdf_timed()

int botan_pbkdf_timed ( const char * pbkdf_algo,
uint8_t out[],
size_t out_len,
const char * passphrase,
const uint8_t salt[],
size_t salt_len,
size_t milliseconds_to_run,
size_t * out_iterations_used )

Derive a key from a passphrase, running until msec time has elapsed.

Parameters
pbkdf_algoPBKDF algorithm, e.g., "PBKDF2(SHA-256)"
outbuffer to store the derived key, must be of out_len bytes
out_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
salt_lenlength of salt in bytes
milliseconds_to_runif iterations is zero, then instead the PBKDF is run until milliseconds_to_run milliseconds has passed
out_iterations_usedset to the number iterations executed
Returns
0 on success, a negative value on failure

Deprecated: use

botan_pwdhash_timed(pbkdf_algo, static_cast<uint32_t>(ms_to_run), iterations_used, nullptr, nullptr, out, out_len, password, 0, salt, salt_len);

Definition at line 32 of file ffi_kdf.cpp.

39 {
40 return botan_pwdhash_timed(algo,
41 static_cast<uint32_t>(ms_to_run),
42 iterations_used,
43 nullptr,
44 nullptr,
45 out,
46 out_len,
47 password,
48 0,
49 salt,
50 salt_len);
51}
botan_pwdhash_timed
int botan_pwdhash_timed(const char *algo, uint32_t msec, size_t *param1, size_t *param2, size_t *param3, uint8_t out[], size_t out_len, const char *password, size_t password_len, const uint8_t salt[], size_t salt_len)
Definition ffi_kdf.cpp:86

References botan_pwdhash_timed().

◆ botan_pk_op_decrypt()

int botan_pk_op_decrypt ( botan_pk_op_decrypt_t op,
uint8_t out[],
size_t * out_len,
const uint8_t ciphertext[],
size_t ciphertext_len )

Definition at line 103 of file ffi_pk_op.cpp.

104 {
105 return BOTAN_FFI_VISIT(
106 op, [=](const auto& o) { return write_vec_output(out, out_len, o.decrypt(ciphertext, ciphertext_len)); });
107}

References BOTAN_FFI_VISIT, and Botan_FFI::write_vec_output().

◆ botan_pk_op_decrypt_create()

int botan_pk_op_decrypt_create ( botan_pk_op_decrypt_t * op,
botan_privkey_t key,
const char * padding,
uint32_t flags )

Definition at line 71 of file ffi_pk_op.cpp.

74 {
75 if(op == nullptr) {
76 return BOTAN_FFI_ERROR_NULL_POINTER;
77 }
78
79 if(flags != 0) {
80 return BOTAN_FFI_ERROR_BAD_FLAG;
81 }
82
83 return ffi_guard_thunk(__func__, [=]() -> int {
84 *op = nullptr;
85
86 auto pk = std::make_unique<Botan::PK_Decryptor_EME>(safe_get(key_obj), Botan::system_rng(), padding);
87 *op = new botan_pk_op_decrypt_struct(std::move(pk));
88 return BOTAN_FFI_SUCCESS;
89 });
90}
Botan::system_rng
RandomNumberGenerator & system_rng()
Definition system_rng.cpp:371

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), and Botan::system_rng().

◆ botan_pk_op_decrypt_destroy()

int botan_pk_op_decrypt_destroy ( botan_pk_op_decrypt_t op)
Returns
0 if success, error if invalid object handle

Definition at line 92 of file ffi_pk_op.cpp.

92 {
93 return BOTAN_FFI_CHECKED_DELETE(op);
94}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_pk_op_decrypt_output_length()

int botan_pk_op_decrypt_output_length ( botan_pk_op_decrypt_t op,
size_t ctext_len,
size_t * ptext_len )

Definition at line 96 of file ffi_pk_op.cpp.

96 {
97 if(ptext_len == nullptr) {
98 return BOTAN_FFI_ERROR_NULL_POINTER;
99 }
100 return BOTAN_FFI_VISIT(op, [=](const auto& o) { *ptext_len = o.plaintext_length(ctext_len); });
101}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_pk_op_encrypt()

int botan_pk_op_encrypt ( botan_pk_op_encrypt_t op,
botan_rng_t rng,
uint8_t out[],
size_t * out_len,
const uint8_t plaintext[],
size_t plaintext_len )

Definition at line 57 of file ffi_pk_op.cpp.

62 {
63 return BOTAN_FFI_VISIT(op, [=](const auto& o) {
64 return write_vec_output(out, out_len, o.encrypt(plaintext, plaintext_len, safe_get(rng_obj)));
65 });
66}

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), and Botan_FFI::write_vec_output().

◆ botan_pk_op_encrypt_create()

int botan_pk_op_encrypt_create ( botan_pk_op_encrypt_t * op,
botan_pubkey_t key,
const char * padding,
uint32_t flags )

Definition at line 28 of file ffi_pk_op.cpp.

28 {
29 if(op == nullptr) {
30 return BOTAN_FFI_ERROR_NULL_POINTER;
31 }
32
33 if(flags != 0 && flags != BOTAN_PUBKEY_DER_FORMAT_SIGNATURE) {
34 return BOTAN_FFI_ERROR_BAD_FLAG;
35 }
36
37 return ffi_guard_thunk(__func__, [=]() -> int {
38 *op = nullptr;
39
40 auto pk = std::make_unique<Botan::PK_Encryptor_EME>(safe_get(key_obj), Botan::system_rng(), padding);
41 *op = new botan_pk_op_encrypt_struct(std::move(pk));
42 return BOTAN_FFI_SUCCESS;
43 });
44}
BOTAN_PUBKEY_DER_FORMAT_SIGNATURE
#define BOTAN_PUBKEY_DER_FORMAT_SIGNATURE
Definition ffi.h:1939

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_PUBKEY_DER_FORMAT_SIGNATURE, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), and Botan::system_rng().

◆ botan_pk_op_encrypt_destroy()

int botan_pk_op_encrypt_destroy ( botan_pk_op_encrypt_t op)
Returns
0 if success, error if invalid object handle

Definition at line 46 of file ffi_pk_op.cpp.

46 {
47 return BOTAN_FFI_CHECKED_DELETE(op);
48}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_pk_op_encrypt_output_length()

int botan_pk_op_encrypt_output_length ( botan_pk_op_encrypt_t op,
size_t ptext_len,
size_t * ctext_len )

Definition at line 50 of file ffi_pk_op.cpp.

50 {
51 if(ctext_len == nullptr) {
52 return BOTAN_FFI_ERROR_NULL_POINTER;
53 }
54 return BOTAN_FFI_VISIT(op, [=](const auto& o) { *ctext_len = o.ciphertext_length(ptext_len); });
55}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_pk_op_kem_decrypt_create()

int botan_pk_op_kem_decrypt_create ( botan_pk_op_kem_decrypt_t * op,
botan_privkey_t key,
const char * kdf )

Definition at line 313 of file ffi_pk_op.cpp.

313 {
314 if(op == nullptr || padding == nullptr) {
315 return BOTAN_FFI_ERROR_NULL_POINTER;
316 }
317
318 return ffi_guard_thunk(__func__, [=]() -> int {
319 auto pk = std::make_unique<Botan::PK_KEM_Decryptor>(safe_get(key_obj), Botan::system_rng(), padding);
320 *op = new botan_pk_op_kem_decrypt_struct(std::move(pk));
321 return BOTAN_FFI_SUCCESS;
322 });
323}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), and Botan::system_rng().

◆ botan_pk_op_kem_decrypt_destroy()

int botan_pk_op_kem_decrypt_destroy ( botan_pk_op_kem_decrypt_t op)
Returns
0 if success, error if invalid object handle

Definition at line 354 of file ffi_pk_op.cpp.

354 {
355 return BOTAN_FFI_CHECKED_DELETE(op);
356}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_pk_op_kem_decrypt_shared_key()

int botan_pk_op_kem_decrypt_shared_key ( botan_pk_op_kem_decrypt_t op,
const uint8_t salt[],
size_t salt_len,
const uint8_t encapsulated_key[],
size_t encapsulated_key_len,
size_t desired_shared_key_len,
uint8_t shared_key[],
size_t * shared_key_len )

Definition at line 338 of file ffi_pk_op.cpp.

345 {
346 return BOTAN_FFI_VISIT(op, [=](auto& kem) {
347 const auto shared_key =
348 kem.decrypt(encapsulated_key, encapsulated_key_len, desired_shared_key_len, salt, salt_len);
349
350 return write_vec_output(shared_key_out, shared_key_len, shared_key);
351 });
352}

References BOTAN_FFI_VISIT, and Botan_FFI::write_vec_output().

◆ botan_pk_op_kem_decrypt_shared_key_length()

int botan_pk_op_kem_decrypt_shared_key_length ( botan_pk_op_kem_decrypt_t op,
size_t desired_shared_key_length,
size_t * output_shared_key_length )

Definition at line 325 of file ffi_pk_op.cpp.

327 {
328 if(output_shared_key_length == nullptr) {
329 return BOTAN_FFI_ERROR_NULL_POINTER;
330 }
331
332 return BOTAN_FFI_VISIT(op, [=](auto& kem) {
333 *output_shared_key_length = kem.shared_key_length(desired_shared_key_length);
334 return BOTAN_FFI_SUCCESS;
335 });
336}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_pk_op_kem_encrypt_create()

int botan_pk_op_kem_encrypt_create ( botan_pk_op_kem_encrypt_t * op,
botan_pubkey_t key,
const char * kdf )

Definition at line 250 of file ffi_pk_op.cpp.

250 {
251 if(op == nullptr || padding == nullptr) {
252 return BOTAN_FFI_ERROR_NULL_POINTER;
253 }
254
255 return ffi_guard_thunk(__func__, [=]() -> int {
256 auto pk = std::make_unique<Botan::PK_KEM_Encryptor>(safe_get(key_obj), padding);
257 *op = new botan_pk_op_kem_encrypt_struct(std::move(pk));
258 return BOTAN_FFI_SUCCESS;
259 });
260}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_pk_op_kem_encrypt_create_shared_key()

int botan_pk_op_kem_encrypt_create_shared_key ( botan_pk_op_kem_encrypt_t op,
botan_rng_t rng,
const uint8_t salt[],
size_t salt_len,
size_t desired_shared_key_len,
uint8_t shared_key[],
size_t * shared_key_len,
uint8_t encapsulated_key[],
size_t * encapsulated_key_len )

Definition at line 291 of file ffi_pk_op.cpp.

299 {
300 return BOTAN_FFI_VISIT(op, [=](auto& kem) {
301 const auto result = kem.encrypt(safe_get(rng), desired_shared_key_len, {salt, salt_len});
302
303 int rc = write_vec_output(encapsulated_key_out, encapsulated_key_len, result.encapsulated_shared_key());
304
305 if(rc != 0) {
306 return rc;
307 }
308
309 return write_vec_output(shared_key_out, shared_key_len, result.shared_key());
310 });
311}

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), and Botan_FFI::write_vec_output().

◆ botan_pk_op_kem_encrypt_destroy()

int botan_pk_op_kem_encrypt_destroy ( botan_pk_op_kem_encrypt_t op)
Returns
0 if success, error if invalid object handle

Definition at line 262 of file ffi_pk_op.cpp.

262 {
263 return BOTAN_FFI_CHECKED_DELETE(op);
264}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_pk_op_kem_encrypt_encapsulated_key_length()

int botan_pk_op_kem_encrypt_encapsulated_key_length ( botan_pk_op_kem_encrypt_t op,
size_t * output_encapsulated_key_length )

Definition at line 279 of file ffi_pk_op.cpp.

280 {
281 if(output_encapsulated_key_length == nullptr) {
282 return BOTAN_FFI_ERROR_NULL_POINTER;
283 }
284
285 return BOTAN_FFI_VISIT(op, [=](auto& kem) {
286 *output_encapsulated_key_length = kem.encapsulated_key_length();
287 return BOTAN_FFI_SUCCESS;
288 });
289}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_pk_op_kem_encrypt_shared_key_length()

int botan_pk_op_kem_encrypt_shared_key_length ( botan_pk_op_kem_encrypt_t op,
size_t desired_shared_key_length,
size_t * output_shared_key_length )

Definition at line 266 of file ffi_pk_op.cpp.

268 {
269 if(output_shared_key_length == nullptr) {
270 return BOTAN_FFI_ERROR_NULL_POINTER;
271 }
272
273 return BOTAN_FFI_VISIT(op, [=](auto& kem) {
274 *output_shared_key_length = kem.shared_key_length(desired_shared_key_length);
275 return BOTAN_FFI_SUCCESS;
276 });
277}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_pk_op_key_agreement()

int botan_pk_op_key_agreement ( botan_pk_op_ka_t op,
uint8_t out[],
size_t * out_len,
const uint8_t other_key[],
size_t other_key_len,
const uint8_t salt[],
size_t salt_len )

Definition at line 237 of file ffi_pk_op.cpp.

243 {
244 return BOTAN_FFI_VISIT(op, [=](const auto& o) {
245 auto k = o.derive_key(*out_len, other_key, other_key_len, salt, salt_len).bits_of();
246 return write_vec_output(out, out_len, k);
247 });
248}

References BOTAN_FFI_VISIT, and Botan_FFI::write_vec_output().

◆ botan_pk_op_key_agreement_create()

int botan_pk_op_key_agreement_create ( botan_pk_op_ka_t * op,
botan_privkey_t key,
const char * kdf,
uint32_t flags )

Definition at line 192 of file ffi_pk_op.cpp.

192 {
193 if(op == nullptr) {
194 return BOTAN_FFI_ERROR_NULL_POINTER;
195 }
196
197 if(flags != 0) {
198 return BOTAN_FFI_ERROR_BAD_FLAG;
199 }
200
201 return ffi_guard_thunk(__func__, [=]() -> int {
202 *op = nullptr;
203 auto pk = std::make_unique<Botan::PK_Key_Agreement>(safe_get(key_obj), Botan::system_rng(), kdf);
204 *op = new botan_pk_op_ka_struct(std::move(pk));
205 return BOTAN_FFI_SUCCESS;
206 });
207}

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), and Botan::system_rng().

◆ botan_pk_op_key_agreement_destroy()

int botan_pk_op_key_agreement_destroy ( botan_pk_op_ka_t op)
Returns
0 if success, error if invalid object handle

Definition at line 209 of file ffi_pk_op.cpp.

209 {
210 return BOTAN_FFI_CHECKED_DELETE(op);
211}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_pk_op_key_agreement_export_public()

int botan_pk_op_key_agreement_export_public ( botan_privkey_t key,
uint8_t out[],
size_t * out_len )

Definition at line 213 of file ffi_pk_op.cpp.

213 {
214 return copy_view_bin(out, out_len, botan_pk_op_key_agreement_view_public, key);
215}
botan_pk_op_key_agreement_view_public
int botan_pk_op_key_agreement_view_public(botan_privkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
Definition ffi_pk_op.cpp:217
Botan_FFI::copy_view_bin
int copy_view_bin(uint8_t out[], size_t *out_len, Fn fn, Args... args)
Definition ffi_util.h:189

References botan_pk_op_key_agreement_view_public(), and Botan_FFI::copy_view_bin().

◆ botan_pk_op_key_agreement_size()

int botan_pk_op_key_agreement_size ( botan_pk_op_ka_t op,
size_t * out_len )

Definition at line 227 of file ffi_pk_op.cpp.

227 {
228 return BOTAN_FFI_VISIT(op, [=](const auto& o) {
229 if(out_len == nullptr) {
230 return BOTAN_FFI_ERROR_NULL_POINTER;
231 }
232 *out_len = o.agreed_value_size();
233 return BOTAN_FFI_SUCCESS;
234 });
235}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_pk_op_key_agreement_view_public()

int botan_pk_op_key_agreement_view_public ( botan_privkey_t key,
botan_view_ctx ctx,
botan_view_bin_fn view )

Definition at line 217 of file ffi_pk_op.cpp.

217 {
218 return BOTAN_FFI_VISIT(key, [=](const auto& k) -> int {
219 if(auto kak = dynamic_cast<const Botan::PK_Key_Agreement_Key*>(&k)) {
220 return invoke_view_callback(view, ctx, kak->public_value());
221 } else {
222 return BOTAN_FFI_ERROR_INVALID_INPUT;
223 }
224 });
225}
Botan::PK_Key_Agreement_Key
Definition pk_keys.h:414

References BOTAN_FFI_ERROR_INVALID_INPUT, BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

Referenced by botan_pk_op_key_agreement_export_public().

◆ botan_pk_op_sign_create()

int botan_pk_op_sign_create ( botan_pk_op_sign_t * op,
botan_privkey_t key,
const char * hash_and_padding,
uint32_t flags )

Definition at line 112 of file ffi_pk_op.cpp.

112 {
113 if(op == nullptr) {
114 return BOTAN_FFI_ERROR_NULL_POINTER;
115 }
116
117 if(flags != 0 && flags != BOTAN_PUBKEY_DER_FORMAT_SIGNATURE) {
118 return BOTAN_FFI_ERROR_BAD_FLAG;
119 }
120
121 return ffi_guard_thunk(__func__, [=]() -> int {
122 *op = nullptr;
123
124 auto format = (flags & BOTAN_PUBKEY_DER_FORMAT_SIGNATURE) ? Botan::Signature_Format::DerSequence
125 : Botan::Signature_Format::Standard;
126
127 auto pk = std::make_unique<Botan::PK_Signer>(safe_get(key_obj), Botan::system_rng(), hash, format);
128 *op = new botan_pk_op_sign_struct(std::move(pk));
129 return BOTAN_FFI_SUCCESS;
130 });
131}
Botan::Signature_Format
Signature_Format
Definition pk_keys.h:32

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_PUBKEY_DER_FORMAT_SIGNATURE, Botan::DerSequence, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), Botan::Standard, and Botan::system_rng().

◆ botan_pk_op_sign_destroy()

int botan_pk_op_sign_destroy ( botan_pk_op_sign_t op)
Returns
0 if success, error if invalid object handle

Definition at line 133 of file ffi_pk_op.cpp.

133 {
134 return BOTAN_FFI_CHECKED_DELETE(op);
135}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_pk_op_sign_finish()

int botan_pk_op_sign_finish ( botan_pk_op_sign_t op,
botan_rng_t rng,
uint8_t sig[],
size_t * sig_len )

Definition at line 149 of file ffi_pk_op.cpp.

149 {
150 return BOTAN_FFI_VISIT(op, [=](auto& o) { return write_vec_output(out, out_len, o.signature(safe_get(rng_obj))); });
151}

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), and Botan_FFI::write_vec_output().

◆ botan_pk_op_sign_output_length()

int botan_pk_op_sign_output_length ( botan_pk_op_sign_t op,
size_t * olen )

Definition at line 137 of file ffi_pk_op.cpp.

137 {
138 if(sig_len == nullptr) {
139 return BOTAN_FFI_ERROR_NULL_POINTER;
140 }
141
142 return BOTAN_FFI_VISIT(op, [=](const auto& o) { *sig_len = o.signature_length(); });
143}

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.

◆ botan_pk_op_sign_update()

int botan_pk_op_sign_update ( botan_pk_op_sign_t op,
const uint8_t in[],
size_t in_len )

Definition at line 145 of file ffi_pk_op.cpp.

145 {
146 return BOTAN_FFI_VISIT(op, [=](auto& o) { o.update(in, in_len); });
147}

References BOTAN_FFI_VISIT.

◆ botan_pk_op_verify_create()

int botan_pk_op_verify_create ( botan_pk_op_verify_t * op,
botan_pubkey_t key,
const char * hash_and_padding,
uint32_t flags )

Definition at line 153 of file ffi_pk_op.cpp.

153 {
154 if(op == nullptr) {
155 return BOTAN_FFI_ERROR_NULL_POINTER;
156 }
157
158 if(flags != 0 && flags != BOTAN_PUBKEY_DER_FORMAT_SIGNATURE) {
159 return BOTAN_FFI_ERROR_BAD_FLAG;
160 }
161
162 return ffi_guard_thunk(__func__, [=]() -> int {
163 *op = nullptr;
164 auto format = (flags & BOTAN_PUBKEY_DER_FORMAT_SIGNATURE) ? Botan::Signature_Format::DerSequence
165 : Botan::Signature_Format::Standard;
166 auto pk = std::make_unique<Botan::PK_Verifier>(safe_get(key_obj), hash, format);
167 *op = new botan_pk_op_verify_struct(std::move(pk));
168 return BOTAN_FFI_SUCCESS;
169 });
170}

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_PUBKEY_DER_FORMAT_SIGNATURE, Botan::DerSequence, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), and Botan::Standard.

◆ botan_pk_op_verify_destroy()

int botan_pk_op_verify_destroy ( botan_pk_op_verify_t op)
Returns
0 if success, error if invalid object handle

Definition at line 172 of file ffi_pk_op.cpp.

172 {
173 return BOTAN_FFI_CHECKED_DELETE(op);
174}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_pk_op_verify_finish()

int botan_pk_op_verify_finish ( botan_pk_op_verify_t op,
const uint8_t sig[],
size_t sig_len )

Definition at line 180 of file ffi_pk_op.cpp.

180 {
181 return BOTAN_FFI_VISIT(op, [=](auto& o) {
182 const bool legit = o.check_signature(sig, sig_len);
183
184 if(legit) {
185 return BOTAN_FFI_SUCCESS;
186 } else {
187 return BOTAN_FFI_INVALID_VERIFIER;
188 }
189 });
190}

References BOTAN_FFI_INVALID_VERIFIER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_pk_op_verify_update()

int botan_pk_op_verify_update ( botan_pk_op_verify_t op,
const uint8_t in[],
size_t in_len )

Definition at line 176 of file ffi_pk_op.cpp.

176 {
177 return BOTAN_FFI_VISIT(op, [=](auto& o) { o.update(in, in_len); });
178}

References BOTAN_FFI_VISIT.

◆ botan_pkcs_hash_id()

int botan_pkcs_hash_id ( const char * hash_name,
uint8_t pkcs_id[],
size_t * pkcs_id_len )

Signature Scheme Utility Functions

Definition at line 438 of file ffi_pkey.cpp.

438 {
439#if defined(BOTAN_HAS_HASH_ID)
440 return ffi_guard_thunk(__func__, [=]() -> int {
441 const std::vector<uint8_t> hash_id = Botan::pkcs_hash_id(hash_name);
442 return write_output(pkcs_id, pkcs_id_len, hash_id.data(), hash_id.size());
443 });
444#else
445 BOTAN_UNUSED(hash_name, pkcs_id, pkcs_id_len);
446 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
447#endif
448}
Botan_FFI::write_output
int write_output(uint8_t out[], size_t *out_len, const uint8_t buf[], size_t buf_len)
Definition ffi_util.h:207
Botan::pkcs_hash_id
std::vector< uint8_t > pkcs_hash_id(std::string_view name)
Definition hash_id.cpp:78

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan::pkcs_hash_id(), and Botan_FFI::write_output().

◆ botan_privkey_algo_name()

int botan_privkey_algo_name ( botan_privkey_t key,
char out[],
size_t * out_len )

Definition at line 137 of file ffi_pkey.cpp.

137 {
138 return BOTAN_FFI_VISIT(key, [=](const auto& k) { return write_str_output(out, out_len, k.algo_name()); });
139}

References BOTAN_FFI_VISIT, and Botan_FFI::write_str_output().

◆ botan_privkey_check_key()

int botan_privkey_check_key ( botan_privkey_t key,
botan_rng_t rng,
uint32_t flags )

Definition at line 153 of file ffi_pkey.cpp.

153 {
154 const bool strong = (flags & BOTAN_CHECK_KEY_EXPENSIVE_TESTS);
155 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
156 return (k.check_key(safe_get(rng), strong) == true) ? 0 : BOTAN_FFI_ERROR_INVALID_INPUT;
157 });
158}
BOTAN_CHECK_KEY_EXPENSIVE_TESTS
#define BOTAN_CHECK_KEY_EXPENSIVE_TESTS
Definition ffi.h:1323

References BOTAN_CHECK_KEY_EXPENSIVE_TESTS, BOTAN_FFI_ERROR_INVALID_INPUT, BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_privkey_create()

int botan_privkey_create ( botan_privkey_t * key,
const char * algo_name,
const char * algo_params,
botan_rng_t rng )

Create a new private key

Parameters
keythe new object will be placed here
algo_namesomething like "RSA" or "ECDSA"
algo_paramsis specific to the algorithm. For RSA, specifies the modulus bit length. For ECC is the name of the curve.
rnga random number generator

Definition at line 29 of file ffi_pkey.cpp.

32 {
33 return ffi_guard_thunk(__func__, [=]() -> int {
34 if(key_obj == nullptr) {
35 return BOTAN_FFI_ERROR_NULL_POINTER;
36 }
37
38 *key_obj = nullptr;
39 if(rng_obj == nullptr) {
40 return BOTAN_FFI_ERROR_NULL_POINTER;
41 }
42
43 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
44 std::unique_ptr<Botan::Private_Key> key(
45 Botan::create_private_key(algo_name ? algo_name : "RSA", rng, algo_params ? algo_params : ""));
46
47 if(key) {
48 *key_obj = new botan_privkey_struct(std::move(key));
49 return BOTAN_FFI_SUCCESS;
50 } else {
51 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
52 }
53 });
54}
Botan::create_private_key
std::unique_ptr< Private_Key > create_private_key(std::string_view alg_name, RandomNumberGenerator &rng, std::string_view params, std::string_view provider)
Definition pk_algs.cpp:487

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::create_private_key(), Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

Referenced by botan_privkey_create_dh(), botan_privkey_create_ecdh(), botan_privkey_create_ecdsa(), botan_privkey_create_mceliece(), and botan_privkey_create_rsa().

◆ botan_privkey_create_dh()

int botan_privkey_create_dh ( botan_privkey_t * key,
botan_rng_t rng,
const char * param )

Definition at line 543 of file ffi_pkey_algs.cpp.

543 {
544 return botan_privkey_create(key_obj, "DH", param_str, rng_obj);
545}
botan_privkey_create
int botan_privkey_create(botan_privkey_t *key, const char *algo_name, const char *algo_params, botan_rng_t rng)
Definition ffi_pkey.cpp:29

References botan_privkey_create().

◆ botan_privkey_create_dsa()

int botan_privkey_create_dsa ( botan_privkey_t * key,
botan_rng_t rng,
size_t pbits,
size_t qbits )

Generates DSA key pair. Gives to a caller control over key length and order of a subgroup 'q'.

Parameters
keyhandler to the resulting key
rnginitialized PRNG
pbitslength of the key in bits. Must be between in range (1024, 3072) and multiple of 64. Bit size of the prime 'p'
qbitsorder of the subgroup. Must be in range (160, 256) and multiple of 8
Returns
BOTAN_FFI_SUCCESS Success, ‘key’ initialized with DSA key
BOTAN_FFI_ERROR_NULL_POINTER either ‘key’ or ‘rng’ is NULL
BOTAN_FFI_ERROR_BAD_PARAMETER unexpected value for either ‘pbits’ or ‘qbits’
BOTAN_FFI_ERROR_NOT_IMPLEMENTED functionality not implemented

Definition at line 324 of file ffi_pkey_algs.cpp.

324 {
325#if defined(BOTAN_HAS_DSA)
326
327 if((rng_obj == nullptr) || (key == nullptr)) {
328 return BOTAN_FFI_ERROR_NULL_POINTER;
329 }
330
331 if((pbits % 64) || (qbits % 8) || (pbits < 1024) || (pbits > 3072) || (qbits < 160) || (qbits > 256)) {
332 return BOTAN_FFI_ERROR_BAD_PARAMETER;
333 }
334
335 return ffi_guard_thunk(__func__, [=]() -> int {
336 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
337 Botan::DL_Group group(rng, Botan::DL_Group::Prime_Subgroup, pbits, qbits);
338 auto dsa = std::make_unique<Botan::DSA_PrivateKey>(rng, group);
339 *key = new botan_privkey_struct(std::move(dsa));
340 return BOTAN_FFI_SUCCESS;
341 });
342#else
343 BOTAN_UNUSED(key, rng_obj, pbits, qbits);
344 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
345#endif
346}
Botan::DL_Group
Definition dl_group.h:46
Botan::DL_Group::Prime_Subgroup
@ Prime_Subgroup
Definition dl_group.h:51

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan::DL_Group::Prime_Subgroup, and Botan_FFI::safe_get().

◆ botan_privkey_create_ecdh()

int botan_privkey_create_ecdh ( botan_privkey_t * key,
botan_rng_t rng,
const char * params )

Definition at line 585 of file ffi_pkey_algs.cpp.

585 {
586 if(key_obj == nullptr || param_str == nullptr) {
587 return BOTAN_FFI_ERROR_NULL_POINTER;
588 }
589 *key_obj = nullptr;
590
591 const std::string params(param_str);
592
593 if(params == "X25519" || params == "x25519" || params == "curve25519") {
594 return botan_privkey_create(key_obj, "X25519", "", rng_obj);
595 }
596
597 if(params == "X448" || params == "x448") {
598 return botan_privkey_create(key_obj, "X448", "", rng_obj);
599 }
600
601 return botan_privkey_create(key_obj, "ECDH", param_str, rng_obj);
602}

References BOTAN_FFI_ERROR_NULL_POINTER, and botan_privkey_create().

◆ botan_privkey_create_ecdsa()

int botan_privkey_create_ecdsa ( botan_privkey_t * key,
botan_rng_t rng,
const char * params )

Definition at line 406 of file ffi_pkey_algs.cpp.

406 {
407 return botan_privkey_create(key_obj, "ECDSA", param_str, rng_obj);
408}

References botan_privkey_create().

◆ botan_privkey_create_elgamal()

int botan_privkey_create_elgamal ( botan_privkey_t * key,
botan_rng_t rng,
size_t pbits,
size_t qbits )

Generates ElGamal key pair. Caller has a control over key length and order of a subgroup 'q'. Function is able to use two types of primes:

  • if pbits-1 == qbits then safe primes are used for key generation
  • otherwise generation uses group of prime order
Parameters
keyhandler to the resulting key
rnginitialized PRNG
pbitslength of the key in bits. Must be at least 1024
qbitsorder of the subgroup. Must be at least 160
Returns
BOTAN_FFI_SUCCESS Success, ‘key’ initialized with DSA key
BOTAN_FFI_ERROR_NULL_POINTER either ‘key’ or ‘rng’ is NULL
BOTAN_FFI_ERROR_BAD_PARAMETER unexpected value for either ‘pbits’ or ‘qbits’
BOTAN_FFI_ERROR_NOT_IMPLEMENTED functionality not implemented

Definition at line 478 of file ffi_pkey_algs.cpp.

478 {
479#if defined(BOTAN_HAS_ELGAMAL)
480 if(key == nullptr || rng_obj == nullptr) {
481 return BOTAN_FFI_ERROR_NULL_POINTER;
482 }
483 *key = nullptr;
484
485 if(pbits < 1024 || qbits < 160) {
486 return BOTAN_FFI_ERROR_BAD_PARAMETER;
487 }
488
489 Botan::DL_Group::PrimeType prime_type =
490 ((pbits - 1) == qbits) ? Botan::DL_Group::Strong : Botan::DL_Group::Prime_Subgroup;
491
492 return ffi_guard_thunk(__func__, [=]() -> int {
493 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
494 Botan::DL_Group group(rng, prime_type, pbits, qbits);
495 auto elg = std::make_unique<Botan::ElGamal_PrivateKey>(rng, group);
496 *key = new botan_privkey_struct(std::move(elg));
497 return BOTAN_FFI_SUCCESS;
498 });
499#else
500 BOTAN_UNUSED(key, rng_obj, pbits, qbits);
501 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
502#endif
503}
Botan::DL_Group::PrimeType
PrimeType
Definition dl_group.h:51
Botan::DL_Group::Strong
@ Strong
Definition dl_group.h:51

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan::DL_Group::Prime_Subgroup, Botan_FFI::safe_get(), and Botan::DL_Group::Strong.

◆ botan_privkey_create_mceliece()

int botan_privkey_create_mceliece ( botan_privkey_t * key,
botan_rng_t rng,
size_t n,
size_t t )

Definition at line 1395 of file ffi_pkey_algs.cpp.

1395 {
1396 const std::string mce_params = std::to_string(n) + "," + std::to_string(t);
1397 return botan_privkey_create(key_obj, "McEliece", mce_params.c_str(), rng_obj);
1398}

References botan_privkey_create().

◆ botan_privkey_create_rsa()

int botan_privkey_create_rsa ( botan_privkey_t * key,
botan_rng_t rng,
size_t n_bits )

Definition at line 210 of file ffi_pkey_algs.cpp.

210 {
211 if(n_bits < 1024 || n_bits > 16 * 1024) {
212 return BOTAN_FFI_ERROR_BAD_PARAMETER;
213 }
214
215 std::string n_str = std::to_string(n_bits);
216
217 return botan_privkey_create(key_obj, "RSA", n_str.c_str(), rng_obj);
218}

References BOTAN_FFI_ERROR_BAD_PARAMETER, and botan_privkey_create().

◆ botan_privkey_destroy()

int botan_privkey_destroy ( botan_privkey_t key)
Returns
0 if success, error if invalid object handle

Definition at line 105 of file ffi_pkey.cpp.

105 {
106 return BOTAN_FFI_CHECKED_DELETE(key);
107}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_privkey_dsa_get_x()

int botan_privkey_dsa_get_x ( botan_mp_t n,
botan_privkey_t key )

Definition at line 386 of file ffi_pkey_algs.cpp.

386 {
387 return botan_privkey_get_field(x, key, "x");
388}
botan_privkey_get_field
int botan_privkey_get_field(botan_mp_t output, botan_privkey_t key, const char *field_name_cstr)
Definition ffi_pkey_algs.cpp:198

References botan_privkey_get_field().

◆ botan_privkey_ed25519_get_privkey()

int botan_privkey_ed25519_get_privkey ( botan_privkey_t key,
uint8_t output[64] )

Definition at line 778 of file ffi_pkey_algs.cpp.

778 {
779#if defined(BOTAN_HAS_ED25519)
780 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
781 if(auto ed = dynamic_cast<const Botan::Ed25519_PrivateKey*>(&k)) {
782 const auto ed_key = ed->raw_private_key_bits();
783 if(ed_key.size() != 64) {
784 return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
785 }
786 Botan::copy_mem(output, ed_key.data(), ed_key.size());
787 return BOTAN_FFI_SUCCESS;
788 } else {
789 return BOTAN_FFI_ERROR_BAD_PARAMETER;
790 }
791 });
792#else
793 BOTAN_UNUSED(key, output);
794 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
795#endif
796}
Botan::Ed25519_PrivateKey
Definition ed25519.h:67

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan::copy_mem().

◆ botan_privkey_ed448_get_privkey()

int botan_privkey_ed448_get_privkey ( botan_privkey_t key,
uint8_t output[57] )

Definition at line 854 of file ffi_pkey_algs.cpp.

854 {
855#if defined(BOTAN_HAS_ED448)
856 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
857 if(auto ed = dynamic_cast<const Botan::Ed448_PrivateKey*>(&k)) {
858 const auto ed_key = ed->raw_private_key_bits();
859 Botan::copy_mem(std::span(output, 57), ed_key);
860 return BOTAN_FFI_SUCCESS;
861 } else {
862 return BOTAN_FFI_ERROR_BAD_PARAMETER;
863 }
864 });
865#else
866 BOTAN_UNUSED(key, output);
867 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
868#endif
869}
Botan::Ed448_PrivateKey
A private key for Ed448/Ed448ph according to RFC 8032.
Definition ed448.h:83

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan::copy_mem().

◆ botan_privkey_export()

int botan_privkey_export ( botan_privkey_t key,
uint8_t out[],
size_t * out_len,
uint32_t flags )

On input *out_len is number of bytes in out[] On output *out_len is number of bytes written (or required) If out is not big enough no output is written, *out_len is set and 1 is returned Returns 0 on success and sets If some other error occurs a negative integer is returned.

Definition at line 187 of file ffi_pkey.cpp.

187 {
188 if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_DER) {
189 return copy_view_bin(out, out_len, botan_privkey_view_der, key);
190 } else if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_PEM) {
191 return copy_view_str(out, out_len, botan_privkey_view_pem, key);
192 } else if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_RAW) {
193 return copy_view_bin(out, out_len, botan_privkey_view_raw, key);
194 } else {
195 return BOTAN_FFI_ERROR_BAD_FLAG;
196 }
197}
BOTAN_PRIVKEY_EXPORT_FLAG_RAW
#define BOTAN_PRIVKEY_EXPORT_FLAG_RAW
Definition ffi.h:1395
botan_privkey_view_der
int botan_privkey_view_der(botan_privkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
Definition ffi_pkey.cpp:199
botan_privkey_view_raw
int botan_privkey_view_raw(botan_privkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
Definition ffi_pkey.cpp:209
BOTAN_PRIVKEY_EXPORT_FLAG_PEM
#define BOTAN_PRIVKEY_EXPORT_FLAG_PEM
Definition ffi.h:1394
BOTAN_PRIVKEY_EXPORT_FLAG_DER
#define BOTAN_PRIVKEY_EXPORT_FLAG_DER
Definition ffi.h:1393
botan_privkey_view_pem
int botan_privkey_view_pem(botan_privkey_t key, botan_view_ctx ctx, botan_view_str_fn view)
Definition ffi_pkey.cpp:204
Botan_FFI::copy_view_str
int copy_view_str(uint8_t out[], size_t *out_len, Fn fn, Args... args)
Definition ffi_util.h:197

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_PRIVKEY_EXPORT_FLAG_DER, BOTAN_PRIVKEY_EXPORT_FLAG_PEM, BOTAN_PRIVKEY_EXPORT_FLAG_RAW, botan_privkey_view_der(), botan_privkey_view_pem(), botan_privkey_view_raw(), Botan_FFI::copy_view_bin(), and Botan_FFI::copy_view_str().

◆ botan_privkey_export_encrypted()

int botan_privkey_export_encrypted ( botan_privkey_t key,
uint8_t out[],
size_t * out_len,
botan_rng_t rng,
const char * passphrase,
const char * encryption_algo,
uint32_t flags )

Set encryption_algo to NULL or "" to have the library choose a default (recommended)

Definition at line 214 of file ffi_pkey.cpp.

220 {
221 return botan_privkey_export_encrypted_pbkdf_iter(key, out, out_len, rng_obj, pass, 100000, nullptr, nullptr, flags);
222}
botan_privkey_export_encrypted_pbkdf_iter
int botan_privkey_export_encrypted_pbkdf_iter(botan_privkey_t key, uint8_t out[], size_t *out_len, botan_rng_t rng, const char *passphrase, size_t pbkdf_iter, const char *cipher, const char *pbkdf_algo, uint32_t flags)
Definition ffi_pkey.cpp:301

References botan_privkey_export_encrypted_pbkdf_iter().

◆ botan_privkey_export_encrypted_pbkdf_iter()

int botan_privkey_export_encrypted_pbkdf_iter ( botan_privkey_t key,
uint8_t out[],
size_t * out_len,
botan_rng_t rng,
const char * passphrase,
size_t pbkdf_iterations,
const char * cipher_algo,
const char * pbkdf_algo,
uint32_t flags )

Export a private key using the specified number of iterations.

Definition at line 301 of file ffi_pkey.cpp.

309 {
310 if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_DER) {
311 return copy_view_bin(
312 out, out_len, botan_privkey_view_encrypted_der, key, rng, passphrase, cipher, pbkdf_algo, pbkdf_iter);
313 } else if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_PEM) {
314 return copy_view_str(
315 out, out_len, botan_privkey_view_encrypted_pem, key, rng, passphrase, cipher, pbkdf_algo, pbkdf_iter);
316 } else {
317 return BOTAN_FFI_ERROR_BAD_FLAG;
318 }
319}
botan_privkey_view_encrypted_der
int botan_privkey_view_encrypted_der(botan_privkey_t key, botan_rng_t rng, const char *passphrase, const char *cipher_algo, const char *pbkdf_algo, size_t pbkdf_iterations, botan_view_ctx ctx, botan_view_bin_fn view)
Definition ffi_pkey.cpp:321
botan_privkey_view_encrypted_pem
int botan_privkey_view_encrypted_pem(botan_privkey_t key, botan_rng_t rng, const char *passphrase, const char *cipher_algo, const char *pbkdf_algo, size_t pbkdf_iterations, botan_view_ctx ctx, botan_view_str_fn view)
Definition ffi_pkey.cpp:346

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_PRIVKEY_EXPORT_FLAG_DER, BOTAN_PRIVKEY_EXPORT_FLAG_PEM, botan_privkey_view_encrypted_der(), botan_privkey_view_encrypted_pem(), Botan_FFI::copy_view_bin(), and Botan_FFI::copy_view_str().

Referenced by botan_privkey_export_encrypted().

◆ botan_privkey_export_encrypted_pbkdf_msec()

int botan_privkey_export_encrypted_pbkdf_msec ( botan_privkey_t key,
uint8_t out[],
size_t * out_len,
botan_rng_t rng,
const char * passphrase,
uint32_t pbkdf_msec_runtime,
size_t * pbkdf_iterations_out,
const char * cipher_algo,
const char * pbkdf_algo,
uint32_t flags )

Definition at line 224 of file ffi_pkey.cpp.

233 {
234 if(pbkdf_iters_out) {
235 *pbkdf_iters_out = 0;
236 }
237
238 if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_DER) {
239 return copy_view_bin(
240 out, out_len, botan_privkey_view_encrypted_der_timed, key, rng, passphrase, cipher, pbkdf_hash, pbkdf_msec);
241 } else if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_PEM) {
242 return copy_view_str(
243 out, out_len, botan_privkey_view_encrypted_pem_timed, key, rng, passphrase, cipher, pbkdf_hash, pbkdf_msec);
244 } else {
245 return BOTAN_FFI_ERROR_BAD_FLAG;
246 }
247}
botan_privkey_view_encrypted_pem_timed
int botan_privkey_view_encrypted_pem_timed(botan_privkey_t key, botan_rng_t rng, const char *passphrase, const char *cipher_algo, const char *pbkdf_algo, size_t pbkdf_runtime_msec, botan_view_ctx ctx, botan_view_str_fn view)
Definition ffi_pkey.cpp:275
botan_privkey_view_encrypted_der_timed
int botan_privkey_view_encrypted_der_timed(botan_privkey_t key, botan_rng_t rng, const char *passphrase, const char *cipher_algo, const char *pbkdf_algo, size_t pbkdf_runtime_msec, botan_view_ctx ctx, botan_view_bin_fn view)
Definition ffi_pkey.cpp:249

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_PRIVKEY_EXPORT_FLAG_DER, BOTAN_PRIVKEY_EXPORT_FLAG_PEM, botan_privkey_view_encrypted_der_timed(), botan_privkey_view_encrypted_pem_timed(), Botan_FFI::copy_view_bin(), and Botan_FFI::copy_view_str().

◆ botan_privkey_export_pubkey()

int botan_privkey_export_pubkey ( botan_pubkey_t * out,
botan_privkey_t in )

Definition at line 129 of file ffi_pkey.cpp.

129 {
130 return ffi_guard_thunk(__func__, [=]() -> int {
131 auto public_key = safe_get(key_obj).public_key();
132 *pubout = new botan_pubkey_struct(std::move(public_key));
133 return BOTAN_FFI_SUCCESS;
134 });
135}

References BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_privkey_get_field()

int botan_privkey_get_field ( botan_mp_t output,
botan_privkey_t key,
const char * field_name )

Definition at line 198 of file ffi_pkey_algs.cpp.

198 {
199 if(field_name_cstr == nullptr) {
200 return BOTAN_FFI_ERROR_NULL_POINTER;
201 }
202
203 const std::string field_name(field_name_cstr);
204
205 return BOTAN_FFI_VISIT(key, [=](const auto& k) { safe_get(output) = privkey_get_field(k, field_name); });
206}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

Referenced by botan_privkey_dsa_get_x(), botan_privkey_rsa_get_d(), botan_privkey_rsa_get_e(), botan_privkey_rsa_get_n(), botan_privkey_rsa_get_p(), and botan_privkey_rsa_get_q().

◆ botan_privkey_load()

int botan_privkey_load ( botan_privkey_t * key,
botan_rng_t rng,
const uint8_t bits[],
size_t len,
const char * password )

Input currently assumed to be PKCS #8 structure; Set password to NULL to indicate no encryption expected Starting in 2.8.0, the rng parameter is unused and may be set to null

Definition at line 80 of file ffi_pkey.cpp.

81 {
82 BOTAN_UNUSED(rng_obj);
83
84 *key = nullptr;
85
86 return ffi_guard_thunk(__func__, [=]() -> int {
87 Botan::DataSource_Memory src(bits, len);
88
89 std::unique_ptr<Botan::Private_Key> pkcs8;
90
91 if(password == nullptr) {
92 pkcs8 = Botan::PKCS8::load_key(src);
93 } else {
94 pkcs8 = Botan::PKCS8::load_key(src, std::string(password));
95 }
96
97 if(pkcs8) {
98 *key = new botan_privkey_struct(std::move(pkcs8));
99 return BOTAN_FFI_SUCCESS;
100 }
101 return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
102 });
103}
Botan::DataSource_Memory
Definition data_src.h:101
Botan::PKCS8::load_key
std::unique_ptr< Private_Key > load_key(DataSource &source, const std::function< std::string()> &get_pass)
Definition pkcs8.cpp:317

References BOTAN_FFI_ERROR_UNKNOWN_ERROR, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan::PKCS8::load_key().

◆ botan_privkey_load_classic_mceliece()

int botan_privkey_load_classic_mceliece ( botan_privkey_t * key,
const uint8_t privkey[],
size_t key_len,
const char * cmce_mode )

Algorithm specific key operation: Classic McEliece

Definition at line 1333 of file ffi_pkey_algs.cpp.

1336 {
1337#if defined(BOTAN_HAS_CLASSICMCELIECE)
1338 if(key == nullptr || privkey == nullptr || cmce_mode == nullptr) {
1339 return BOTAN_FFI_ERROR_NULL_POINTER;
1340 }
1341
1342 *key = nullptr;
1343
1344 return ffi_guard_thunk(__func__, [=]() -> int {
1345 const auto mode = Botan::Classic_McEliece_Parameter_Set::from_string(cmce_mode);
1346 auto cmce_key = std::make_unique<Botan::Classic_McEliece_PrivateKey>(std::span{privkey, key_len}, mode);
1347 *key = new botan_privkey_struct(std::move(cmce_key));
1348 return BOTAN_FFI_SUCCESS;
1349 });
1350#else
1351 BOTAN_UNUSED(key, privkey, key_len, cmce_mode);
1352 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1353#endif
1354}
Botan::Classic_McEliece_Parameter_Set::from_string
static Classic_McEliece_Parameter_Set from_string(std::string_view param_name)
Get the parameter set for a given parameter set name.
Definition cmce_parameter_set.cpp:16

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan::Classic_McEliece_Parameter_Set::from_string().

◆ botan_privkey_load_dh()

int botan_privkey_load_dh ( botan_privkey_t * key,
botan_mp_t p,
botan_mp_t g,
botan_mp_t x )

Definition at line 547 of file ffi_pkey_algs.cpp.

547 {
548#if defined(BOTAN_HAS_DIFFIE_HELLMAN)
549 if(key == nullptr) {
550 return BOTAN_FFI_ERROR_NULL_POINTER;
551 }
552 *key = nullptr;
553 return ffi_guard_thunk(__func__, [=]() -> int {
554 Botan::DL_Group group(safe_get(p), safe_get(g));
555 auto dh = std::make_unique<Botan::DH_PrivateKey>(group, safe_get(x));
556 *key = new botan_privkey_struct(std::move(dh));
557 return BOTAN_FFI_SUCCESS;
558 });
559#else
560 BOTAN_UNUSED(key, p, g, x);
561 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
562#endif
563}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_privkey_load_dsa()

int botan_privkey_load_dsa ( botan_privkey_t * key,
botan_mp_t p,
botan_mp_t q,
botan_mp_t g,
botan_mp_t x )

Definition at line 348 of file ffi_pkey_algs.cpp.

348 {
349#if defined(BOTAN_HAS_DSA)
350 if(key == nullptr) {
351 return BOTAN_FFI_ERROR_NULL_POINTER;
352 }
353 *key = nullptr;
354
355 return ffi_guard_thunk(__func__, [=]() -> int {
356 Botan::DL_Group group(safe_get(p), safe_get(q), safe_get(g));
357 auto dsa = std::make_unique<Botan::DSA_PrivateKey>(group, safe_get(x));
358 *key = new botan_privkey_struct(std::move(dsa));
359 return BOTAN_FFI_SUCCESS;
360 });
361#else
362 BOTAN_UNUSED(key, p, q, g, x);
363 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
364#endif
365}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_privkey_load_ecdh()

int botan_privkey_load_ecdh ( botan_privkey_t * key,
botan_mp_t scalar,
const char * curve_name )

Definition at line 628 of file ffi_pkey_algs.cpp.

628 {
629#if defined(BOTAN_HAS_ECDH)
630 if(key == nullptr || curve_name == nullptr) {
631 return BOTAN_FFI_ERROR_NULL_POINTER;
632 }
633 *key = nullptr;
634 return ffi_guard_thunk(__func__, [=]() -> int {
635 std::unique_ptr<Botan::ECDH_PrivateKey> p_key;
636 int rc = privkey_load_ec(p_key, safe_get(scalar), curve_name);
637 if(rc == BOTAN_FFI_SUCCESS) {
638 *key = new botan_privkey_struct(std::move(p_key));
639 }
640 return rc;
641 });
642#else
643 BOTAN_UNUSED(key, scalar, curve_name);
644 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
645#endif
646}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_privkey_load_ecdsa()

int botan_privkey_load_ecdsa ( botan_privkey_t * key,
botan_mp_t scalar,
const char * curve_name )

Definition at line 456 of file ffi_pkey_algs.cpp.

456 {
457#if defined(BOTAN_HAS_ECDSA)
458 if(key == nullptr || curve_name == nullptr) {
459 return BOTAN_FFI_ERROR_NULL_POINTER;
460 }
461 *key = nullptr;
462
463 return ffi_guard_thunk(__func__, [=]() -> int {
464 std::unique_ptr<Botan::ECDSA_PrivateKey> p_key;
465 int rc = privkey_load_ec(p_key, safe_get(scalar), curve_name);
466 if(rc == BOTAN_FFI_SUCCESS) {
467 *key = new botan_privkey_struct(std::move(p_key));
468 }
469 return rc;
470 });
471#else
472 BOTAN_UNUSED(key, scalar, curve_name);
473 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
474#endif
475}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_privkey_load_ed25519()

int botan_privkey_load_ed25519 ( botan_privkey_t * key,
const uint8_t privkey[32] )

Definition at line 742 of file ffi_pkey_algs.cpp.

742 {
743#if defined(BOTAN_HAS_ED25519)
744 if(key == nullptr) {
745 return BOTAN_FFI_ERROR_NULL_POINTER;
746 }
747 *key = nullptr;
748 return ffi_guard_thunk(__func__, [=]() -> int {
749 auto ed25519 =
750 std::make_unique<Botan::Ed25519_PrivateKey>(Botan::Ed25519_PrivateKey::from_seed(std::span{privkey, 32}));
751 *key = new botan_privkey_struct(std::move(ed25519));
752 return BOTAN_FFI_SUCCESS;
753 });
754#else
755 BOTAN_UNUSED(key, privkey);
756 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
757#endif
758}
Botan::Ed25519_PrivateKey::from_seed
static Ed25519_PrivateKey from_seed(std::span< const uint8_t > seed)
Definition ed25519_key.cpp:106

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan::Ed25519_PrivateKey::from_seed().

◆ botan_privkey_load_ed448()

int botan_privkey_load_ed448 ( botan_privkey_t * key,
const uint8_t privkey[57] )

Definition at line 820 of file ffi_pkey_algs.cpp.

820 {
821#if defined(BOTAN_HAS_ED448)
822 if(key == nullptr) {
823 return BOTAN_FFI_ERROR_NULL_POINTER;
824 }
825 *key = nullptr;
826 return ffi_guard_thunk(__func__, [=]() -> int {
827 auto ed448 = std::make_unique<Botan::Ed448_PrivateKey>(std::span(privkey, 57));
828 *key = new botan_privkey_struct(std::move(ed448));
829 return BOTAN_FFI_SUCCESS;
830 });
831#else
832 BOTAN_UNUSED(key, privkey);
833 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
834#endif
835}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_privkey_load_elgamal()

int botan_privkey_load_elgamal ( botan_privkey_t * key,
botan_mp_t p,
botan_mp_t g,
botan_mp_t x )

Loads ElGamal private key

Parameters
keyvariable populated with key material
pprime order of a Z_p group
ggroup generator
xprivate key
Precondition
key is NULL on input
Postcondition
function allocates memory and assigns to ‘key’
Returns
0 on success, a negative value on failure

Definition at line 523 of file ffi_pkey_algs.cpp.

523 {
524#if defined(BOTAN_HAS_ELGAMAL)
525 if(key == nullptr) {
526 return BOTAN_FFI_ERROR_NULL_POINTER;
527 }
528 *key = nullptr;
529 return ffi_guard_thunk(__func__, [=]() -> int {
530 Botan::DL_Group group(safe_get(p), safe_get(g));
531 auto elg = std::make_unique<Botan::ElGamal_PrivateKey>(group, safe_get(x));
532 *key = new botan_privkey_struct(std::move(elg));
533 return BOTAN_FFI_SUCCESS;
534 });
535#else
536 BOTAN_UNUSED(key, p, g, x);
537 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
538#endif
539}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_privkey_load_frodokem()

int botan_privkey_load_frodokem ( botan_privkey_t * key,
const uint8_t privkey[],
size_t key_len,
const char * frodo_mode )

Algorithm specific key operation: FrodoKEM

Definition at line 1289 of file ffi_pkey_algs.cpp.

1289 {
1290#if defined(BOTAN_HAS_FRODOKEM)
1291 if(key == nullptr || privkey == nullptr || frodo_mode == nullptr) {
1292 return BOTAN_FFI_ERROR_NULL_POINTER;
1293 }
1294
1295 *key = nullptr;
1296
1297 return ffi_guard_thunk(__func__, [=]() -> int {
1298 const auto mode = Botan::FrodoKEMMode(frodo_mode);
1299 auto frodo_key = std::make_unique<Botan::FrodoKEM_PrivateKey>(std::span{privkey, key_len}, mode);
1300 *key = new botan_privkey_struct(std::move(frodo_key));
1301 return BOTAN_FFI_SUCCESS;
1302 });
1303#else
1304 BOTAN_UNUSED(key, privkey, key_len, frodo_mode);
1305 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1306#endif
1307}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_privkey_load_kyber()

int botan_privkey_load_kyber ( botan_privkey_t * key,
const uint8_t privkey[],
size_t key_len )

Definition at line 1033 of file ffi_pkey_algs.cpp.

1033 {
1034#if defined(BOTAN_HAS_KYBER)
1035 if(key == nullptr) {
1036 return BOTAN_FFI_ERROR_NULL_POINTER;
1037 }
1038 *key = nullptr;
1039
1040 const auto mode = [](size_t len) -> std::optional<Botan::KyberMode> {
1041 if(len == 1632) {
1042 return Botan::KyberMode::Kyber512_R3;
1043 } else if(len == 2400) {
1044 return Botan::KyberMode::Kyber768_R3;
1045 } else if(len == 3168) {
1046 return Botan::KyberMode::Kyber1024_R3;
1047 } else {
1048 return {};
1049 }
1050 }(key_len);
1051
1052 if(mode.has_value()) {
1053 return ffi_guard_thunk(__func__, [=]() -> int {
1054 auto kyber = std::make_unique<Botan::Kyber_PrivateKey>(std::span{privkey, key_len}, *mode);
1055 *key = new botan_privkey_struct(std::move(kyber));
1056 return BOTAN_FFI_SUCCESS;
1057 });
1058 } else {
1059 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1060 }
1061#else
1062 BOTAN_UNUSED(key, key_len, privkey);
1063 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1064#endif
1065}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan::KyberMode::Kyber1024_R3, Botan::KyberMode::Kyber512_R3, and Botan::KyberMode::Kyber768_R3.

◆ botan_privkey_load_ml_dsa()

int botan_privkey_load_ml_dsa ( botan_privkey_t * key,
const uint8_t privkey[],
size_t key_len,
const char * mldsa_mode )

Definition at line 1185 of file ffi_pkey_algs.cpp.

1185 {
1186#if defined(BOTAN_HAS_ML_DSA)
1187 if(key == nullptr || privkey == nullptr || mldsa_mode == nullptr) {
1188 return BOTAN_FFI_ERROR_NULL_POINTER;
1189 }
1190
1191 *key = nullptr;
1192
1193 return ffi_guard_thunk(__func__, [=]() -> int {
1194 auto mode = Botan::ML_DSA_Mode(mldsa_mode);
1195 if(!mode.is_ml_dsa()) {
1196 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1197 }
1198
1199 auto mldsa_key = std::make_unique<Botan::ML_DSA_PrivateKey>(std::span{privkey, key_len}, mode);
1200 *key = new botan_privkey_struct(std::move(mldsa_key));
1201 return BOTAN_FFI_SUCCESS;
1202 });
1203#else
1204 BOTAN_UNUSED(key, key_len, privkey, mldsa_mode);
1205 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1206#endif
1207}
Botan::ML_DSA_Mode
DilithiumMode ML_DSA_Mode
Definition ml_dsa.h:21

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_privkey_load_ml_kem()

int botan_privkey_load_ml_kem ( botan_privkey_t * key,
const uint8_t privkey[],
size_t key_len,
const char * mlkem_mode )

Definition at line 1133 of file ffi_pkey_algs.cpp.

1133 {
1134#if defined(BOTAN_HAS_ML_KEM)
1135 if(key == nullptr || privkey == nullptr || mlkem_mode == nullptr) {
1136 return BOTAN_FFI_ERROR_NULL_POINTER;
1137 }
1138
1139 *key = nullptr;
1140
1141 return ffi_guard_thunk(__func__, [=]() -> int {
1142 auto mode = Botan::ML_KEM_Mode(mlkem_mode);
1143 if(!mode.is_ml_kem()) {
1144 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1145 }
1146
1147 auto mlkem_key = std::make_unique<Botan::ML_KEM_PrivateKey>(std::span{privkey, key_len}, mode);
1148 *key = new botan_privkey_struct(std::move(mlkem_key));
1149 return BOTAN_FFI_SUCCESS;
1150 });
1151#else
1152 BOTAN_UNUSED(key, key_len, privkey, mlkem_mode);
1153 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1154#endif
1155}
Botan::ML_KEM_Mode
KyberMode ML_KEM_Mode
Definition ml_kem.h:21

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_privkey_load_rsa()

int botan_privkey_load_rsa ( botan_privkey_t * key,
botan_mp_t p,
botan_mp_t q,
botan_mp_t e )

Definition at line 220 of file ffi_pkey_algs.cpp.

220 {
221#if defined(BOTAN_HAS_RSA)
222 if(key == nullptr) {
223 return BOTAN_FFI_ERROR_NULL_POINTER;
224 }
225 *key = nullptr;
226
227 return ffi_guard_thunk(__func__, [=]() -> int {
228 auto rsa = std::make_unique<Botan::RSA_PrivateKey>(safe_get(rsa_p), safe_get(rsa_q), safe_get(rsa_e));
229 *key = new botan_privkey_struct(std::move(rsa));
230 return BOTAN_FFI_SUCCESS;
231 });
232#else
233 BOTAN_UNUSED(key, rsa_p, rsa_q, rsa_e);
234 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
235#endif
236}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_privkey_load_rsa_pkcs1()

int botan_privkey_load_rsa_pkcs1 ( botan_privkey_t * key,
const uint8_t bits[],
size_t len )

Definition at line 238 of file ffi_pkey_algs.cpp.

238 {
239#if defined(BOTAN_HAS_RSA)
240 if(key == nullptr || bits == nullptr) {
241 return BOTAN_FFI_ERROR_NULL_POINTER;
242 }
243 *key = nullptr;
244
245 return ffi_guard_thunk(__func__, [=]() -> int {
246 Botan::AlgorithmIdentifier alg_id("RSA", Botan::AlgorithmIdentifier::USE_NULL_PARAM);
247 auto rsa = std::make_unique<Botan::RSA_PrivateKey>(alg_id, std::span{bits, len});
248 *key = new botan_privkey_struct(std::move(rsa));
249 return BOTAN_FFI_SUCCESS;
250 });
251#else
252 BOTAN_UNUSED(key, bits, len);
253 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
254#endif
255}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan::AlgorithmIdentifier::USE_NULL_PARAM.

◆ botan_privkey_load_slh_dsa()

int botan_privkey_load_slh_dsa ( botan_privkey_t * key,
const uint8_t privkey[],
size_t key_len,
const char * slhdsa_mode )

Definition at line 1237 of file ffi_pkey_algs.cpp.

1237 {
1238#if defined(BOTAN_HAS_SLH_DSA_WITH_SHA2) || defined(BOTAN_HAS_SLH_DSA_WITH_SHAKE)
1239 if(key == nullptr || privkey == nullptr || slhdsa_mode == nullptr) {
1240 return BOTAN_FFI_ERROR_NULL_POINTER;
1241 }
1242
1243 *key = nullptr;
1244
1245 return ffi_guard_thunk(__func__, [=]() -> int {
1246 auto mode = Botan::SLH_DSA_Parameters::create(slhdsa_mode);
1247 if(!mode.is_slh_dsa()) {
1248 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1249 }
1250
1251 auto slhdsa_key = std::make_unique<Botan::SLH_DSA_PrivateKey>(std::span{privkey, key_len}, mode);
1252 *key = new botan_privkey_struct(std::move(slhdsa_key));
1253 return BOTAN_FFI_SUCCESS;
1254 });
1255#else
1256 BOTAN_UNUSED(key, key_len, privkey, slhdsa_mode);
1257 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1258#endif
1259}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_privkey_load_sm2()

int botan_privkey_load_sm2 ( botan_privkey_t * key,
botan_mp_t scalar,
const char * curve_name )

Definition at line 707 of file ffi_pkey_algs.cpp.

707 {
708#if defined(BOTAN_HAS_SM2)
709 if(key == nullptr || curve_name == nullptr) {
710 return BOTAN_FFI_ERROR_NULL_POINTER;
711 }
712 *key = nullptr;
713
714 return ffi_guard_thunk(__func__, [=]() -> int {
715 std::unique_ptr<Botan::SM2_PrivateKey> p_key;
716 int rc = privkey_load_ec(p_key, safe_get(scalar), curve_name);
717
718 if(rc == BOTAN_FFI_SUCCESS) {
719 *key = new botan_privkey_struct(std::move(p_key));
720 }
721 return rc;
722 });
723#else
724 BOTAN_UNUSED(key, scalar, curve_name);
725 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
726#endif
727}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

Referenced by botan_privkey_load_sm2_enc().

◆ botan_privkey_load_sm2_enc()

int botan_privkey_load_sm2_enc ( botan_privkey_t * key,
botan_mp_t scalar,
const char * curve_name )

Definition at line 736 of file ffi_pkey_algs.cpp.

736 {
737 return botan_privkey_load_sm2(key, scalar, curve_name);
738}
botan_privkey_load_sm2
int botan_privkey_load_sm2(botan_privkey_t *key, const botan_mp_t scalar, const char *curve_name)
Definition ffi_pkey_algs.cpp:707

References botan_privkey_load_sm2().

◆ botan_privkey_load_x25519()

int botan_privkey_load_x25519 ( botan_privkey_t * key,
const uint8_t privkey[32] )

Definition at line 890 of file ffi_pkey_algs.cpp.

890 {
891#if defined(BOTAN_HAS_X25519)
892 if(key == nullptr) {
893 return BOTAN_FFI_ERROR_NULL_POINTER;
894 }
895 *key = nullptr;
896 return ffi_guard_thunk(__func__, [=]() -> int {
897 auto x25519 = std::make_unique<Botan::X25519_PrivateKey>(std::span{privkey, 32});
898 *key = new botan_privkey_struct(std::move(x25519));
899 return BOTAN_FFI_SUCCESS;
900 });
901#else
902 BOTAN_UNUSED(key, privkey);
903 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
904#endif
905}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_privkey_load_x448()

int botan_privkey_load_x448 ( botan_privkey_t * key,
const uint8_t privkey[56] )

Definition at line 962 of file ffi_pkey_algs.cpp.

962 {
963#if defined(BOTAN_HAS_X448)
964 if(key == nullptr) {
965 return BOTAN_FFI_ERROR_NULL_POINTER;
966 }
967 *key = nullptr;
968 return ffi_guard_thunk(__func__, [=]() -> int {
969 auto x448 = std::make_unique<Botan::X448_PrivateKey>(std::span{privkey, 56});
970 *key = new botan_privkey_struct(std::move(x448));
971 return BOTAN_FFI_SUCCESS;
972 });
973#else
974 BOTAN_UNUSED(key, privkey);
975 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
976#endif
977}
Botan::x448
Point448 x448(const ScalarX448 &k, const Point448 &u)
Multiply a scalar k with a point u.
Definition x448_internal.cpp:48

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_privkey_oid()

int botan_privkey_oid ( botan_asn1_oid_t * oid,
botan_privkey_t key )

Definition at line 384 of file ffi_pkey.cpp.

384 {
385 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
386 if(oid == nullptr) {
387 return BOTAN_FFI_ERROR_NULL_POINTER;
388 }
389
390 auto oid_ptr = std::make_unique<Botan::OID>(k.object_identifier());
391 *oid = new botan_asn1_oid_struct(std::move(oid_ptr));
392
393 return BOTAN_FFI_SUCCESS;
394 });
395}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_privkey_remaining_operations()

int botan_privkey_remaining_operations ( botan_privkey_t key,
uint64_t * out )

Gets information on many operations a (stateful) key has remaining and sets

Parameters
outto that value
Returns
0 on success, a negative value on failure or if the key is not stateful

Definition at line 412 of file ffi_pkey.cpp.

412 {
413 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
414 if(out == nullptr) {
415 return BOTAN_FFI_ERROR_NULL_POINTER;
416 }
417
418 if(auto remaining = k.remaining_operations()) {
419 *out = remaining.value();
420 return BOTAN_FFI_SUCCESS;
421 } else {
422 return BOTAN_FFI_ERROR_NO_VALUE;
423 }
424 });
425}

References BOTAN_FFI_ERROR_NO_VALUE, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_privkey_rsa_get_d()

int botan_privkey_rsa_get_d ( botan_mp_t d,
botan_privkey_t rsa_key )

Definition at line 290 of file ffi_pkey_algs.cpp.

290 {
291 return botan_privkey_get_field(d, key, "d");
292}

References botan_privkey_get_field().

◆ botan_privkey_rsa_get_e()

int botan_privkey_rsa_get_e ( botan_mp_t e,
botan_privkey_t rsa_key )

Definition at line 286 of file ffi_pkey_algs.cpp.

286 {
287 return botan_privkey_get_field(e, key, "e");
288}

References botan_privkey_get_field().

◆ botan_privkey_rsa_get_n()

int botan_privkey_rsa_get_n ( botan_mp_t n,
botan_privkey_t rsa_key )

Definition at line 282 of file ffi_pkey_algs.cpp.

282 {
283 return botan_privkey_get_field(n, key, "n");
284}

References botan_privkey_get_field().

◆ botan_privkey_rsa_get_p()

int botan_privkey_rsa_get_p ( botan_mp_t p,
botan_privkey_t rsa_key )

Definition at line 274 of file ffi_pkey_algs.cpp.

274 {
275 return botan_privkey_get_field(p, key, "p");
276}

References botan_privkey_get_field().

◆ botan_privkey_rsa_get_privkey()

int botan_privkey_rsa_get_privkey ( botan_privkey_t rsa_key,
uint8_t out[],
size_t * out_len,
uint32_t flags )

Definition at line 302 of file ffi_pkey_algs.cpp.

302 {
303#if defined(BOTAN_HAS_RSA)
304 return BOTAN_FFI_VISIT(rsa_key, [=](const auto& k) -> int {
305 if(const Botan::RSA_PrivateKey* rsa = dynamic_cast<const Botan::RSA_PrivateKey*>(&k)) {
306 if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_DER) {
307 return write_vec_output(out, out_len, rsa->private_key_bits());
308 } else if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_PEM) {
309 return write_str_output(out, out_len, Botan::PEM_Code::encode(rsa->private_key_bits(), "RSA PRIVATE KEY"));
310 } else {
311 return BOTAN_FFI_ERROR_BAD_FLAG;
312 }
313 } else {
314 return BOTAN_FFI_ERROR_BAD_PARAMETER;
315 }
316 });
317#else
318 BOTAN_UNUSED(rsa_key, out, out_len, flags);
319 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
320#endif
321}
Botan::RSA_PrivateKey
Definition rsa.h:102
Botan::PEM_Code::encode
std::string encode(const uint8_t der[], size_t length, std::string_view label, size_t width)
Definition pem.cpp:39

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_PRIVKEY_EXPORT_FLAG_DER, BOTAN_PRIVKEY_EXPORT_FLAG_PEM, BOTAN_UNUSED, Botan::PEM_Code::encode(), Botan_FFI::write_str_output(), and Botan_FFI::write_vec_output().

◆ botan_privkey_rsa_get_q()

int botan_privkey_rsa_get_q ( botan_mp_t q,
botan_privkey_t rsa_key )

Definition at line 278 of file ffi_pkey_algs.cpp.

278 {
279 return botan_privkey_get_field(q, key, "q");
280}

References botan_privkey_get_field().

◆ botan_privkey_stateful_operation()

int botan_privkey_stateful_operation ( botan_privkey_t key,
int * out )

Checks whether a key is stateful and sets

Parameters
outto 1 if it is, or 0 if the key is not stateful
Returns
0 on success, a negative value on failure

Definition at line 397 of file ffi_pkey.cpp.

397 {
398 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
399 if(out == nullptr) {
400 return BOTAN_FFI_ERROR_NULL_POINTER;
401 }
402
403 if(k.stateful_operation()) {
404 *out = 1;
405 } else {
406 *out = 0;
407 }
408 return BOTAN_FFI_SUCCESS;
409 });
410}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_privkey_view_der()

int botan_privkey_view_der ( botan_privkey_t key,
botan_view_ctx ctx,
botan_view_bin_fn view )

View the private key's DER encoding

Definition at line 199 of file ffi_pkey.cpp.

199 {
200 return BOTAN_FFI_VISIT(
201 key, [=](const auto& k) -> int { return invoke_view_callback(view, ctx, Botan::PKCS8::BER_encode(k)); });
202}
Botan::PKCS8::BER_encode
std::vector< uint8_t > BER_encode(const Private_Key &key, RandomNumberGenerator &rng, std::string_view pass, std::chrono::milliseconds msec, std::string_view pbe_algo)
Definition pkcs8.cpp:164

References Botan::PKCS8::BER_encode(), BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

Referenced by botan_privkey_export().

◆ botan_privkey_view_encrypted_der()

int botan_privkey_view_encrypted_der ( botan_privkey_t key,
botan_rng_t rng,
const char * passphrase,
const char * cipher_algo,
const char * pbkdf_algo,
size_t pbkdf_iterations,
botan_view_ctx ctx,
botan_view_bin_fn view )

View the encryption of a private key (binary DER encoding)

Set cipher_algo, pbkdf_algo to NULL to use defaults Set pbkdf_iterations to 0 to use defaults

Definition at line 321 of file ffi_pkey.cpp.

328 {
329 if(passphrase == nullptr) {
330 return BOTAN_FFI_ERROR_NULL_POINTER;
331 }
332
333 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
334 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
335
336 const std::string cipher = (maybe_cipher ? maybe_cipher : "");
337 const std::string pbkdf_algo = (maybe_pbkdf_algo ? maybe_pbkdf_algo : "");
338 const size_t pbkdf_iter = (maybe_pbkdf_iterations ? maybe_pbkdf_iterations : 100000);
339
340 auto pkcs8 = Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(k, rng, passphrase, pbkdf_iter, cipher, pbkdf_algo);
341
342 return invoke_view_callback(view, ctx, pkcs8);
343 });
344}
Botan::PKCS8::BER_encode_encrypted_pbkdf_iter
std::vector< uint8_t > BER_encode_encrypted_pbkdf_iter(const Private_Key &key, RandomNumberGenerator &rng, std::string_view pass, size_t pbkdf_iterations, std::string_view cipher, std::string_view pbkdf_hash)
Definition pkcs8.cpp:204

References Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, Botan_FFI::invoke_view_callback(), and Botan_FFI::safe_get().

Referenced by botan_privkey_export_encrypted_pbkdf_iter().

◆ botan_privkey_view_encrypted_der_timed()

int botan_privkey_view_encrypted_der_timed ( botan_privkey_t key,
botan_rng_t rng,
const char * passphrase,
const char * cipher_algo,
const char * pbkdf_algo,
size_t pbkdf_runtime_msec,
botan_view_ctx ctx,
botan_view_bin_fn view )

View the encryption of a private key (binary DER encoding)

Set cipher_algo, pbkdf_algo to NULL to use defaults

Definition at line 249 of file ffi_pkey.cpp.

256 {
257 if(passphrase == nullptr) {
258 return BOTAN_FFI_ERROR_NULL_POINTER;
259 }
260
261 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
262 const std::chrono::milliseconds pbkdf_time(pbkdf_runtime_msec);
263 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
264
265 const std::string cipher = (maybe_cipher ? maybe_cipher : "");
266 const std::string pbkdf_algo = (maybe_pbkdf_algo ? maybe_pbkdf_algo : "");
267
268 auto pkcs8 =
269 Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(k, rng, passphrase, pbkdf_time, nullptr, cipher, pbkdf_algo);
270
271 return invoke_view_callback(view, ctx, pkcs8);
272 });
273}
Botan::PKCS8::BER_encode_encrypted_pbkdf_msec
std::vector< uint8_t > BER_encode_encrypted_pbkdf_msec(const Private_Key &key, RandomNumberGenerator &rng, std::string_view pass, std::chrono::milliseconds pbkdf_msec, size_t *pbkdf_iterations, std::string_view cipher, std::string_view pbkdf_hash)
Definition pkcs8.cpp:247

References Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(), BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, Botan_FFI::invoke_view_callback(), and Botan_FFI::safe_get().

Referenced by botan_privkey_export_encrypted_pbkdf_msec().

◆ botan_privkey_view_encrypted_pem()

int botan_privkey_view_encrypted_pem ( botan_privkey_t key,
botan_rng_t rng,
const char * passphrase,
const char * cipher_algo,
const char * pbkdf_algo,
size_t pbkdf_iterations,
botan_view_ctx ctx,
botan_view_str_fn view )

View the encryption of a private key (PEM encoding)

Set cipher_algo, pbkdf_algo to NULL to use defaults Set pbkdf_iterations to 0 to use defaults

Definition at line 346 of file ffi_pkey.cpp.

353 {
354 if(passphrase == nullptr) {
355 return BOTAN_FFI_ERROR_NULL_POINTER;
356 }
357
358 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
359 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
360
361 const std::string cipher = (maybe_cipher ? maybe_cipher : "");
362 const std::string pbkdf_algo = (maybe_pbkdf_algo ? maybe_pbkdf_algo : "");
363 const size_t pbkdf_iter = (maybe_pbkdf_iterations ? maybe_pbkdf_iterations : 100000);
364
365 auto pkcs8 = Botan::PKCS8::PEM_encode_encrypted_pbkdf_iter(k, rng, passphrase, pbkdf_iter, cipher, pbkdf_algo);
366
367 return invoke_view_callback(view, ctx, pkcs8);
368 });
369}
Botan::PKCS8::PEM_encode_encrypted_pbkdf_iter
std::string PEM_encode_encrypted_pbkdf_iter(const Private_Key &key, RandomNumberGenerator &rng, std::string_view pass, size_t pbkdf_iterations, std::string_view cipher, std::string_view pbkdf_hash)
Definition pkcs8.cpp:234

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, Botan_FFI::invoke_view_callback(), Botan::PKCS8::PEM_encode_encrypted_pbkdf_iter(), and Botan_FFI::safe_get().

Referenced by botan_privkey_export_encrypted_pbkdf_iter().

◆ botan_privkey_view_encrypted_pem_timed()

int botan_privkey_view_encrypted_pem_timed ( botan_privkey_t key,
botan_rng_t rng,
const char * passphrase,
const char * cipher_algo,
const char * pbkdf_algo,
size_t pbkdf_runtime_msec,
botan_view_ctx ctx,
botan_view_str_fn view )

View the encryption of a private key (PEM encoding)

Set cipher_algo, pbkdf_algo to NULL to use defaults

Definition at line 275 of file ffi_pkey.cpp.

282 {
283 if(passphrase == nullptr) {
284 return BOTAN_FFI_ERROR_NULL_POINTER;
285 }
286
287 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
288 const std::chrono::milliseconds pbkdf_time(pbkdf_runtime_msec);
289 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
290
291 const std::string cipher = (maybe_cipher ? maybe_cipher : "");
292 const std::string pbkdf_algo = (maybe_pbkdf_algo ? maybe_pbkdf_algo : "");
293
294 auto pkcs8 =
295 Botan::PKCS8::PEM_encode_encrypted_pbkdf_msec(k, rng, passphrase, pbkdf_time, nullptr, cipher, pbkdf_algo);
296
297 return invoke_view_callback(view, ctx, pkcs8);
298 });
299}
Botan::PKCS8::PEM_encode_encrypted_pbkdf_msec
std::string PEM_encode_encrypted_pbkdf_msec(const Private_Key &key, RandomNumberGenerator &rng, std::string_view pass, std::chrono::milliseconds pbkdf_msec, size_t *pbkdf_iterations, std::string_view cipher, std::string_view pbkdf_hash)
Definition pkcs8.cpp:281

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, Botan_FFI::invoke_view_callback(), Botan::PKCS8::PEM_encode_encrypted_pbkdf_msec(), and Botan_FFI::safe_get().

Referenced by botan_privkey_export_encrypted_pbkdf_msec().

◆ botan_privkey_view_kyber_raw_key()

int botan_privkey_view_kyber_raw_key ( botan_privkey_t key,
botan_view_ctx ctx,
botan_view_bin_fn view )

Definition at line 1099 of file ffi_pkey_algs.cpp.

1099 {
1100#if defined(BOTAN_HAS_KYBER)
1101 return BOTAN_FFI_VISIT(key, [=](const auto& k) -> int {
1102 if(auto kyber = dynamic_cast<const Botan::Kyber_PrivateKey*>(&k)) {
1103 return invoke_view_callback(view, ctx, kyber->raw_private_key_bits());
1104 } else {
1105 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1106 }
1107 });
1108#else
1109 BOTAN_UNUSED(key, ctx, view);
1110 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1111#endif
1112}
Botan::Kyber_PrivateKey
Definition kyber.h:150

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::invoke_view_callback().

◆ botan_privkey_view_pem()

int botan_privkey_view_pem ( botan_privkey_t key,
botan_view_ctx ctx,
botan_view_str_fn view )

View the private key's PEM encoding

Definition at line 204 of file ffi_pkey.cpp.

204 {
205 return BOTAN_FFI_VISIT(
206 key, [=](const auto& k) -> int { return invoke_view_callback(view, ctx, Botan::PKCS8::PEM_encode(k)); });
207}
Botan::PKCS8::PEM_encode
std::string PEM_encode(const Private_Key &key)
Definition pkcs8.cpp:119

References BOTAN_FFI_VISIT, Botan_FFI::invoke_view_callback(), and Botan::PKCS8::PEM_encode().

Referenced by botan_privkey_export().

◆ botan_privkey_view_raw()

int botan_privkey_view_raw ( botan_privkey_t key,
botan_view_ctx ctx,
botan_view_bin_fn view )

View the private key's raw encoding

Definition at line 209 of file ffi_pkey.cpp.

209 {
210 return BOTAN_FFI_VISIT(
211 key, [=](const auto& k) -> int { return invoke_view_callback(view, ctx, k.raw_private_key_bits()); });
212}

References BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

Referenced by botan_privkey_export().

◆ botan_privkey_x25519_get_privkey()

int botan_privkey_x25519_get_privkey ( botan_privkey_t key,
uint8_t output[32] )

Definition at line 924 of file ffi_pkey_algs.cpp.

924 {
925#if defined(BOTAN_HAS_X25519)
926 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
927 if(auto x25519 = dynamic_cast<const Botan::X25519_PrivateKey*>(&k)) {
928 const auto x25519_key = x25519->raw_private_key_bits();
929 if(x25519_key.size() != 32) {
930 return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
931 }
932 Botan::copy_mem(output, x25519_key.data(), x25519_key.size());
933 return BOTAN_FFI_SUCCESS;
934 } else {
935 return BOTAN_FFI_ERROR_BAD_PARAMETER;
936 }
937 });
938#else
939 BOTAN_UNUSED(key, output);
940 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
941#endif
942}
Botan::X25519_PrivateKey
Definition x25519.h:61

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan::copy_mem().

◆ botan_privkey_x448_get_privkey()

int botan_privkey_x448_get_privkey ( botan_privkey_t key,
uint8_t output[56] )

Definition at line 996 of file ffi_pkey_algs.cpp.

996 {
997#if defined(BOTAN_HAS_X448)
998 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
999 if(auto x448 = dynamic_cast<const Botan::X448_PrivateKey*>(&k)) {
1000 const auto x448_key = x448->raw_private_key_bits();
1001 Botan::copy_mem(std::span{output, 56}, x448_key);
1002 return BOTAN_FFI_SUCCESS;
1003 } else {
1004 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1005 }
1006 });
1007#else
1008 BOTAN_UNUSED(key, output);
1009 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1010#endif
1011}
Botan::X448_PrivateKey
A private key for the X448 key agreement scheme according to RFC 7748.
Definition x448.h:69

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan::copy_mem().

◆ botan_pubkey_algo_name()

int botan_pubkey_algo_name ( botan_pubkey_t key,
char out[],
size_t * out_len )

Definition at line 141 of file ffi_pkey.cpp.

141 {
142 return BOTAN_FFI_VISIT(key, [=](const auto& k) { return write_str_output(out, out_len, k.algo_name()); });
143}

References BOTAN_FFI_VISIT, and Botan_FFI::write_str_output().

◆ botan_pubkey_check_key()

int botan_pubkey_check_key ( botan_pubkey_t key,
botan_rng_t rng,
uint32_t flags )

Returns 0 if key is valid, negative if invalid key or some other error

Definition at line 145 of file ffi_pkey.cpp.

145 {
146 const bool strong = (flags & BOTAN_CHECK_KEY_EXPENSIVE_TESTS);
147
148 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
149 return (k.check_key(safe_get(rng), strong) == true) ? 0 : BOTAN_FFI_ERROR_INVALID_INPUT;
150 });
151}

References BOTAN_CHECK_KEY_EXPENSIVE_TESTS, BOTAN_FFI_ERROR_INVALID_INPUT, BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_pubkey_destroy()

int botan_pubkey_destroy ( botan_pubkey_t key)
Returns
0 if success, error if invalid object handle

Definition at line 125 of file ffi_pkey.cpp.

125 {
126 return BOTAN_FFI_CHECKED_DELETE(key);
127}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_pubkey_dsa_get_g()

int botan_pubkey_dsa_get_g ( botan_mp_t d,
botan_pubkey_t key )

Definition at line 398 of file ffi_pkey_algs.cpp.

398 {
399 return botan_pubkey_get_field(g, key, "g");
400}
botan_pubkey_get_field
int botan_pubkey_get_field(botan_mp_t output, botan_pubkey_t key, const char *field_name_cstr)
Definition ffi_pkey_algs.cpp:188

References botan_pubkey_get_field().

◆ botan_pubkey_dsa_get_p()

int botan_pubkey_dsa_get_p ( botan_mp_t p,
botan_pubkey_t key )

Definition at line 390 of file ffi_pkey_algs.cpp.

390 {
391 return botan_pubkey_get_field(p, key, "p");
392}

References botan_pubkey_get_field().

◆ botan_pubkey_dsa_get_q()

int botan_pubkey_dsa_get_q ( botan_mp_t q,
botan_pubkey_t key )

Definition at line 394 of file ffi_pkey_algs.cpp.

394 {
395 return botan_pubkey_get_field(q, key, "q");
396}

References botan_pubkey_get_field().

◆ botan_pubkey_dsa_get_y()

int botan_pubkey_dsa_get_y ( botan_mp_t y,
botan_pubkey_t key )

Definition at line 402 of file ffi_pkey_algs.cpp.

402 {
403 return botan_pubkey_get_field(y, key, "y");
404}

References botan_pubkey_get_field().

◆ botan_pubkey_ecc_key_used_explicit_encoding()

int botan_pubkey_ecc_key_used_explicit_encoding ( botan_pubkey_t key)

Definition at line 412 of file ffi_pkey_algs.cpp.

412 {
413#if defined(BOTAN_HAS_ECC_KEY)
414 return ffi_guard_thunk(__func__, [=]() -> int {
415 const Botan::Public_Key& pub_key = safe_get(key);
416 const Botan::EC_PublicKey* ec_key = dynamic_cast<const Botan::EC_PublicKey*>(&pub_key);
417
418 if(ec_key == nullptr) {
419 return BOTAN_FFI_ERROR_BAD_PARAMETER;
420 }
421
422 return ec_key->domain().used_explicit_encoding() ? 1 : 0;
423 });
424#else
425 BOTAN_UNUSED(key);
426 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
427#endif
428}
Botan::EC_Group::used_explicit_encoding
bool used_explicit_encoding() const
Definition ec_group.h:263
Botan::EC_PublicKey
Definition ecc_key.h:32
Botan::EC_PublicKey::domain
const EC_Group & domain() const
Definition ecc_key.cpp:64
Botan::Public_Key
Definition pk_keys.h:148

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_UNUSED, Botan::EC_PublicKey::domain(), Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), and Botan::EC_Group::used_explicit_encoding().

◆ botan_pubkey_ed25519_get_pubkey()

int botan_pubkey_ed25519_get_pubkey ( botan_pubkey_t key,
uint8_t pubkey[32] )

Definition at line 798 of file ffi_pkey_algs.cpp.

798 {
799#if defined(BOTAN_HAS_ED25519)
800 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
801 if(auto ed = dynamic_cast<const Botan::Ed25519_PublicKey*>(&k)) {
802 const std::vector<uint8_t>& ed_key = ed->get_public_key();
803 if(ed_key.size() != 32) {
804 return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
805 }
806 Botan::copy_mem(output, ed_key.data(), ed_key.size());
807 return BOTAN_FFI_SUCCESS;
808 } else {
809 return BOTAN_FFI_ERROR_BAD_PARAMETER;
810 }
811 });
812#else
813 BOTAN_UNUSED(key, output);
814 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
815#endif
816}
Botan::Ed25519_PublicKey
Definition ed25519.h:17

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan::copy_mem().

◆ botan_pubkey_ed448_get_pubkey()

int botan_pubkey_ed448_get_pubkey ( botan_pubkey_t key,
uint8_t pubkey[57] )

Definition at line 871 of file ffi_pkey_algs.cpp.

871 {
872#if defined(BOTAN_HAS_ED448)
873 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
874 if(auto ed = dynamic_cast<const Botan::Ed448_PublicKey*>(&k)) {
875 const auto ed_key = ed->public_key_bits();
876 Botan::copy_mem(std::span(output, 57), ed_key);
877 return BOTAN_FFI_SUCCESS;
878 } else {
879 return BOTAN_FFI_ERROR_BAD_PARAMETER;
880 }
881 });
882#else
883 BOTAN_UNUSED(key, output);
884 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
885#endif
886}
Botan::Ed448_PublicKey
A public key for Ed448/Ed448ph according to RFC 8032.
Definition ed448.h:27

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan::copy_mem().

◆ botan_pubkey_estimated_strength()

int botan_pubkey_estimated_strength ( botan_pubkey_t key,
size_t * estimate )

Definition at line 427 of file ffi_pkey.cpp.

427 {
428 return BOTAN_FFI_VISIT(key, [=](const auto& k) { *estimate = k.estimated_strength(); });
429}

References BOTAN_FFI_VISIT.

◆ botan_pubkey_export()

int botan_pubkey_export ( botan_pubkey_t key,
uint8_t out[],
size_t * out_len,
uint32_t flags )

Definition at line 160 of file ffi_pkey.cpp.

160 {
161 if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_DER) {
162 return copy_view_bin(out, out_len, botan_pubkey_view_der, key);
163 } else if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_PEM) {
164 return copy_view_str(out, out_len, botan_pubkey_view_pem, key);
165 } else if(flags == BOTAN_PRIVKEY_EXPORT_FLAG_RAW) {
166 return copy_view_bin(out, out_len, botan_pubkey_view_raw, key);
167 } else {
168 return BOTAN_FFI_ERROR_BAD_FLAG;
169 }
170}
botan_pubkey_view_pem
int botan_pubkey_view_pem(botan_pubkey_t key, botan_view_ctx ctx, botan_view_str_fn view)
Definition ffi_pkey.cpp:177
botan_pubkey_view_der
int botan_pubkey_view_der(botan_pubkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
Definition ffi_pkey.cpp:172
botan_pubkey_view_raw
int botan_pubkey_view_raw(botan_pubkey_t key, botan_view_ctx ctx, botan_view_bin_fn view)
Definition ffi_pkey.cpp:182

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_PRIVKEY_EXPORT_FLAG_DER, BOTAN_PRIVKEY_EXPORT_FLAG_PEM, BOTAN_PRIVKEY_EXPORT_FLAG_RAW, botan_pubkey_view_der(), botan_pubkey_view_pem(), botan_pubkey_view_raw(), Botan_FFI::copy_view_bin(), and Botan_FFI::copy_view_str().

◆ botan_pubkey_fingerprint()

int botan_pubkey_fingerprint ( botan_pubkey_t key,
const char * hash,
uint8_t out[],
size_t * out_len )

Definition at line 431 of file ffi_pkey.cpp.

431 {
432 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
433 auto h = Botan::HashFunction::create_or_throw(hash_fn);
434 return write_vec_output(out, out_len, h->process(k.public_key_bits()));
435 });
436}
Botan::HashFunction::create_or_throw
static std::unique_ptr< HashFunction > create_or_throw(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:298

References BOTAN_FFI_VISIT, Botan::HashFunction::create_or_throw(), and Botan_FFI::write_vec_output().

◆ botan_pubkey_get_field()

int botan_pubkey_get_field ( botan_mp_t output,
botan_pubkey_t key,
const char * field_name )

Definition at line 188 of file ffi_pkey_algs.cpp.

188 {
189 if(field_name_cstr == nullptr) {
190 return BOTAN_FFI_ERROR_NULL_POINTER;
191 }
192
193 const std::string field_name(field_name_cstr);
194
195 return BOTAN_FFI_VISIT(key, [=](const auto& k) { safe_get(output) = pubkey_get_field(k, field_name); });
196}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

Referenced by botan_pubkey_dsa_get_g(), botan_pubkey_dsa_get_p(), botan_pubkey_dsa_get_q(), botan_pubkey_dsa_get_y(), botan_pubkey_rsa_get_e(), and botan_pubkey_rsa_get_n().

◆ botan_pubkey_load()

int botan_pubkey_load ( botan_pubkey_t * key,
const uint8_t bits[],
size_t len )

Definition at line 109 of file ffi_pkey.cpp.

109 {
110 *key = nullptr;
111
112 return ffi_guard_thunk(__func__, [=]() -> int {
113 Botan::DataSource_Memory src(bits, bits_len);
114 std::unique_ptr<Botan::Public_Key> pubkey(Botan::X509::load_key(src));
115
116 if(pubkey == nullptr) {
117 return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
118 }
119
120 *key = new botan_pubkey_struct(std::move(pubkey));
121 return BOTAN_FFI_SUCCESS;
122 });
123}
Botan::X509::load_key
std::unique_ptr< Public_Key > load_key(DataSource &source)
Definition x509_key.cpp:28

References BOTAN_FFI_ERROR_UNKNOWN_ERROR, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan::X509::load_key().

◆ botan_pubkey_load_classic_mceliece()

int botan_pubkey_load_classic_mceliece ( botan_pubkey_t * key,
const uint8_t pubkey[],
size_t key_len,
const char * cmce_mode )

Definition at line 1356 of file ffi_pkey_algs.cpp.

1359 {
1360#if defined(BOTAN_HAS_CLASSICMCELIECE)
1361 if(key == nullptr || pubkey == nullptr || cmce_mode == nullptr) {
1362 return BOTAN_FFI_ERROR_NULL_POINTER;
1363 }
1364
1365 *key = nullptr;
1366
1367 return ffi_guard_thunk(__func__, [=]() -> int {
1368 const auto mode = Botan::Classic_McEliece_Parameter_Set::from_string(cmce_mode);
1369 auto cmce_key = std::make_unique<Botan::Classic_McEliece_PublicKey>(std::span{pubkey, key_len}, mode);
1370 *key = new botan_pubkey_struct(std::move(cmce_key));
1371 return BOTAN_FFI_SUCCESS;
1372 });
1373#else
1374 BOTAN_UNUSED(key, pubkey, key_len, cmce_mode);
1375 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1376#endif
1377}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan::Classic_McEliece_Parameter_Set::from_string().

◆ botan_pubkey_load_dh()

int botan_pubkey_load_dh ( botan_pubkey_t * key,
botan_mp_t p,
botan_mp_t g,
botan_mp_t y )

Loads Diffie Hellman public key

Parameters
keyvariable populated with key material
pprime order of a Z_p group
ggroup generator
ypublic key
Precondition
key is NULL on input
Postcondition
function allocates memory and assigns to ‘key’
Returns
0 on success, a negative value on failure

Definition at line 565 of file ffi_pkey_algs.cpp.

565 {
566#if defined(BOTAN_HAS_DIFFIE_HELLMAN)
567 if(key == nullptr) {
568 return BOTAN_FFI_ERROR_NULL_POINTER;
569 }
570 *key = nullptr;
571 return ffi_guard_thunk(__func__, [=]() -> int {
572 Botan::DL_Group group(safe_get(p), safe_get(g));
573 auto dh = std::make_unique<Botan::DH_PublicKey>(group, safe_get(y));
574 *key = new botan_pubkey_struct(std::move(dh));
575 return BOTAN_FFI_SUCCESS;
576 });
577#else
578 BOTAN_UNUSED(key, p, g, y);
579 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
580#endif
581}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_pubkey_load_dsa()

int botan_pubkey_load_dsa ( botan_pubkey_t * key,
botan_mp_t p,
botan_mp_t q,
botan_mp_t g,
botan_mp_t y )

Definition at line 367 of file ffi_pkey_algs.cpp.

367 {
368#if defined(BOTAN_HAS_DSA)
369 if(key == nullptr) {
370 return BOTAN_FFI_ERROR_NULL_POINTER;
371 }
372 *key = nullptr;
373
374 return ffi_guard_thunk(__func__, [=]() -> int {
375 Botan::DL_Group group(safe_get(p), safe_get(q), safe_get(g));
376 auto dsa = std::make_unique<Botan::DSA_PublicKey>(group, safe_get(y));
377 *key = new botan_pubkey_struct(std::move(dsa));
378 return BOTAN_FFI_SUCCESS;
379 });
380#else
381 BOTAN_UNUSED(key, p, q, g, y);
382 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
383#endif
384}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_pubkey_load_ecdh()

int botan_pubkey_load_ecdh ( botan_pubkey_t * key,
botan_mp_t public_x,
botan_mp_t public_y,
const char * curve_name )

Definition at line 604 of file ffi_pkey_algs.cpp.

607 {
608#if defined(BOTAN_HAS_ECDH)
609 if(key == nullptr || curve_name == nullptr) {
610 return BOTAN_FFI_ERROR_NULL_POINTER;
611 }
612 *key = nullptr;
613 return ffi_guard_thunk(__func__, [=]() -> int {
614 std::unique_ptr<Botan::ECDH_PublicKey> p_key;
615 int rc = pubkey_load_ec(p_key, safe_get(public_x), safe_get(public_y), curve_name);
616
617 if(rc == BOTAN_FFI_SUCCESS) {
618 *key = new botan_pubkey_struct(std::move(p_key));
619 }
620 return rc;
621 });
622#else
623 BOTAN_UNUSED(key, public_x, public_y, curve_name);
624 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
625#endif
626}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_pubkey_load_ecdsa()

int botan_pubkey_load_ecdsa ( botan_pubkey_t * key,
botan_mp_t public_x,
botan_mp_t public_y,
const char * curve_name )

Definition at line 430 of file ffi_pkey_algs.cpp.

433 {
434#if defined(BOTAN_HAS_ECDSA)
435 if(key == nullptr || curve_name == nullptr) {
436 return BOTAN_FFI_ERROR_NULL_POINTER;
437 }
438 *key = nullptr;
439
440 return ffi_guard_thunk(__func__, [=]() -> int {
441 std::unique_ptr<Botan::ECDSA_PublicKey> p_key;
442
443 int rc = pubkey_load_ec(p_key, safe_get(public_x), safe_get(public_y), curve_name);
444 if(rc == BOTAN_FFI_SUCCESS) {
445 *key = new botan_pubkey_struct(std::move(p_key));
446 }
447
448 return rc;
449 });
450#else
451 BOTAN_UNUSED(key, public_x, public_y, curve_name);
452 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
453#endif
454}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_pubkey_load_ed25519()

int botan_pubkey_load_ed25519 ( botan_pubkey_t * key,
const uint8_t pubkey[32] )

Definition at line 760 of file ffi_pkey_algs.cpp.

760 {
761#if defined(BOTAN_HAS_ED25519)
762 if(key == nullptr) {
763 return BOTAN_FFI_ERROR_NULL_POINTER;
764 }
765 *key = nullptr;
766 return ffi_guard_thunk(__func__, [=]() -> int {
767 const std::vector<uint8_t> pubkey_vec(pubkey, pubkey + 32);
768 auto ed25519 = std::make_unique<Botan::Ed25519_PublicKey>(pubkey_vec);
769 *key = new botan_pubkey_struct(std::move(ed25519));
770 return BOTAN_FFI_SUCCESS;
771 });
772#else
773 BOTAN_UNUSED(key, pubkey);
774 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
775#endif
776}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_pubkey_load_ed448()

int botan_pubkey_load_ed448 ( botan_pubkey_t * key,
const uint8_t pubkey[57] )

Definition at line 837 of file ffi_pkey_algs.cpp.

837 {
838#if defined(BOTAN_HAS_ED448)
839 if(key == nullptr) {
840 return BOTAN_FFI_ERROR_NULL_POINTER;
841 }
842 *key = nullptr;
843 return ffi_guard_thunk(__func__, [=]() -> int {
844 auto ed448 = std::make_unique<Botan::Ed448_PublicKey>(std::span(pubkey, 57));
845 *key = new botan_pubkey_struct(std::move(ed448));
846 return BOTAN_FFI_SUCCESS;
847 });
848#else
849 BOTAN_UNUSED(key, pubkey);
850 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
851#endif
852}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_pubkey_load_elgamal()

int botan_pubkey_load_elgamal ( botan_pubkey_t * key,
botan_mp_t p,
botan_mp_t g,
botan_mp_t y )

Loads ElGamal public key

Parameters
keyvariable populated with key material
pprime order of a Z_p group
ggroup generator
ypublic key
Precondition
key is NULL on input
Postcondition
function allocates memory and assigns to ‘key’
Returns
0 on success, a negative value on failure

Definition at line 505 of file ffi_pkey_algs.cpp.

505 {
506#if defined(BOTAN_HAS_ELGAMAL)
507 if(key == nullptr) {
508 return BOTAN_FFI_ERROR_NULL_POINTER;
509 }
510 *key = nullptr;
511 return ffi_guard_thunk(__func__, [=]() -> int {
512 Botan::DL_Group group(safe_get(p), safe_get(g));
513 auto elg = std::make_unique<Botan::ElGamal_PublicKey>(group, safe_get(y));
514 *key = new botan_pubkey_struct(std::move(elg));
515 return BOTAN_FFI_SUCCESS;
516 });
517#else
518 BOTAN_UNUSED(key, p, g, y);
519 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
520#endif
521}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_pubkey_load_frodokem()

int botan_pubkey_load_frodokem ( botan_pubkey_t * key,
const uint8_t pubkey[],
size_t key_len,
const char * frodo_mode )

Definition at line 1309 of file ffi_pkey_algs.cpp.

1309 {
1310#if defined(BOTAN_HAS_FRODOKEM)
1311 if(key == nullptr || pubkey == nullptr || frodo_mode == nullptr) {
1312 return BOTAN_FFI_ERROR_NULL_POINTER;
1313 }
1314
1315 *key = nullptr;
1316
1317 return ffi_guard_thunk(__func__, [=]() -> int {
1318 const auto mode = Botan::FrodoKEMMode(frodo_mode);
1319 auto frodo_key = std::make_unique<Botan::FrodoKEM_PublicKey>(std::span{pubkey, key_len}, mode);
1320 *key = new botan_pubkey_struct(std::move(frodo_key));
1321 return BOTAN_FFI_SUCCESS;
1322 });
1323#else
1324 BOTAN_UNUSED(key, pubkey, key_len, frodo_mode);
1325 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1326#endif
1327}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_pubkey_load_kyber()

int botan_pubkey_load_kyber ( botan_pubkey_t * key,
const uint8_t pubkey[],
size_t key_len )

Definition at line 1067 of file ffi_pkey_algs.cpp.

1067 {
1068#if defined(BOTAN_HAS_KYBER)
1069 if(key == nullptr) {
1070 return BOTAN_FFI_ERROR_NULL_POINTER;
1071 }
1072 *key = nullptr;
1073
1074 const auto mode = [](size_t len) -> std::optional<Botan::KyberMode> {
1075 if(len == 800) {
1076 return Botan::KyberMode::Kyber512_R3;
1077 } else if(len == 1184) {
1078 return Botan::KyberMode::Kyber768_R3;
1079 } else if(len == 1568) {
1080 return Botan::KyberMode::Kyber1024_R3;
1081 } else {
1082 return {};
1083 }
1084 }(key_len);
1085
1086 if(mode.has_value()) {
1087 auto kyber = std::make_unique<Botan::Kyber_PublicKey>(std::span{pubkey, key_len}, *mode);
1088 *key = new botan_pubkey_struct(std::move(kyber));
1089 return BOTAN_FFI_SUCCESS;
1090 } else {
1091 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1092 }
1093#else
1094 BOTAN_UNUSED(key, pubkey, key_len);
1095 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1096#endif
1097}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan::KyberMode::Kyber1024_R3, Botan::KyberMode::Kyber512_R3, and Botan::KyberMode::Kyber768_R3.

◆ botan_pubkey_load_ml_dsa()

int botan_pubkey_load_ml_dsa ( botan_pubkey_t * key,
const uint8_t pubkey[],
size_t key_len,
const char * mldsa_mode )

Definition at line 1209 of file ffi_pkey_algs.cpp.

1209 {
1210#if defined(BOTAN_HAS_ML_DSA)
1211 if(key == nullptr || pubkey == nullptr || mldsa_mode == nullptr) {
1212 return BOTAN_FFI_ERROR_NULL_POINTER;
1213 }
1214
1215 *key = nullptr;
1216
1217 return ffi_guard_thunk(__func__, [=]() -> int {
1218 auto mode = Botan::ML_DSA_Mode(mldsa_mode);
1219 if(!mode.is_ml_dsa()) {
1220 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1221 }
1222
1223 auto mldsa_key = std::make_unique<Botan::ML_DSA_PublicKey>(std::span{pubkey, key_len}, mode);
1224 *key = new botan_pubkey_struct(std::move(mldsa_key));
1225 return BOTAN_FFI_SUCCESS;
1226 });
1227#else
1228 BOTAN_UNUSED(key, key_len, pubkey, mldsa_mode);
1229 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1230#endif
1231}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_pubkey_load_ml_kem()

int botan_pubkey_load_ml_kem ( botan_pubkey_t * key,
const uint8_t pubkey[],
size_t key_len,
const char * mlkem_mode )

Definition at line 1157 of file ffi_pkey_algs.cpp.

1157 {
1158#if defined(BOTAN_HAS_ML_KEM)
1159 if(key == nullptr || pubkey == nullptr || mlkem_mode == nullptr) {
1160 return BOTAN_FFI_ERROR_NULL_POINTER;
1161 }
1162
1163 *key = nullptr;
1164
1165 return ffi_guard_thunk(__func__, [=]() -> int {
1166 auto mode = Botan::ML_KEM_Mode(mlkem_mode);
1167 if(!mode.is_ml_kem()) {
1168 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1169 }
1170
1171 auto mlkem_key = std::make_unique<Botan::ML_KEM_PublicKey>(std::span{pubkey, key_len}, mode.mode());
1172 *key = new botan_pubkey_struct(std::move(mlkem_key));
1173 return BOTAN_FFI_SUCCESS;
1174 });
1175#else
1176 BOTAN_UNUSED(key, key_len, pubkey, mlkem_mode);
1177 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1178#endif
1179}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_pubkey_load_rsa()

int botan_pubkey_load_rsa ( botan_pubkey_t * key,
botan_mp_t n,
botan_mp_t e )

Definition at line 257 of file ffi_pkey_algs.cpp.

257 {
258#if defined(BOTAN_HAS_RSA)
259 if(key == nullptr) {
260 return BOTAN_FFI_ERROR_NULL_POINTER;
261 }
262 *key = nullptr;
263 return ffi_guard_thunk(__func__, [=]() -> int {
264 auto rsa = std::make_unique<Botan::RSA_PublicKey>(safe_get(n), safe_get(e));
265 *key = new botan_pubkey_struct(std::move(rsa));
266 return BOTAN_FFI_SUCCESS;
267 });
268#else
269 BOTAN_UNUSED(key, n, e);
270 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
271#endif
272}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_pubkey_load_slh_dsa()

int botan_pubkey_load_slh_dsa ( botan_pubkey_t * key,
const uint8_t pubkey[],
size_t key_len,
const char * slhdsa_mode )

Definition at line 1261 of file ffi_pkey_algs.cpp.

1261 {
1262#if defined(BOTAN_HAS_SLH_DSA_WITH_SHA2) || defined(BOTAN_HAS_SLH_DSA_WITH_SHAKE)
1263 if(key == nullptr || pubkey == nullptr || slhdsa_mode == nullptr) {
1264 return BOTAN_FFI_ERROR_NULL_POINTER;
1265 }
1266
1267 *key = nullptr;
1268
1269 return ffi_guard_thunk(__func__, [=]() -> int {
1270 auto mode = Botan::SLH_DSA_Parameters::create(slhdsa_mode);
1271 if(!mode.is_slh_dsa()) {
1272 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1273 }
1274
1275 auto mldsa_key = std::make_unique<Botan::SLH_DSA_PublicKey>(std::span{pubkey, key_len}, mode);
1276 *key = new botan_pubkey_struct(std::move(mldsa_key));
1277 return BOTAN_FFI_SUCCESS;
1278 });
1279#else
1280 BOTAN_UNUSED(key, key_len, pubkey, slhdsa_mode);
1281 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1282#endif
1283}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_pubkey_load_sm2()

int botan_pubkey_load_sm2 ( botan_pubkey_t * key,
botan_mp_t public_x,
botan_mp_t public_y,
const char * curve_name )

Definition at line 683 of file ffi_pkey_algs.cpp.

686 {
687#if defined(BOTAN_HAS_SM2)
688 if(key == nullptr || curve_name == nullptr) {
689 return BOTAN_FFI_ERROR_NULL_POINTER;
690 }
691 *key = nullptr;
692
693 return ffi_guard_thunk(__func__, [=]() -> int {
694 std::unique_ptr<Botan::SM2_PublicKey> p_key;
695 if(!pubkey_load_ec(p_key, safe_get(public_x), safe_get(public_y), curve_name)) {
696 *key = new botan_pubkey_struct(std::move(p_key));
697 return BOTAN_FFI_SUCCESS;
698 }
699 return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
700 });
701#else
702 BOTAN_UNUSED(key, public_x, public_y, curve_name);
703 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
704#endif
705}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_ERROR_UNKNOWN_ERROR, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

Referenced by botan_pubkey_load_sm2_enc().

◆ botan_pubkey_load_sm2_enc()

int botan_pubkey_load_sm2_enc ( botan_pubkey_t * key,
botan_mp_t public_x,
botan_mp_t public_y,
const char * curve_name )

Definition at line 729 of file ffi_pkey_algs.cpp.

732 {
733 return botan_pubkey_load_sm2(key, public_x, public_y, curve_name);
734}
botan_pubkey_load_sm2
int botan_pubkey_load_sm2(botan_pubkey_t *key, const botan_mp_t public_x, const botan_mp_t public_y, const char *curve_name)
Definition ffi_pkey_algs.cpp:683

References botan_pubkey_load_sm2().

◆ botan_pubkey_load_x25519()

int botan_pubkey_load_x25519 ( botan_pubkey_t * key,
const uint8_t pubkey[32] )

Definition at line 907 of file ffi_pkey_algs.cpp.

907 {
908#if defined(BOTAN_HAS_X25519)
909 if(key == nullptr) {
910 return BOTAN_FFI_ERROR_NULL_POINTER;
911 }
912 *key = nullptr;
913 return ffi_guard_thunk(__func__, [=]() -> int {
914 auto x25519 = std::make_unique<Botan::X25519_PublicKey>(std::span{pubkey, 32});
915 *key = new botan_pubkey_struct(std::move(x25519));
916 return BOTAN_FFI_SUCCESS;
917 });
918#else
919 BOTAN_UNUSED(key, pubkey);
920 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
921#endif
922}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_pubkey_load_x448()

int botan_pubkey_load_x448 ( botan_pubkey_t * key,
const uint8_t pubkey[56] )

Definition at line 979 of file ffi_pkey_algs.cpp.

979 {
980#if defined(BOTAN_HAS_X448)
981 if(key == nullptr) {
982 return BOTAN_FFI_ERROR_NULL_POINTER;
983 }
984 *key = nullptr;
985 return ffi_guard_thunk(__func__, [=]() -> int {
986 auto x448 = std::make_unique<Botan::X448_PublicKey>(std::span{pubkey, 56});
987 *key = new botan_pubkey_struct(std::move(x448));
988 return BOTAN_FFI_SUCCESS;
989 });
990#else
991 BOTAN_UNUSED(key, pubkey);
992 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
993#endif
994}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_pubkey_oid()

int botan_pubkey_oid ( botan_asn1_oid_t * oid,
botan_pubkey_t key )

Definition at line 371 of file ffi_pkey.cpp.

371 {
372 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
373 if(oid == nullptr) {
374 return BOTAN_FFI_ERROR_NULL_POINTER;
375 }
376
377 auto oid_ptr = std::make_unique<Botan::OID>(k.object_identifier());
378 *oid = new botan_asn1_oid_struct(std::move(oid_ptr));
379
380 return BOTAN_FFI_SUCCESS;
381 });
382}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and BOTAN_FFI_VISIT.

◆ botan_pubkey_rsa_get_e()

int botan_pubkey_rsa_get_e ( botan_mp_t e,
botan_pubkey_t rsa_key )

Definition at line 294 of file ffi_pkey_algs.cpp.

294 {
295 return botan_pubkey_get_field(e, key, "e");
296}

References botan_pubkey_get_field().

◆ botan_pubkey_rsa_get_n()

int botan_pubkey_rsa_get_n ( botan_mp_t n,
botan_pubkey_t rsa_key )

Definition at line 298 of file ffi_pkey_algs.cpp.

298 {
299 return botan_pubkey_get_field(n, key, "n");
300}

References botan_pubkey_get_field().

◆ botan_pubkey_sm2_compute_za()

int botan_pubkey_sm2_compute_za ( uint8_t out[],
size_t * out_len,
const char * ident,
const char * hash_algo,
botan_pubkey_t key )

Definition at line 650 of file ffi_pkey_algs.cpp.

651 {
652 if(out == nullptr || out_len == nullptr || ident == nullptr || hash_algo == nullptr || key == nullptr) {
653 return BOTAN_FFI_ERROR_NULL_POINTER;
654 }
655
656#if defined(BOTAN_HAS_SM2)
657 return ffi_guard_thunk(__func__, [=]() -> int {
658 const Botan::Public_Key& pub_key = safe_get(key);
659 const Botan::EC_PublicKey* ec_key = dynamic_cast<const Botan::EC_PublicKey*>(&pub_key);
660
661 if(ec_key == nullptr) {
662 return BOTAN_FFI_ERROR_BAD_PARAMETER;
663 }
664
665 if(ec_key->algo_name() != "SM2") {
666 return BOTAN_FFI_ERROR_BAD_PARAMETER;
667 }
668
669 const std::string ident_str(ident);
670 std::unique_ptr<Botan::HashFunction> hash = Botan::HashFunction::create_or_throw(hash_algo);
671
672 const auto& pt = ec_key->_public_ec_point();
673
674 const auto za = Botan::sm2_compute_za(*hash, ident_str, ec_key->domain(), pt);
675
676 return write_vec_output(out, out_len, za);
677 });
678#else
679 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
680#endif
681}
Botan::Asymmetric_Key::algo_name
virtual std::string algo_name() const =0
Botan::EC_PublicKey::_public_ec_point
const EC_AffinePoint & _public_ec_point() const
Definition ecc_key.cpp:76
Botan::sm2_compute_za
std::vector< uint8_t > sm2_compute_za(HashFunction &hash, std::string_view user_id, const EC_Group &group, const EC_AffinePoint &pubkey)
Definition sm2.cpp:68

References Botan::EC_PublicKey::_public_ec_point(), Botan::Asymmetric_Key::algo_name(), BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, Botan::HashFunction::create_or_throw(), Botan::EC_PublicKey::domain(), Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), Botan::sm2_compute_za(), and Botan_FFI::write_vec_output().

◆ botan_pubkey_view_der()

int botan_pubkey_view_der ( botan_pubkey_t key,
botan_view_ctx ctx,
botan_view_bin_fn view )

View the public key's DER encoding

Definition at line 172 of file ffi_pkey.cpp.

172 {
173 return BOTAN_FFI_VISIT(
174 key, [=](const auto& k) -> int { return invoke_view_callback(view, ctx, k.subject_public_key()); });
175}

References BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

Referenced by botan_pubkey_export().

◆ botan_pubkey_view_ec_public_point()

int botan_pubkey_view_ec_public_point ( botan_pubkey_t key,
botan_view_ctx ctx,
botan_view_bin_fn view )

View the uncompressed public point associated with the key

Definition at line 1379 of file ffi_pkey_algs.cpp.

1379 {
1380#if defined(BOTAN_HAS_ECC_PUBLIC_KEY_CRYPTO)
1381 return BOTAN_FFI_VISIT(key, [=](const auto& k) -> int {
1382 if(auto ecc = dynamic_cast<const Botan::EC_PublicKey*>(&k)) {
1383 auto pt = ecc->_public_ec_point().serialize_uncompressed();
1384 return invoke_view_callback(view, ctx, pt);
1385 } else {
1386 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1387 }
1388 });
1389#else
1390 BOTAN_UNUSED(key, view, ctx);
1391 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1392#endif
1393}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::invoke_view_callback().

◆ botan_pubkey_view_kyber_raw_key()

int botan_pubkey_view_kyber_raw_key ( botan_pubkey_t key,
botan_view_ctx ctx,
botan_view_bin_fn view )

Definition at line 1114 of file ffi_pkey_algs.cpp.

1114 {
1115#if defined(BOTAN_HAS_KYBER)
1116 return BOTAN_FFI_VISIT(key, [=](const auto& k) -> int {
1117 if(auto kyber = dynamic_cast<const Botan::Kyber_PublicKey*>(&k)) {
1118 return invoke_view_callback(view, ctx, kyber->public_key_bits());
1119 } else {
1120 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1121 }
1122 });
1123#else
1124 BOTAN_UNUSED(key, ctx, view);
1125 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1126#endif
1127}
Botan::Kyber_PublicKey
Definition kyber.h:94

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::invoke_view_callback().

◆ botan_pubkey_view_pem()

int botan_pubkey_view_pem ( botan_pubkey_t key,
botan_view_ctx ctx,
botan_view_str_fn view )

View the public key's PEM encoding

Definition at line 177 of file ffi_pkey.cpp.

177 {
178 return BOTAN_FFI_VISIT(
179 key, [=](const auto& k) -> int { return invoke_view_callback(view, ctx, Botan::X509::PEM_encode(k)); });
180}
Botan::X509::PEM_encode
std::string PEM_encode(const Public_Key &key)
Definition x509_key.cpp:21

References BOTAN_FFI_VISIT, Botan_FFI::invoke_view_callback(), and Botan::X509::PEM_encode().

Referenced by botan_pubkey_export().

◆ botan_pubkey_view_raw()

int botan_pubkey_view_raw ( botan_pubkey_t key,
botan_view_ctx ctx,
botan_view_bin_fn view )

View the public key's raw encoding

Definition at line 182 of file ffi_pkey.cpp.

182 {
183 return BOTAN_FFI_VISIT(
184 key, [=](const auto& k) -> int { return invoke_view_callback(view, ctx, k.raw_public_key_bits()); });
185}

References BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

Referenced by botan_pubkey_export().

◆ botan_pubkey_x25519_get_pubkey()

int botan_pubkey_x25519_get_pubkey ( botan_pubkey_t key,
uint8_t pubkey[32] )

Definition at line 944 of file ffi_pkey_algs.cpp.

944 {
945#if defined(BOTAN_HAS_X25519)
946 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
947 if(auto x25519 = dynamic_cast<const Botan::X25519_PublicKey*>(&k)) {
948 Botan::copy_mem(std::span{output, 32}, x25519->raw_public_key_bits());
949 return BOTAN_FFI_SUCCESS;
950 } else {
951 return BOTAN_FFI_ERROR_BAD_PARAMETER;
952 }
953 });
954#else
955 BOTAN_UNUSED(key, output);
956 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
957#endif
958}
Botan::X25519_PublicKey
Definition x25519.h:14

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan::copy_mem().

◆ botan_pubkey_x448_get_pubkey()

int botan_pubkey_x448_get_pubkey ( botan_pubkey_t key,
uint8_t pubkey[56] )

Definition at line 1013 of file ffi_pkey_algs.cpp.

1013 {
1014#if defined(BOTAN_HAS_X448)
1015 return BOTAN_FFI_VISIT(key, [=](const auto& k) {
1016 if(auto x448 = dynamic_cast<const Botan::X448_PublicKey*>(&k)) {
1017 Botan::copy_mem(std::span{output, 56}, x448->raw_public_key_bits());
1018 return BOTAN_FFI_SUCCESS;
1019 } else {
1020 return BOTAN_FFI_ERROR_BAD_PARAMETER;
1021 }
1022 });
1023#else
1024 BOTAN_UNUSED(key, output);
1025 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
1026#endif
1027}
Botan::X448_PublicKey
A public key for the X448 key agreement scheme according to RFC 7748.
Definition x448.h:19

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan::copy_mem().

◆ botan_pwdhash()

int botan_pwdhash ( const char * algo,
size_t param1,
size_t param2,
size_t param3,
uint8_t out[],
size_t out_len,
const char * passphrase,
size_t passphrase_len,
const uint8_t salt[],
size_t salt_len )

Definition at line 53 of file ffi_kdf.cpp.

62 {
63 if(algo == nullptr || password == nullptr) {
64 return BOTAN_FFI_ERROR_NULL_POINTER;
65 }
66
67 if(password_len == 0) {
68 password_len = std::strlen(password);
69 }
70
71 return ffi_guard_thunk(__func__, [=]() -> int {
72 auto pwdhash_fam = Botan::PasswordHashFamily::create(algo);
73
74 if(!pwdhash_fam) {
75 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
76 }
77
78 auto pwdhash = pwdhash_fam->from_params(param1, param2, param3);
79
80 pwdhash->derive_key(out, out_len, password, password_len, salt, salt_len);
81
82 return BOTAN_FFI_SUCCESS;
83 });
84}
Botan::PasswordHashFamily::create
static std::unique_ptr< PasswordHashFamily > create(std::string_view algo_spec, std::string_view provider="")
Definition pwdhash.cpp:54

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::PasswordHashFamily::create(), and Botan_FFI::ffi_guard_thunk().

Referenced by botan_pbkdf(), and botan_scrypt().

◆ botan_pwdhash_timed()

int botan_pwdhash_timed ( const char * algo,
uint32_t msec,
size_t * param1,
size_t * param2,
size_t * param3,
uint8_t out[],
size_t out_len,
const char * passphrase,
size_t passphrase_len,
const uint8_t salt[],
size_t salt_len )

Definition at line 86 of file ffi_kdf.cpp.

96 {
97 if(algo == nullptr || password == nullptr) {
98 return BOTAN_FFI_ERROR_NULL_POINTER;
99 }
100
101 if(password_len == 0) {
102 password_len = std::strlen(password);
103 }
104
105 return ffi_guard_thunk(__func__, [=]() -> int {
106 auto pwdhash_fam = Botan::PasswordHashFamily::create(algo);
107
108 if(!pwdhash_fam) {
109 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
110 }
111
112 auto pwdhash = pwdhash_fam->tune(out_len, std::chrono::milliseconds(msec));
113
114 if(param1) {
115 *param1 = pwdhash->iterations();
116 }
117 if(param2) {
118 *param2 = pwdhash->parallelism();
119 }
120 if(param3) {
121 *param3 = pwdhash->memory_param();
122 }
123
124 pwdhash->derive_key(out, out_len, password, password_len, salt, salt_len);
125
126 return BOTAN_FFI_SUCCESS;
127 });
128}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::PasswordHashFamily::create(), and Botan_FFI::ffi_guard_thunk().

Referenced by botan_pbkdf_timed().

◆ botan_rng_add_entropy()

int botan_rng_add_entropy ( botan_rng_t rng,
const uint8_t * entropy,
size_t entropy_len )

Add some seed material to a random number generator

Parameters
rngrng object
entropythe data to add
entropy_lenlength of entropy buffer
Returns
0 on success, a negative value on failure

Definition at line 181 of file ffi_rng.cpp.

181 {
182 return BOTAN_FFI_VISIT(rng, [=](auto& r) { r.add_entropy(input, len); });
183}

References BOTAN_FFI_VISIT.

◆ botan_rng_destroy()

int botan_rng_destroy ( botan_rng_t rng)

Frees all resources of the random number generator object

Parameters
rngrng object
Returns
0 if success, error if invalid object handle

Definition at line 162 of file ffi_rng.cpp.

162 {
163 return BOTAN_FFI_CHECKED_DELETE(rng);
164}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_rng_get()

int botan_rng_get ( botan_rng_t rng,
uint8_t * out,
size_t out_len )

Get random bytes from a random number generator

Parameters
rngrng object
outoutput buffer of size out_len
out_lennumber of requested bytes
Returns
0 on success, negative on failure

Definition at line 166 of file ffi_rng.cpp.

166 {
167 return BOTAN_FFI_VISIT(rng, [=](auto& r) { r.randomize(out, out_len); });
168}

References BOTAN_FFI_VISIT.

◆ botan_rng_init()

int botan_rng_init ( botan_rng_t * rng,
const char * rng_type )

Initialize a random number generator object

Parameters
rngrng object
rng_typetype of the rng, possible values: "system": system RNG "esdm-full": ESDM RNG (fully seeded) "esdm-pr": ESDM RNG (w. prediction resistance) "user": userspace RNG "user-threadsafe": userspace RNG, with internal locking "rdrand": directly read RDRAND Set rng_type to null to let the library choose some default.

Definition at line 33 of file ffi_rng.cpp.

33 {
34 return ffi_guard_thunk(__func__, [=]() -> int {
35 if(rng_out == nullptr) {
36 return BOTAN_FFI_ERROR_NULL_POINTER;
37 }
38
39 const std::string rng_type_s(rng_type ? rng_type : "system");
40
41 std::unique_ptr<Botan::RandomNumberGenerator> rng;
42
43 if(rng_type_s == "system") {
44 rng = std::make_unique<Botan::System_RNG>();
45 } else if(rng_type_s == "user" || rng_type_s == "user-threadsafe") {
46 rng = std::make_unique<Botan::AutoSeeded_RNG>();
47 } else if(rng_type_s == "null") {
48 rng = std::make_unique<Botan::Null_RNG>();
49 }
50#if defined(BOTAN_HAS_PROCESSOR_RNG)
51 else if((rng_type_s == "rdrand" || rng_type_s == "hwrng") && Botan::Processor_RNG::available()) {
52 rng = std::make_unique<Botan::Processor_RNG>();
53 }
54#endif
55#if defined(BOTAN_HAS_JITTER_RNG)
56 else if(rng_type_s == "jitter") {
57 rng = std::make_unique<Botan::Jitter_RNG>();
58 }
59#endif
60#if defined(BOTAN_HAS_ESDM_RNG)
61 else if(rng_type_s == "esdm-full") {
62 rng = std::make_unique<Botan::ESDM_RNG>(false);
63 } else if(rng_type_s == "esdm-pr") {
64 rng = std::make_unique<Botan::ESDM_RNG>(true);
65 }
66#endif
67
68 if(!rng) {
69 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
70 }
71
72 *rng_out = new botan_rng_struct(std::move(rng));
73 return BOTAN_FFI_SUCCESS;
74 });
75}
Botan::Processor_RNG::available
static bool available()
Definition processor_rng.cpp:109

References Botan::Processor_RNG::available(), BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and Botan_FFI::ffi_guard_thunk().

◆ botan_rng_init_custom()

int botan_rng_init_custom ( botan_rng_t * rng_out,
const char * rng_name,
void * context,
int(* get_cb )(void *context, uint8_t *out, size_t out_len),
int(* add_entropy_cb )(void *context, const uint8_t input[], size_t length),
void(* destroy_cb )(void *context) )

Initialize a custom random number generator from a set of callback functions

Parameters
rng_outrng object to create
rng_namename of the rng
contextAn application-specific context passed to the callback functions
get_cbCallback for getting random bytes from the rng, return 0 for success
add_entropy_cbCallback for adding entropy to the rng, return 0 for success, may be NULL
destroy_cbCallback called when rng is destroyed, may be NULL

Definition at line 77 of file ffi_rng.cpp.

82 {
83 return ffi_guard_thunk(__func__, [=]() -> int {
84 if(rng_out == nullptr) {
85 return BOTAN_FFI_ERROR_NULL_POINTER;
86 }
87
88 if(rng_name == nullptr) {
89 return BOTAN_FFI_ERROR_NULL_POINTER;
90 }
91
92 if(get_cb == nullptr) {
93 return BOTAN_FFI_ERROR_NULL_POINTER;
94 }
95
96 class Custom_RNG : public Botan::RandomNumberGenerator {
97 public:
98 Custom_RNG(std::string_view name,
99 void* context,
100 int (*get_cb)(void* context, uint8_t* out, size_t out_len),
101 int (*add_entropy_cb)(void* context, const uint8_t input[], size_t length),
102 void (*destroy_cb)(void* context)) :
103 m_name(name) {
104 m_context = context;
105 m_get_cb = get_cb;
106 m_add_entropy_cb = add_entropy_cb;
107 m_destroy_cb = destroy_cb;
108 }
109
110 ~Custom_RNG() override {
111 if(m_destroy_cb) {
112 m_destroy_cb(m_context);
113 }
114 }
115
116 Custom_RNG(const Custom_RNG& other) = delete;
117 Custom_RNG(Custom_RNG&& other) = delete;
118 Custom_RNG& operator=(const Custom_RNG& other) = delete;
119 Custom_RNG& operator=(Custom_RNG&& other) = delete;
120
121 protected:
122 void fill_bytes_with_input(std::span<uint8_t> output, std::span<const uint8_t> input) override {
123 if(accepts_input() && !input.empty()) {
124 int rc = m_add_entropy_cb(m_context, input.data(), input.size());
125 if(rc) {
126 throw Botan::Invalid_State("Failed to add entropy via C callback, rc=" + std::to_string(rc));
127 }
128 }
129
130 if(!output.empty()) {
131 int rc = m_get_cb(m_context, output.data(), output.size());
132 if(rc) {
133 throw Botan::Invalid_State("Failed to get random from C callback, rc=" + std::to_string(rc));
134 }
135 }
136 }
137
138 public:
139 bool accepts_input() const override { return m_add_entropy_cb != nullptr; }
140
141 std::string name() const override { return m_name; }
142
143 void clear() override {}
144
145 bool is_seeded() const override { return true; }
146
147 private:
148 std::string m_name;
149 void* m_context;
150 std::function<int(void* context, uint8_t* out, size_t out_len)> m_get_cb;
151 std::function<int(void* context, const uint8_t input[], size_t length)> m_add_entropy_cb;
152 std::function<void(void* context)> m_destroy_cb;
153 };
154
155 auto rng = std::make_unique<Custom_RNG>(rng_name, context, get_cb, add_entropy_cb, destroy_cb);
156
157 *rng_out = new botan_rng_struct(std::move(rng));
158 return BOTAN_FFI_SUCCESS;
159 });
160}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and Botan_FFI::ffi_guard_thunk().

◆ botan_rng_reseed()

int botan_rng_reseed ( botan_rng_t rng,
size_t bits )

Reseed a random number generator Uses the System_RNG as a seed generator.

Parameters
rngrng object
bitsnumber of bits to reseed with
Returns
0 on success, a negative value on failure

Definition at line 177 of file ffi_rng.cpp.

177 {
178 return BOTAN_FFI_VISIT(rng, [=](auto& r) { r.reseed_from_rng(Botan::system_rng(), bits); });
179}

References BOTAN_FFI_VISIT, and Botan::system_rng().

◆ botan_rng_reseed_from_rng()

int botan_rng_reseed_from_rng ( botan_rng_t rng,
botan_rng_t source_rng,
size_t bits )

Reseed a random number generator

Parameters
rngrng object
source_rngthe rng that will be read from
bitsnumber of bits to reseed with
Returns
0 on success, a negative value on failure

Definition at line 185 of file ffi_rng.cpp.

185 {
186 return BOTAN_FFI_VISIT(rng, [=](auto& r) { r.reseed_from_rng(safe_get(source_rng), bits); });
187}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

◆ botan_same_mem()

int botan_same_mem ( const uint8_t * x,
const uint8_t * y,
size_t len )

Deprecated equivalent to botan_constant_time_compare

Definition at line 308 of file ffi.cpp.

308 {
309 return botan_constant_time_compare(x, y, len);
310}
botan_constant_time_compare
int botan_constant_time_compare(const uint8_t *x, const uint8_t *y, size_t len)
Definition ffi.cpp:302

References botan_constant_time_compare().

◆ botan_scrub_mem()

int botan_scrub_mem ( void * mem,
size_t bytes )

Clear out memory using a system specific approach to bypass elision by the compiler (currently using RtlSecureZeroMemory or tricks with volatile pointers).

Definition at line 312 of file ffi.cpp.

312 {
313 Botan::secure_scrub_memory(mem, bytes);
314 return BOTAN_FFI_SUCCESS;
315}
Botan::secure_scrub_memory
void secure_scrub_memory(void *ptr, size_t n)
Definition mem_utils.cpp:24

References BOTAN_FFI_SUCCESS, and Botan::secure_scrub_memory().

◆ botan_scrypt()

int botan_scrypt ( uint8_t out[],
size_t out_len,
const char * passphrase,
const uint8_t salt[],
size_t salt_len,
size_t N,
size_t r,
size_t p )

Derive a key using scrypt Deprecated; use botan_pwdhash("Scrypt", N, r, p, out, out_len, password, 0, salt, salt_len);

Definition at line 146 of file ffi_kdf.cpp.

153 {
154 return botan_pwdhash("Scrypt", N, r, p, out, out_len, password, 0, salt, salt_len);
155}

References botan_pwdhash().

◆ botan_srp6_client_agree()

int botan_srp6_client_agree ( const char * username,
const char * password,
const char * group_id,
const char * hash_id,
const uint8_t salt[],
size_t salt_len,
const uint8_t B[],
size_t B_len,
botan_rng_t rng_obj,
uint8_t A[],
size_t * A_len,
uint8_t K[],
size_t * K_len )

SRP6a Client side

Parameters
usernamethe username we are attempting login for
passwordthe password we are attempting to use
group_idspecifies the shared SRP group
hash_idspecifies a secure hash function
saltis the salt value sent by the server
salt_lenthe length of salt
Bis the server's public value
B_lenis the server's public value length
rng_objis a random number generator object
Aout buffer to store the SRP-6 A value
A_lenSRP-6 A verifier value length
Kout buffer to store the symmetric value
K_lensymmetric key length
Returns
0 on success, negative on failure

Definition at line 143 of file ffi_srp6.cpp.

155 {
156#if defined(BOTAN_HAS_SRP6)
157 return ffi_guard_thunk(__func__, [=]() -> int {
158 if(!identity || !password || !salt || !group_id || !hash_id || !b || !rng_obj) {
159 return BOTAN_FFI_ERROR_NULL_POINTER;
160 }
161 try {
162 std::vector<uint8_t> saltv(salt, salt + salt_len);
163 Botan::RandomNumberGenerator& rng = safe_get(rng_obj);
164 auto b_bn = Botan::BigInt::from_bytes({b, b_len});
165 auto [A_bn, K_sk] = Botan::srp6_client_agree(identity, password, group_id, hash_id, saltv, b_bn, rng);
166 auto ret_a = write_vec_output(A, A_len, A_bn.serialize());
167 auto ret_k = write_vec_output(K, K_len, K_sk.bits_of());
168 if(ret_a != BOTAN_FFI_SUCCESS) {
169 return ret_a;
170 }
171 if(ret_k != BOTAN_FFI_SUCCESS) {
172 return ret_k;
173 }
174 return BOTAN_FFI_SUCCESS;
175 } catch(Botan::Lookup_Error&) {
176 return BOTAN_FFI_ERROR_BAD_PARAMETER;
177 }
178 });
179#else
180 BOTAN_UNUSED(identity, password, group_id, hash_id, rng_obj);
181 BOTAN_UNUSED(salt, salt_len, b, b_len, A, A_len, K, K_len);
182 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
183#endif
184}
Botan::BigInt::from_bytes
static BigInt from_bytes(std::span< const uint8_t > bytes)
Definition bigint.cpp:86
Botan::srp6_client_agree
std::pair< BigInt, SymmetricKey > srp6_client_agree(std::string_view identifier, std::string_view password, std::string_view group_id, std::string_view hash_id, const std::vector< uint8_t > &salt, const BigInt &B, RandomNumberGenerator &rng)
Definition srp6.cpp:65

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan::BigInt::from_bytes(), Botan_FFI::safe_get(), Botan::srp6_client_agree(), and Botan_FFI::write_vec_output().

Referenced by botan_srp6_server_session_step1().

◆ botan_srp6_generate_verifier()

int botan_srp6_generate_verifier ( const char * identifier,
const char * password,
const uint8_t salt[],
size_t salt_len,
const char * group_id,
const char * hash_id,
uint8_t verifier[],
size_t * verifier_len )

Generate a new SRP-6 verifier

Parameters
identifiera username or other client identifier
passwordthe secret used to authenticate user
salta randomly chosen value, at least 128 bits long
salt_lenthe length of salt
group_idspecifies the shared SRP group
hash_idspecifies a secure hash function
verifierout buffer to store the SRP-6 verifier value
verifier_lenSRP-6 verifier value length
Returns
0 on success, negative on failure

Definition at line 115 of file ffi_srp6.cpp.

122 {
123#if defined(BOTAN_HAS_SRP6)
124 return ffi_guard_thunk(__func__, [=]() -> int {
125 if(!username || !password || !salt || !group_id || !hash_id) {
126 return BOTAN_FFI_ERROR_NULL_POINTER;
127 }
128 try {
129 std::vector<uint8_t> salt_vec(salt, salt + salt_len);
130 auto verifier_bn = Botan::srp6_generate_verifier(username, password, salt_vec, group_id, hash_id);
131 return write_vec_output(verifier, verifier_len, verifier_bn.serialize());
132 } catch(Botan::Lookup_Error&) {
133 return BOTAN_FFI_ERROR_BAD_PARAMETER;
134 }
135 });
136#else
137 BOTAN_UNUSED(username, password, group_id, hash_id);
138 BOTAN_UNUSED(salt, salt_len, verifier, verifier_len);
139 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
140#endif
141}
Botan::srp6_generate_verifier
BigInt srp6_generate_verifier(std::string_view identifier, std::string_view password, const std::vector< uint8_t > &salt, std::string_view group_id, std::string_view hash_id)
Definition srp6.cpp:128

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan::srp6_generate_verifier(), and Botan_FFI::write_vec_output().

Referenced by botan_srp6_server_session_step1().

◆ botan_srp6_group_size()

int botan_srp6_group_size ( const char * group_id,
size_t * group_p_bytes )

Return the size, in bytes, of the prime associated with group_id

Definition at line 47 of file ffi_srp6.cpp.

47 {
48#if defined(BOTAN_HAS_SRP6)
49 if(group_id == nullptr || group_p_bytes == nullptr) {
50 return BOTAN_FFI_ERROR_NULL_POINTER;
51 }
52
53 return ffi_guard_thunk(__func__, [=]() -> int {
54 auto group = Botan::DL_Group::from_name(group_id);
55 *group_p_bytes = group.p_bytes();
56 return BOTAN_FFI_SUCCESS;
57 });
58#else
59 BOTAN_UNUSED(group_id, group_p_bytes);
60 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
61#endif
62}
Botan::DL_Group::from_name
static DL_Group from_name(std::string_view name)
Definition dl_group.cpp:212

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan::DL_Group::from_name().

Referenced by botan_srp6_server_session_step1().

◆ botan_srp6_server_session_destroy()

int botan_srp6_server_session_destroy ( botan_srp6_server_session_t srp6)

Frees all resources of the SRP-6 server session object

Parameters
srp6SRP-6 server session object
Returns
0 if success, error if invalid object handle

Definition at line 43 of file ffi_srp6.cpp.

43 {
44 return BOTAN_FFI_CHECKED_DELETE(srp6);
45}

References BOTAN_FFI_CHECKED_DELETE.

◆ botan_srp6_server_session_init()

int botan_srp6_server_session_init ( botan_srp6_server_session_t * srp6)

Initialize an SRP-6 server session object

Parameters
srp6SRP-6 server session object

Definition at line 31 of file ffi_srp6.cpp.

31 {
32#if defined(BOTAN_HAS_SRP6)
33 return ffi_guard_thunk(__func__, [=]() -> int {
34 *srp6 = new botan_srp6_server_session_struct(std::make_unique<Botan::SRP6_Server_Session>());
35 return BOTAN_FFI_SUCCESS;
36 });
37#else
38 BOTAN_UNUSED(srp6);
39 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
40#endif
41}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_srp6_server_session_step1()

int botan_srp6_server_session_step1 ( botan_srp6_server_session_t srp6,
const uint8_t verifier[],
size_t verifier_len,
const char * group_id,
const char * hash_id,
botan_rng_t rng_obj,
uint8_t B_pub[],
size_t * B_pub_len )

SRP-6 Server side step 1

Parameters
srp6SRP-6 server session object
verifierthe verification value saved from client registration
verifier_lenSRP-6 verifier value length
group_idthe SRP group id
hash_idthe SRP hash in use
rng_obja random number generator object
B_pubout buffer to store the SRP-6 B value
B_pub_lenSRP-6 B value length
Returns
0 on success, negative on failure

References BOTAN_FFI_EXPORT, botan_srp6_client_agree(), botan_srp6_generate_verifier(), botan_srp6_group_size(), botan_srp6_server_session_step1(), botan_srp6_server_session_step2(), botan_zfec_decode(), and botan_zfec_encode().

Referenced by botan_srp6_server_session_step1().

◆ botan_srp6_server_session_step2()

int botan_srp6_server_session_step2 ( botan_srp6_server_session_t srp6,
const uint8_t A[],
size_t A_len,
uint8_t key[],
size_t * key_len )

SRP-6 Server side step 2

Parameters
srp6SRP-6 server session object
Athe client's value
A_lenthe client's value length
keyout buffer to store the symmetric key value
key_lensymmetric key length
Returns
0 on success, negative on failure

Definition at line 94 of file ffi_srp6.cpp.

95 {
96#if defined(BOTAN_HAS_SRP6)
97 return BOTAN_FFI_VISIT(srp6, [=](auto& s) -> int {
98 if(!a) {
99 return BOTAN_FFI_ERROR_NULL_POINTER;
100 }
101 try {
102 Botan::BigInt a_bn = Botan::BigInt::from_bytes({a, a_len});
103 auto key_sk = s.step2(a_bn);
104 return write_vec_output(key, key_len, key_sk.bits_of());
105 } catch(Botan::Decoding_Error&) {
106 return BOTAN_FFI_ERROR_BAD_PARAMETER;
107 }
108 });
109#else
110 BOTAN_UNUSED(srp6, a, a_len, key, key_len);
111 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
112#endif
113}
Botan::Decoding_Error
Definition exceptn.h:191

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, BOTAN_UNUSED, Botan::BigInt::from_bytes(), and Botan_FFI::write_vec_output().

Referenced by botan_srp6_server_session_step1().

◆ botan_system_rng_get()

int botan_system_rng_get ( uint8_t * out,
size_t out_len )

Get random bytes from system random number generator

Parameters
outoutput buffer of size out_len
out_lennumber of requested bytes
Returns
0 on success, negative on failure

Definition at line 170 of file ffi_rng.cpp.

170 {
171 return ffi_guard_thunk(__func__, [=]() -> int {
172 Botan::system_rng().randomize(out, out_len);
173 return BOTAN_FFI_SUCCESS;
174 });
175}
Botan::RandomNumberGenerator::randomize
void randomize(std::span< uint8_t > output)
Definition rng.h:68

References BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), Botan::RandomNumberGenerator::randomize(), and Botan::system_rng().

◆ botan_totp_check()

int botan_totp_check ( botan_totp_t totp,
uint32_t totp_code,
uint64_t timestamp,
size_t acceptable_clock_drift )

Verify a TOTP code

Parameters
totpthe TOTP object
totp_codethe presented OTP
timestampthe current local timestamp
acceptable_clock_driftspecifies the acceptable amount of clock drift (in terms of time steps) between the two hosts.

Definition at line 69 of file ffi_totp.cpp.

69 {
70#if defined(BOTAN_HAS_TOTP)
71 return BOTAN_FFI_VISIT(totp, [=](auto& t) {
72 const bool ok = t.verify_totp(totp_code, timestamp, acceptable_clock_drift);
73 return (ok ? BOTAN_FFI_SUCCESS : BOTAN_FFI_INVALID_VERIFIER);
74 });
75
76#else
77 BOTAN_UNUSED(totp, totp_code, timestamp, acceptable_clock_drift);
78 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
79#endif
80}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_INVALID_VERIFIER, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

◆ botan_totp_destroy()

int botan_totp_destroy ( botan_totp_t totp)

Destroy a TOTP instance

Returns
0 if success, error if invalid object handle

Definition at line 46 of file ffi_totp.cpp.

46 {
47#if defined(BOTAN_HAS_TOTP)
48 return BOTAN_FFI_CHECKED_DELETE(totp);
49#else
50 BOTAN_UNUSED(totp);
51 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
52#endif
53}

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_totp_generate()

int botan_totp_generate ( botan_totp_t totp,
uint32_t * totp_code,
uint64_t timestamp )

Generate a TOTP code for the provided timestamp

Parameters
totpthe TOTP object
totp_codethe OTP code will be written here
timestampthe current local timestamp

Definition at line 55 of file ffi_totp.cpp.

55 {
56#if defined(BOTAN_HAS_TOTP)
57 if(totp == nullptr || totp_code == nullptr) {
58 return BOTAN_FFI_ERROR_NULL_POINTER;
59 }
60
61 return BOTAN_FFI_VISIT(totp, [=](auto& t) { *totp_code = t.generate_totp(timestamp); });
62
63#else
64 BOTAN_UNUSED(totp, totp_code, timestamp);
65 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
66#endif
67}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

◆ botan_totp_init()

int botan_totp_init ( botan_totp_t * totp,
const uint8_t key[],
size_t key_len,
const char * hash_algo,
size_t digits,
size_t time_step )

Initialize a TOTP instance

Definition at line 25 of file ffi_totp.cpp.

26 {
27 if(totp == nullptr || key == nullptr || hash_algo == nullptr) {
28 return BOTAN_FFI_ERROR_NULL_POINTER;
29 }
30
31 *totp = nullptr;
32
33#if defined(BOTAN_HAS_TOTP)
34 return ffi_guard_thunk(__func__, [=]() -> int {
35 auto otp = std::make_unique<Botan::TOTP>(key, key_len, hash_algo, digits, time_step);
36 *totp = new botan_totp_struct(std::move(otp));
37
38 return BOTAN_FFI_SUCCESS;
39 });
40#else
41 BOTAN_UNUSED(totp, key, key_len, hash_algo, digits, time_step);
42 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
43#endif
44}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_tpm2_crypto_backend_state_destroy()

int botan_tpm2_crypto_backend_state_destroy ( botan_tpm2_crypto_backend_state_t cbs)

Frees all resouces of a TPM2 Crypto Callback State Note that this does not attempt to de-register the crypto backend, it just frees the resource pointed to by cbs. Use the ESAPI function Esys_SetCryptoCallbacks(ctx, nullptr) to deregister manually.

Parameters
cbsTPM2 Crypto Callback State
Returns
0 on success

Definition at line 207 of file ffi_tpm2.cpp.

207 {
208#if defined(BOTAN_HAS_TPM2_CRYPTO_BACKEND)
209 return BOTAN_FFI_CHECKED_DELETE(cbs);
210#else
211 BOTAN_UNUSED(cbs);
212 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
213#endif
214}

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_tpm2_ctx_destroy()

int botan_tpm2_ctx_destroy ( botan_tpm2_ctx_t ctx)

Frees all resouces of a TPM2 context

Parameters
ctxTPM2 context
Returns
0 on success

Definition at line 175 of file ffi_tpm2.cpp.

175 {
176#if defined(BOTAN_HAS_TPM2)
177 return BOTAN_FFI_CHECKED_DELETE(ctx);
178#else
179 BOTAN_UNUSED(ctx);
180 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
181#endif
182}

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_tpm2_ctx_enable_crypto_backend()

int botan_tpm2_ctx_enable_crypto_backend ( botan_tpm2_ctx_t ctx,
botan_rng_t rng )

Enable Botan's TSS2 crypto backend that replaces the cryptographic functions required for the communication with the TPM with implementations provided by Botan instead of using TSS' defaults OpenSSL or mbedTLS. Note that the provided rng should not be dependent on the TPM and the caller must ensure that it remains usable for the lifetime of the ctx.

Parameters
ctxTPM2 context
rngrandom number generator to be used by the crypto backend

Definition at line 152 of file ffi_tpm2.cpp.

152 {
153#if defined(BOTAN_HAS_TPM2)
154 return BOTAN_FFI_VISIT(ctx, [=](botan_tpm2_ctx_wrapper& ctx_wrapper) -> int {
155 Botan::RandomNumberGenerator& rng_ref = safe_get(rng);
156
157 // The lifetime of the RNG used for the crypto backend should be managed
158 // by the TPM2::Context. Here, we just need to trust the user that they
159 // keep the passed-in RNG instance intact for the lifetime of the context.
160 std::shared_ptr<Botan::RandomNumberGenerator> rng_ptr(&rng_ref, [](auto*) {});
161 ctx_wrapper.ctx->use_botan_crypto_backend(rng_ptr);
162 return BOTAN_FFI_SUCCESS;
163 });
164#else
165 BOTAN_UNUSED(ctx, rng);
166 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
167#endif
168}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::safe_get().

◆ botan_tpm2_ctx_from_esys()

int botan_tpm2_ctx_from_esys ( botan_tpm2_ctx_t * ctx_out,
struct ESYS_CONTEXT * esys_ctx )

Wrap an existing ESYS_CONTEXT for use in Botan. Note that destroying the created botan_tpm2_ctx_t won't finalize esys_ctx

Parameters
ctx_outoutput TPM2 context
esys_ctxESYS_CONTEXT to wrap
Returns
0 on success

Definition at line 134 of file ffi_tpm2.cpp.

134 {
135#if defined(BOTAN_HAS_TPM2)
136 return ffi_guard_thunk(__func__, [=]() -> int {
137 if(ctx_out == nullptr || esys_ctx == nullptr) {
138 return BOTAN_FFI_ERROR_NULL_POINTER;
139 }
140
141 auto ctx = std::make_unique<botan_tpm2_ctx_wrapper>();
142 ctx->ctx = Botan::TPM2::Context::create(esys_ctx);
143 *ctx_out = new botan_tpm2_ctx_struct(std::move(ctx));
144 return BOTAN_FFI_SUCCESS;
145 });
146#else
147 BOTAN_UNUSED(ctx_out, esys_ctx);
148 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
149#endif
150}
Botan::TPM2::Context::create
static std::shared_ptr< Context > create(const std::string &tcti_nameconf)
Definition tpm2_context.cpp:55

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan::TPM2::Context::create(), and Botan_FFI::ffi_guard_thunk().

◆ botan_tpm2_ctx_init()

int botan_tpm2_ctx_init ( botan_tpm2_ctx_t * ctx_out,
const char * tcti_nameconf )

Initialize a TPM2 context

Parameters
ctx_outoutput TPM2 context
tcti_nameconfTCTI config (may be nullptr)
Returns
0 on success

Definition at line 74 of file ffi_tpm2.cpp.

74 {
75#if defined(BOTAN_HAS_TPM2)
76 return ffi_guard_thunk(__func__, [=]() -> int {
77 if(ctx_out == nullptr) {
78 return BOTAN_FFI_ERROR_NULL_POINTER;
79 }
80 auto ctx = std::make_unique<botan_tpm2_ctx_wrapper>();
81
82 auto tcti = [=]() -> std::optional<std::string> {
83 if(tcti_nameconf == nullptr) {
84 return {};
85 } else {
86 return std::string(tcti_nameconf);
87 }
88 }();
89
90 ctx->ctx = Botan::TPM2::Context::create(std::move(tcti));
91 *ctx_out = new botan_tpm2_ctx_struct(std::move(ctx));
92 return BOTAN_FFI_SUCCESS;
93 });
94#else
95 BOTAN_UNUSED(ctx_out, tcti_nameconf);
96 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
97#endif
98}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan::TPM2::Context::create(), and Botan_FFI::ffi_guard_thunk().

◆ botan_tpm2_ctx_init_ex()

int botan_tpm2_ctx_init_ex ( botan_tpm2_ctx_t * ctx_out,
const char * tcti_name,
const char * tcti_conf )

Initialize a TPM2 context

Parameters
ctx_outoutput TPM2 context
tcti_nameTCTI name (may be nullptr)
tcti_confTCTI config (may be nullptr)
Returns
0 on success

Definition at line 100 of file ffi_tpm2.cpp.

100 {
101#if defined(BOTAN_HAS_TPM2)
102 return ffi_guard_thunk(__func__, [=]() -> int {
103 if(ctx_out == nullptr) {
104 return BOTAN_FFI_ERROR_NULL_POINTER;
105 }
106 auto ctx = std::make_unique<botan_tpm2_ctx_wrapper>();
107
108 auto tcti_name_str = [=]() -> std::optional<std::string> {
109 if(tcti_name == nullptr) {
110 return {};
111 } else {
112 return std::string(tcti_name);
113 }
114 }();
115
116 auto tcti_conf_str = [=]() -> std::optional<std::string> {
117 if(tcti_conf == nullptr) {
118 return {};
119 } else {
120 return std::string(tcti_conf);
121 }
122 }();
123
124 ctx->ctx = Botan::TPM2::Context::create(std::move(tcti_name_str), std::move(tcti_conf_str));
125 *ctx_out = new botan_tpm2_ctx_struct(std::move(ctx));
126 return BOTAN_FFI_SUCCESS;
127 });
128#else
129 BOTAN_UNUSED(ctx_out, tcti_name, tcti_conf);
130 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
131#endif
132}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan::TPM2::Context::create(), and Botan_FFI::ffi_guard_thunk().

◆ botan_tpm2_enable_crypto_backend()

int botan_tpm2_enable_crypto_backend ( botan_tpm2_crypto_backend_state_t * cbs_out,
struct ESYS_CONTEXT * esys_ctx,
botan_rng_t rng )

Use this if you just need Botan's crypto backend but do not want to wrap any other ESYS functionality using Botan's TPM2 wrapper. A Crypto Backend State is created that the user needs to keep alive for as long as the crypto backend is used and needs to be destroyed after. Note that the provided rng should not be dependent on the TPM and the caller must ensure that it remains usable for the lifetime of the esys_ctx.

Parameters
cbs_outTo be created Crypto Backend State
esys_ctxTPM2 context
rngrandom number generator to be used by the crypto backend

Definition at line 184 of file ffi_tpm2.cpp.

186 {
187#if defined(BOTAN_HAS_TPM2_CRYPTO_BACKEND)
188 return ffi_guard_thunk(__func__, [=]() -> int {
189 if(cbs_out == nullptr || esys_ctx == nullptr) {
190 return BOTAN_FFI_ERROR_NULL_POINTER;
191 }
192
193 Botan::RandomNumberGenerator& rng_ref = safe_get(rng);
194
195 // Here, we just need to trust the user that they keep the passed-in RNG
196 // instance intact for the lifetime of the context.
197 std::shared_ptr<Botan::RandomNumberGenerator> rng_ptr(&rng_ref, [](auto*) {});
198 *cbs_out = new botan_tpm2_crypto_backend_state_struct(Botan::TPM2::use_botan_crypto_backend(esys_ctx, rng_ptr));
199 return BOTAN_FFI_SUCCESS;
200 });
201#else
202 BOTAN_UNUSED(cbs_out, esys_ctx, rng);
203 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
204#endif
205}
Botan::TPM2::use_botan_crypto_backend
std::unique_ptr< CryptoCallbackState > use_botan_crypto_backend(ESYS_CONTEXT *context, const std::shared_ptr< Botan::RandomNumberGenerator > &rng)
Definition tpm2_crypto_backend.cpp:16

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), and Botan::TPM2::use_botan_crypto_backend().

◆ botan_tpm2_rng_init()

int botan_tpm2_rng_init ( botan_rng_t * rng_out,
botan_tpm2_ctx_t ctx,
botan_tpm2_session_t s1,
botan_tpm2_session_t s2,
botan_tpm2_session_t s3 )

Initialize a random number generator object via TPM2

Parameters
rng_outrng object to create
ctxTPM2 context
s1the first session to use (optional, may be nullptr)
s2the second session to use (optional, may be nullptr)
s3the third session to use (optional, may be nullptr)

Definition at line 216 of file ffi_tpm2.cpp.

220 {
221#if defined(BOTAN_HAS_TPM2)
222 return BOTAN_FFI_VISIT(ctx, [=](botan_tpm2_ctx_wrapper& ctx_wrapper) -> int {
223 if(rng_out == nullptr) {
224 return BOTAN_FFI_ERROR_NULL_POINTER;
225 }
226
227 *rng_out = new botan_rng_struct(
228 std::make_unique<Botan::TPM2::RandomNumberGenerator>(ctx_wrapper.ctx, sessions(s1, s2, s3)));
229 return BOTAN_FFI_SUCCESS;
230 });
231#else
232 BOTAN_UNUSED(rng_out, ctx, s1, s2, s3);
233 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
234#endif
235}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

◆ botan_tpm2_session_destroy()

int botan_tpm2_session_destroy ( botan_tpm2_session_t session)

Create an unauthenticated session for use with TPM2

Parameters
sessionthe session object to destroy

Definition at line 255 of file ffi_tpm2.cpp.

255 {
256#if defined(BOTAN_HAS_TPM2)
257 return BOTAN_FFI_CHECKED_DELETE(session);
258#else
259 BOTAN_UNUSED(session);
260 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
261#endif
262}

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_tpm2_supports_crypto_backend()

int botan_tpm2_supports_crypto_backend ( void )

Checks if Botan's TSS2 crypto backend can be used in this build

Returns
1 if the crypto backend can be enabled

Definition at line 66 of file ffi_tpm2.cpp.

66 {
67#if defined(BOTAN_HAS_TPM2)
68 return Botan::TPM2::Context::supports_botan_crypto_backend() ? 1 : 0;
69#else
70 return 0;
71#endif
72}
Botan::TPM2::Context::supports_botan_crypto_backend
static bool supports_botan_crypto_backend() noexcept
Definition tpm2_context.cpp:47

References Botan::TPM2::Context::supports_botan_crypto_backend().

◆ botan_tpm2_unauthenticated_session_init()

int botan_tpm2_unauthenticated_session_init ( botan_tpm2_session_t * session_out,
botan_tpm2_ctx_t ctx )

Create an unauthenticated session for use with TPM2

Parameters
session_outthe session object to create
ctxTPM2 context

Definition at line 237 of file ffi_tpm2.cpp.

237 {
238#if defined(BOTAN_HAS_TPM2)
239 return BOTAN_FFI_VISIT(ctx, [=](botan_tpm2_ctx_wrapper& ctx_wrapper) -> int {
240 if(session_out == nullptr) {
241 return BOTAN_FFI_ERROR_NULL_POINTER;
242 }
243
244 auto session = std::make_unique<botan_tpm2_session_wrapper>();
245 session->session = Botan::TPM2::Session::unauthenticated_session(ctx_wrapper.ctx);
246 *session_out = new botan_tpm2_session_struct(std::move(session));
247 return BOTAN_FFI_SUCCESS;
248 });
249#else
250 BOTAN_UNUSED(session_out, ctx);
251 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
252#endif
253}
Botan::TPM2::Session::unauthenticated_session
static std::shared_ptr< Session > unauthenticated_session(const std::shared_ptr< Context > &ctx, std::string_view sym_algo="CFB(AES-256)", std::string_view hash_algo="SHA-256")
Definition tpm2_session.cpp:42

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan::TPM2::Session::unauthenticated_session().

◆ botan_version_datestamp()

uint32_t botan_version_datestamp ( void )

Return the date this version was released as an integer.

Returns 0 if the library was not built from an official release

Definition at line 298 of file ffi.cpp.

298 {
299 return Botan::version_datestamp();
300}
Botan::version_datestamp
uint32_t version_datestamp()
Definition version.cpp:32

References Botan::version_datestamp().

◆ botan_version_major()

uint32_t botan_version_major ( void )

Return the major version of the library

Definition at line 286 of file ffi.cpp.

286 {
287 return Botan::version_major();
288}
Botan::version_major
uint32_t version_major()
Definition version.cpp:55

References Botan::version_major().

◆ botan_version_minor()

uint32_t botan_version_minor ( void )

Return the minor version of the library

Definition at line 290 of file ffi.cpp.

290 {
291 return Botan::version_minor();
292}
Botan::version_minor
uint32_t version_minor()
Definition version.cpp:59

References Botan::version_minor().

◆ botan_version_patch()

uint32_t botan_version_patch ( void )

Return the patch version of the library

Definition at line 294 of file ffi.cpp.

294 {
295 return Botan::version_patch();
296}
Botan::version_patch
uint32_t version_patch()
Definition version.cpp:63

References Botan::version_patch().

◆ botan_version_string()

const char * botan_version_string ( void )

Return a free-form version string, e.g., 2.0.0

Definition at line 282 of file ffi.cpp.

282 {
283 return Botan::version_cstr();
284}
Botan::version_cstr
const char * version_cstr()
Definition version.cpp:20

References Botan::version_cstr().

◆ botan_x509_cert_allowed_usage()

int botan_x509_cert_allowed_usage ( botan_x509_cert_t cert,
unsigned int key_usage )

Definition at line 151 of file ffi_cert.cpp.

151 {
152#if defined(BOTAN_HAS_X509_CERTIFICATES)
153 return BOTAN_FFI_VISIT(cert, [=](const auto& c) -> int {
154 const Botan::Key_Constraints k = static_cast<Botan::Key_Constraints>(key_usage);
155 if(c.allowed_usage(k)) {
156 return BOTAN_FFI_SUCCESS;
157 }
158 return 1;
159 });
160#else
161 BOTAN_UNUSED(cert, key_usage);
162 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
163#endif
164}
Botan::Key_Constraints
Definition pkix_enums.h:108

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

◆ botan_x509_cert_destroy()

int botan_x509_cert_destroy ( botan_x509_cert_t cert)
Returns
0 if success, error if invalid object handle

Definition at line 166 of file ffi_cert.cpp.

166 {
167#if defined(BOTAN_HAS_X509_CERTIFICATES)
168 return BOTAN_FFI_CHECKED_DELETE(cert);
169#else
170 BOTAN_UNUSED(cert);
171 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
172#endif
173}

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_x509_cert_dup()

int botan_x509_cert_dup ( botan_x509_cert_t * new_cert,
botan_x509_cert_t cert )

Definition at line 48 of file ffi_cert.cpp.

48 {
49 if(!cert_obj) {
50 return BOTAN_FFI_ERROR_NULL_POINTER;
51 }
52
53#if defined(BOTAN_HAS_X509_CERTIFICATES) && defined(BOTAN_TARGET_OS_HAS_FILESYSTEM)
54
55 return ffi_guard_thunk(__func__, [=]() -> int {
56 auto c = std::make_unique<Botan::X509_Certificate>(safe_get(cert));
57 *cert_obj = new botan_x509_cert_struct(std::move(c));
58 return BOTAN_FFI_SUCCESS;
59 });
60
61#else
62 BOTAN_UNUSED(cert);
63 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
64#endif
65}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_x509_cert_get_authority_key_id()

int botan_x509_cert_get_authority_key_id ( botan_x509_cert_t cert,
uint8_t out[],
size_t * out_len )

Definition at line 231 of file ffi_cert.cpp.

231 {
232#if defined(BOTAN_HAS_X509_CERTIFICATES)
233 return BOTAN_FFI_VISIT(cert, [=](const auto& c) { return write_vec_output(out, out_len, c.authority_key_id()); });
234#else
235 BOTAN_UNUSED(cert, out, out_len);
236 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
237#endif
238}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::write_vec_output().

◆ botan_x509_cert_get_fingerprint()

int botan_x509_cert_get_fingerprint ( botan_x509_cert_t cert,
const char * hash,
uint8_t out[],
size_t * out_len )

Definition at line 222 of file ffi_cert.cpp.

222 {
223#if defined(BOTAN_HAS_X509_CERTIFICATES)
224 return BOTAN_FFI_VISIT(cert, [=](const auto& c) { return write_str_output(out, out_len, c.fingerprint(hash)); });
225#else
226 BOTAN_UNUSED(cert, hash, out, out_len);
227 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
228#endif
229}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::write_str_output().

◆ botan_x509_cert_get_issuer_dn()

int botan_x509_cert_get_issuer_dn ( botan_x509_cert_t cert,
const char * key,
size_t index,
uint8_t out[],
size_t * out_len )

Definition at line 104 of file ffi_cert.cpp.

105 {
106#if defined(BOTAN_HAS_X509_CERTIFICATES)
107 return BOTAN_FFI_VISIT(cert, [=](const auto& c) -> int {
108 auto issuer_info = c.issuer_info(key);
109 if(index < issuer_info.size()) {
110 return write_str_output(out, out_len, c.issuer_info(key).at(index));
111 } else {
112 return BOTAN_FFI_ERROR_BAD_PARAMETER;
113 }
114 });
115#else
116 BOTAN_UNUSED(cert, key, index, out, out_len);
117 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
118#endif
119}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::write_str_output().

◆ botan_x509_cert_get_public_key()

int botan_x509_cert_get_public_key ( botan_x509_cert_t cert,
botan_pubkey_t * key )

Definition at line 85 of file ffi_cert.cpp.

85 {
86 if(key == nullptr) {
87 return BOTAN_FFI_ERROR_NULL_POINTER;
88 }
89
90 *key = nullptr;
91
92#if defined(BOTAN_HAS_X509_CERTIFICATES)
93 return ffi_guard_thunk(__func__, [=]() -> int {
94 auto public_key = safe_get(cert).subject_public_key();
95 *key = new botan_pubkey_struct(std::move(public_key));
96 return BOTAN_FFI_SUCCESS;
97 });
98#else
99 BOTAN_UNUSED(cert);
100 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
101#endif
102}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::safe_get().

◆ botan_x509_cert_get_public_key_bits()

int botan_x509_cert_get_public_key_bits ( botan_x509_cert_t cert,
uint8_t out[],
size_t * out_len )

Definition at line 249 of file ffi_cert.cpp.

249 {
250 return copy_view_bin(out, out_len, botan_x509_cert_view_public_key_bits, cert);
251}
botan_x509_cert_view_public_key_bits
int botan_x509_cert_view_public_key_bits(botan_x509_cert_t cert, botan_view_ctx ctx, botan_view_bin_fn view)
Definition ffi_cert.cpp:253

References botan_x509_cert_view_public_key_bits(), and Botan_FFI::copy_view_bin().

◆ botan_x509_cert_get_serial_number()

int botan_x509_cert_get_serial_number ( botan_x509_cert_t cert,
uint8_t out[],
size_t * out_len )

Definition at line 213 of file ffi_cert.cpp.

213 {
214#if defined(BOTAN_HAS_X509_CERTIFICATES)
215 return BOTAN_FFI_VISIT(cert, [=](const auto& c) { return write_vec_output(out, out_len, c.serial_number()); });
216#else
217 BOTAN_UNUSED(cert, out, out_len);
218 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
219#endif
220}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::write_vec_output().

◆ botan_x509_cert_get_subject_dn()

int botan_x509_cert_get_subject_dn ( botan_x509_cert_t cert,
const char * key,
size_t index,
uint8_t out[],
size_t * out_len )

Definition at line 121 of file ffi_cert.cpp.

122 {
123#if defined(BOTAN_HAS_X509_CERTIFICATES)
124 return BOTAN_FFI_VISIT(cert, [=](const auto& c) -> int {
125 auto subject_info = c.subject_info(key);
126 if(index < subject_info.size()) {
127 return write_str_output(out, out_len, c.subject_info(key).at(index));
128 } else {
129 return BOTAN_FFI_ERROR_BAD_PARAMETER;
130 }
131 });
132#else
133 BOTAN_UNUSED(cert, key, index, out, out_len);
134 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
135#endif
136}

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::write_str_output().

◆ botan_x509_cert_get_subject_key_id()

int botan_x509_cert_get_subject_key_id ( botan_x509_cert_t cert,
uint8_t out[],
size_t * out_len )

Definition at line 240 of file ffi_cert.cpp.

240 {
241#if defined(BOTAN_HAS_X509_CERTIFICATES)
242 return BOTAN_FFI_VISIT(cert, [=](const auto& c) { return write_vec_output(out, out_len, c.subject_key_id()); });
243#else
244 BOTAN_UNUSED(cert, out, out_len);
245 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
246#endif
247}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::write_vec_output().

◆ botan_x509_cert_get_time_expires()

int botan_x509_cert_get_time_expires ( botan_x509_cert_t cert,
char out[],
size_t * out_len )

Definition at line 185 of file ffi_cert.cpp.

185 {
186#if defined(BOTAN_HAS_X509_CERTIFICATES)
187 return BOTAN_FFI_VISIT(cert,
188 [=](const auto& c) { return write_str_output(out, out_len, c.not_after().to_string()); });
189#else
190 BOTAN_UNUSED(cert, out, out_len);
191 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
192#endif
193}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::write_str_output().

◆ botan_x509_cert_get_time_starts()

int botan_x509_cert_get_time_starts ( botan_x509_cert_t cert,
char out[],
size_t * out_len )

Definition at line 175 of file ffi_cert.cpp.

175 {
176#if defined(BOTAN_HAS_X509_CERTIFICATES)
177 return BOTAN_FFI_VISIT(cert,
178 [=](const auto& c) { return write_str_output(out, out_len, c.not_before().to_string()); });
179#else
180 BOTAN_UNUSED(cert, out, out_len);
181 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
182#endif
183}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::write_str_output().

◆ botan_x509_cert_hostname_match()

int botan_x509_cert_hostname_match ( botan_x509_cert_t cert,
const char * hostname )

Check if the certificate matches the specified hostname via alternative name or CN match. RFC 5280 wildcards also supported.

Definition at line 263 of file ffi_cert.cpp.

263 {
264 if(hostname == nullptr) {
265 return BOTAN_FFI_ERROR_NULL_POINTER;
266 }
267
268#if defined(BOTAN_HAS_X509_CERTIFICATES)
269 return BOTAN_FFI_VISIT(cert, [=](const auto& c) { return c.matches_dns_name(hostname) ? 0 : -1; });
270#else
271 BOTAN_UNUSED(cert);
272 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
273#endif
274}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

◆ botan_x509_cert_load()

int botan_x509_cert_load ( botan_x509_cert_t * cert_obj,
const uint8_t cert[],
size_t cert_len )

Definition at line 67 of file ffi_cert.cpp.

67 {
68 if(!cert_obj || !cert_bits) {
69 return BOTAN_FFI_ERROR_NULL_POINTER;
70 }
71
72#if defined(BOTAN_HAS_X509_CERTIFICATES)
73 return ffi_guard_thunk(__func__, [=]() -> int {
74 Botan::DataSource_Memory bits(cert_bits, cert_bits_len);
75 auto c = std::make_unique<Botan::X509_Certificate>(bits);
76 *cert_obj = new botan_x509_cert_struct(std::move(c));
77 return BOTAN_FFI_SUCCESS;
78 });
79#else
80 BOTAN_UNUSED(cert_bits_len);
81 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
82#endif
83}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_x509_cert_load_file()

int botan_x509_cert_load_file ( botan_x509_cert_t * cert_obj,
const char * filename )

Definition at line 30 of file ffi_cert.cpp.

30 {
31 if(!cert_obj || !cert_path) {
32 return BOTAN_FFI_ERROR_NULL_POINTER;
33 }
34
35#if defined(BOTAN_HAS_X509_CERTIFICATES) && defined(BOTAN_TARGET_OS_HAS_FILESYSTEM)
36
37 return ffi_guard_thunk(__func__, [=]() -> int {
38 auto c = std::make_unique<Botan::X509_Certificate>(cert_path);
39 *cert_obj = new botan_x509_cert_struct(std::move(c));
40 return BOTAN_FFI_SUCCESS;
41 });
42
43#else
44 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
45#endif
46}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and Botan_FFI::ffi_guard_thunk().

◆ botan_x509_cert_not_after()

int botan_x509_cert_not_after ( botan_x509_cert_t cert,
uint64_t * time_since_epoch )

Definition at line 204 of file ffi_cert.cpp.

204 {
205#if defined(BOTAN_HAS_X509_CERTIFICATES)
206 return BOTAN_FFI_VISIT(cert, [=](const auto& c) { *time_since_epoch = c.not_after().time_since_epoch(); });
207#else
208 BOTAN_UNUSED(cert, time_since_epoch);
209 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
210#endif
211}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

◆ botan_x509_cert_not_before()

int botan_x509_cert_not_before ( botan_x509_cert_t cert,
uint64_t * time_since_epoch )

Definition at line 195 of file ffi_cert.cpp.

195 {
196#if defined(BOTAN_HAS_X509_CERTIFICATES)
197 return BOTAN_FFI_VISIT(cert, [=](const auto& c) { *time_since_epoch = c.not_before().time_since_epoch(); });
198#else
199 BOTAN_UNUSED(cert, time_since_epoch);
200 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
201#endif
202}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

◆ botan_x509_cert_to_string()

int botan_x509_cert_to_string ( botan_x509_cert_t cert,
char out[],
size_t * out_len )

Definition at line 138 of file ffi_cert.cpp.

138 {
139 return copy_view_str(reinterpret_cast<uint8_t*>(out), out_len, botan_x509_cert_view_as_string, cert);
140}
botan_x509_cert_view_as_string
int botan_x509_cert_view_as_string(botan_x509_cert_t cert, botan_view_ctx ctx, botan_view_str_fn view)
Definition ffi_cert.cpp:142

References botan_x509_cert_view_as_string(), and Botan_FFI::copy_view_str().

◆ botan_x509_cert_validation_status()

const char * botan_x509_cert_validation_status ( int code)

Returns a pointer to a static character string explaining the status code, or else NULL if unknown.

Definition at line 343 of file ffi_cert.cpp.

343 {
344 if(code < 0) {
345 return nullptr;
346 }
347
348#if defined(BOTAN_HAS_X509_CERTIFICATES)
349 Botan::Certificate_Status_Code sc = static_cast<Botan::Certificate_Status_Code>(code);
350 return Botan::to_string(sc);
351#else
352 return nullptr;
353#endif
354}
Botan::to_string
std::string to_string(ErrorType type)
Convert an ErrorType to string.
Definition exceptn.cpp:13
Botan::Certificate_Status_Code
Certificate_Status_Code
Definition pkix_enums.h:20

References Botan::to_string().

◆ botan_x509_cert_verify()

int botan_x509_cert_verify ( int * validation_result,
botan_x509_cert_t cert,
const botan_x509_cert_t * intermediates,
size_t intermediates_len,
const botan_x509_cert_t * trusted,
size_t trusted_len,
const char * trusted_path,
size_t required_strength,
const char * hostname,
uint64_t reference_time )

Returns 0 if the validation was successful, 1 if validation failed, and negative on error. A status code with details is written to *validation_result

Intermediates or trusted lists can be null Trusted path can be null

Definition at line 276 of file ffi_cert.cpp.

285 {
286 if(required_strength == 0) {
287 required_strength = 110;
288 }
289
290#if defined(BOTAN_HAS_X509_CERTIFICATES)
291 return ffi_guard_thunk(__func__, [=]() -> int {
292 const std::string hostname((hostname_cstr == nullptr) ? "" : hostname_cstr);
293 const Botan::Usage_Type usage = Botan::Usage_Type::UNSPECIFIED;
294 const auto validation_time = reference_time == 0
295 ? std::chrono::system_clock::now()
296 : std::chrono::system_clock::from_time_t(static_cast<time_t>(reference_time));
297
298 std::vector<Botan::X509_Certificate> end_certs;
299 end_certs.push_back(safe_get(cert));
300 for(size_t i = 0; i != intermediates_len; ++i) {
301 end_certs.push_back(safe_get(intermediates[i]));
302 }
303
304 std::unique_ptr<Botan::Certificate_Store> trusted_from_path;
305 std::unique_ptr<Botan::Certificate_Store_In_Memory> trusted_extra;
306 std::vector<Botan::Certificate_Store*> trusted_roots;
307
308 if(trusted_path && *trusted_path) {
309 trusted_from_path = std::make_unique<Botan::Certificate_Store_In_Memory>(trusted_path);
310 trusted_roots.push_back(trusted_from_path.get());
311 }
312
313 if(trusted_len > 0) {
314 trusted_extra = std::make_unique<Botan::Certificate_Store_In_Memory>();
315 for(size_t i = 0; i != trusted_len; ++i) {
316 trusted_extra->add_certificate(safe_get(trusted[i]));
317 }
318 trusted_roots.push_back(trusted_extra.get());
319 }
320
321 Botan::Path_Validation_Restrictions restrictions(false, required_strength);
322
323 auto validation_result =
324 Botan::x509_path_validate(end_certs, restrictions, trusted_roots, hostname, usage, validation_time);
325
326 if(result_code) {
327 *result_code = static_cast<int>(validation_result.result());
328 }
329
330 if(validation_result.successful_validation()) {
331 return 0;
332 } else {
333 return 1;
334 }
335 });
336#else
337 BOTAN_UNUSED(result_code, cert, intermediates, intermediates_len, trusted);
338 BOTAN_UNUSED(trusted_len, trusted_path, hostname_cstr, reference_time);
339 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
340#endif
341}
Botan::Path_Validation_Restrictions
Definition x509path.h:34
Botan::x509_path_validate
Path_Validation_Result x509_path_validate(const std::vector< X509_Certificate > &end_certs, const Path_Validation_Restrictions &restrictions, const std::vector< Certificate_Store * > &trusted_roots, std::string_view hostname, Usage_Type usage, std::chrono::system_clock::time_point ref_time, std::chrono::milliseconds ocsp_timeout, const std::vector< std::optional< OCSP::Response > > &ocsp_resp)
Definition x509path.cpp:882
Botan::Usage_Type
Usage_Type
Definition x509cert.h:22

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), Botan::UNSPECIFIED, and Botan::x509_path_validate().

◆ botan_x509_cert_verify_with_crl()

int botan_x509_cert_verify_with_crl ( int * validation_result,
botan_x509_cert_t cert,
const botan_x509_cert_t * intermediates,
size_t intermediates_len,
const botan_x509_cert_t * trusted,
size_t trusted_len,
const botan_x509_crl_t * crls,
size_t crls_len,
const char * trusted_path,
size_t required_strength,
const char * hostname,
uint64_t reference_time )

Different flavor of botan_x509_cert_verify, supports revocation lists. CRLs are passed as an array, same as intermediates and trusted CAs

Definition at line 417 of file ffi_cert.cpp.

428 {
429 if(required_strength == 0) {
430 required_strength = 110;
431 }
432
433#if defined(BOTAN_HAS_X509_CERTIFICATES)
434 return ffi_guard_thunk(__func__, [=]() -> int {
435 const std::string hostname((hostname_cstr == nullptr) ? "" : hostname_cstr);
436 const Botan::Usage_Type usage = Botan::Usage_Type::UNSPECIFIED;
437 const auto validation_time = reference_time == 0
438 ? std::chrono::system_clock::now()
439 : std::chrono::system_clock::from_time_t(static_cast<time_t>(reference_time));
440
441 std::vector<Botan::X509_Certificate> end_certs;
442 end_certs.push_back(safe_get(cert));
443 for(size_t i = 0; i != intermediates_len; ++i) {
444 end_certs.push_back(safe_get(intermediates[i]));
445 }
446
447 std::unique_ptr<Botan::Certificate_Store> trusted_from_path;
448 std::unique_ptr<Botan::Certificate_Store_In_Memory> trusted_extra;
449 std::unique_ptr<Botan::Certificate_Store_In_Memory> trusted_crls;
450 std::vector<Botan::Certificate_Store*> trusted_roots;
451
452 if(trusted_path && *trusted_path) {
453 trusted_from_path = std::make_unique<Botan::Certificate_Store_In_Memory>(trusted_path);
454 trusted_roots.push_back(trusted_from_path.get());
455 }
456
457 if(trusted_len > 0) {
458 trusted_extra = std::make_unique<Botan::Certificate_Store_In_Memory>();
459 for(size_t i = 0; i != trusted_len; ++i) {
460 trusted_extra->add_certificate(safe_get(trusted[i]));
461 }
462 trusted_roots.push_back(trusted_extra.get());
463 }
464
465 if(crls_len > 0) {
466 trusted_crls = std::make_unique<Botan::Certificate_Store_In_Memory>();
467 for(size_t i = 0; i != crls_len; ++i) {
468 trusted_crls->add_crl(safe_get(crls[i]));
469 }
470 trusted_roots.push_back(trusted_crls.get());
471 }
472
473 Botan::Path_Validation_Restrictions restrictions(false, required_strength);
474
475 auto validation_result =
476 Botan::x509_path_validate(end_certs, restrictions, trusted_roots, hostname, usage, validation_time);
477
478 if(result_code) {
479 *result_code = static_cast<int>(validation_result.result());
480 }
481
482 if(validation_result.successful_validation()) {
483 return 0;
484 } else {
485 return 1;
486 }
487 });
488#else
489 BOTAN_UNUSED(result_code, cert, intermediates, intermediates_len, trusted);
490 BOTAN_UNUSED(trusted_len, trusted_path, hostname_cstr, reference_time, crls, crls_len);
491 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
492#endif
493}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), Botan_FFI::safe_get(), Botan::UNSPECIFIED, and Botan::x509_path_validate().

◆ botan_x509_cert_view_as_string()

int botan_x509_cert_view_as_string ( botan_x509_cert_t cert,
botan_view_ctx ctx,
botan_view_str_fn view )

Definition at line 142 of file ffi_cert.cpp.

142 {
143#if defined(BOTAN_HAS_X509_CERTIFICATES)
144 return BOTAN_FFI_VISIT(cert, [=](const auto& c) { return invoke_view_callback(view, ctx, c.to_string()); });
145#else
146 BOTAN_UNUSED(cert, ctx, view);
147 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
148#endif
149}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::invoke_view_callback().

Referenced by botan_x509_cert_to_string().

◆ botan_x509_cert_view_public_key_bits()

int botan_x509_cert_view_public_key_bits ( botan_x509_cert_t cert,
botan_view_ctx ctx,
botan_view_bin_fn view )

Definition at line 253 of file ffi_cert.cpp.

253 {
254#if defined(BOTAN_HAS_X509_CERTIFICATES)
255 return BOTAN_FFI_VISIT(cert,
256 [=](const auto& c) { return invoke_view_callback(view, ctx, c.subject_public_key_bits()); });
257#else
258 BOTAN_UNUSED(cert, ctx, view);
259 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
260#endif
261}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::invoke_view_callback().

Referenced by botan_x509_cert_get_public_key_bits().

◆ botan_x509_crl_destroy()

int botan_x509_crl_destroy ( botan_x509_crl_t crl)

Definition at line 398 of file ffi_cert.cpp.

398 {
399#if defined(BOTAN_HAS_X509_CERTIFICATES)
400 return BOTAN_FFI_CHECKED_DELETE(crl);
401#else
402 BOTAN_UNUSED(crl);
403 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
404#endif
405}

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

◆ botan_x509_crl_load()

int botan_x509_crl_load ( botan_x509_crl_t * crl_obj,
const uint8_t crl_bits[],
size_t crl_bits_len )

Definition at line 380 of file ffi_cert.cpp.

380 {
381 if(!crl_obj || !crl_bits) {
382 return BOTAN_FFI_ERROR_NULL_POINTER;
383 }
384
385#if defined(BOTAN_HAS_X509_CERTIFICATES)
386 return ffi_guard_thunk(__func__, [=]() -> int {
387 Botan::DataSource_Memory bits(crl_bits, crl_bits_len);
388 auto c = std::make_unique<Botan::X509_CRL>(bits);
389 *crl_obj = new botan_x509_crl_struct(std::move(c));
390 return BOTAN_FFI_SUCCESS;
391 });
392#else
393 BOTAN_UNUSED(crl_bits_len);
394 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
395#endif
396}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan_FFI::ffi_guard_thunk().

◆ botan_x509_crl_load_file()

int botan_x509_crl_load_file ( botan_x509_crl_t * crl_obj,
const char * crl_path )

Definition at line 362 of file ffi_cert.cpp.

362 {
363 if(!crl_obj || !crl_path) {
364 return BOTAN_FFI_ERROR_NULL_POINTER;
365 }
366
367#if defined(BOTAN_HAS_X509_CERTIFICATES) && defined(BOTAN_TARGET_OS_HAS_FILESYSTEM)
368
369 return ffi_guard_thunk(__func__, [=]() -> int {
370 auto c = std::make_unique<Botan::X509_CRL>(crl_path);
371 *crl_obj = new botan_x509_crl_struct(std::move(c));
372 return BOTAN_FFI_SUCCESS;
373 });
374
375#else
376 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
377#endif
378}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and Botan_FFI::ffi_guard_thunk().

◆ botan_x509_is_revoked()

int botan_x509_is_revoked ( botan_x509_crl_t crl,
botan_x509_cert_t cert )

Given a CRL and a certificate, check if the certificate is revoked on that particular CRL

Definition at line 407 of file ffi_cert.cpp.

407 {
408#if defined(BOTAN_HAS_X509_CERTIFICATES)
409 return BOTAN_FFI_VISIT(crl, [=](const auto& c) { return c.is_revoked(safe_get(cert)) ? 0 : -1; });
410#else
411 BOTAN_UNUSED(cert);
412 BOTAN_UNUSED(crl);
413 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
414#endif
415}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_VISIT, BOTAN_UNUSED, and Botan_FFI::safe_get().

◆ botan_zfec_decode()

int botan_zfec_decode ( size_t K,
size_t N,
const size_t * indexes,
uint8_t *const * inputs,
size_t shareSize,
uint8_t ** outputs )

Decode some previously encoded shares using certain ZFEC parameters.

Parameters
Kthe number of shares needed for recovery
Nthe total number of shares
indexesThe index into the encoder's outputs for the corresponding element of the inputs array. Must be of length K.
inputsK previously encoded shares to decode
shareSizethe length in bytes of each input
outputsAn out parameter pointing to a fully allocated array of size [K][shareSize]. For all k in range, a decoded block will written to the memory starting at outputs[k][0].
Returns
0 on success, negative on failure

Definition at line 31 of file ffi_zfec.cpp.

32 {
33#if defined(BOTAN_HAS_ZFEC)
34 return Botan_FFI::ffi_guard_thunk(__func__, [=]() -> int {
35 std::map<size_t, const uint8_t*> shares;
36 for(size_t k = 0; k < K; ++k) {
37 shares.insert(std::pair<size_t, const uint8_t*>(indexes[k], inputs[k]));
38 }
39 Botan::ZFEC(K, N).decode_shares(
40 shares, shareSize, [=](size_t index, const uint8_t block[], size_t blockSize) -> void {
41 std::copy(block, block + blockSize, outputs[index]);
42 });
43 return BOTAN_FFI_SUCCESS;
44 });
45#else
46 BOTAN_UNUSED(K, N, indexes, inputs, shareSize, outputs);
47 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
48#endif
49}
Botan::ZFEC::decode_shares
void decode_shares(const std::map< size_t, const uint8_t * > &shares, size_t share_size, const output_cb_t &output_cb) const
Definition zfec.cpp:445

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan::ZFEC::decode_shares(), and Botan_FFI::ffi_guard_thunk().

Referenced by botan_srp6_server_session_step1().

◆ botan_zfec_encode()

int botan_zfec_encode ( size_t K,
size_t N,
const uint8_t * input,
size_t size,
uint8_t ** outputs )

ZFEC Encode some bytes with certain ZFEC parameters.

Parameters
Kthe number of shares needed for recovery
Nthe number of shares generated
inputthe data to FEC
sizethe length in bytes of input, which must be a multiple of K
outputsAn out parameter pointing to a fully allocated array of size [N][size / K]. For all n in range, an encoded block will be written to the memory starting at outputs[n][0].
Returns
0 on success, negative on failure

Definition at line 17 of file ffi_zfec.cpp.

17 {
18#if defined(BOTAN_HAS_ZFEC)
19 return Botan_FFI::ffi_guard_thunk(__func__, [=]() -> int {
20 Botan::ZFEC(K, N).encode(input, size, [=](size_t index, const uint8_t block[], size_t blockSize) -> void {
21 std::copy(block, block + blockSize, outputs[index]);
22 });
23 return BOTAN_FFI_SUCCESS;
24 });
25#else
26 BOTAN_UNUSED(K, N, input, size, outputs);
27 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
28#endif
29}
Botan::ZFEC::encode
void encode(const uint8_t input[], size_t size, const output_cb_t &output_cb) const
Definition zfec.cpp:402

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, Botan::ZFEC::encode(), and Botan_FFI::ffi_guard_thunk().

Referenced by botan_srp6_server_session_step1().

Generated by doxygen 1.13.2