forked from cisco/libacvp
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathintro.txt
139 lines (93 loc) · 5 KB
/
intro.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/**
@mainpage Introduction to libacvp
This document describes the libacvp external API. libacvp implements an ACVP client
based on https://github.com/usnistgov/ACVP.git
that provides configuration and invocation for cryptographic algorithm testing.
This document is organized as follows. The first chapter provides
background material on ACVP, an overview of libacvp and an overview
of the acvp_app. The subsequent
chapters provide a detailed reference to the libacvp API and related
functions. The reference material is created automatically (using the
doxygen utility) from comments embedded in some of the C header
files.
@section LICENSE License and Disclaimer
libacvp is distributed under the following license, which is included
in the source code distribution. It is reproduced in the manual in
case you attained the library from another source.
@latexonly
\begin{quote}
Copyright (c) 2017 Cisco Systems, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
\begin{itemize}
\item Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
\item Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
\item Neither the name of the Cisco Systems, Inc. nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
\end{itemize}
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
\end{quote}
@endlatexonly
@section Features Supported Features
The user should be aware that it is possible to misuse this library,
which may result in inadequate security. If you are implementing a
feature using this library, you will want to read the Security Considerations
section of the ACVP specs(https://github.com/usnistgov/ACVP). In addition, it is important that
you read and understand the terms outlined in the @ref LICENSE section.
@section Installing Installing and Building libacvp
@latexonly
To install libacvp, download the latest release of the distribution.
libacvp uses the GNU \texttt{make}
utilities\footnote{BSD make may not work; if both versions of make
are on your platform, you may have to invoke GNU make as \texttt{gmake}.}. In
the \texttt{libacvp} directory run make:
\begin{verbatim}
make
\end{verbatim}
This package has been tested on both 32 and 64 bit Linux systems running
CentOS and Ubuntu. The OpenSSL development package should be installed
on the system.
Note: In this first iteration of the API reference there are some items listed
as TBD. These are items that we will evaluate and *may* implement in the future.
If these TBD items are of interest to you feel free to implement them and
submit them to the libacvp github. This is an open source project and all
worthwhile contributions will be embraced.
\subsection{Shared Linking}
By default libacvp is built as a shared library.
\subsection{Static Linking}
TBD
\subsection{SafeC Library}
TBD
\subsection{Release builds}
TBD
\subsection{Java build}
TBD
@section Examples Example Code
The example application is built automatically when building libacvp.
Note, the example code is not suitable for including into
commercial software. The example apps is primarily used to test
the libacvp library in linux and to show how the API should be used.
@section Overview ACVP Overview
@latexonly
ACVP enables communication between a cryptographic module that is embedded inside of a device or otherwise running on a platform accessible via computer network, and an external testing system, using standard network communication interfaces and protocols. This communication protocol can also be used to validate the correctness of the implementations of the algorithms in the cryptographic module with a validation authority. This document describes how ACVP is structured with respect to the client-server model, the messaging protocol, optional features and flows.
For a full description of the protocol and JSON schema please refer to the ACVp specification github:
https://github.com/usnistgov/ACVP
@endlatexonly
*/