diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contents.rst | 1 | ||||
| -rw-r--r-- | doc/cryptobox.rst | 2 | ||||
| -rw-r--r-- | doc/download.rst | 46 | ||||
| -rw-r--r-- | doc/release_process.rst | 2 | ||||
| -rw-r--r-- | doc/relnotes/1_11_2.rst | 2 | ||||
| -rw-r--r-- | doc/relnotes/1_11_3.rst | 9 | ||||
| -rw-r--r-- | doc/tls.rst | 16 | ||||
| -rw-r--r-- | doc/vcs.rst | 41 |
8 files changed, 70 insertions, 49 deletions
diff --git a/doc/contents.rst b/doc/contents.rst index ba9396c99..a5591d0b0 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -39,6 +39,7 @@ Contents users pgpkey algos + vcs release_process build_log diff --git a/doc/cryptobox.rst b/doc/cryptobox.rst index a418ddaf6..ea77eee5a 100644 --- a/doc/cryptobox.rst +++ b/doc/cryptobox.rst @@ -22,7 +22,7 @@ namespace `Botan::CryptoBox`. Decrypts something encrypted with encrypt. - .. cpp:function:: std::string decrypt(const std::string& input, + .. cpp:function:: std::string decrypt(const std::string& input, \ const std::string& passphrase) Decrypts something encrypted with encrypt. diff --git a/doc/download.rst b/doc/download.rst index 8382ebc53..a67039976 100644 --- a/doc/download.rst +++ b/doc/download.rst @@ -38,8 +38,9 @@ The latest version of the current development series, from branch :tgz:`1.11.2` (:tgz_sig:`sig <1.11.2>`), :tbz:`1.11.2` (:tbz_sig:`sig <1.11.2>`) -A script also creates daily snapshots of trunk, which are available -`here <https://files.randombit.net/botan/snapshots/>`_. +To access the latest unreleased sources, see :doc:`vcs`. A script also +creates regular snapshots of trunk, which are available `here +<https://files.randombit.net/botan/snapshots/>`_. .. note:: @@ -53,44 +54,3 @@ The latest version of the previous stable series, from branch ``net.randombit.botan.1_8`` is :doc:`relnotes/1_8_14`: :tgz:`1.8.14` (:tgz_sig:`sig <1.8.14>`), :tbz:`1.8.14` (:tbz_sig:`sig <1.8.14>`) - -Accessing Version Control ----------------------------------------- - -Botan's development occurs using a distributed version control system -called `Monotone <http://www.monotone.ca>`_ (though there is also a -mirror on `github <https://github.com/randombit/botan>`_. The main -branch of development occurs on the branch named -``net.randombit.botan``. To download that branch and set up a new -workspace, run:: - - $ mtn db init --db=botan.mtn - $ mtn pull --db=botan.mtn randombit.net 'net.randombit.botan' - [...] - $ mtn checkout --db=botan.mtn --branch=net.randombit.botan - [...] - -By default the ``checkout`` command will place the workspace in a -directory with the same name as the branch you are checking out. If -you want a different directory name, just include it after the -``--branch`` option (you can also rename this directory at any time). - -If this is the first time you've connected to the server, Monotone -will print:: - - mtn: first time connecting to server randombit.net - mtn: I'll assume it's really them, but you might want to double-check - mtn: their key's fingerprint: 8c0b868f2247215c63c96983b1c8ca0f0f0cfd9a - -The fingerprint shown above was the correct one as of June 20, 2012. - -To pull further changes, from anywhere in the workspace run these -commands:: - - $ mtn pull - [...] - $ mtn update - [summary of changes] - -The ``mtn update`` command will give you a summary of which files -changed; to view the full changelog, run ``mtn log``. diff --git a/doc/release_process.rst b/doc/release_process.rst index 04e40f613..88daff0c6 100644 --- a/doc/release_process.rst +++ b/doc/release_process.rst @@ -73,7 +73,7 @@ The current botan website is derived entirely from the ReST content in called ``mtn-watch`` periodically checks for new updates on the ``net.randombit.botan`` branch (only), and if found regenerates the site content. Thus as soon as the changes are synced to the server -running on ``randombit.net``, the website will be updated. +running on ``mtn.randombit.net``, the website will be updated. Announce The Release ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/relnotes/1_11_2.rst b/doc/relnotes/1_11_2.rst index 714091d8f..767fbf624 100644 --- a/doc/relnotes/1_11_2.rst +++ b/doc/relnotes/1_11_2.rst @@ -21,7 +21,7 @@ New Parallel Filter """""""""""""""""""""""""""""""""""""""" * The new filter :cpp:class:`Threaded_Fork` acts like a normal - :cpp:class:`Fork,` sending its input to a number of different + :cpp:class:`Fork`, sending its input to a number of different filters, but each subchain of filters in the fork runs in its own thread. Contributed by Joel Low. diff --git a/doc/relnotes/1_11_3.rst b/doc/relnotes/1_11_3.rst index 73e16e96a..3c1ab4c30 100644 --- a/doc/relnotes/1_11_3.rst +++ b/doc/relnotes/1_11_3.rst @@ -1,6 +1,13 @@ Version 1.11.3, Not Yet Released ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +* A new TLS policy mechanism + :cpp:func:`TLS::Policy::server_uses_own_ciphersuite_preferences` + controls how a server chooses a ciphersuite. Previously it always + chose its most preferred cipher out of the client's list, but this + can allow configuring a server to choose by the client's preferences + instead. + * Implementations of the OCB and GCM authenticated cipher modes are now included @@ -12,8 +19,8 @@ Version 1.11.3, Not Yet Released have been removed * New functions for symmetric encryption are included in cryptobox.h + though interfaces and formats are subject to change. * A new function :cpp:func:`algorithm_kat_detailed` returns a string providing information about failures, instead of just a pass/fail indicator as in :cpp:func:`algorithm_kat`. - diff --git a/doc/tls.rst b/doc/tls.rst index 83503fcb1..406b94d93 100644 --- a/doc/tls.rst +++ b/doc/tls.rst @@ -526,17 +526,24 @@ be negotiated during a handshake. Default: "secp521r1", "secp384r1", "secp256r1", "secp256k1", "secp224r1", "secp224k1" - Also allowed: "secp192r1", "secp192k1", "secp160r2", "secp160r1", "secp160k1" + Also allowed: "secp192r1", "secp192k1", "secp160r2", "secp160r1", + "secp160k1" .. cpp:function:: std::vector<byte> compression() const Return the list of compression methods we are willing to use, in order of - preference. + preference. Default is null compression only. .. note:: TLS compression is not currently supported. + .. cpp:function:: bool server_uses_own_ciphersuite_preferences() const + + If this returns true, a server will pick the cipher it prefers the + most out of the client's list. Otherwise, it will negotiate the + first cipher in the client's ciphersuite list that it supports. + .. cpp:function:: bool negotiate_heartbeat_support() const If this function returns true, clients will offer the heartbeat @@ -545,6 +552,11 @@ be negotiated during a handshake. support and servers will ignore clients offering heartbeat support. + If this returns true, callers should expect to handle heartbeat + data in their ``proc_fn``. + + Default + .. cpp:function:: bool allow_server_initiated_renegotiation() const If this function returns true, a client will accept a diff --git a/doc/vcs.rst b/doc/vcs.rst new file mode 100644 index 000000000..e2353ee53 --- /dev/null +++ b/doc/vcs.rst @@ -0,0 +1,41 @@ + +Accessing Version Control +======================================== + +Botan's development occurs using a distributed version control system +called `Monotone <http://www.monotone.ca>`_ (though there is also a +mirror on `github <https://github.com/randombit/botan>`_). The main +branch of development occurs on the branch named +``net.randombit.botan``. To download that branch and set up a new +workspace, run:: + + $ mtn db init --db=botan.mtn + $ mtn pull --db=botan.mtn mtn.randombit.net 'net.randombit.botan' + [...] + $ mtn checkout --db=botan.mtn --branch=net.randombit.botan + [...] + +By default the ``checkout`` command will place the workspace in a +directory with the same name as the branch you are checking out. If +you want a different directory name, just include it after the +``--branch`` option (you can also rename this directory at any time). + +If this is the first time you've connected to the server, Monotone +will print:: + + mtn: first time connecting to server mtn.randombit.net + mtn: I'll assume it's really them, but you might want to double-check + mtn: their key's fingerprint: 8c0b868f2247215c63c96983b1c8ca0f0f0cfd9a + +The fingerprint shown above was the correct one as of March 21, 2013. + +To pull further changes, from anywhere in the workspace run these +commands:: + + $ mtn pull + [...] + $ mtn update + [summary of changes] + +The ``mtn update`` command will give you a summary of which files +changed; to view the full changelog, run ``mtn log``. |