summaryrefslogtreecommitdiffstats
path: root/src/tpm2/SupportLibraryFunctionPrototypes_fp.h
blob: 3b1e1a9a339f4ac5592b384a03a3128d4fc64344 (plain)
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/********************************************************************************/
/*										*/
/*			For Selected Math Library     				*/
/*			     Written by Ken Goldman				*/
/*		       IBM Thomas J. Watson Research Center			*/
/* $Id: SupportLibraryFunctionPrototypes_fp.h 1529 2019-11-21 23:29:01Z kgoldman $ */
/*										*/
/*  Licenses and Notices							*/
/*										*/
/*  1. Copyright Licenses:							*/
/*										*/
/*  - Trusted Computing Group (TCG) grants to the user of the source code in	*/
/*    this specification (the "Source Code") a worldwide, irrevocable, 		*/
/*    nonexclusive, royalty free, copyright license to reproduce, create 	*/
/*    derivative works, distribute, display and perform the Source Code and	*/
/*    derivative works thereof, and to grant others the rights granted herein.	*/
/*										*/
/*  - The TCG grants to the user of the other parts of the specification 	*/
/*    (other than the Source Code) the rights to reproduce, distribute, 	*/
/*    display, and perform the specification solely for the purpose of 		*/
/*    developing products based on such documents.				*/
/*										*/
/*  2. Source Code Distribution Conditions:					*/
/*										*/
/*  - Redistributions of Source Code must retain the above copyright licenses, 	*/
/*    this list of conditions and the following disclaimers.			*/
/*										*/
/*  - Redistributions in binary form must reproduce the above copyright 	*/
/*    licenses, this list of conditions	and the following disclaimers in the 	*/
/*    documentation and/or other materials provided with the distribution.	*/
/*										*/
/*  3. Disclaimers:								*/
/*										*/
/*  - THE COPYRIGHT LICENSES SET FORTH ABOVE DO NOT REPRESENT ANY FORM OF	*/
/*  LICENSE OR WAIVER, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, WITH	*/
/*  RESPECT TO PATENT RIGHTS HELD BY TCG MEMBERS (OR OTHER THIRD PARTIES)	*/
/*  THAT MAY BE NECESSARY TO IMPLEMENT THIS SPECIFICATION OR OTHERWISE.		*/
/*  Contact TCG Administration (admin@trustedcomputinggroup.org) for 		*/
/*  information on specification licensing rights available through TCG 	*/
/*  membership agreements.							*/
/*										*/
/*  - THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED 	*/
/*    WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR 	*/
/*    FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, COMPLETENESS, OR 		*/
/*    NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS, OR ANY WARRANTY 		*/
/*    OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE.		*/
/*										*/
/*  - Without limitation, TCG and its members and licensors disclaim all 	*/
/*    liability, including liability for infringement of any proprietary 	*/
/*    rights, relating to use of information in this specification and to the	*/
/*    implementation of this specification, and TCG disclaims all liability for	*/
/*    cost of procurement of substitute goods or services, lost profits, loss 	*/
/*    of use, loss of data or any incidental, consequential, direct, indirect, 	*/
/*    or special damages, whether under contract, tort, warranty or otherwise, 	*/
/*    arising in any way out of use or reliance upon this specification or any 	*/
/*    information herein.							*/
/*										*/
/*  (c) Copyright IBM Corp. and others, 2016 - 2019				*/
/*										*/
/********************************************************************************/

#ifndef SUPPORT_LIBRARY_FUNCTION_PROTOTYPES_H
#define SUPPORT_LIBRARY_FUNCTION_PROTOTYPES_H

/* 10.1.11	SupportLibraryFunctionPrototypes_fp.h */
/* 10.1.11.1	Introduction */

/* This file contains the function prototypes for the functions that need to be present in the
   selected math library. For each function listed, there should be a small stub function. That
   stub provides the interface between the TPM code and the support library. In most cases, the stub
   function will only need to do a format conversion between the TPM big number and the support
   library big number. The TPM big number format was chosen to make this relatively simple and
   fast. */


/* 10.1.11.2	SupportLibInit() */
/* This function is called by CryptInit() so that necessary initializations can be performed on the
   cryptographic library. */


LIB_EXPORT
int SupportLibInit(void);


/* 10.1.11.3	MathLibraryCompatibililtyCheck() */
/* This function is only used during development to make sure that the library that is being
   referenced is using the same size of data structures as the TPM. */

BOOL
MathLibraryCompatibilityCheck(
			      void
			      );
/* 10.1.1114 BnModMult() */
/* Does multiply op1 * op2 and divide by modulus returning the remainder of the divide. */

LIB_EXPORT BOOL
BnModMult(bigNum result, bigConst op1, bigConst op2, bigConst modulus);

/* 10.1.11.5 BnMult() */
/* Multiplies two numbers and returns the result */

LIB_EXPORT BOOL BnMult(bigNum result, bigConst multiplicand, bigConst multiplier);

/* 10.1.11.6 BnDiv() */
/* This function divides two bigNum values. The function returns FALSE if there is an error in the
   operation. */
LIB_EXPORT BOOL BnDiv(bigNum quotient, bigNum remainder,
		      bigConst dividend, bigConst divisor);

/* 10.1.11.7 BnMod() */
#define BnMod(a, b)     BnDiv(NULL, (a), (a), (b))

/* 10.1.11.8 BnGcd() */
/* Get the greatest common divisor of two numbers. This function is only needed when the TPM
   implements RSA. */
LIB_EXPORT BOOL BnGcd(bigNum gcd, bigConst number1, bigConst number2);

/* 10.1.11.9 BnModExp() */
/* Do modular exponentiation using bigNum values. This function is only needed when the TPM
   implements RSA. */
LIB_EXPORT BOOL BnModExp(bigNum result, bigConst number,
			 bigConst exponent, bigConst modulus);

/* 10.1.11.10 BnModInverse() */
/* Modular multiplicative inverse. This function is only needed when the TPM implements RSA. */
LIB_EXPORT BOOL BnModInverse(bigNum result, bigConst number,
			     bigConst modulus);

/* 10.1.11.11 BnEccModMult() */
/* This function does a point multiply of the form R = [d]S. A return of FALSE indicates that the
   result was the point at infinity. This function is only needed if the TPM supports ECC. */
LIB_EXPORT BOOL BnEccModMult(bigPoint R, pointConst S, bigConst d, bigCurve E);

/* 10.1.11.13	BnEccModMult2() */
/* This function does a point multiply of the form R = [d]S + [u]Q. A return of FALSE indicates that
   the result was the point at infinity. This function is only needed if the TPM supports ECC */
LIB_EXPORT BOOL BnEccModMult2(bigPoint R, pointConst S, bigConst d,
			      pointConst Q, bigConst u, bigCurve E);

/* 10.1.11.14 BnEccAdd() */
/* This function does a point add R = S + Q. A return of FALSE indicates that the result was the
   point at infinity. This function is only needed if the TPM supports ECC. */
LIB_EXPORT BOOL BnEccAdd(bigPoint R, pointConst S, pointConst Q, bigCurve E);

/* 10.1.11.15 BnCurveInitialize() */
/* This function is used to initialize the pointers of a bnCurve_t structure. The structure is a set
   of pointers to bigNum values. The curve-dependent values are set by a different function. This
   function is only needed if the TPM supports ECC.*/
LIB_EXPORT bigCurve BnCurveInitialize(bigCurve E, TPM_ECC_CURVE curveId);

/* 10.1.11.16	BnCurveFree() */
/* This function will free the allocated components of the curve and end the frame in which the
   curve data exists */
LIB_EXPORT void BnCurveFree(bigCurve E);

#endif