aboutsummaryrefslogtreecommitdiffstats
path: root/readme.rst
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2017-01-07 11:42:14 -0500
committerJack Lloyd <[email protected]>2017-01-07 11:42:14 -0500
commit02f0a1197c78f4289cd9d2093c6c50058cbbfdc6 (patch)
treec985a681542c51f53105034f776b87b05f7f4b6e /readme.rst
parentc46692e9562e0faa6961532c21998d5cd5c2ee20 (diff)
Switch to readthedocs Sphinx theme
Move some text and change some headers to look better with how rtd theme formats the table of contents. GH #822
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst59
1 files changed, 10 insertions, 49 deletions
diff --git a/readme.rst b/readme.rst
index a652cb65d..93f10f930 100644
--- a/readme.rst
+++ b/readme.rst
@@ -8,7 +8,11 @@ and released under the permissive `Simplified BSD
Botan's goal is to be the best option for cryptography in new C++ code by
offering the tools necessary to implement a range of practical systems, such as
TLS/DTLS, PKIX certificate handling, PKCS#11 and TPM hardware support, password
-hashing, and post quantum crypto schemes. Find the full feature list below.
+hashing, and post quantum crypto schemes. In addition to the C++, botan has a
+C89 API specifically designed to be easy to call from other languages. A Python
+binding using ctypes calling the C89 API is included.
+
+Find the full feature list below.
Development is coordinated on `GitHub <https://github.com/randombit/botan>`_
and contributions are welcome (read `doc/contributing.rst` for more info).
@@ -36,14 +40,8 @@ For all the details on building the library, read the
# shows available commands
$ make install
-The library can also be built into a single-file amalgamation for easy
-inclusion into external build systems.
-
-In addition to C++, botan has a C89 API specifically designed to be easy
-to call from other languages. A Python binding using ctypes is included.
-
-Continuous integration status
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Botan can also be built into a single-file amalgamation for easy inclusion into
+external build systems, see the manual for details.
.. image:: https://travis-ci.org/randombit/botan.svg?branch=master
:target: https://travis-ci.org/randombit/botan
@@ -61,8 +59,6 @@ Continuous integration status
:target: https://botan-ci.kullo.net/
:alt: Kullo CI status
-Static analyzer status
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: https://codecov.io/github/randombit/botan/coverage.svg?branch=master
:target: https://codecov.io/github/randombit/botan
:alt: Code coverage report
@@ -75,11 +71,11 @@ Static analyzer status
:target: https://sonarqube.com/dashboard/index/botan
:alt: Sonarqube analysis
-Download
+Release Downloads
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See the `change notes <https://botan.randombit.net/news.html>`_ and
-`security page <https://botan.randombit.net/security.html>`_
+See the `release notes <https://botan.randombit.net/news.html>`_ and
+`security advisories <https://botan.randombit.net/security.html>`_
All releases are signed with a
`PGP key <https://botan.randombit.net/pgpkey.txt>`_::
@@ -116,36 +112,6 @@ The latest 1.10 release is
`(sig) <https://botan.randombit.net/releases/Botan-1.10.14.tgz.asc>`_
released on 2016-11-28
-Books and other resources
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-You should have some knowledge of cryptography *before* trying to use
-the library. This is an area where it is very easy to make mistakes,
-and where things are often subtle and/or counterintuitive. Obviously
-the library tries to provide things at a high level precisely to
-minimize the number of ways things can go wrong, but naive use will
-almost certainly not result in a secure system.
-
-Especially recommended are:
-
-- *Cryptography Engineering*
- by Niels Ferguson, Bruce Schneier, and Tadayoshi Kohno
-
-- *Security Engineering -- A Guide to Building Dependable Distributed Systems*
- by Ross Anderson
- (`available online <https://www.cl.cam.ac.uk/~rja14/book.html>`_)
-
-- *Handbook of Applied Cryptography*
- by Alfred J. Menezes, Paul C. Van Oorschot, and Scott A. Vanstone
- (`available online <http://www.cacr.math.uwaterloo.ca/hac/>`_)
-
-If you're doing something non-trivial or unique, you might want to at
-the very least ask for review/input on a mailing list such as the
-`metzdowd <http://www.metzdowd.com/mailman/listinfo/cryptography>`_ or
-`randombit <http://lists.randombit.net/mailman/listinfo/cryptography>`_
-crypto lists. And (if possible) pay a professional cryptographer or
-security company to review your design and code.
-
Find Enclosed
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -225,8 +191,3 @@ Recommended Algorithms
or ECDSA using P-256/SHA-256 or P-521/SHA-512
* Key Agreement: ECDH using P-256 or X25519. If you are concerned
about quantum computers, combine ECC with NewHope.
-
-Code coverage map
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. image:: https://codecov.io/gh/randombit/botan/graphs/tree.svg