diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dev/release_process.rst | 18 | ||||
| -rw-r--r-- | doc/relnotes/1_11_18.rst | 5 | ||||
| -rw-r--r-- | doc/relnotes/index.rst | 1 | ||||
| -rw-r--r-- | doc/website/contents.rst | 2 | ||||
| -rw-r--r-- | doc/website/download.rst | 3 | ||||
| -rw-r--r-- | doc/website/index.rst | 10 | ||||
| -rw-r--r-- | doc/website/users.rst | 118 | ||||
| -rw-r--r-- | doc/website/vcs.rst | 41 |
8 files changed, 17 insertions, 181 deletions
diff --git a/doc/dev/release_process.rst b/doc/dev/release_process.rst index 7f7f97abc..2848008c9 100644 --- a/doc/dev/release_process.rst +++ b/doc/dev/release_process.rst @@ -18,24 +18,18 @@ point to the new release. Add the new release to Check in these changes (alone, with no other modifications) with a checkin message along the lines of "Update for X.Y.Z release", then -tag the release with the version in monotone (eg tag '1.11.8', no -prefix). +tag the release with the version in git (eg tag '1.11.8', no prefix). Build The Release ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The release script is ``src/scripts/dist.py`` and runs from -a monotone repository by pulling the revision matching the tag set -previously. For instance:: +The release script is ``src/scripts/dist.py`` and must be +run from a git workspace. - $ src/scripts/dist.py --mtn-db ~/var/mtn/botan.mtn 1.11.8 + $ src/scripts/dist.py 1.11.8 -The ``--mtn-db`` 'option' is mandatory, unless the environmental -variable ``BOTAN_MTN_DB`` is set, in which case that value is used if -``--mtn-db`` is not provided. - -Another useful option is ``--output-dir``, which specifies where -the output will be placed. +One useful option is ``--output-dir``, which specifies where the +output will be placed. The ``--pgp-key-id`` option is used to specifiy a PGP keyid. If set, the script assumes that it can execute GnuPG and will attempt to diff --git a/doc/relnotes/1_11_18.rst b/doc/relnotes/1_11_18.rst new file mode 100644 index 000000000..eb980b95e --- /dev/null +++ b/doc/relnotes/1_11_18.rst @@ -0,0 +1,5 @@ +Version 1.11.18, Not Yet Released +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* In this release Botan has switched VCS from `monotone` to `git`, + and is now hosted on github at https://github.com/randombt/botan diff --git a/doc/relnotes/index.rst b/doc/relnotes/index.rst index f94a0bfea..b93b327f5 100644 --- a/doc/relnotes/index.rst +++ b/doc/relnotes/index.rst @@ -8,6 +8,7 @@ Series 1.11 .. toctree:: :maxdepth: 1 + 1_11_18 1_11_17 1_11_16 1_11_15 diff --git a/doc/website/contents.rst b/doc/website/contents.rst index afe5c5d01..26a38a718 100644 --- a/doc/website/contents.rst +++ b/doc/website/contents.rst @@ -6,12 +6,10 @@ Contents index download - vcs license manual pgpkey credits - users algos news.rst diff --git a/doc/website/download.rst b/doc/website/download.rst index b605bddfc..f1790c41a 100644 --- a/doc/website/download.rst +++ b/doc/website/download.rst @@ -4,6 +4,9 @@ Download All releases are signed with a :doc:`PGP key <pgpkey>`. +You can access the latest development sources on `GitHub +<https://github.com/randombit/botan>`_. + .. note:: All users, especially for new applications, are encouraged to use diff --git a/doc/website/index.rst b/doc/website/index.rst index f96b13daa..12c20dcdc 100644 --- a/doc/website/index.rst +++ b/doc/website/index.rst @@ -18,12 +18,6 @@ and :doc:`manual` for the documentation. If you need help or have questions, send a mail to the `development mailing list -<http://lists.randombit.net/mailman/listinfo/botan-devel/>`_. - -You can browse the source online via the -`GitHub mirror <https://github.com/randombit/botan>`_. - -To report a bug use -`Bugzilla <http://bugs.randombit.net/>`_ or +<http://lists.randombit.net/mailman/listinfo/botan-devel/>`_ or +open a ticket on `GitHub Issues <https://github.com/randombit/botan/issues>`_. - diff --git a/doc/website/users.rst b/doc/website/users.rst deleted file mode 100644 index 7cb0d924a..000000000 --- a/doc/website/users.rst +++ /dev/null @@ -1,118 +0,0 @@ - -Users -======================================== - -This is a list of some of the known users of botan. The open source -projects might be helpful as an additional reference for library -usage. - -If you'd like to be added to the list, email the development list. - -Open Source Software -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* `BIND 10 <http://www.isc.org/bind10>`_ the new version of the BIND - DNS server uses botan for various crypto operations. - -* `SoftHSM <http://trac.opendnssec.org/wiki/SoftHSM>`_ an open sourced - software PKCS #11 implementation, which is used as part of the - `OpenDNSSEC <http://www.opendnssec.org>`_ project. - -* `Qt Creator <http://qt.nokia.com/products/developer-tools>`_, an - IDE for building Qt applications. - -* `NetSieben's <http://netsieben.com/products/ssh/>`_ - SSH library provides SSHv2 client connections for C++ - applications, using botan for the crypto. (GPL or commercial) - -* `InSiTo <http://www.flexsecure.eu/insito/index.html>`_ is a library - for ePassports based on botan which was commissioned by the German - Federal Office for Information Security. - -* `QCA <http://delta.affinix.com/qca/>`_, the Qt Cryptographic - Architecture (part of KDE4) uses parts of botan as an `embedded - crypto provider - <http://quickgit.kde.org/?p=qca.git&a=tree&hb=master&f=src%2Fbotantools%2Fbotan>`_ - and also has a `qca-botan plugin <http://quickgit.kde.org/?p=qca.git&a=tree&hb=master&f=plugins%2Fqca-botan>`_. - -* `TCHead <http://16s.us/TCHead/>`_ is a utility for analyzing - TrueCrypt volume headers. - -* `Octopod <http://code.google.com/p/octopod/>`_ is a - file sharing system. - -* `Silverlock <http://www.petroules.com/products/silverlock/>`_ - is a GPL password management tool for Windows, OS X, and Linux.</p> - -* `Monotone <http://monotone.ca/>`_, a free distributed - version control system, uses botan for RSA authentication, - content hashing, and message authentication. - -* `Publimark <http://www.gleguelv.org/soft/publimark/index.html>`_ - is a tool for hiding messages in an audio file. - -* `KeySafe <http://therning.org/magnus/computer/keysafe>`_, - a password application for GNOME - -* `SuSE <http://gcc.opensuse.org>`_ uses botan as part - of a test suite for the GCC optimizer. - -* `Openbench <http://www.exactcode.de/site/open_source/openbench/>`_, - an open source benchmark suite, uses botan as a component. - -* `VNCcrack <http://www.randombit.net/code/vnccrack/>`_ - is a password cracker for the VNC authentication/response protocol. - -Commercial Software -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* `Hulu Desktop <http://www.hulu.com/labs/hulu-desktop>`_ uses botan - on Windows `(ref) - <http://download.hulu.com/HuluDesktop_ThirdPartyLicenses.txt>`_. - -* `Hitman Pro <http://www.surfright.nl/en>`_ is a malware - scanner for Windows. - -* `Flying Lab Software <http://www.burningsea.com>`_, a Seattle based - game developer, uses botan as a part of their user authentication - process. - -* `CryptoTE <http://idlebox.net/2009/cryptote/>`_ is a text editor - with integrated strong cryptography. - -* `TextEgg <http://www.textegg.com/>`_ is an encrypted document editor. - -* `Seagate <http://www.seagate.com/www/en-us/support/downloads/>`_ - uses botan for the drive encryption in the Maxtor OneTouch III Mini - Edition hard drive. - -* `E.V.E. Paradox <http://www.entropicsoftware.com/eve/eve.html>`_, a - suite of games for Windows. - -Research Projects -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* `A Unified Approach to Intra-Domain Security - <http://www.csiir.ornl.gov/shue/research/securecom09.pdf>`_ - describes a system by researches from Oak Ridge National Lab and - Indiana University that uses botan to secure ARP and DHCP. - -* `CLL: A Cryptographic Link Layer for Local Area Networks - <http://www.springerlink.com/content/c4681m76808l4621/>`_ describes - a network encryption system using botan. (One of the coauthors, Yves - Jerschow, also contributed a number of optimizations to the - library). - -* The system described in `Enabling Intrusion Detection in IPsec - Protected IPv6 Networks Through Secret-key Sharing - <http://www.dtic.mil/dtic/tr/fulltext/u2/a431510.pdf>`_. - -* `An experimental tamper detection system - <http://www.cis.udel.edu/~hiper/passages/papers/jochenMILCOM03.pdf>`_ - designed by researchers from the University of Delaware and the US - Army Research Laboratory. - -* A prototype implementation of a telephony signal security system, - described in `Prototyping and evaluation of TCAPsec - <http://www.cs.kau.se/cs/education/courses/davddiss/Uppsatser_2007/D2007-04.pdf>`_ - by Kang Chung and Mathilda Gustafsson. diff --git a/doc/website/vcs.rst b/doc/website/vcs.rst deleted file mode 100644 index e2353ee53..000000000 --- a/doc/website/vcs.rst +++ /dev/null @@ -1,41 +0,0 @@ - -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``. |