diff options
| -rw-r--r-- | doc/index.txt | 2 | ||||
| -rw-r--r-- | doc/kdf.txt | 2 | ||||
| -rw-r--r-- | doc/log.txt | 3 | ||||
| -rw-r--r-- | doc/pubkey.txt | 7 | ||||
| -rw-r--r-- | doc/x509.txt | 6 |
5 files changed, 13 insertions, 7 deletions
diff --git a/doc/index.txt b/doc/index.txt index 18b01e55d..f286ee471 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -23,7 +23,9 @@ Contents: pgpkeys license credits + contrib support + users log Indices and tables diff --git a/doc/kdf.txt b/doc/kdf.txt index de73927d1..feb458108 100644 --- a/doc/kdf.txt +++ b/doc/kdf.txt @@ -1,5 +1,5 @@ -.. _key_derivation_functions: +.. _key_derivation_function: Key Derivation Functions ======================================== diff --git a/doc/log.txt b/doc/log.txt index d146eb116..5feeaeece 100644 --- a/doc/log.txt +++ b/doc/log.txt @@ -12,7 +12,8 @@ Version 1.9.16, Not Yet Released * The documentation, previously written in LaTeX, is now in reStructuredText suitable for processing by Sphinx, which can - generate nicely formatted HTML and PDFs. + generate nicely formatted HTML and PDFs. The documentation has + also been greatly updated and expanded. * The class EC_Domain_Params has been renamed EC_Group, with a typedef for backwards compatability. diff --git a/doc/pubkey.txt b/doc/pubkey.txt index 6279234e9..538710441 100644 --- a/doc/pubkey.txt +++ b/doc/pubkey.txt @@ -173,6 +173,8 @@ passphrase passed in first, and then it cancels. In a future version, it is likely that ``User_Interface`` will be replaced by a simple callback using ``std::function``. +.. _serializing_public_keys: + Serializing Public Keys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -334,8 +336,9 @@ is created by the constructor: .. cpp:function:: DLIES_Encryptor::DLIES_Encryptor(const PK_Key_Agreement_Key&, KDF* kdf, MessageAuthenticationCode* mac, size_t mac_key_len = 20) - Where *kdf* is a :ref:`key_derivation_function` and *mac* is a - :ref:`message_auth_code`. + Where *kdf* is a key derivation function (see + :ref:`key_derivation_function`) and *mac* is a + MessageAuthenticationCode. The decryption classes are named ``PK_Decryptor``, ``PK_Decryptor_EME``, and ``DLIES_Decryptor``. They are created in the diff --git a/doc/x509.txt b/doc/x509.txt index 942d27f4c..9c3730ccb 100644 --- a/doc/x509.txt +++ b/doc/x509.txt @@ -34,9 +34,9 @@ So what's in an X.509 certificate? Obviously, you want to be able to get the public key. This is achieved by calling the member function ``subject_public_key``, which will return a ``Public_Key``\*. As to what to do with this, read about -``load_key`` in :ref:`pk_import_export`. In the general case, this -could be any kind of public key, though 99% of the time it will be an -RSA key. However, Diffie-Hellman, DSA, and ECDSA keys are also +``load_key`` in :ref:`serializing_public_keys`. In the general case, +this could be any kind of public key, though 99% of the time it will +be an RSA key. However, Diffie-Hellman, DSA, and ECDSA keys are also supported, so be careful about how you treat this. It is also a wise idea to examine the value returned by ``constraints``, to see what uses the public key is approved for. |