diff options
author | Jack Lloyd <[email protected]> | 2018-09-28 10:48:41 -0400 |
---|---|---|
committer | Jack Lloyd <[email protected]> | 2018-09-28 10:51:12 -0400 |
commit | 8e6fa0a74ee5bf3fcf129ae1c474a3d732500f74 (patch) | |
tree | db9d7f035bdcea3ee1e36dcc5ad1dd4afa825a58 /doc/manual/tls.rst | |
parent | 519b21c9586045be3e9316e57bbc5c68ba5841da (diff) |
Spell check the documentation
Diffstat (limited to 'doc/manual/tls.rst')
-rw-r--r-- | doc/manual/tls.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/manual/tls.rst b/doc/manual/tls.rst index 5e615af0f..310beaee1 100644 --- a/doc/manual/tls.rst +++ b/doc/manual/tls.rst @@ -24,7 +24,7 @@ passed in results in some change in the state, such as a handshake completing, or some data or an alert being received from the other side, then the appropriate user provided callback will be invoked. -If the reader is familiar with OpenSSL's BIO layer, it might be analagous +If the reader is familiar with OpenSSL's BIO layer, it might be analogous to saying the only way of interacting with Botan's TLS is via a `BIO_mem` I/O abstraction. This makes the library completely agnostic to how you write your network layer, be it blocking sockets, libevent, asio, a @@ -45,7 +45,7 @@ information about the connection. As an example you could ``send`` to perform a blocking write on a socket, or append the data to a queue managed by your application, and initiate - an asyncronous write. + an asynchronous write. For TLS all writes must occur *in the order requested*. For DTLS this ordering is not strictly required, but is still recommended. @@ -64,7 +64,7 @@ information about the connection. For TLS the record number will always increase. For DTLS, it is possible to receive records with the `rec_no` field out of - order, or with gaps, cooresponding to reordered or lost datagrams. + order, or with gaps, corresponding to reordered or lost datagrams. .. cpp:function:: void tls_alert(Alert alert) @@ -93,7 +93,7 @@ information about the connection. const Policy& policy) Optional - default implementation should work for many users. - It can be overrided for implementing extra validation routines + It can be overridden for implementing extra validation routines such as public key pinning. Verifies the certificate chain in *cert_chain*, assuming the leaf @@ -211,7 +211,7 @@ available: If the current TLS connection state is unable to transmit new application records (for example because a handshake has not - yet completed or the connnection has already ended due to an + yet completed or the connection has already ended due to an error) an exception will be thrown. .. cpp:function:: void close() @@ -484,7 +484,7 @@ TLS Servers ) The first 5 arguments as well as the final argument -*reserved_io_buffer_size*, are treated similiarly to the :ref:`client +*reserved_io_buffer_size*, are treated similarly to the :ref:`client <tls_client>`. If a client sends the ALPN extension, the ``callbacks`` function @@ -887,7 +887,7 @@ policy settings from a file. simply allow only ECDH key exchange in the application policy. DH exchange also often involves transferring several additional Kb (without the benefit of post quantum security) so if CECPQ1 is being disabled for - traffic overhread reasons, DH should also be avoid. + traffic overhead reasons, DH should also be avoid. Also allowed: "RSA", "SRP_SHA", "ECDHE_PSK", "DHE_PSK", "PSK" @@ -1126,7 +1126,7 @@ TLS Ciphersuites .. cpp:function:: std::string to_string() const - Return the ful name of ciphersuite (for example + Return the full name of ciphersuite (for example "RSA_WITH_RC4_128_SHA" or "ECDHE_RSA_WITH_AES_128_GCM_SHA256") .. cpp:function:: std::string kex_algo() const |