| Dees_Troy | 83bd483 | 2013-05-04 12:39:56 +0000 | [diff] [blame] | 1 | --------------------------------------------------------------------------- |
| 2 | OpenAES-0.7.0 |
| 3 | Nabil S. Al Ramli |
| 4 | www.nalramli.com |
| 5 | --------------------------------------------------------------------------- |
| 6 | |
| 7 | License Terms |
| 8 | ------------- |
| 9 | |
| 10 | --------------------------------------------------------------------------- |
| 11 | OpenAES Licence |
| 12 | --------------------------------------------------------------------------- |
| 13 | Copyright (c) 2012, Nabil S. Al Ramli, www.nalramli.com |
| 14 | All rights reserved. |
| 15 | |
| 16 | Redistribution and use in source and binary forms, with or without |
| 17 | modification, are permitted provided that the following conditions are met: |
| 18 | |
| 19 | - Redistributions of source code must retain the above copyright notice, |
| 20 | this list of conditions and the following disclaimer. |
| 21 | - Redistributions in binary form must reproduce the above copyright |
| 22 | notice, this list of conditions and the following disclaimer in the |
| 23 | documentation and/or other materials provided with the distribution. |
| 24 | |
| 25 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 26 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 27 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 28 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| 29 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 30 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 31 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 32 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 33 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 34 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 35 | POSSIBILITY OF SUCH DAMAGE. |
| 36 | --------------------------------------------------------------------------- |
| 37 | |
| 38 | Introduction |
| 39 | ------------ |
| 40 | |
| 41 | OpenAES is an open source implementation of the Advanced Encryption |
| 42 | Standard. It is distributed as a portable, lightweight C library that can |
| 43 | be easily integrated into applications. |
| 44 | |
| 45 | Compiling |
| 46 | --------- |
| 47 | |
| 48 | OpenAES has been tested with the GCC as well as VC compilers. It is |
| 49 | necessary to compile the source files located in ./src, and to add ./inc to |
| 50 | the include paths. |
| 51 | |
| 52 | If you are building with OAES_HAVE_ISAAC defined (true by default), then |
| 53 | you also need to link in the source files under ./src/isaac and also add |
| 54 | ./src/isaac to the include paths. |
| 55 | |
| 56 | You may edit ./inc/oaes_config.h to modify build options. |
| 57 | |
| 58 | CMake 2.8.0 can be used to build the test programs on different platforms. |
| 59 | |
| 60 | In a Linux command line terminal type: |
| 61 | |
| 62 | cmake . |
| 63 | make |
| 64 | |
| 65 | In Windows, in a Visual Studio command line window type: |
| 66 | |
| 67 | cmake . -G "NMake Makefiles" |
| 68 | nmake |
| 69 | |
| 70 | Usage |
| 71 | ----- |
| 72 | |
| 73 | Usage is described in the header file ./inc/oaes_lib.h. |
| 74 | |
| 75 | Samples |
| 76 | ------- |
| 77 | |
| 78 | Samples applications are provided in the /test folder. |