<!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/xhtml;charset=UTF-8"/>
<title>BeeCrypt: BeeCrypt API Documentation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">BeeCrypt <span id="projectnumber">4.2.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<h1>BeeCrypt API Documentation </h1> </div>
</div>
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="intro_sec"></a>
Introduction</h2>
<p>BeeCrypt started its life when the need for a portable and fast cryptography library arose at Virtual Unlimited in 1997. I'm still trying to make it faster, easier to use and more portable, in addition to providing better documentation.</p>
<h2><a class="anchor" id="license_sec"></a>
License</h2>
<p>BeeCrypt is released under the following license:</p>
<p>This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.</p>
<p>This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</p>
<p>Legal disclaimer: note that depending on where you are, the use of cryptography may be limited or forbidden by law. Before using this library, make sure you are legally entitled to do so.</p>
<h2><a class="anchor" id="features_sec"></a>
Features</h2>
<p>Included in the library are: </p>
<ul>
<li>
entropy sources for initializing pseudo-random generators </li>
<li>
pseudo-random generators <ul>
<li>
FIPS-186 </li>
</ul>
</li>
<li>
block ciphers <ul>
<li>
AES </li>
<li>
Blowfish </li>
</ul>
</li>
<li>
hash functions <ul>
<li>
MD5 </li>
<li>
RIPEMD-128 </li>
<li>
RIPEMD-160 </li>
<li>
RIPEMD-256 </li>
<li>
RIPEMD-320 </li>
<li>
SHA-1 </li>
<li>
SHA-224 </li>
<li>
SHA-256 </li>
<li>
SHA-384 </li>
<li>
SHA-512 </li>
</ul>
</li>
<li>
keyed hash functions (a.k.a. message authentication codes) <ul>
<li>
HMAC-MD5 </li>
<li>
HMAC-SHA-1 </li>
<li>
HMAC-SHA-224 </li>
<li>
HMAC-SHA-256 </li>
<li>
HMAC-SHA-384 </li>
<li>
HMAC-SHA-512 </li>
</ul>
</li>
<li>
multi-precision integer library, with assembler-optimized routines for a range of processors; optimized to perform well on both 32-bit and 64-bit machines; uses Barrett modular reduction instead of the more common usual Montgomery algorithm; also implements sliding windows </li>
<li>
probabilistic primality testing, with optimized small prime trial division </li>
<li>
discrete logarithm parameter generation over a prime field </li>
<li>
Diffie-Hellman key agreement </li>
<li>
DHAES encryption scheme </li>
<li>
DSA signature scheme </li>
<li>
ElGamal signature scheme (two variants) </li>
<li>
RSA keypair generation with chinese remainder theorem variables </li>
<li>
RSA public & private key operations </li>
<li>
OpenMP support </li>
</ul>
<h2><a class="anchor" id="testing_sec"></a>
Testing</h2>
<p>The library has been tested on the following platforms: </p>
<ul>
<li>
Cygwin </li>
<li>
Darwin/MacOS X </li>
<li>
Linux glibc 2.x alpha </li>
<li>
Linux glibc 2.x arm </li>
<li>
Linux glibc 2.x ia64 </li>
<li>
Linux glibc 2.x m68k </li>
<li>
Linux glibc 2.x ppc </li>
<li>
Linux glibc 2.x s390 </li>
<li>
Linux glibc 2.x s390x </li>
<li>
Linux glibc 2.x sparc </li>
<li>
Linux glibc 2.x x86 </li>
<li>
Linux glibc 2.x x86_64/amd64 </li>
<li>
Solaris 2.[6789] sparc (with Forte or GNU compilers) </li>
<li>
Solaris 2.[78] x86 (with Forte or GNU compilers) </li>
<li>
Tru64 Unix alpha </li>
<li>
Win32 (Windows 95, 98, NT 4.0, 2000, XP) </li>
</ul>
<h2><a class="anchor" id="porting_sec"></a>
Porting</h2>
<p>The library is currently in the process of being ported to: </p>
<ul>
<li>
MinGW </li>
<li>
AIX (shared libraries don't seem to work in 64-bit mode) </li>
</ul>
<p>The structures in the library are geared towards exchange with Java and its security and cryptography classes. This library can also be accessed from Java by installing BeeCrypt for Java, a JCE 1.2 crypto provider and the counterpart of this library.</p>
<h2><a class="anchor" id="future_sec"></a>
The Future</h2>
<ul>
<li>
compliance with and compliance statements for IEEE P1363 </li>
<li>
switch from OSS to ALSA for entropy gathering </li>
<li>
experiments with CUDA (AES, MD6?) </li>
<li>
more blockciphers (Twofish, ... ) </li>
<li>
more hash functions (SHA-3 candidates, MD2, MD4, Tiger) </li>
<li>
more hash functions (MD2, MD4, Tiger, ...) </li>
<li>
Elliptic Curves (ECDSA, ... ) </li>
<li>
RSA signatures as specified by RFC-2440. </li>
</ul>
<p>Let us know which one you'd prefer to see added first. </p>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Apr 10 2011 20:49:30 for BeeCrypt by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
