xref: /aosp_15_r20/external/ms-tpm-20-ref/TPMCmd/tpm/include/prototypes/CryptCmac_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_CMAC_FP_H_
41 #define    _CRYPT_CMAC_FP_H_
42 
43 #if ALG_CMAC
44 
45 //*** CryptCmacStart()
46 // This is the function to start the CMAC sequence operation. It initializes the
47 // dispatch functions for the data and end operations for CMAC and initializes the
48 // parameters that are used for the processing of data, including the key, key size
49 // and block cipher algorithm.
50 UINT16
51 CryptCmacStart(
52     SMAC_STATE          *state,
53     TPMU_PUBLIC_PARMS   *keyParms,
54     TPM_ALG_ID           macAlg,
55     TPM2B               *key
56 );
57 
58 //*** CryptCmacData()
59 // This function is used to add data to the CMAC sequence computation. The function
60 // will XOR new data into the IV. If the buffer is full, and there is additional
61 // input data, the data is encrypted into the IV buffer, the new data is then
62 // XOR into the IV. When the data runs out, the function returns without encrypting
63 // even if the buffer is full. The last data block of a sequence will not be
64 // encrypted until the call to CryptCmacEnd(). This is to allow the proper subkey
65 // to be computed and applied before the last block is encrypted.
66 void
67 CryptCmacData(
68     SMAC_STATES         *state,
69     UINT32               size,
70     const BYTE          *buffer
71 );
72 
73 //*** CryptCmacEnd()
74 // This is the completion function for the CMAC. It does padding, if needed, and
75 // selects the subkey to be applied before the last block is encrypted.
76 UINT16
77 CryptCmacEnd(
78     SMAC_STATES             *state,
79     UINT32                   outSize,
80     BYTE                    *outBuffer
81 );
82 #endif
83 
84 #endif  // _CRYPT_CMAC_FP_H_
85