aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2017-04-02 16:10:52 -0400
committerJack Lloyd <[email protected]>2017-04-02 16:10:52 -0400
commitd93a1ad12e4bd872a687ea31329efd2c9878c8d9 (patch)
tree04be720275d02b045dd779f273233d1ee343ea19
parentafbf3dc9e0e1169dce42a72275d95128c6d4e4da (diff)
Document new functions
-rw-r--r--doc/manual/ffi.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/manual/ffi.rst b/doc/manual/ffi.rst
index d53bdb977..ee868e7db 100644
--- a/doc/manual/ffi.rst
+++ b/doc/manual/ffi.rst
@@ -478,6 +478,21 @@ Public Key Creation, Import and Export
.. cpp:function:: int botan_pubkey_destroy(botan_pubkey_t key)
+.. cpp:function:: int botan_pubkey_get_field(botan_mp_t output, \
+ botan_pubkey_t key, \
+ const char* field_name)
+
+ Read an algorithm specific field from the public key object, placing it into output.
+ For exampe "n" or "e" for RSA keys or "p", "q", "g", and "y" for DSA keys.
+
+.. cpp:function:: int botan_privkey_get_field(botan_mp_t output, \
+ botan_privkey_t key, \
+ const char* field_name)
+
+ Read an algorithm specific field from the private key object, placing it into output.
+ For exampe "p" or "q" for RSA keys, or "x" for DSA keys or ECC keys.
+
+
RSA specific functions
----------------------------------------
@@ -519,6 +534,19 @@ RSA specific functions
Initialize a public RSA key using parameters n and e.
+DSA specific functions
+----------------------------------------
+
+.. cpp:function:: 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)
+
+ Initialize a private DSA key using group parameters p, q, and g and private key x.
+
+.. cpp:function:: 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)
+
+ Initialize a private DSA key using group parameters p, q, and g and public key y.
+
Public Key Encryption/Decryption
----------------------------------------