VirtualBox

source: vbox/trunk/src/VBox/Runtime/r3/linux/tpm-linux.cpp

Last change on this file was 98103, checked in by vboxsync, 17 months ago

Copyright year updates by scm.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.2 KB
Line 
1/* $Id: tpm-linux.cpp 98103 2023-01-17 14:15:46Z vboxsync $ */
2/** @file
3 * IPRT - Trusted Platform Module (TPM) access, Linux variant.
4 */
5
6/*
7 * Copyright (C) 2021-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37
38/*********************************************************************************************************************************
39* Header Files *
40*********************************************************************************************************************************/
41#define LOG_GROUP RTLOGGROUP_DEFAULT
42#include <iprt/tpm.h>
43
44#include <iprt/assertcompile.h>
45#include <iprt/asm.h>
46#include <iprt/err.h>
47#include <iprt/file.h>
48#include <iprt/log.h>
49#include <iprt/mem.h>
50#include <iprt/string.h>
51#include <iprt/linux/sysfs.h>
52
53
54/*********************************************************************************************************************************
55* Defined Constants And Macros *
56*********************************************************************************************************************************/
57
58
59/*********************************************************************************************************************************
60* Structures and Typedefs *
61*********************************************************************************************************************************/
62
63/**
64 * Internal TPM instance data.
65 */
66typedef struct RTTPMINT
67{
68 /** Handle to the /dev/tpmX device. */
69 RTFILE hTpmDev;
70 /** Handle to the sysfs cancel interface. */
71 RTFILE hTpmCancel;
72 /** The deduced TPM version. */
73 RTTPMVERSION enmTpmVers;
74 /** Flag whether a request is currently being executed. */
75 volatile bool fReqExec;
76} RTTPMINT;
77/** Pointer to the internal TPM instance data. */
78typedef RTTPMINT *PRTTPMINT;
79
80
81/*********************************************************************************************************************************
82* Internal Functions *
83*********************************************************************************************************************************/
84
85RTDECL(int) RTTpmOpen(PRTTPM phTpm, uint32_t idTpm)
86{
87 AssertPtrReturn(phTpm, VERR_INVALID_POINTER);
88 if (idTpm == RTTPM_ID_DEFAULT)
89 idTpm = 0;
90
91 int rc = VINF_SUCCESS;
92 PRTTPMINT pThis = (PRTTPMINT)RTMemAllocZ(sizeof(*pThis));
93 if (pThis)
94 {
95 pThis->hTpmDev = NIL_RTFILE;
96 pThis->hTpmCancel = NIL_RTFILE;
97 pThis->enmTpmVers = RTTPMVERSION_UNKNOWN;
98 pThis->fReqExec = false;
99
100 rc = RTFileOpenF(&pThis->hTpmDev, RTFILE_O_OPEN | RTFILE_O_READWRITE | RTFILE_O_DENY_NONE,
101 "/dev/tpm%u", idTpm);
102 if (RT_SUCCESS(rc))
103 {
104 /* Open the sysfs path to cancel a request, either /sys/class/tpm/tpmX/device/cancel or /sys/class/misc/tpmX/device/cancel. */
105 rc = RTFileOpenF(&pThis->hTpmCancel, RTFILE_O_OPEN | RTFILE_O_WRITE | RTFILE_O_DENY_NONE,
106 "/sys/class/tpm/tpm%u/device/cancel", idTpm);
107 if (rc == VERR_FILE_NOT_FOUND)
108 rc = RTFileOpenF(&pThis->hTpmCancel, RTFILE_O_OPEN | RTFILE_O_WRITE | RTFILE_O_DENY_NONE,
109 "/sys/class/misc/tpm%u/device/cancel", idTpm);
110 if ( RT_SUCCESS(rc)
111 || rc == VERR_FILE_NOT_FOUND)
112 {
113 /* Try to figure out the TPM version. */
114 int64_t iVersion = 0;
115 rc = RTLinuxSysFsReadIntFile(10 /*uBase*/, &iVersion, "/sys/class/tpm/tpm%u/tpm_version_major", idTpm);
116 if (rc == VERR_FILE_NOT_FOUND)
117 rc = RTLinuxSysFsReadIntFile(10 /*uBase*/, &iVersion, "/sys/class/misc/tpm%u/tpm_version_major", idTpm);
118 if (RT_SUCCESS(rc))
119 {
120 if (iVersion == 1)
121 pThis->enmTpmVers = RTTPMVERSION_1_2;
122 else if (iVersion == 2)
123 pThis->enmTpmVers = RTTPMVERSION_2_0;
124 }
125
126 *phTpm = pThis;
127 return VINF_SUCCESS;
128 }
129
130 RTFileClose(pThis->hTpmDev);
131 pThis->hTpmDev = NIL_RTFILE;
132 }
133
134 RTMemFree(pThis);
135 }
136 else
137 rc = VERR_NO_MEMORY;
138 return rc;
139}
140
141
142RTDECL(int) RTTpmClose(RTTPM hTpm)
143{
144 PRTTPMINT pThis = hTpm;
145
146 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
147
148 RTFileClose(pThis->hTpmDev);
149 if (pThis->hTpmCancel != NIL_RTFILE)
150 RTFileClose(pThis->hTpmCancel);
151
152 pThis->hTpmDev = NIL_RTFILE;
153 pThis->hTpmCancel = NIL_RTFILE;
154 RTMemFree(pThis);
155 return VINF_SUCCESS;
156}
157
158
159RTDECL(RTTPMVERSION) RTTpmGetVersion(RTTPM hTpm)
160{
161 PRTTPMINT pThis = hTpm;
162
163 AssertPtrReturn(pThis, RTTPMVERSION_INVALID);
164 return pThis->enmTpmVers;
165}
166
167
168RTDECL(uint32_t) RTTpmGetLocalityMax(RTTPM hTpm)
169{
170 RT_NOREF(hTpm);
171 return 0; /* On Linux only TPM locality 0 is supported. */
172}
173
174
175RTDECL(int) RTTpmReqCancel(RTTPM hTpm)
176{
177 PRTTPMINT pThis = hTpm;
178
179 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
180 if (pThis->hTpmCancel == NIL_RTFILE)
181 return VERR_NOT_SUPPORTED;
182
183 if (ASMAtomicReadBool(&pThis->fReqExec))
184 {
185 uint8_t bCancel = '-';
186 return RTFileWrite(pThis->hTpmCancel, &bCancel, sizeof(bCancel), NULL /*pcbWritten*/);
187 }
188
189 return VINF_SUCCESS;
190}
191
192
193RTDECL(int) RTTpmReqExec(RTTPM hTpm, uint8_t bLoc, const void *pvReq, size_t cbReq,
194 void *pvResp, size_t cbRespMax, size_t *pcbResp)
195{
196 PRTTPMINT pThis = hTpm;
197
198 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
199 AssertPtrReturn(pvReq, VERR_INVALID_POINTER);
200 AssertPtrReturn(pvResp, VERR_INVALID_POINTER);
201 AssertReturn(cbReq && cbRespMax, VERR_INVALID_PARAMETER);
202 AssertReturn(bLoc == 0, VERR_NOT_SUPPORTED); /** @todo There doesn't seem to be a way to use a different locality. */
203
204 /* The request has to be supplied by a single blocking write. */
205 ASMAtomicXchgBool(&pThis->fReqExec, true);
206 int rc = RTFileWrite(pThis->hTpmDev, pvReq, cbReq, NULL /*pcbWritten*/);
207 if (RT_SUCCESS(rc))
208 {
209 size_t cbResp = 0;
210 /* The response has to be retrieved in a single read as well. */
211 rc = RTFileRead(pThis->hTpmDev, pvResp, cbRespMax, &cbResp);
212 ASMAtomicXchgBool(&pThis->fReqExec, false);
213 if (RT_SUCCESS(rc))
214 {
215 /* Check whether the response is complete. */
216 if ( cbResp >= sizeof(TPMRESPHDR)
217 && RTTpmRespGetSz((PCTPMRESPHDR)pvResp) == cbResp)
218 {
219 if (pcbResp)
220 *pcbResp = cbResp;
221 }
222 else
223 rc = VERR_BUFFER_OVERFLOW;
224 }
225 }
226
227 return rc;
228}
229
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use