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 #include "Tpm.h"
36 #include "NV_ReadLock_fp.h"
37
38 #if CC_NV_ReadLock // Conditional expansion of this file
39
40 /*(See part 3 specification)
41 // Set read lock on a NV index
42 */
43 // Return Type: TPM_RC
44 // TPM_RC_ATTRIBUTES TPMA_NV_READ_STCLEAR is not SET so
45 // Index referenced by 'nvIndex' may not be
46 // write locked
47 // TPM_RC_NV_AUTHORIZATION the authorization was valid but the
48 // authorizing entity ('authHandle')
49 // is not allowed to read from the Index
50 // referenced by 'nvIndex'
51 TPM_RC
TPM2_NV_ReadLock(NV_ReadLock_In * in)52 TPM2_NV_ReadLock(
53 NV_ReadLock_In *in // IN: input parameter list
54 )
55 {
56 TPM_RC result;
57 NV_REF locator;
58 // The referenced index has been checked multiple times before this is called
59 // so it must be present and will be loaded into cache
60 NV_INDEX *nvIndex = NvGetIndexInfo(in->nvIndex, &locator);
61 TPMA_NV nvAttributes = nvIndex->publicArea.attributes;
62
63 // Input Validation
64 // Common read access checks. NvReadAccessChecks() may return
65 // TPM_RC_NV_AUTHORIZATION, TPM_RC_NV_LOCKED, or TPM_RC_NV_UNINITIALIZED
66 result = NvReadAccessChecks(in->authHandle,
67 in->nvIndex,
68 nvAttributes);
69 if(result == TPM_RC_NV_AUTHORIZATION)
70 return TPM_RC_NV_AUTHORIZATION;
71 // Index is already locked for write
72 else if(result == TPM_RC_NV_LOCKED)
73 return TPM_RC_SUCCESS;
74
75 // If NvReadAccessChecks return TPM_RC_NV_UNINITALIZED, then continue.
76 // It is not an error to read lock an uninitialized Index.
77
78 // if TPMA_NV_READ_STCLEAR is not set, the index can not be read-locked
79 if(!IS_ATTRIBUTE(nvAttributes, TPMA_NV, READ_STCLEAR))
80 return TPM_RCS_ATTRIBUTES + RC_NV_ReadLock_nvIndex;
81
82 // Internal Data Update
83
84 // Set the READLOCK attribute
85 SET_ATTRIBUTE(nvAttributes, TPMA_NV, READLOCKED);
86
87 // Write NV info back
88 return NvWriteIndexAttributes(nvIndex->publicArea.nvIndex,
89 locator,
90 nvAttributes);
91 }
92
93 #endif // CC_NV_ReadLock