aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2012-06-20 13:48:30 +0000
committerlloyd <[email protected]>2012-06-20 13:48:30 +0000
commit8729e97de61943ebd0555b94627c7ba50704d02f (patch)
tree28d6b5a4f1e52520cadee79515968b7ad2a19a5b /doc
parentc33f696fcd61409e5733959e2bfa625e934c0368 (diff)
Doc updates
Diffstat (limited to 'doc')
-rw-r--r--doc/credentials_manager.txt7
-rw-r--r--doc/faq.txt10
-rw-r--r--doc/index.txt28
-rw-r--r--doc/tls.txt2
4 files changed, 28 insertions, 19 deletions
diff --git a/doc/credentials_manager.txt b/doc/credentials_manager.txt
new file mode 100644
index 000000000..6eb836d60
--- /dev/null
+++ b/doc/credentials_manager.txt
@@ -0,0 +1,7 @@
+
+Credentials Manager
+==================================================
+
+A ``Credentials_Manager`` is a big ball of wax that isn't yet
+documented. :(
+
diff --git a/doc/faq.txt b/doc/faq.txt
index 9658621fe..e3b85af8e 100644
--- a/doc/faq.txt
+++ b/doc/faq.txt
@@ -170,7 +170,8 @@ Does botan support SSL/TLS, SSH, S/MIME, OpenPGP...
------------------------------------------------------------
Support for SSL/TLS is included in version 1.9.4 and later. Currently
-SSLv3 and TLS 1.0 and 1.1 are supported.
+SSLv3 and TLS 1.0 and 1.1 are supported. The latest development
+versions also support TLS 1.2.
`NetSieben SSH <http://netsieben.com/products/ssh/>`_ is an open
source SSHv2 implementation that uses botan.
@@ -188,6 +189,9 @@ The most common stumbling block is a compiler that is buggy or can't
handle modern C++ (specifically, C++98). Check out the :doc:`build log
<build_log>` for a sense of which platforms are actively being tested.
+Versions 1.11.0 and higher require a C++11 compiler. GCC 4.7.0 and
+Clang 3.1 are known to work well.
+
I'm not feeling this, what can I use instead?
------------------------------------------------------------
@@ -200,9 +204,5 @@ I'm not feeling this, what can I use instead?
targeted to being an SSL/TLS implementation but there is a lot of
other stuff in there as well.
-* `XySSL <http://www.ohloh.net/projects/xyssl>`_ is a C library
- providing a very small footprint crypto library and SSL
- implementation.
-
* `Adam Shostack <http://www.homeport.org/~adam/crypto/>`_ maintains a
(somewhat out of date) list of open source crypto libraries.
diff --git a/doc/index.txt b/doc/index.txt
index 33de06f55..cab41f776 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -10,8 +10,9 @@ message processing system <filters>`, and a wide variety of other
features. A third party open source implementation of `SSHv2
<http://www.netsieben.com/products/ssh/>`_ that uses botan is also
available. In addition to C++ you can use botan from :doc:`Python
-<python>` or Perl, though the current bindings only wrap portions of
-the library.
+<python>` or `Node.js <https://github.com/justinfreitag/node-botan>`_
+or Perl, though the current bindings only wrap portions of the
+library.
See the :doc:`faq` for a list of common questions and answers.
@@ -19,13 +20,14 @@ See the :doc:`faq` for a list of common questions and answers.
See :doc:`download` for information about getting the latest version.
-The core of botan is written in C++98 with no dependencies besides the
-STL and the rest of the ISO standard library, but the library also
-includes optional modules which make further assumptions about their
-environment, providing features such as compression (using zlib or
-bzip2), entropy gathering, and secure memory allocation. Assembly
-implementations of key algorithms like SHA-1 and multiple precision
-integer routines for x86 and x86-64 processors are also included.
+The core of botan is written in C++11 (or C++98 for versions up to and
+including 1.10) with no dependencies besides the STL and the rest of
+the ISO standard library, but the library also includes optional
+modules which make further assumptions about their environment,
+providing features such as compression (using zlib or bzip2), entropy
+gathering, and secure memory allocation. Assembly implementations of
+key algorithms like SHA-1 and multiple precision integer routines for
+x86 and x86-64 processors are also included.
It runs on most common operating systems and can be used with a number
of different commercial and open source compilers. The :doc:`build log
@@ -58,10 +60,10 @@ history.
If you need help or have questions, send a mail to the `development
mailing list
<http://lists.randombit.net/mailman/listinfo/botan-devel/>`_.
-"Philosophical" bug reports, announcements of programs using the
-library, and related topics are also welcome. :doc:`Commercial support
-options <support>` are also available. If you find what you believe to
-be a bug, please file a ticket in `Bugzilla
+Patches, "philosophical" bug reports, announcements of programs using
+the library, and related topics are also welcome. :doc:`Commercial
+support options <support>` are also available. If you find what you
+believe to be a bug, please file a ticket in `Bugzilla
<http://bugs.randombit.net/>`_.
A useful reference while reading this manual is the `Doxygen
diff --git a/doc/tls.txt b/doc/tls.txt
index 267fb6e62..95fb428a9 100644
--- a/doc/tls.txt
+++ b/doc/tls.txt
@@ -56,7 +56,7 @@ these methods available:
received, or if a fatal alert of any kind was received from the
counterparty.
- .. cpp:function:: void renegotiate()
+ .. cpp:function:: void renegotiate(bool force_full_renegotiation = false)
Initiates a renegotiation. The counterparty is allowed by the
protocol to ignore this request. If a successful renegotiation