<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome — Botan</title>
<link rel="stylesheet" href="_static/agogo.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.10.17',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Botan" href="contents.html" />
<link rel="next" title="Recommended Reading" href="reading.html" />
<link rel="prev" title="Contents" href="contents.html" />
</head>
<body role="document">
<div class="header-wrapper">
<div class="header">
<h1>Botan</h1>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome">
<h1>Welcome<a class="headerlink" href="#welcome" title="Permalink to this headline">ΒΆ</a></h1>
<p>Botan is a <a class="reference internal" href="license.html"><span class="doc">BSD-licensed</span></a> crypto library for C++. It
provides applications with most any <a class="reference internal" href="algos.html"><span class="doc">cryptographic algorithm</span></a> you might be looking for, along with <a class="reference internal" href="ssl.html"><span class="doc">SSL/TLS</span></a>,
<a class="reference internal" href="x509.html"><span class="doc">X.509 certificates and CRLs</span></a>, a <a class="reference internal" href="filters.html"><span class="doc">pipeline-style
message processing system</span></a>, and a wide variety of other
features. A third party open source implementation of <a class="reference external" href="http://www.netsieben.com/products/ssh/">SSHv2</a> that uses botan is also
available. In addition to C++ you can use botan from <a class="reference internal" href="python.html"><span class="doc">Python</span></a> or Perl, though the current bindings only wrap portions of
the library.</p>
<p>See the <a class="reference internal" href="faq.html"><span class="doc">Frequently Asked Questions</span></a> for a list of common questions and answers.</p>
<p>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.</p>
<p>It runs on most common operating systems and can be used with a number
of different commercial and open source compilers. The <a class="reference internal" href="build_log.html"><span class="doc">build log</span></a> contains information about recently tested targets. It is
already included in most major package distributions, including
<a class="reference external" href="https://admin.fedoraproject.org/pkgdb/acls/name/botan">Fedora</a>,
<a class="reference external" href="http://download.fedora.redhat.com/pub/epel/beta/6/SRPMS/repoview/botan.html">EPEL</a> (for RHEL/CentOS),
<a class="reference external" href="http://packages.debian.org/search?keywords=libbotan">Debian</a>,
<a class="reference external" href="http://packages.ubuntu.com/search?keywords=botan">Ubuntu</a>,
<a class="reference external" href="http://packages.gentoo.org/package/botan">Gentoo</a>,
<a class="reference external" href="http://www.archlinux.org/packages/extra/x86_64/botan/">Arch Linux</a>,
<a class="reference external" href="http://slackbuilds.org/result/?search=Botan">Slackbuild</a>,
<a class="reference external" href="http://www.freshports.org/security/botan">FreeBSD</a>,
<a class="reference external" href="ftp://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/security/botan/README.html">NetBSD</a>,
<a class="reference external" href="http://cygwin.com/packages/botan/">Cygwin</a>,
<a class="reference external" href="http://www.macports.org/ports.php?by=name&amp;substr=botan">MacPorts</a>,
<a class="reference external" href="http://www.openpkg.org/product/packages/?package=botan">OpenPKG</a>, and
<a class="reference external" href="http://www.t2-project.org/packages/botan.html">T2 SDE</a> and has
more than a few <a class="reference internal" href="users.html"><span class="doc">known users</span></a>.</p>
<p>It was started as a personal project by <a class="reference external" href="http://www.randombit.net">Jack Lloyd</a>,who continues to be the maintainer and
release manager. Since the first release in 2001, a number of
<a class="reference internal" href="credits.html"><span class="doc">individuals and organizations</span></a> have contributed bug
fixes and new features. Check out the <a class="reference internal" href="log.html"><span class="doc">release notes</span></a> and
<a class="reference external" href="http://botan.randombit.net/news">news archive</a> for more project
history.</p>
<p>If you need help or have questions, send a mail to the <a class="reference external" href="http://lists.randombit.net/mailman/listinfo/botan-devel/">development
mailing list</a>.
“Philosophical” bug reports, announcements of programs using the
library, and related topics are also welcome. <a class="reference internal" href="support.html"><span class="doc">Commercial support
options</span></a> are also available. If you find what you believe to
be a bug, please file a ticket in <a class="reference external" href="http://bugs.randombit.net/">Bugzilla</a>.</p>
<p>A useful reference while reading this manual is the <a class="reference external" href="http://botan.randombit.net/doxygen">Doxygen
documentation</a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h3>Table Of Contents</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Welcome</a></li>
<li class="toctree-l1"><a class="reference internal" href="reading.html">Recommended Reading</a></li>
<li class="toctree-l1"><a class="reference internal" href="building.html">Building The Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="firststep.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="filters.html">Information Flow: Pipes and Filters</a></li>
<li class="toctree-l1"><a class="reference internal" href="pubkey.html">Public Key Cryptography</a></li>
<li class="toctree-l1"><a class="reference internal" href="x509.html">Certificate Handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssl.html">SSL and TLS</a></li>
<li class="toctree-l1"><a class="reference internal" href="bigint.html">BigInt</a></li>
<li class="toctree-l1"><a class="reference internal" href="lowlevel.html">The Low-Level Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="secmem.html">Secure Memory Containers</a></li>
<li class="toctree-l1"><a class="reference internal" href="kdf.html">Key Derivation Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pbkdf.html">PBKDF Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="passhash.html">Password Hashing</a></li>
<li class="toctree-l1"><a class="reference internal" href="rng.html">Random Number Generators</a></li>
<li class="toctree-l1"><a class="reference internal" href="fpe.html">Format Preserving Encryption</a></li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python Binding</a></li>
</ul>
<div role="search">
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<a href="contents.html" title="Contents"
accesskey="P">previous</a> |
<a href="reading.html" title="Recommended Reading"
accesskey="N">next</a> |
<a href="genindex.html" title="General Index"
accesskey="I">index</a>
</div>
<div role="note" aria-label="source link">
<br/>
<a href="_sources/index.txt"
rel="nofollow">Show Source</a>
</div>
</div>
<div class="right">
<div class="footer" role="contentinfo">
© Copyright 2000-2011, Jack Lloyd.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</body>
</html>
