xref: /aosp_15_r20/external/ms-tpm-20-ref/TPMCmd/tpm/include/prototypes/CryptDes_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_DES_FP_H_
41 #define    _CRYPT_DES_FP_H_
42 
43 #if ALG_TDES
44 
45 //*** CryptSetOddByteParity()
46 // This function sets the per byte parity of a 64-bit value. The least-significant
47 // bit is of each byte is replaced with the odd parity of the other 7 bits in the
48 // byte. With odd parity, no byte will ever be 0x00.
49 UINT64
50 CryptSetOddByteParity(
51     UINT64          k
52 );
53 
54 //*** CryptDesValidateKey()
55 // Function to check to see if the input key is a valid DES key where the definition
56 // of valid is that none of the elements are on the list of weak, semi-weak, or
57 // possibly weak keys; and that for two keys, K1!=K2, and for three keys that
58 // K1!=K2 and K2!=K3.
59 BOOL
60 CryptDesValidateKey(
61     TPM2B_SYM_KEY       *desKey     // IN: key to validate
62 );
63 
64 //*** CryptGenerateKeyDes()
65 // This function is used to create a DES key of the appropriate size. The key will
66 // have odd parity in the bytes.
67 TPM_RC
68 CryptGenerateKeyDes(
69     TPMT_PUBLIC             *publicArea,        // IN/OUT: The public area template
70                                                 //     for the new key.
71     TPMT_SENSITIVE          *sensitive,         // OUT: sensitive area
72     RAND_STATE              *rand               // IN: the "entropy" source for
73 );
74 #endif
75 
76 #endif  // _CRYPT_DES_FP_H_
77