README
1
2================================================================================
3
4 TinyCrypt Cryptographic Library
5
6================================================================================
7
8 Copyright (c) 2017, Intel Corporation. All rights reserved.
9
10Redistribution and use in source and binary forms, with or without modification,
11are permitted provided that the following conditions are met:
12
13 - Redistributions of source code must retain the above copyright notice, this
14 list of conditions and the following disclaimer.
15
16 - Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19
20 - Neither the name of the Intel Corporation nor the names of its contributors
21 may be used to endorse or promote products derived from this software
22 without specific prior written permission.
23
24
25THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
26ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
27WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
29ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
32ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35
36================================================================================
37
38Overview:
39
40The TinyCrypt Library provides an implementation for constrained devices of a
41minimal set of standard cryptography primitives.
42
43Please, ***SEE THE DOCUMENTATION*** folder for more information on the supported
44cryptographic primitives and the limitations of TinyCrypt library. For usage,
45security and technicalities, please see the corresponding header file of each
46cryptographic primitive.
47
48================================================================================
49
50Organization:
51
52/lib: C source code of the cryptographic primitives.
53/lib/include/tinycrypt: C header files of the cryptographic primitives.
54/tests: Test vectors of the cryptographic primitives.
55/doc: Documentation of TinyCrypt.
56
57================================================================================
58
59Building:
60
611) In Makefile.conf set:
62 - CFLAGS for compiler flags.
63 - CC for compiler.
64 - ENABLE_TESTS for enabling (true) or disabling (false) tests compilation.
652) In lib/Makefile select the primitives required by your project.
663) In tests/Makefile select the corresponding tests of the selected primitives.
674) make
685) run tests in tests/
69
70================================================================================
71
72
