1 // SPDX-License-Identifier: GPL-2.0-only
3 * AMD Secure Encrypted Virtualization (SEV) guest driver interface
5 * Copyright (C) 2021 Advanced Micro Devices, Inc.
10 #include <linux/module.h>
11 #include <linux/kernel.h>
12 #include <linux/types.h>
13 #include <linux/mutex.h>
15 #include <linux/platform_device.h>
16 #include <linux/miscdevice.h>
17 #include <linux/set_memory.h>
19 #include <crypto/aead.h>
20 #include <linux/scatterlist.h>
21 #include <linux/psp-sev.h>
22 #include <uapi/linux/sev-guest.h>
23 #include <uapi/linux/psp-sev.h>
28 #include "sev-guest.h"
30 #define DEVICE_NAME "sev-guest"
34 struct snp_guest_crypto {
35 struct crypto_aead *tfm;
40 struct snp_guest_dev {
42 struct miscdevice misc;
45 struct snp_guest_crypto *crypto;
46 struct snp_guest_msg *request, *response;
47 struct snp_secrets_page_layout *layout;
48 struct snp_req_data input;
49 u32 *os_area_msg_seqno;
54 module_param(vmpck_id, uint, 0444);
55 MODULE_PARM_DESC(vmpck_id, "The VMPCK ID to use when communicating with the PSP.");
57 /* Mutex to serialize the shared buffer access and command handling. */
58 static DEFINE_MUTEX(snp_cmd_mutex);
60 static bool is_vmpck_empty(struct snp_guest_dev *snp_dev)
62 char zero_key[VMPCK_KEY_LEN] = {0};
65 return !memcmp(snp_dev->vmpck, zero_key, VMPCK_KEY_LEN);
71 * If an error is received from the host or AMD Secure Processor (ASP) there
72 * are two options. Either retry the exact same encrypted request or discontinue
75 * This is because in the current encryption scheme GHCB v2 uses AES-GCM to
76 * encrypt the requests. The IV for this scheme is the sequence number. GCM
77 * cannot tolerate IV reuse.
79 * The ASP FW v1.51 only increments the sequence numbers on a successful
80 * guest<->ASP back and forth and only accepts messages at its exact sequence
83 * So if the sequence number were to be reused the encryption scheme is
84 * vulnerable. If the sequence number were incremented for a fresh IV the ASP
85 * will reject the request.
87 static void snp_disable_vmpck(struct snp_guest_dev *snp_dev)
89 dev_alert(snp_dev->dev, "Disabling vmpck_id %d to prevent IV reuse.\n",
91 memzero_explicit(snp_dev->vmpck, VMPCK_KEY_LEN);
92 snp_dev->vmpck = NULL;
95 static inline u64 __snp_get_msg_seqno(struct snp_guest_dev *snp_dev)
99 lockdep_assert_held(&snp_cmd_mutex);
101 /* Read the current message sequence counter from secrets pages */
102 count = *snp_dev->os_area_msg_seqno;
107 /* Return a non-zero on success */
108 static u64 snp_get_msg_seqno(struct snp_guest_dev *snp_dev)
110 u64 count = __snp_get_msg_seqno(snp_dev);
113 * The message sequence counter for the SNP guest request is a 64-bit
114 * value but the version 2 of GHCB specification defines a 32-bit storage
115 * for it. If the counter exceeds the 32-bit value then return zero.
116 * The caller should check the return value, but if the caller happens to
117 * not check the value and use it, then the firmware treats zero as an
118 * invalid number and will fail the message request.
120 if (count >= UINT_MAX) {
121 dev_err(snp_dev->dev, "request message sequence counter overflow\n");
128 static void snp_inc_msg_seqno(struct snp_guest_dev *snp_dev)
131 * The counter is also incremented by the PSP, so increment it by 2
132 * and save in secrets page.
134 *snp_dev->os_area_msg_seqno += 2;
137 static inline struct snp_guest_dev *to_snp_dev(struct file *file)
139 struct miscdevice *dev = file->private_data;
141 return container_of(dev, struct snp_guest_dev, misc);
144 static struct snp_guest_crypto *init_crypto(struct snp_guest_dev *snp_dev, u8 *key, size_t keylen)
146 struct snp_guest_crypto *crypto;
148 crypto = kzalloc(sizeof(*crypto), GFP_KERNEL_ACCOUNT);
152 crypto->tfm = crypto_alloc_aead("gcm(aes)", 0, 0);
153 if (IS_ERR(crypto->tfm))
156 if (crypto_aead_setkey(crypto->tfm, key, keylen))
159 crypto->iv_len = crypto_aead_ivsize(crypto->tfm);
160 crypto->iv = kmalloc(crypto->iv_len, GFP_KERNEL_ACCOUNT);
164 if (crypto_aead_authsize(crypto->tfm) > MAX_AUTHTAG_LEN) {
165 if (crypto_aead_setauthsize(crypto->tfm, MAX_AUTHTAG_LEN)) {
166 dev_err(snp_dev->dev, "failed to set authsize to %d\n", MAX_AUTHTAG_LEN);
171 crypto->a_len = crypto_aead_authsize(crypto->tfm);
172 crypto->authtag = kmalloc(crypto->a_len, GFP_KERNEL_ACCOUNT);
173 if (!crypto->authtag)
181 crypto_free_aead(crypto->tfm);
188 static void deinit_crypto(struct snp_guest_crypto *crypto)
190 crypto_free_aead(crypto->tfm);
192 kfree(crypto->authtag);
196 static int enc_dec_message(struct snp_guest_crypto *crypto, struct snp_guest_msg *msg,
197 u8 *src_buf, u8 *dst_buf, size_t len, bool enc)
199 struct snp_guest_msg_hdr *hdr = &msg->hdr;
200 struct scatterlist src[3], dst[3];
201 DECLARE_CRYPTO_WAIT(wait);
202 struct aead_request *req;
205 req = aead_request_alloc(crypto->tfm, GFP_KERNEL);
210 * AEAD memory operations:
211 * +------ AAD -------+------- DATA -----+---- AUTHTAG----+
212 * | msg header | plaintext | hdr->authtag |
213 * | bytes 30h - 5Fh | or | |
215 * +------------------+------------------+----------------+
217 sg_init_table(src, 3);
218 sg_set_buf(&src[0], &hdr->algo, AAD_LEN);
219 sg_set_buf(&src[1], src_buf, hdr->msg_sz);
220 sg_set_buf(&src[2], hdr->authtag, crypto->a_len);
222 sg_init_table(dst, 3);
223 sg_set_buf(&dst[0], &hdr->algo, AAD_LEN);
224 sg_set_buf(&dst[1], dst_buf, hdr->msg_sz);
225 sg_set_buf(&dst[2], hdr->authtag, crypto->a_len);
227 aead_request_set_ad(req, AAD_LEN);
228 aead_request_set_tfm(req, crypto->tfm);
229 aead_request_set_callback(req, 0, crypto_req_done, &wait);
231 aead_request_set_crypt(req, src, dst, len, crypto->iv);
232 ret = crypto_wait_req(enc ? crypto_aead_encrypt(req) : crypto_aead_decrypt(req), &wait);
234 aead_request_free(req);
238 static int __enc_payload(struct snp_guest_dev *snp_dev, struct snp_guest_msg *msg,
239 void *plaintext, size_t len)
241 struct snp_guest_crypto *crypto = snp_dev->crypto;
242 struct snp_guest_msg_hdr *hdr = &msg->hdr;
244 memset(crypto->iv, 0, crypto->iv_len);
245 memcpy(crypto->iv, &hdr->msg_seqno, sizeof(hdr->msg_seqno));
247 return enc_dec_message(crypto, msg, plaintext, msg->payload, len, true);
250 static int dec_payload(struct snp_guest_dev *snp_dev, struct snp_guest_msg *msg,
251 void *plaintext, size_t len)
253 struct snp_guest_crypto *crypto = snp_dev->crypto;
254 struct snp_guest_msg_hdr *hdr = &msg->hdr;
256 /* Build IV with response buffer sequence number */
257 memset(crypto->iv, 0, crypto->iv_len);
258 memcpy(crypto->iv, &hdr->msg_seqno, sizeof(hdr->msg_seqno));
260 return enc_dec_message(crypto, msg, msg->payload, plaintext, len, false);
263 static int verify_and_dec_payload(struct snp_guest_dev *snp_dev, void *payload, u32 sz)
265 struct snp_guest_crypto *crypto = snp_dev->crypto;
266 struct snp_guest_msg *resp = snp_dev->response;
267 struct snp_guest_msg *req = snp_dev->request;
268 struct snp_guest_msg_hdr *req_hdr = &req->hdr;
269 struct snp_guest_msg_hdr *resp_hdr = &resp->hdr;
271 dev_dbg(snp_dev->dev, "response [seqno %lld type %d version %d sz %d]\n",
272 resp_hdr->msg_seqno, resp_hdr->msg_type, resp_hdr->msg_version, resp_hdr->msg_sz);
274 /* Verify that the sequence counter is incremented by 1 */
275 if (unlikely(resp_hdr->msg_seqno != (req_hdr->msg_seqno + 1)))
278 /* Verify response message type and version number. */
279 if (resp_hdr->msg_type != (req_hdr->msg_type + 1) ||
280 resp_hdr->msg_version != req_hdr->msg_version)
284 * If the message size is greater than our buffer length then return
287 if (unlikely((resp_hdr->msg_sz + crypto->a_len) > sz))
290 /* Decrypt the payload */
291 return dec_payload(snp_dev, resp, payload, resp_hdr->msg_sz + crypto->a_len);
294 static int enc_payload(struct snp_guest_dev *snp_dev, u64 seqno, int version, u8 type,
295 void *payload, size_t sz)
297 struct snp_guest_msg *req = snp_dev->request;
298 struct snp_guest_msg_hdr *hdr = &req->hdr;
300 memset(req, 0, sizeof(*req));
302 hdr->algo = SNP_AEAD_AES_256_GCM;
303 hdr->hdr_version = MSG_HDR_VER;
304 hdr->hdr_sz = sizeof(*hdr);
305 hdr->msg_type = type;
306 hdr->msg_version = version;
307 hdr->msg_seqno = seqno;
308 hdr->msg_vmpck = vmpck_id;
311 /* Verify the sequence number is non-zero */
315 dev_dbg(snp_dev->dev, "request [seqno %lld type %d version %d sz %d]\n",
316 hdr->msg_seqno, hdr->msg_type, hdr->msg_version, hdr->msg_sz);
318 return __enc_payload(snp_dev, req, payload, sz);
321 static int handle_guest_request(struct snp_guest_dev *snp_dev, u64 exit_code, int msg_ver,
322 u8 type, void *req_buf, size_t req_sz, void *resp_buf,
323 u32 resp_sz, __u64 *fw_err)
329 /* Get message sequence and verify that its a non-zero */
330 seqno = snp_get_msg_seqno(snp_dev);
334 memset(snp_dev->response, 0, sizeof(struct snp_guest_msg));
336 /* Encrypt the userspace provided payload */
337 rc = enc_payload(snp_dev, seqno, msg_ver, type, req_buf, req_sz);
342 * Call firmware to process the request. In this function the encrypted
343 * message enters shared memory with the host. So after this call the
344 * sequence number must be incremented or the VMPCK must be deleted to
345 * prevent reuse of the IV.
347 rc = snp_issue_guest_request(exit_code, &snp_dev->input, &err);
350 * If the extended guest request fails due to having too small of a
351 * certificate data buffer, retry the same guest request without the
352 * extended data request in order to increment the sequence number
353 * and thus avoid IV reuse.
355 if (exit_code == SVM_VMGEXIT_EXT_GUEST_REQUEST &&
356 err == SNP_GUEST_REQ_INVALID_LEN) {
357 const unsigned int certs_npages = snp_dev->input.data_npages;
359 exit_code = SVM_VMGEXIT_GUEST_REQUEST;
362 * If this call to the firmware succeeds, the sequence number can
363 * be incremented allowing for continued use of the VMPCK. If
364 * there is an error reflected in the return value, this value
365 * is checked further down and the result will be the deletion
366 * of the VMPCK and the error code being propagated back to the
367 * user as an ioctl() return code.
369 rc = snp_issue_guest_request(exit_code, &snp_dev->input, &err);
372 * Override the error to inform callers the given extended
373 * request buffer size was too small and give the caller the
374 * required buffer size.
376 err = SNP_GUEST_REQ_INVALID_LEN;
377 snp_dev->input.data_npages = certs_npages;
384 dev_alert(snp_dev->dev,
385 "Detected error from ASP request. rc: %d, fw_err: %llu\n",
390 rc = verify_and_dec_payload(snp_dev, resp_buf, resp_sz);
392 dev_alert(snp_dev->dev,
393 "Detected unexpected decode failure from ASP. rc: %d\n",
398 /* Increment to new message sequence after payload decryption was successful. */
399 snp_inc_msg_seqno(snp_dev);
404 snp_disable_vmpck(snp_dev);
408 static int get_report(struct snp_guest_dev *snp_dev, struct snp_guest_request_ioctl *arg)
410 struct snp_guest_crypto *crypto = snp_dev->crypto;
411 struct snp_report_resp *resp;
412 struct snp_report_req req;
415 lockdep_assert_held(&snp_cmd_mutex);
417 if (!arg->req_data || !arg->resp_data)
420 if (copy_from_user(&req, (void __user *)arg->req_data, sizeof(req)))
424 * The intermediate response buffer is used while decrypting the
425 * response payload. Make sure that it has enough space to cover the
428 resp_len = sizeof(resp->data) + crypto->a_len;
429 resp = kzalloc(resp_len, GFP_KERNEL_ACCOUNT);
433 rc = handle_guest_request(snp_dev, SVM_VMGEXIT_GUEST_REQUEST, arg->msg_version,
434 SNP_MSG_REPORT_REQ, &req, sizeof(req), resp->data,
435 resp_len, &arg->fw_err);
439 if (copy_to_user((void __user *)arg->resp_data, resp, sizeof(*resp)))
447 static int get_derived_key(struct snp_guest_dev *snp_dev, struct snp_guest_request_ioctl *arg)
449 struct snp_guest_crypto *crypto = snp_dev->crypto;
450 struct snp_derived_key_resp resp = {0};
451 struct snp_derived_key_req req;
453 /* Response data is 64 bytes and max authsize for GCM is 16 bytes. */
456 lockdep_assert_held(&snp_cmd_mutex);
458 if (!arg->req_data || !arg->resp_data)
462 * The intermediate response buffer is used while decrypting the
463 * response payload. Make sure that it has enough space to cover the
466 resp_len = sizeof(resp.data) + crypto->a_len;
467 if (sizeof(buf) < resp_len)
470 if (copy_from_user(&req, (void __user *)arg->req_data, sizeof(req)))
473 rc = handle_guest_request(snp_dev, SVM_VMGEXIT_GUEST_REQUEST, arg->msg_version,
474 SNP_MSG_KEY_REQ, &req, sizeof(req), buf, resp_len,
479 memcpy(resp.data, buf, sizeof(resp.data));
480 if (copy_to_user((void __user *)arg->resp_data, &resp, sizeof(resp)))
483 /* The response buffer contains the sensitive data, explicitly clear it. */
484 memzero_explicit(buf, sizeof(buf));
485 memzero_explicit(&resp, sizeof(resp));
489 static int get_ext_report(struct snp_guest_dev *snp_dev, struct snp_guest_request_ioctl *arg)
491 struct snp_guest_crypto *crypto = snp_dev->crypto;
492 struct snp_ext_report_req req;
493 struct snp_report_resp *resp;
494 int ret, npages = 0, resp_len;
496 lockdep_assert_held(&snp_cmd_mutex);
498 if (!arg->req_data || !arg->resp_data)
501 if (copy_from_user(&req, (void __user *)arg->req_data, sizeof(req)))
504 /* userspace does not want certificate data */
505 if (!req.certs_len || !req.certs_address)
508 if (req.certs_len > SEV_FW_BLOB_MAX_SIZE ||
509 !IS_ALIGNED(req.certs_len, PAGE_SIZE))
512 if (!access_ok((const void __user *)req.certs_address, req.certs_len))
516 * Initialize the intermediate buffer with all zeros. This buffer
517 * is used in the guest request message to get the certs blob from
518 * the host. If host does not supply any certs in it, then copy
519 * zeros to indicate that certificate data was not provided.
521 memset(snp_dev->certs_data, 0, req.certs_len);
522 npages = req.certs_len >> PAGE_SHIFT;
525 * The intermediate response buffer is used while decrypting the
526 * response payload. Make sure that it has enough space to cover the
529 resp_len = sizeof(resp->data) + crypto->a_len;
530 resp = kzalloc(resp_len, GFP_KERNEL_ACCOUNT);
534 snp_dev->input.data_npages = npages;
535 ret = handle_guest_request(snp_dev, SVM_VMGEXIT_EXT_GUEST_REQUEST, arg->msg_version,
536 SNP_MSG_REPORT_REQ, &req.data,
537 sizeof(req.data), resp->data, resp_len, &arg->fw_err);
539 /* If certs length is invalid then copy the returned length */
540 if (arg->fw_err == SNP_GUEST_REQ_INVALID_LEN) {
541 req.certs_len = snp_dev->input.data_npages << PAGE_SHIFT;
543 if (copy_to_user((void __user *)arg->req_data, &req, sizeof(req)))
551 copy_to_user((void __user *)req.certs_address, snp_dev->certs_data,
557 if (copy_to_user((void __user *)arg->resp_data, resp, sizeof(*resp)))
565 static long snp_guest_ioctl(struct file *file, unsigned int ioctl, unsigned long arg)
567 struct snp_guest_dev *snp_dev = to_snp_dev(file);
568 void __user *argp = (void __user *)arg;
569 struct snp_guest_request_ioctl input;
572 if (copy_from_user(&input, argp, sizeof(input)))
577 /* Message version must be non-zero */
578 if (!input.msg_version)
581 mutex_lock(&snp_cmd_mutex);
583 /* Check if the VMPCK is not empty */
584 if (is_vmpck_empty(snp_dev)) {
585 dev_err_ratelimited(snp_dev->dev, "VMPCK is disabled\n");
586 mutex_unlock(&snp_cmd_mutex);
592 ret = get_report(snp_dev, &input);
594 case SNP_GET_DERIVED_KEY:
595 ret = get_derived_key(snp_dev, &input);
597 case SNP_GET_EXT_REPORT:
598 ret = get_ext_report(snp_dev, &input);
604 mutex_unlock(&snp_cmd_mutex);
606 if (input.fw_err && copy_to_user(argp, &input, sizeof(input)))
612 static void free_shared_pages(void *buf, size_t sz)
614 unsigned int npages = PAGE_ALIGN(sz) >> PAGE_SHIFT;
620 ret = set_memory_encrypted((unsigned long)buf, npages);
622 WARN_ONCE(ret, "failed to restore encryption mask (leak it)\n");
626 __free_pages(virt_to_page(buf), get_order(sz));
629 static void *alloc_shared_pages(struct device *dev, size_t sz)
631 unsigned int npages = PAGE_ALIGN(sz) >> PAGE_SHIFT;
635 page = alloc_pages(GFP_KERNEL_ACCOUNT, get_order(sz));
639 ret = set_memory_decrypted((unsigned long)page_address(page), npages);
641 dev_err(dev, "failed to mark page shared, ret=%d\n", ret);
642 __free_pages(page, get_order(sz));
646 return page_address(page);
649 static const struct file_operations snp_guest_fops = {
650 .owner = THIS_MODULE,
651 .unlocked_ioctl = snp_guest_ioctl,
654 static u8 *get_vmpck(int id, struct snp_secrets_page_layout *layout, u32 **seqno)
660 *seqno = &layout->os_area.msg_seqno_0;
661 key = layout->vmpck0;
664 *seqno = &layout->os_area.msg_seqno_1;
665 key = layout->vmpck1;
668 *seqno = &layout->os_area.msg_seqno_2;
669 key = layout->vmpck2;
672 *seqno = &layout->os_area.msg_seqno_3;
673 key = layout->vmpck3;
682 static int __init sev_guest_probe(struct platform_device *pdev)
684 struct snp_secrets_page_layout *layout;
685 struct sev_guest_platform_data *data;
686 struct device *dev = &pdev->dev;
687 struct snp_guest_dev *snp_dev;
688 struct miscdevice *misc;
689 void __iomem *mapping;
692 if (!dev->platform_data)
695 data = (struct sev_guest_platform_data *)dev->platform_data;
696 mapping = ioremap_encrypted(data->secrets_gpa, PAGE_SIZE);
700 layout = (__force void *)mapping;
703 snp_dev = devm_kzalloc(&pdev->dev, sizeof(struct snp_guest_dev), GFP_KERNEL);
708 snp_dev->vmpck = get_vmpck(vmpck_id, layout, &snp_dev->os_area_msg_seqno);
709 if (!snp_dev->vmpck) {
710 dev_err(dev, "invalid vmpck id %d\n", vmpck_id);
714 /* Verify that VMPCK is not zero. */
715 if (is_vmpck_empty(snp_dev)) {
716 dev_err(dev, "vmpck id %d is null\n", vmpck_id);
720 platform_set_drvdata(pdev, snp_dev);
722 snp_dev->layout = layout;
724 /* Allocate the shared page used for the request and response message. */
725 snp_dev->request = alloc_shared_pages(dev, sizeof(struct snp_guest_msg));
726 if (!snp_dev->request)
729 snp_dev->response = alloc_shared_pages(dev, sizeof(struct snp_guest_msg));
730 if (!snp_dev->response)
733 snp_dev->certs_data = alloc_shared_pages(dev, SEV_FW_BLOB_MAX_SIZE);
734 if (!snp_dev->certs_data)
735 goto e_free_response;
738 snp_dev->crypto = init_crypto(snp_dev, snp_dev->vmpck, VMPCK_KEY_LEN);
739 if (!snp_dev->crypto)
740 goto e_free_cert_data;
742 misc = &snp_dev->misc;
743 misc->minor = MISC_DYNAMIC_MINOR;
744 misc->name = DEVICE_NAME;
745 misc->fops = &snp_guest_fops;
747 /* initial the input address for guest request */
748 snp_dev->input.req_gpa = __pa(snp_dev->request);
749 snp_dev->input.resp_gpa = __pa(snp_dev->response);
750 snp_dev->input.data_gpa = __pa(snp_dev->certs_data);
752 ret = misc_register(misc);
754 goto e_free_cert_data;
756 dev_info(dev, "Initialized SEV guest driver (using vmpck_id %d)\n", vmpck_id);
760 free_shared_pages(snp_dev->certs_data, SEV_FW_BLOB_MAX_SIZE);
762 free_shared_pages(snp_dev->response, sizeof(struct snp_guest_msg));
764 free_shared_pages(snp_dev->request, sizeof(struct snp_guest_msg));
770 static int __exit sev_guest_remove(struct platform_device *pdev)
772 struct snp_guest_dev *snp_dev = platform_get_drvdata(pdev);
774 free_shared_pages(snp_dev->certs_data, SEV_FW_BLOB_MAX_SIZE);
775 free_shared_pages(snp_dev->response, sizeof(struct snp_guest_msg));
776 free_shared_pages(snp_dev->request, sizeof(struct snp_guest_msg));
777 deinit_crypto(snp_dev->crypto);
778 misc_deregister(&snp_dev->misc);
784 * This driver is meant to be a common SEV guest interface driver and to
785 * support any SEV guest API. As such, even though it has been introduced
786 * with the SEV-SNP support, it is named "sev-guest".
788 static struct platform_driver sev_guest_driver = {
789 .remove = __exit_p(sev_guest_remove),
795 module_platform_driver_probe(sev_guest_driver, sev_guest_probe);
798 MODULE_LICENSE("GPL");
799 MODULE_VERSION("1.0.0");
800 MODULE_DESCRIPTION("AMD SEV Guest Driver");
801 MODULE_ALIAS("platform:sev-guest");