summaryrefslogtreecommitdiffstats
path: root/meta-tpm/recipes-tpm/openssl-tpm-engine/files/0005-tpm-openssl-tpm-engine-parse-an-encrypted-TPM-key-pa.patch
blob: d60362a1180d28b6ffb965f82062a68669896c24 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
From 889639aed890d03a47d9c575280cc785ecc28380 Mon Sep 17 00:00:00 2001
From: Limeng <Meng.Li@windriver.com>
Date: Tue, 22 Aug 2017 13:02:51 +0800
Subject: [PATCH] tpm : openssl-tpm-engine: parse an encrypted TPM key password
 from env

when openssl-tpm-engine lib is used on an unattended device, there is no
way to input TPM key password. So add this feature to support parse an
encrypted(AES algorithm) TPM key password from env.
The default decrypting AES password and salt is set in bb file.
When we create a TPM key(TSS format), generate a 8 bytes random data
as its password, and then we need to encrypt the password with the same
AES password and salt in bb file.
At last, we set a env as below:
export TPM_KEY_ENC_PW=xxxxxxxx
"xxxxxxxx" is the encrypted TPM key password for libtpm.so.

Signed-off-by: Meng Li <Meng.Li@windriver.com>

Rebase to 0.5.0
Signed-off-by: Hongxu Jia <hongxu.jia@windriver.com>
---
 src/e_tpm.c     | 110 +++++++++++++++++++++++++++++++++++++++++++-------------
 src/e_tpm.h     |   4 +--
 src/e_tpm_err.c |   4 +--
 3 files changed, 89 insertions(+), 29 deletions(-)

diff --git a/src/e_tpm.c b/src/e_tpm.c
index afbf720..6347f0e 100644
--- a/src/e_tpm.c
+++ b/src/e_tpm.c
@@ -290,7 +290,7 @@ static int tpm_decode_base64(unsigned char *indata,
 	return 0;
 }
 
-static int tpm_decrypt_srk_pw(unsigned char *indata, int in_len,
+static int tpm_decrypt_pw(unsigned char *indata, int in_len,
 				unsigned char *outdata,
 				int *out_len)
 {
@@ -303,35 +303,35 @@ static int tpm_decrypt_srk_pw(unsigned char *indata, int in_len,
 	const EVP_MD *dgst = NULL;
 	EVP_CIPHER_CTX *ctx = NULL;
 
-	if (sizeof(SRK_DEC_SALT) - 1 > PKCS5_SALT_LEN) {
-		TSSerr(TPM_F_TPM_DECRYPT_SRK_PW, TPM_R_DECRYPT_SRK_PW_FAILED);
+	if (sizeof(DEC_SALT) - 1 > PKCS5_SALT_LEN) {
+		TSSerr(TPM_F_TPM_DECRYPT_PW, TPM_R_DECRYPT_PW_FAILED);
 		return 1;
 	}
 
-	aes_pw = malloc(sizeof(SRK_DEC_PW) - 1);
+	aes_pw = malloc(sizeof(DEC_PW) - 1);
 	if (aes_pw == NULL) {
-		TSSerr(TPM_F_TPM_DECRYPT_SRK_PW, TPM_R_DECRYPT_SRK_PW_FAILED);
+		TSSerr(TPM_F_TPM_DECRYPT_PW, TPM_R_DECRYPT_PW_FAILED);
 		return 1;
 	}
 
 	memset(aes_salt, 0x00, sizeof(aes_salt));
-	memcpy(aes_pw, SRK_DEC_PW, sizeof(SRK_DEC_PW) - 1);
-	memcpy(aes_salt, SRK_DEC_SALT, sizeof(SRK_DEC_SALT) - 1);
+	memcpy(aes_pw, DEC_PW, sizeof(DEC_PW) - 1);
+	memcpy(aes_salt, DEC_SALT, sizeof(DEC_SALT) - 1);
 
 	cipher = EVP_get_cipherbyname("aes-128-cbc");
 	if (cipher == NULL) {
-		TSSerr(TPM_F_TPM_DECRYPT_SRK_PW, TPM_R_DECRYPT_SRK_PW_FAILED);
+		TSSerr(TPM_F_TPM_DECRYPT_PW, TPM_R_DECRYPT_PW_FAILED);
 		free(aes_pw);
 		return 1;
 	}
 	dgst = EVP_sha256();
 
-	EVP_BytesToKey(cipher, dgst, aes_salt, (unsigned char *)aes_pw, sizeof(SRK_DEC_PW) - 1, 1, key, iv);
+	EVP_BytesToKey(cipher, dgst, aes_salt, (unsigned char *)aes_pw, sizeof(DEC_PW) - 1, 1, key, iv);
 
 	ctx = EVP_CIPHER_CTX_new();
 	/* Don't set key or IV right away; we want to check lengths */
 	if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, 0)) {
-		TSSerr(TPM_F_TPM_DECRYPT_SRK_PW, TPM_R_DECRYPT_SRK_PW_FAILED);
+		TSSerr(TPM_F_TPM_DECRYPT_PW, TPM_R_DECRYPT_PW_FAILED);
 		free(aes_pw);
 		return 1;
 	}
@@ -340,14 +340,14 @@ static int tpm_decrypt_srk_pw(unsigned char *indata, int in_len,
 	OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) == 16);
 
 	if (!EVP_CipherInit_ex(ctx, NULL, NULL, key, iv, 0)) {
-		TSSerr(TPM_F_TPM_DECRYPT_SRK_PW, TPM_R_DECRYPT_SRK_PW_FAILED);
+		TSSerr(TPM_F_TPM_DECRYPT_PW, TPM_R_DECRYPT_PW_FAILED);
 		free(aes_pw);
 		return 1;
 	}
 
 	if (!EVP_CipherUpdate(ctx, dec_data, &dec_data_len, indata, in_len)) {
 		/* Error */
-		TSSerr(TPM_F_TPM_DECRYPT_SRK_PW, TPM_R_DECRYPT_SRK_PW_FAILED);
+		TSSerr(TPM_F_TPM_DECRYPT_PW, TPM_R_DECRYPT_PW_FAILED);
 		free(aes_pw);
 		EVP_CIPHER_CTX_free(ctx);
 		return 1;
@@ -355,7 +355,7 @@ static int tpm_decrypt_srk_pw(unsigned char *indata, int in_len,
 
 	if (!EVP_CipherFinal_ex(ctx, dec_data + dec_data_len, &dec_data_lenfinal)) {
 		/* Error */
-		TSSerr(TPM_F_TPM_DECRYPT_SRK_PW, TPM_R_DECRYPT_SRK_PW_FAILED);
+		TSSerr(TPM_F_TPM_DECRYPT_PW, TPM_R_DECRYPT_PW_FAILED);
 		free(aes_pw);
 		EVP_CIPHER_CTX_free(ctx);
 		return 1;
@@ -463,8 +463,7 @@ int tpm_load_srk(UI_METHOD *ui, void *cb_data)
 			return 0;
 		}
 
-		if (tpm_decrypt_srk_pw(out_buf, out_len,
-							auth, &authlen)) {
+		if (tpm_decrypt_pw(out_buf, out_len, auth, &authlen)) {
 			Tspi_Context_CloseObject(hContext, hSRK);
 			free(auth);
 			free(out_buf);
@@ -475,7 +474,7 @@ int tpm_load_srk(UI_METHOD *ui, void *cb_data)
 		free(out_buf);
 	}
 #ifdef TPM_SRK_PLAIN_PW
-	else if (NULL != (srkPasswd = getenv("TPM_SRK_PW")) {
+	else if (NULL != (srkPasswd = getenv("TPM_SRK_PW"))) {
 		if (0 == strcmp(srkPasswd, "#WELLKNOWN#")) {
 			memset(auth, 0, TPM_WELL_KNOWN_KEY_LEN);
 			secretMode = TSS_SECRET_MODE_SHA1;
@@ -832,6 +831,9 @@ static EVP_PKEY *tpm_engine_load_key(ENGINE *e, const char *key_id,
 	if (authusage) {
 		TSS_HPOLICY hPolicy;
 		BYTE *auth;
+		char *tpmKeyPasswd = NULL;
+		int authlen = 0;
+		TSS_FLAG secretMode = secret_mode;
 
 		if ((auth = calloc(1, 128)) == NULL) {
 			Tspi_Context_CloseObject(hContext, hKey);
@@ -839,13 +841,71 @@ static EVP_PKEY *tpm_engine_load_key(ENGINE *e, const char *key_id,
 			return NULL;
 		}
 
-		if (!tpm_engine_get_auth(ui, (char *)auth, 128,
-					 "TPM Key Password: ",
-					 cb_data)) {
-			Tspi_Context_CloseObject(hContext, hKey);
-			free(auth);
-			TSSerr(TPM_F_TPM_ENGINE_LOAD_KEY, TPM_R_REQUEST_FAILED);
-			return NULL;
+		tpmKeyPasswd = getenv("TPM_KEY_ENC_PW");
+		if (NULL != tpmKeyPasswd) {
+			int in_len = strlen(tpmKeyPasswd);
+			int out_len;
+			unsigned char *out_buf;
+
+			if (!in_len || in_len % 4) {
+				Tspi_Context_CloseObject(hContext, hKey);
+				free(auth);
+				TSSerr(TPM_F_TPM_ENGINE_LOAD_KEY, TPM_R_REQUEST_FAILED);
+				return NULL;
+			}
+			out_len = in_len * 3 / 4;
+			out_buf = malloc(out_len);
+			if (NULL == out_buf) {
+				Tspi_Context_CloseObject(hContext, hKey);
+				free(auth);
+				TSSerr(TPM_F_TPM_ENGINE_LOAD_KEY, ERR_R_MALLOC_FAILURE);
+				return NULL;
+			}
+
+			if (tpm_decode_base64(tpmKeyPasswd, strlen(tpmKeyPasswd),
+						out_buf, &out_len)) {
+				Tspi_Context_CloseObject(hContext, hKey);
+				free(auth);
+				free(out_buf);
+				TSSerr(TPM_F_TPM_ENGINE_LOAD_KEY, TPM_R_REQUEST_FAILED);
+				return NULL;
+			}
+
+			if (tpm_decrypt_pw(out_buf, out_len, auth, &authlen)) {
+				Tspi_Context_CloseObject(hContext, hKey);
+				free(auth);
+				free(out_buf);
+				TSSerr(TPM_F_TPM_ENGINE_LOAD_KEY, TPM_R_REQUEST_FAILED);
+				return 0;
+			}
+			secretMode = TSS_SECRET_MODE_PLAIN;
+			free(out_buf);
+		}
+#ifdef TPM_KEY_PLAIN_PW
+		else if (NULL != (tpmKeyPasswd = getenv("TPM_KEY_PW"))) {
+			if (0 == strcmp(tpmKeyPasswd, "#WELLKNOWN#")) {
+				memset(auth, 0, TPM_WELL_KNOWN_KEY_LEN);
+				secretMode = TSS_SECRET_MODE_SHA1;
+				authlen = TPM_WELL_KNOWN_KEY_LEN;
+			} else {
+				int authbuflen = 128;
+				memset(auth, 0, authbuflen);
+				strncpy(auth, tpmKeyPasswd, authbuflen-1);
+				secretMode = TSS_SECRET_MODE_PLAIN;
+				authlen = strlen(auth);
+			}
+		}
+#endif
+		else {
+			if (!tpm_engine_get_auth(ui, (char *)auth, 128,
+				"TPM Key Password: ", cb_data)) {
+				Tspi_Context_CloseObject(hContext, hKey);
+				free(auth);
+				TSSerr(TPM_F_TPM_ENGINE_LOAD_KEY, TPM_R_REQUEST_FAILED);
+				return NULL;
+			}
+			secretMode = secret_mode;
+			authlen = strlen(auth);
 		}
 
 		if ((result = Tspi_Context_CreateObject(hContext,
@@ -867,8 +927,8 @@ static EVP_PKEY *tpm_engine_load_key(ENGINE *e, const char *key_id,
 		}
 
 		if ((result = Tspi_Policy_SetSecret(hPolicy,
-						      TSS_SECRET_MODE_PLAIN,
-						      strlen((char *)auth), auth))) {
+						  	secretMode,
+						  	authlen, auth))) {
 			Tspi_Context_CloseObject(hContext, hKey);
 			Tspi_Context_CloseObject(hContext, hPolicy);
 			free(auth);
diff --git a/src/e_tpm.h b/src/e_tpm.h
index 56ff202..7faf744 100644
--- a/src/e_tpm.h
+++ b/src/e_tpm.h
@@ -67,7 +67,7 @@ void ERR_TSS_error(int function, int reason, char *file, int line);
 #define TPM_F_TPM_ENGINE_GET_AUTH		117
 #define TPM_F_TPM_CREATE_SRK_POLICY		118
 #define TPM_F_TPM_DECODE_BASE64			119
-#define TPM_F_TPM_DECRYPT_SRK_PW		120
+#define TPM_F_TPM_DECRYPT_PW			120
 
 /* Reason codes. */
 #define TPM_R_ALREADY_LOADED			100
@@ -99,7 +99,7 @@ void ERR_TSS_error(int function, int reason, char *file, int line);
 #define TPM_R_UI_METHOD_FAILED			126
 #define TPM_R_UNKNOWN_SECRET_MODE		127
 #define TPM_R_DECODE_BASE64_FAILED		128
-#define TPM_R_DECRYPT_SRK_PW_FAILED		129
+#define TPM_R_DECRYPT_PW_FAILED			129
 
 /* structure pointed to by the RSA object's app_data pointer */
 struct rsa_app_data
diff --git a/src/e_tpm_err.c b/src/e_tpm_err.c
index bffe686..b04dffb 100644
--- a/src/e_tpm_err.c
+++ b/src/e_tpm_err.c
@@ -235,7 +235,7 @@ static ERR_STRING_DATA TPM_str_functs[] = {
 	{ERR_PACK(0, TPM_F_TPM_FILL_RSA_OBJECT, 0), "TPM_FILL_RSA_OBJECT"},
 	{ERR_PACK(0, TPM_F_TPM_ENGINE_GET_AUTH, 0), "TPM_ENGINE_GET_AUTH"},
 	{ERR_PACK(0, TPM_F_TPM_DECODE_BASE64, 0), "TPM_DECODE_BASE64"},
-	{ERR_PACK(0, TPM_F_TPM_DECRYPT_SRK_PW, 0), "TPM_DECRYPT_SRK_PW"},
+	{ERR_PACK(0, TPM_F_TPM_DECRYPT_PW, 0), "TPM_DECRYPT_SRK_PW"},
 	{0, NULL}
 };
 
@@ -267,7 +267,7 @@ static ERR_STRING_DATA TPM_str_reasons[] = {
 	{TPM_R_ID_INVALID, "engine id doesn't match"},
 	{TPM_R_UI_METHOD_FAILED, "ui function failed"},
 	{TPM_R_DECODE_BASE64_FAILED, "decode base64 failed"},
-	{TPM_R_DECRYPT_SRK_PW_FAILED, "decrypt srk password failed"},
+	{TPM_R_DECRYPT_PW_FAILED, "decrypt password failed"},
 	{0, NULL}
 };
 
-- 
2.7.4