1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2019-2021 Linaro Ltd.
6 * Sumit Garg <sumit.garg@linaro.org>
10 #include <linux/key-type.h>
11 #include <linux/module.h>
12 #include <linux/slab.h>
13 #include <linux/string.h>
14 #include <linux/tee_drv.h>
15 #include <linux/uuid.h>
17 #include <keys/trusted_tee.h>
19 #define DRIVER_NAME "trusted-key-tee"
22 * Get random data for symmetric key
24 * [out] memref[0] Random data
26 #define TA_CMD_GET_RANDOM 0x0
29 * Seal trusted key using hardware unique key
31 * [in] memref[0] Plain key
32 * [out] memref[1] Sealed key datablob
34 #define TA_CMD_SEAL 0x1
37 * Unseal trusted key using hardware unique key
39 * [in] memref[0] Sealed key datablob
40 * [out] memref[1] Plain key
42 #define TA_CMD_UNSEAL 0x2
45 * struct trusted_key_tee_private - TEE Trusted key private data
46 * @dev: TEE based Trusted key device.
47 * @ctx: TEE context handler.
48 * @session_id: Trusted key TA session identifier.
49 * @shm_pool: Memory pool shared with TEE device.
51 struct trusted_key_tee_private {
53 struct tee_context *ctx;
55 struct tee_shm *shm_pool;
58 static struct trusted_key_tee_private pvt_data;
61 * Have the TEE seal(encrypt) the symmetric key
63 static int trusted_tee_seal(struct trusted_key_payload *p, char *datablob)
66 struct tee_ioctl_invoke_arg inv_arg;
67 struct tee_param param[4];
68 struct tee_shm *reg_shm_in = NULL, *reg_shm_out = NULL;
70 memset(&inv_arg, 0, sizeof(inv_arg));
71 memset(¶m, 0, sizeof(param));
73 reg_shm_in = tee_shm_register(pvt_data.ctx, (unsigned long)p->key,
74 p->key_len, TEE_SHM_DMA_BUF |
75 TEE_SHM_KERNEL_MAPPED);
76 if (IS_ERR(reg_shm_in)) {
77 dev_err(pvt_data.dev, "key shm register failed\n");
78 return PTR_ERR(reg_shm_in);
81 reg_shm_out = tee_shm_register(pvt_data.ctx, (unsigned long)p->blob,
82 sizeof(p->blob), TEE_SHM_DMA_BUF |
83 TEE_SHM_KERNEL_MAPPED);
84 if (IS_ERR(reg_shm_out)) {
85 dev_err(pvt_data.dev, "blob shm register failed\n");
86 ret = PTR_ERR(reg_shm_out);
90 inv_arg.func = TA_CMD_SEAL;
91 inv_arg.session = pvt_data.session_id;
92 inv_arg.num_params = 4;
94 param[0].attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT;
95 param[0].u.memref.shm = reg_shm_in;
96 param[0].u.memref.size = p->key_len;
97 param[0].u.memref.shm_offs = 0;
98 param[1].attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT;
99 param[1].u.memref.shm = reg_shm_out;
100 param[1].u.memref.size = sizeof(p->blob);
101 param[1].u.memref.shm_offs = 0;
103 ret = tee_client_invoke_func(pvt_data.ctx, &inv_arg, param);
104 if ((ret < 0) || (inv_arg.ret != 0)) {
105 dev_err(pvt_data.dev, "TA_CMD_SEAL invoke err: %x\n",
109 p->blob_len = param[1].u.memref.size;
114 tee_shm_free(reg_shm_out);
116 tee_shm_free(reg_shm_in);
122 * Have the TEE unseal(decrypt) the symmetric key
124 static int trusted_tee_unseal(struct trusted_key_payload *p, char *datablob)
127 struct tee_ioctl_invoke_arg inv_arg;
128 struct tee_param param[4];
129 struct tee_shm *reg_shm_in = NULL, *reg_shm_out = NULL;
131 memset(&inv_arg, 0, sizeof(inv_arg));
132 memset(¶m, 0, sizeof(param));
134 reg_shm_in = tee_shm_register(pvt_data.ctx, (unsigned long)p->blob,
135 p->blob_len, TEE_SHM_DMA_BUF |
136 TEE_SHM_KERNEL_MAPPED);
137 if (IS_ERR(reg_shm_in)) {
138 dev_err(pvt_data.dev, "blob shm register failed\n");
139 return PTR_ERR(reg_shm_in);
142 reg_shm_out = tee_shm_register(pvt_data.ctx, (unsigned long)p->key,
143 sizeof(p->key), TEE_SHM_DMA_BUF |
144 TEE_SHM_KERNEL_MAPPED);
145 if (IS_ERR(reg_shm_out)) {
146 dev_err(pvt_data.dev, "key shm register failed\n");
147 ret = PTR_ERR(reg_shm_out);
151 inv_arg.func = TA_CMD_UNSEAL;
152 inv_arg.session = pvt_data.session_id;
153 inv_arg.num_params = 4;
155 param[0].attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT;
156 param[0].u.memref.shm = reg_shm_in;
157 param[0].u.memref.size = p->blob_len;
158 param[0].u.memref.shm_offs = 0;
159 param[1].attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT;
160 param[1].u.memref.shm = reg_shm_out;
161 param[1].u.memref.size = sizeof(p->key);
162 param[1].u.memref.shm_offs = 0;
164 ret = tee_client_invoke_func(pvt_data.ctx, &inv_arg, param);
165 if ((ret < 0) || (inv_arg.ret != 0)) {
166 dev_err(pvt_data.dev, "TA_CMD_UNSEAL invoke err: %x\n",
170 p->key_len = param[1].u.memref.size;
175 tee_shm_free(reg_shm_out);
177 tee_shm_free(reg_shm_in);
183 * Have the TEE generate random symmetric key
185 static int trusted_tee_get_random(unsigned char *key, size_t key_len)
188 struct tee_ioctl_invoke_arg inv_arg;
189 struct tee_param param[4];
190 struct tee_shm *reg_shm = NULL;
192 memset(&inv_arg, 0, sizeof(inv_arg));
193 memset(¶m, 0, sizeof(param));
195 reg_shm = tee_shm_register(pvt_data.ctx, (unsigned long)key, key_len,
196 TEE_SHM_DMA_BUF | TEE_SHM_KERNEL_MAPPED);
197 if (IS_ERR(reg_shm)) {
198 dev_err(pvt_data.dev, "key shm register failed\n");
199 return PTR_ERR(reg_shm);
202 inv_arg.func = TA_CMD_GET_RANDOM;
203 inv_arg.session = pvt_data.session_id;
204 inv_arg.num_params = 4;
206 param[0].attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT;
207 param[0].u.memref.shm = reg_shm;
208 param[0].u.memref.size = key_len;
209 param[0].u.memref.shm_offs = 0;
211 ret = tee_client_invoke_func(pvt_data.ctx, &inv_arg, param);
212 if ((ret < 0) || (inv_arg.ret != 0)) {
213 dev_err(pvt_data.dev, "TA_CMD_GET_RANDOM invoke err: %x\n",
217 ret = param[0].u.memref.size;
220 tee_shm_free(reg_shm);
225 static int optee_ctx_match(struct tee_ioctl_version_data *ver, const void *data)
227 if (ver->impl_id == TEE_IMPL_ID_OPTEE)
233 static int trusted_key_probe(struct device *dev)
235 struct tee_client_device *rng_device = to_tee_client_device(dev);
237 struct tee_ioctl_open_session_arg sess_arg;
239 memset(&sess_arg, 0, sizeof(sess_arg));
241 pvt_data.ctx = tee_client_open_context(NULL, optee_ctx_match, NULL,
243 if (IS_ERR(pvt_data.ctx))
246 memcpy(sess_arg.uuid, rng_device->id.uuid.b, TEE_IOCTL_UUID_LEN);
247 sess_arg.clnt_login = TEE_IOCTL_LOGIN_REE_KERNEL;
248 sess_arg.num_params = 0;
250 ret = tee_client_open_session(pvt_data.ctx, &sess_arg, NULL);
251 if ((ret < 0) || (sess_arg.ret != 0)) {
252 dev_err(dev, "tee_client_open_session failed, err: %x\n",
257 pvt_data.session_id = sess_arg.session;
259 ret = register_key_type(&key_type_trusted);
268 tee_client_close_session(pvt_data.ctx, pvt_data.session_id);
270 tee_client_close_context(pvt_data.ctx);
275 static int trusted_key_remove(struct device *dev)
277 unregister_key_type(&key_type_trusted);
278 tee_client_close_session(pvt_data.ctx, pvt_data.session_id);
279 tee_client_close_context(pvt_data.ctx);
284 static const struct tee_client_device_id trusted_key_id_table[] = {
285 {UUID_INIT(0xf04a0fe7, 0x1f5d, 0x4b9b,
286 0xab, 0xf7, 0x61, 0x9b, 0x85, 0xb4, 0xce, 0x8c)},
289 MODULE_DEVICE_TABLE(tee, trusted_key_id_table);
291 static struct tee_client_driver trusted_key_driver = {
292 .id_table = trusted_key_id_table,
295 .bus = &tee_bus_type,
296 .probe = trusted_key_probe,
297 .remove = trusted_key_remove,
301 static int trusted_tee_init(void)
303 return driver_register(&trusted_key_driver.driver);
306 static void trusted_tee_exit(void)
308 driver_unregister(&trusted_key_driver.driver);
311 struct trusted_key_ops trusted_key_tee_ops = {
312 .migratable = 0, /* non-migratable */
313 .init = trusted_tee_init,
314 .seal = trusted_tee_seal,
315 .unseal = trusted_tee_unseal,
316 .get_random = trusted_tee_get_random,
317 .exit = trusted_tee_exit,