xref: /aosp_15_r20/external/ms-tpm-20-ref/TPMCmd/tpm/include/prototypes/CryptEccKeyExchange_fp.h (revision 5c591343844d1f9da7da26467c4bf7efc8a7a413)
1 /* Microsoft Reference Implementation for TPM 2.0
2  *
3  *  The copyright in this software is being made available under the BSD License,
4  *  included below. This software may be subject to other third party and
5  *  contributor rights, including patent rights, and no such rights are granted
6  *  under this license.
7  *
8  *  Copyright (c) Microsoft Corporation
9  *
10  *  All rights reserved.
11  *
12  *  BSD License
13  *
14  *  Redistribution and use in source and binary forms, with or without modification,
15  *  are permitted provided that the following conditions are met:
16  *
17  *  Redistributions of source code must retain the above copyright notice, this list
18  *  of conditions and the following disclaimer.
19  *
20  *  Redistributions in binary form must reproduce the above copyright notice, this
21  *  list of conditions and the following disclaimer in the documentation and/or
22  *  other materials provided with the distribution.
23  *
24  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ""AS IS""
25  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
28  *  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29  *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
31  *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 /*(Auto-generated)
36  *  Created by TpmPrototypes; Version 3.0 July 18, 2017
37  *  Date: Mar 28, 2019  Time: 08:25:18PM
38  */
39 
40 #ifndef    _CRYPT_ECC_KEY_EXCHANGE_FP_H_
41 #define    _CRYPT_ECC_KEY_EXCHANGE_FP_H_
42 
43 #if CC_ZGen_2Phase == YES
44 
45 //*** CryptEcc2PhaseKeyExchange()
46 // This function is the dispatch routine for the EC key exchange functions that use
47 // two ephemeral and two static keys.
48 //  Return Type: TPM_RC
49 //      TPM_RC_SCHEME             scheme is not defined
50 LIB_EXPORT TPM_RC
51 CryptEcc2PhaseKeyExchange(
52     TPMS_ECC_POINT          *outZ1,         // OUT: a computed point
53     TPMS_ECC_POINT          *outZ2,         // OUT: and optional second point
54     TPM_ECC_CURVE            curveId,       // IN: the curve for the computations
55     TPM_ALG_ID               scheme,        // IN: the key exchange scheme
56     TPM2B_ECC_PARAMETER     *dsA,           // IN: static private TPM key
57     TPM2B_ECC_PARAMETER     *deA,           // IN: ephemeral private TPM key
58     TPMS_ECC_POINT          *QsB,           // IN: static public party B key
59     TPMS_ECC_POINT          *QeB            // IN: ephemeral public party B key
60 );
61 #if ALG_SM2
62 
63 //*** SM2KeyExchange()
64 // This function performs the key exchange defined in SM2.
65 // The first step is to compute
66 //  'tA' = ('dsA' + 'deA'  avf(Xe,A)) mod 'n'
67 // Then, compute the 'Z' value from
68 // 'outZ' = ('h'  'tA' mod 'n') ('QsA' + [avf('QeB.x')]('QeB')).
69 // The function will compute the ephemeral public key from the ephemeral
70 // private key.
71 // All points are required to be on the curve of 'inQsA'. The function will fail
72 // catastrophically if this is not the case
73 //  Return Type: TPM_RC
74 //      TPM_RC_NO_RESULT        the value for dsA does not give a valid point on the
75 //                              curve
76 LIB_EXPORT TPM_RC
77 SM2KeyExchange(
78     TPMS_ECC_POINT        *outZ,         // OUT: the computed point
79     TPM_ECC_CURVE          curveId,      // IN: the curve for the computations
80     TPM2B_ECC_PARAMETER   *dsAIn,        // IN: static private TPM key
81     TPM2B_ECC_PARAMETER   *deAIn,        // IN: ephemeral private TPM key
82     TPMS_ECC_POINT        *QsBIn,        // IN: static public party B key
83     TPMS_ECC_POINT        *QeBIn         // IN: ephemeral public party B key
84 );
85 #endif
86 #endif // CC_ZGen_2Phase
87 
88 #endif  // _CRYPT_ECC_KEY_EXCHANGE_FP_H_
89