diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/downloads.rst | 0 | ||||
| -rw-r--r-- | doc/manual/contents.rst | 3 | ||||
| -rw-r--r-- | doc/manual/ffi.rst | 25 | ||||
| -rw-r--r-- | doc/manual/rng.rst | 2 | ||||
| -rw-r--r-- | doc/manual/support.rst | 4 |
5 files changed, 18 insertions, 16 deletions
diff --git a/doc/downloads.rst b/doc/downloads.rst deleted file mode 100644 index e69de29bb..000000000 --- a/doc/downloads.rst +++ /dev/null diff --git a/doc/manual/contents.rst b/doc/manual/contents.rst index d4e06f82d..941bf014e 100644 --- a/doc/manual/contents.rst +++ b/doc/manual/contents.rst @@ -6,6 +6,7 @@ Contents index goals + support building platforms versions @@ -41,4 +42,4 @@ Contents side_channels packaging fuzzing - support + diff --git a/doc/manual/ffi.rst b/doc/manual/ffi.rst index e0643974b..467136316 100644 --- a/doc/manual/ffi.rst +++ b/doc/manual/ffi.rst @@ -1,12 +1,12 @@ -FFI Interface +FFI (C89) Interface ======================================== .. versionadded:: 1.11.14 Botan's ffi module provides a C89 API intended to be easily usable with other language's foreign function interface (FFI) libraries. For instance the included -Python module uses the ``ctypes`` module for all library access. This API is of +Python wrapper uses Python's ``ctypes`` module and the C89 API. This API is of course also useful for programs written directly in C. Code examples can be found in `src/tests/test_ffi.cpp`. @@ -99,7 +99,7 @@ need to implement custom primitives using a PRP. .. cpp:type:: opaque* botan_block_cipher_t - An opauqe data type for a block cipher. Don't mess with it. + An opaque data type for a block cipher. Don't mess with it. .. cpp:function:: int botan_block_cipher_init(botan_block_cipher_t* bc, const char* cipher_name) @@ -119,12 +119,13 @@ need to implement custom primitives using a PRP. .. cpp:function:: int botan_block_cipher_encrypt_blocks(botan_block_cipher_t bc, const uint8_t in[], uint8_t out[], size_t blocks) - The key must have been set first with + The key must have been set first with :cpp:func:`botan_block_cipher_set_key`. Encrypt *blocks* blocks of data stored in *in* and place the ciphertext into *out*. The two parameters may be the same buffer, but must not overlap. .. cpp:function:: int botan_block_cipher_decrypt_blocks(botan_block_cipher_t bc, const uint8_t in[], uint8_t out[], size_t blocks) + The key must have been set first with :cpp:func:`botan_block_cipher_set_key`. Decrypt *blocks* blocks of data stored in *in* and place the ciphertext into *out*. The two parameters may be the same buffer, but must not overlap. @@ -430,14 +431,14 @@ Multiple Precision Integers .. cpp:function:: int botan_mp_gcd(botan_mp_t out, botan_mp_t x, botan_mp_t y) - Compute the greated common divisor of ``x`` and ``y``. + Compute the greatest common divisor of ``x`` and ``y``. .. cpp:function:: int botan_mp_is_prime(botan_mp_t n, botan_rng_t rng, size_t test_prob) - Test if ``n`` is prime. The algorithm used (Miller-Rabin) is probabalistic, + Test if ``n`` is prime. The algorithm used (Miller-Rabin) is probabilistic, set ``test_prob`` to the desired assurance level. For example if ``test_prob`` is 64, then sufficient Miller-Rabin iterations will run to - assure there is at most a ``1/2**64`` chance that ``n`` is composit. + assure there is at most a ``1/2**64`` chance that ``n`` is composite. .. cpp:function:: int botan_mp_get_bit(botan_mp_t n, size_t bit) @@ -565,14 +566,14 @@ Public Key Creation, Import and Export 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. + For example "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. + For example "p" or "q" for RSA keys, or "x" for DSA keys or ECC keys. RSA specific functions @@ -642,18 +643,18 @@ ElGamal specific functions Initialize a public ElGamal key using group parameters p and g and public key y. -Diffie Hellmann specific functions +Diffie-Hellman specific functions ---------------------------------------- .. cpp:function:: int botan_privkey_load_dh(botan_privkey_t* key, \ botan_mp_t p, botan_mp_t g, botan_mp_t x) - Initialize a private Diffie Hellmann key using group parameters p and g and private key x. + Initialize a private Diffie-Hellman key using group parameters p and g and private key x. .. cpp:function:: int botan_pubkey_load_dh(botan_pubkey_t* key, \ botan_mp_t p, botan_mp_t g, botan_mp_t y) - Initialize a public Diffie Hellmann key using group parameters p and g and public key y. + Initialize a public Diffie-Hellman key using group parameters p and g and public key y. Public Key Encryption/Decryption ---------------------------------------- diff --git a/doc/manual/rng.rst b/doc/manual/rng.rst index 99cc83914..7e80e2ed9 100644 --- a/doc/manual/rng.rst +++ b/doc/manual/rng.rst @@ -23,7 +23,7 @@ The major interfaces are Like randomize, but first incorporates the additional input field into the state of the RNG. The additional input could be anything which - parameterizes this request. + parameterizes this request. Not all RNG types accept additional inputs. .. cpp:function:: void RandomNumberGenerator::randomize_with_ts_input(uint8_t* data, size_t length) diff --git a/doc/manual/support.rst b/doc/manual/support.rst index 8813e0359..ca7166fbc 100644 --- a/doc/manual/support.rst +++ b/doc/manual/support.rst @@ -1,5 +1,5 @@ Support Information -------------------------- +======================= Following table provides the support status for Botan branches. Any branch not listed here (including 1.11) is no longer supported. Dates in the future are @@ -17,7 +17,7 @@ Branch First Release End of Active Development End of Life "Active development" refers to adding new features and optimizations. At the conclusion of the active development phase, only bugfixes are applied. -Getting Support +Getting Help ------------------ To get help with Botan, open an issue on |