diff options
| -rw-r--r-- | doc/contrib.txt | 60 | ||||
| -rw-r--r-- | doc/users.txt | 130 |
2 files changed, 190 insertions, 0 deletions
diff --git a/doc/contrib.txt b/doc/contrib.txt new file mode 100644 index 000000000..fb30fbad4 --- /dev/null +++ b/doc/contrib.txt @@ -0,0 +1,60 @@ + +Contributing To Botan +======================================== + +Getting The Latest Sources +---------------------------------------- + +Botan's development occurs using a distributed version control system +called `Monotone <http://www.monotone.ca>`_. + +The main branch of development occurs on the branch named +``net.randombit.botan``; this is probably the branch you want, +especially if you are planning on making major changes. 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 September 21, +2010. + +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``. + +Monotone's distributed nature means you can check into your database +while continuing to merge changes made upstream. This is particularly +useful if your change is large or invasive, as you can checkpoint your +progress over time. + +If you are making a large number of changes, you may want to start up +a new branch that occasionally merges against the mainline; check the +monotone documentation for details. + +After you finish your changes, you can review them using ``mtn diff`` +to diff against the latest official head; send the output to the +mailing list for review and inclusion. + diff --git a/doc/users.txt b/doc/users.txt new file mode 100644 index 000000000..a855ca56e --- /dev/null +++ b/doc/users.txt @@ -0,0 +1,130 @@ + +Known Users +======================================== + +This is a list of some of the known users of botan. If you'd like to +be added to the list, email the development list. + +Open Source Software +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* `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://websvn.kde.org/trunk/kdesupport/qca/src/botantools/botan/>`_. + +* `Silverlock <http://www.petroules.com/products/silverlock/>`_ + is a GPL password management tool for Windows, OS X, and Linux.</p> + +* `eVersys <http://code.google.com/p/eversys/>`_ is a GPL + alternative to Rational ClearCase. + +* `Monotone <http://monotone.ca/>`_, a free distributed + version control system, uses botan for RSA authentication, + content hashing, and message authentication. + +* `Publimark <http://perso.wanadoo.fr/gleguelv/soft/>`_, a + tool for hiding messages in an audio file. + +* `KeySafe <http://www.gnomefiles.org/app.php/KeySafe>`_, + a password application for GNOME + +* `Octopod <http://code.google.com/p/octopod/>`_ is a + file sharing system. + +* `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. + +* `Cutlass <http://www.synacklabs.net/projects/cutlass/>`_, an + encrypted P2P system providing IM, file transfer, and VoIP, used + botan. + +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. + +* `Trillian Astra <http://www.trillianastra.com>`_, Cerulean Studios + IM client, uses botan + +* `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. + +* `Aegeus Technology Ltd <http://www.aegeus-technology.com>`_ used + botan in a research implementation of SPKI. + +* `Portalsphere <http://www.portalsphere.com>`_, a CORBA based + application server, provides access to botan (though a Tcl wrapper) + to application developers. + +* `E.V.E. Paradox <http://www.eveparadox.com>`_, a suite of games for + Windows, uses botan. + +Books, Dissertations, Journal Papers +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* `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.stormingmedia.us/01/0151/A015134.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. + + * `Code Reading: An Open Source Perspective + <http://www.spinellis.gr/codereading/>`_, by Diomidis Spinnellis, + includes code from an early version of botan (then called OpenCL). + |