diff options
| author | Jack Lloyd <[email protected]> | 2016-04-13 01:24:21 -0400 |
|---|---|---|
| committer | Jack Lloyd <[email protected]> | 2016-04-13 01:25:51 -0400 |
| commit | 5d34bc57073db07db0b47eb1dd784c1c6fac9c8d (patch) | |
| tree | 55417f177a9c324b127bc794e76e3ae3b1562e89 /doc | |
| parent | 7aac6b2fc3a4c754eafb3f50c3de5c188b22d67c (diff) | |
Fix formatting bugs in TLS doc
Fixes GH #460
Closes GH #474
[ci skip]
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/tls.rst | 17 |
1 files changed, 6 insertions, 11 deletions
diff --git a/doc/manual/tls.rst b/doc/manual/tls.rst index 3d0286e61..a10a4280c 100644 --- a/doc/manual/tls.rst +++ b/doc/manual/tls.rst @@ -364,10 +364,6 @@ information about that session: Returns ``true`` if the connection was negotiated with the correct extensions to prevent the renegotiation attack. -There are also functions for serialization and deserializing sessions: - -.. cpp:class:: TLS::Session - .. cpp:function:: std::vector<byte> encrypt(const SymmetricKey& key, \ RandomNumberGenerator& rng) @@ -382,18 +378,17 @@ There are also functions for serialization and deserializing sessions: size_t length, \ const SymmetricKey& key) - Decrypts a session that was encrypted previously with - ``encrypt`` and *key*, or throws an exception if decryption - fails. + Decrypts a session that was encrypted previously with ``encrypt`` and + ``key``, or throws an exception if decryption fails. .. cpp:function:: secure_vector<byte> DER_encode() const Returns a serialized version of the session. - .. warning:: The return value contains the master secret for - the session, and an attacker who recovers it could - recover plaintext of previous sessions or - impersonate one side to the other. + .. warning:: The return value of ``DER_encode`` contains the + master secret for the session, and an attacker who + recovers it could recover plaintext of previous + sessions or impersonate one side to the other. .. _tls_session_managers: |