ISARA Toolkit 1.1

The ISARA Toolkit provides a set of cryptographic primitives that let you develop software resistant to attacks by quantum computers. These primitives include:

  • SHA2 and SHA3 hashes (256-bit and 512-bit)

  • HMAC and Poly1305 message authentication codes

  • HMAC-DRBG and SHAKE random number generators

  • RFC-5869, NIST SP 800-56A Alternative 1 Concatenation, and PBKDF2 key derivation functions

  • Leighton-Micali digital signature scheme

  • LUKE and NewHope key agreement schemes

  • McEliece Quasi-Cyclic Moderate Density Parity-Check with CCA2 Gamma Conversion asymmetric cipher

  • ChaCha20 symmetric cipher

Contents

The Toolkit is organized into several directories:

  • doc — API documentation (doc/library/index.html) and Developer’s Guide (doc/guide/guide.html).

  • include — Toolkit headers.

  • one or more lib_architecture directories — Toolkit static and shared libraries optimized for the given architecture.

  • samples — Sample programs demonstrating how to use the Toolkit.

Getting Help

The latest version of the Toolkit documentation is available on ISARA’s website:

Using the Toolkit

After unpacking the Toolkit archive, you can start using it by adding the following command-line arguments to your compiler:

-I/path/to/isara_toolkit/include \
-L/path/to/isara_toolkit/lib_architecture \
-liqr_toolkit

where architecture is one of the available architectures in your archive. For example, the Ubuntu archive includes these versions of the libraries:

  • lib_bdver4 - AMD Piledriver CPUs

  • lib_core2 - Intel Core2 CPUs

  • lib_sandybridge - Intel Sandybridge CPUs

  • lib_skylake - Intel Skylake CPUs

  • lib_x86-64 - 64-bit AMD and Intel CPUs

  • lib_i7 - Intel Core i7 CPUs

Note
 If you’re linking against the shared library, you will need to link against the math library (-lm option).

If you require a version of the library tuned for a specific architecture, please contact ISARA’s sales team.

Building the Samples

Note
 Before building the samples, copy one of the CPU-specific versions of the Toolkit libraries into a lib directory. For example, to build the samples for Intel Core2 or better CPUs, copy the contents of lib_core2 into lib.

To build the samples:

cd /path/to/isara_toolkit/samples/sample_name
cmake .
make

To build all of the samples at once:

cd /path/to/isara_toolkit/samples
./build.sh

For more details and tool requirements, please refer to the Developer’s Guide (doc/guide/guide.html) documentation.

System Requirements

  • 32-bit Android 5 or newer

  • 64-bit FreeBSD 10 or newer

  • 64-bit Mac OS X 10.11 or newer

  • 64-bit Ubuntu 16.04 or newer

  • 64-bit Windows 7 or newer

Legal

The ISARA Toolkit is licensed for use:

Copyright © 2015-2016, ISARA Corporation, All Rights Reserved.

The code and other content set out herein is not in the public domain, is considered a trade secret and is confidential to ISARA Corporation. Use, reproduction or distribution, in whole or in part, of such code or other content is strictly prohibited except by express written permission of ISARA Corporation. Please contact ISARA Corporation at info@isara.com for more information.

Sample code (and only the sample code) is covered by the Apache 2.0 license:

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Apache License 2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.