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