xref: /aosp_15_r20/external/ms-tpm-20-ref/TPMCmd/tpm/include/prototypes/DA_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: Apr  2, 2019  Time: 04:23:27PM
38  */
39 
40 #ifndef    _DA_FP_H_
41 #define    _DA_FP_H_
42 
43 //*** DAPreInstall_Init()
44 // This function initializes the DA parameters to their manufacturer-default
45 // values. The default values are determined by a platform-specific specification.
46 //
47 // This function should not be called outside of a manufacturing or simulation
48 // environment.
49 //
50 // The DA parameters will be restored to these initial values by TPM2_Clear().
51 void
52 DAPreInstall_Init(
53     void
54 );
55 
56 //*** DAStartup()
57 // This function is called  by TPM2_Startup() to initialize the DA parameters.
58 // In the case of Startup(CLEAR), use of lockoutAuth will be enabled if the
59 // lockout recovery time is 0. Otherwise, lockoutAuth will not be enabled until
60 // the TPM has been continuously powered for the lockoutRecovery time.
61 //
62 // This function requires that NV be available and not rate limiting.
63 BOOL
64 DAStartup(
65     STARTUP_TYPE     type           // IN: startup type
66 );
67 
68 //*** DARegisterFailure()
69 // This function is called when a authorization failure occurs on an entity
70 // that is subject to dictionary-attack protection. When a DA failure is
71 // triggered, register the failure by resetting the relevant self-healing
72 // timer to the current time.
73 void
74 DARegisterFailure(
75     TPM_HANDLE       handle         // IN: handle for failure
76 );
77 
78 //*** DASelfHeal()
79 // This function is called to check if sufficient time has passed to allow
80 // decrement of failedTries or to re-enable use of lockoutAuth.
81 //
82 // This function should be called when the time interval is updated.
83 void
84 DASelfHeal(
85     void
86 );
87 
88 #endif  // _DA_FP_H_
89