1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2018 Xilinx, Inc.
10 #include <asm/arch/hardware.h>
11 #include <asm/arch/sys_proto.h>
13 #include <linux/bitops.h>
14 #include <u-boot/md5.h>
15 #include <u-boot/rsa.h>
16 #include <u-boot/rsa-mod-exp.h>
17 #include <u-boot/sha256.h>
20 #include <zynq_bootimg.h>
22 DECLARE_GLOBAL_DATA_PTR;
24 #ifdef CONFIG_CMD_ZYNQ_RSA
26 #define ZYNQ_EFUSE_RSA_ENABLE_MASK 0x400
27 #define ZYNQ_ATTRIBUTE_PL_IMAGE_MASK 0x20
28 #define ZYNQ_ATTRIBUTE_CHECKSUM_TYPE_MASK 0x7000
29 #define ZYNQ_ATTRIBUTE_RSA_PRESENT_MASK 0x8000
30 #define ZYNQ_ATTRIBUTE_RSA_PART_OWNER_MASK 0x30000
32 #define ZYNQ_RSA_MODULAR_SIZE 256
33 #define ZYNQ_RSA_MODULAR_EXT_SIZE 256
34 #define ZYNQ_RSA_EXPO_SIZE 64
35 #define ZYNQ_RSA_SPK_SIGNATURE_SIZE 256
36 #define ZYNQ_RSA_PARTITION_SIGNATURE_SIZE 256
37 #define ZYNQ_RSA_SIGNATURE_SIZE 0x6C0
38 #define ZYNQ_RSA_HEADER_SIZE 4
39 #define ZYNQ_RSA_MAGIC_WORD_SIZE 60
40 #define ZYNQ_RSA_PART_OWNER_UBOOT 1
41 #define ZYNQ_RSA_ALIGN_PPK_START 64
43 #define WORD_LENGTH_SHIFT 2
45 static u8 *ppkmodular;
46 static u8 *ppkmodularex;
48 struct zynq_rsa_public_key {
49 uint len; /* Length of modulus[] in number of u32 */
50 u32 n0inv; /* -1 / modulus[0] mod 2^32 */
51 u32 *modulus; /* modulus as little endian array */
52 u32 *rr; /* R^2 as little endian array */
55 static struct zynq_rsa_public_key public_key;
57 static struct partition_hdr part_hdr[ZYNQ_MAX_PARTITION_NUMBER];
60 * Extract the primary public key components from already autheticated FSBL
62 static void zynq_extract_ppk(u32 fsbl_len)
67 debug("%s\n", __func__);
70 * Extract the authenticated PPK from OCM i.e at end of the FSBL
72 ppkptr = (u8 *)(fsbl_len + ZYNQ_OCM_BASEADDR);
73 padsize = ((u32)ppkptr % ZYNQ_RSA_ALIGN_PPK_START);
75 ppkptr += (ZYNQ_RSA_ALIGN_PPK_START - padsize);
77 ppkptr += ZYNQ_RSA_HEADER_SIZE;
79 ppkptr += ZYNQ_RSA_MAGIC_WORD_SIZE;
81 ppkmodular = (u8 *)ppkptr;
82 ppkptr += ZYNQ_RSA_MODULAR_SIZE;
83 ppkmodularex = (u8 *)ppkptr;
84 ppkptr += ZYNQ_RSA_MODULAR_EXT_SIZE;
88 * Calculate the inverse(-1 / modulus[0] mod 2^32 ) for the PPK
90 static u32 zynq_calc_inv(void)
92 u32 modulus = public_key.modulus[0];
96 inverse = modulus & BIT(0);
99 inverse *= 2 - modulus * inverse;
103 return ~(inverse - 1);
107 * Recreate the signature by padding the bytes and verify with hash value
109 static int zynq_pad_and_check(u8 *signature, u8 *hash)
111 u8 padding[] = {0x30, 0x31, 0x30, 0x0D, 0x06, 0x09, 0x60, 0x86, 0x48,
112 0x01, 0x65, 0x03, 0x04, 0x02, 0x01, 0x05, 0x00, 0x04,
114 u8 *pad_ptr = signature + 256;
119 * Re-Create PKCS#1v1.5 Padding
120 * MSB ----------------------------------------------------LSB
121 * 0x0 || 0x1 || 0xFF(for 202 bytes) || 0x0 || T_padding || SHA256 Hash
123 if (*--pad_ptr != 0 || *--pad_ptr != 1)
126 for (ii = 0; ii < pad; ii++) {
127 if (*--pad_ptr != 0xFF)
134 for (ii = 0; ii < sizeof(padding); ii++) {
135 if (*--pad_ptr != padding[ii])
139 for (ii = 0; ii < 32; ii++) {
140 if (*--pad_ptr != hash[ii])
147 * Verify and extract the hash value from signature using the public key
148 * and compare it with calculated hash value.
150 static int zynq_rsa_verify_key(const struct zynq_rsa_public_key *key,
151 const u8 *sig, const u32 sig_len, const u8 *hash)
156 if (!key || !sig || !hash)
159 if (sig_len != (key->len * sizeof(u32))) {
160 printf("Signature is of incorrect length %d\n", sig_len);
164 /* Sanity check for stack size */
165 if (sig_len > ZYNQ_RSA_SPK_SIGNATURE_SIZE) {
166 printf("Signature length %u exceeds maximum %d\n", sig_len,
167 ZYNQ_RSA_SPK_SIGNATURE_SIZE);
171 buf = malloc(sig_len);
175 memcpy(buf, sig, sig_len);
177 status = zynq_pow_mod((u32 *)key, (u32 *)buf);
183 status = zynq_pad_and_check((u8 *)buf, (u8 *)hash);
190 * Authenticate the partition
192 static int zynq_authenticate_part(u8 *buffer, u32 size)
194 u8 hash_signature[32];
200 debug("%s\n", __func__);
202 signature_ptr = (u8 *)(buffer + size - ZYNQ_RSA_SIGNATURE_SIZE);
204 signature_ptr += ZYNQ_RSA_HEADER_SIZE;
206 signature_ptr += ZYNQ_RSA_MAGIC_WORD_SIZE;
208 ppkmodular = (u8 *)signature_ptr;
209 signature_ptr += ZYNQ_RSA_MODULAR_SIZE;
210 ppkmodularex = signature_ptr;
211 signature_ptr += ZYNQ_RSA_MODULAR_EXT_SIZE;
212 signature_ptr += ZYNQ_RSA_EXPO_SIZE;
214 sha256_csum_wd((const unsigned char *)signature_ptr,
215 (ZYNQ_RSA_MODULAR_EXT_SIZE + ZYNQ_RSA_EXPO_SIZE +
216 ZYNQ_RSA_MODULAR_SIZE),
217 (unsigned char *)hash_signature, 0x1000);
219 spk_modular = (u8 *)signature_ptr;
220 signature_ptr += ZYNQ_RSA_MODULAR_SIZE;
221 spk_modular_ex = (u8 *)signature_ptr;
222 signature_ptr += ZYNQ_RSA_MODULAR_EXT_SIZE;
223 signature_ptr += ZYNQ_RSA_EXPO_SIZE;
225 public_key.len = ZYNQ_RSA_MODULAR_SIZE / sizeof(u32);
226 public_key.modulus = (u32 *)ppkmodular;
227 public_key.rr = (u32 *)ppkmodularex;
228 public_key.n0inv = zynq_calc_inv();
230 status = zynq_rsa_verify_key(&public_key, signature_ptr,
231 ZYNQ_RSA_SPK_SIGNATURE_SIZE,
236 signature_ptr += ZYNQ_RSA_SPK_SIGNATURE_SIZE;
238 sha256_csum_wd((const unsigned char *)buffer,
239 (size - ZYNQ_RSA_PARTITION_SIGNATURE_SIZE),
240 (unsigned char *)hash_signature, 0x1000);
242 public_key.len = ZYNQ_RSA_MODULAR_SIZE / sizeof(u32);
243 public_key.modulus = (u32 *)spk_modular;
244 public_key.rr = (u32 *)spk_modular_ex;
245 public_key.n0inv = zynq_calc_inv();
247 return zynq_rsa_verify_key(&public_key, (u8 *)signature_ptr,
248 ZYNQ_RSA_PARTITION_SIGNATURE_SIZE,
249 (u8 *)hash_signature);
253 * Parses the partition header and verfies the authenticated and
256 static int zynq_verify_image(u32 src_ptr)
258 u32 silicon_ver, image_base_addr, status;
259 u32 partition_num = 0;
260 u32 efuseval, srcaddr, size, fsbl_len;
261 struct partition_hdr *hdr_ptr;
262 u32 part_data_len, part_img_len, part_attr;
263 u32 part_load_addr, part_dst_addr, part_chksum_offset;
264 u32 part_start_addr, part_total_size, partitioncount;
265 bool encrypt_part_flag = false;
266 bool part_chksum_flag = false;
267 bool signed_part_flag = false;
269 image_base_addr = src_ptr;
271 silicon_ver = zynq_get_silicon_version();
273 /* RSA not supported in silicon versions 1.0 and 2.0 */
274 if (silicon_ver == 0 || silicon_ver == 1)
277 zynq_get_partition_info(image_base_addr, &fsbl_len,
280 /* Extract ppk if efuse was blown Otherwise return error */
281 efuseval = readl(&efuse_base->status);
282 if (!(efuseval & ZYNQ_EFUSE_RSA_ENABLE_MASK))
285 zynq_extract_ppk(fsbl_len);
287 partitioncount = zynq_get_part_count(&part_hdr[0]);
290 * As the first two partitions are related to fsbl,
291 * we can ignore those two in bootimage and the below
292 * code doesn't need to validate it as fsbl is already
295 if (partitioncount <= 2 ||
296 partitioncount > ZYNQ_MAX_PARTITION_NUMBER)
299 while (partition_num < partitioncount) {
300 if (((part_hdr[partition_num].partitionattr &
301 ZYNQ_ATTRIBUTE_RSA_PART_OWNER_MASK) >> 16) !=
302 ZYNQ_RSA_PART_OWNER_UBOOT) {
303 printf("UBOOT is not Owner for partition %d\n",
308 hdr_ptr = &part_hdr[partition_num];
309 status = zynq_validate_hdr(hdr_ptr);
313 part_data_len = hdr_ptr->datawordlen;
314 part_img_len = hdr_ptr->imagewordlen;
315 part_attr = hdr_ptr->partitionattr;
316 part_load_addr = hdr_ptr->loadaddr;
317 part_chksum_offset = hdr_ptr->checksumoffset;
318 part_start_addr = hdr_ptr->partitionstart;
319 part_total_size = hdr_ptr->partitionwordlen;
321 if (part_data_len != part_img_len) {
322 debug("Encrypted\n");
323 encrypt_part_flag = true;
326 if (part_attr & ZYNQ_ATTRIBUTE_CHECKSUM_TYPE_MASK)
327 part_chksum_flag = true;
329 if (part_attr & ZYNQ_ATTRIBUTE_RSA_PRESENT_MASK) {
330 debug("RSA Signed\n");
331 signed_part_flag = true;
332 size = part_total_size << WORD_LENGTH_SHIFT;
337 if (!signed_part_flag && !part_chksum_flag) {
338 printf("Partition not signed & no chksum\n");
343 srcaddr = image_base_addr +
344 (part_start_addr << WORD_LENGTH_SHIFT);
347 * This validation is just for PS DDR.
348 * TODO: Update this for PL DDR check as well.
350 if (part_load_addr < gd->bd->bi_dram[0].start &&
351 ((part_load_addr + part_data_len) >
352 (gd->bd->bi_dram[0].start +
353 gd->bd->bi_dram[0].size))) {
354 printf("INVALID_LOAD_ADDRESS_FAIL\n");
358 if (part_attr & ZYNQ_ATTRIBUTE_PL_IMAGE_MASK)
359 part_load_addr = srcaddr;
361 memcpy((u32 *)part_load_addr, (u32 *)srcaddr,
364 if (part_chksum_flag) {
365 part_chksum_offset = image_base_addr +
366 (part_chksum_offset <<
368 status = zynq_validate_partition(part_load_addr,
373 printf("PART_CHKSUM_FAIL\n");
376 debug("Partition Validation Done\n");
379 if (signed_part_flag) {
380 status = zynq_authenticate_part((u8 *)part_load_addr,
383 printf("AUTHENTICATION_FAIL\n");
386 debug("Authentication Done\n");
389 if (encrypt_part_flag) {
390 debug("DECRYPTION\n");
392 part_dst_addr = part_load_addr;
394 if (part_attr & ZYNQ_ATTRIBUTE_PL_IMAGE_MASK) {
399 status = zynq_decrypt_load(part_load_addr,
404 printf("DECRYPTION_FAIL\n");
414 static int do_zynq_rsa(struct cmd_tbl *cmdtp, int flag, int argc,
420 if (argc != cmdtp->maxargs)
421 return CMD_RET_FAILURE;
423 src_ptr = simple_strtoul(argv[2], &endp, 16);
424 if (*argv[2] == 0 || *endp != 0)
425 return CMD_RET_USAGE;
427 if (zynq_verify_image(src_ptr))
428 return CMD_RET_FAILURE;
430 return CMD_RET_SUCCESS;
434 #ifdef CONFIG_CMD_ZYNQ_AES
435 static int zynq_decrypt_image(struct cmd_tbl *cmdtp, int flag, int argc,
439 u32 srcaddr, srclen, dstaddr, dstlen;
442 if (argc < 5 && argc > cmdtp->maxargs)
443 return CMD_RET_USAGE;
445 srcaddr = simple_strtoul(argv[2], &endp, 16);
446 if (*argv[2] == 0 || *endp != 0)
447 return CMD_RET_USAGE;
448 srclen = simple_strtoul(argv[3], &endp, 16);
449 if (*argv[3] == 0 || *endp != 0)
450 return CMD_RET_USAGE;
451 dstaddr = simple_strtoul(argv[4], &endp, 16);
452 if (*argv[4] == 0 || *endp != 0)
453 return CMD_RET_USAGE;
454 dstlen = simple_strtoul(argv[5], &endp, 16);
455 if (*argv[5] == 0 || *endp != 0)
456 return CMD_RET_USAGE;
459 * Roundup source and destination lengths to
463 srclen = roundup(srclen, 4);
465 dstlen = roundup(dstlen, 4);
467 status = zynq_decrypt_load(srcaddr, srclen >> 2, dstaddr, dstlen >> 2);
469 return CMD_RET_FAILURE;
471 return CMD_RET_SUCCESS;
475 static struct cmd_tbl zynq_commands[] = {
476 #ifdef CONFIG_CMD_ZYNQ_RSA
477 U_BOOT_CMD_MKENT(rsa, 3, 1, do_zynq_rsa, "", ""),
479 #ifdef CONFIG_CMD_ZYNQ_AES
480 U_BOOT_CMD_MKENT(aes, 6, 1, zynq_decrypt_image, "", ""),
484 static int do_zynq(struct cmd_tbl *cmdtp, int flag, int argc,
487 struct cmd_tbl *zynq_cmd;
490 if (!ARRAY_SIZE(zynq_commands)) {
491 puts("No zynq specific command enabled\n");
492 return CMD_RET_USAGE;
496 return CMD_RET_USAGE;
497 zynq_cmd = find_cmd_tbl(argv[1], zynq_commands,
498 ARRAY_SIZE(zynq_commands));
500 return CMD_RET_USAGE;
502 ret = zynq_cmd->cmd(zynq_cmd, flag, argc, argv);
504 return cmd_process_error(zynq_cmd, ret);
507 #ifdef CONFIG_SYS_LONGHELP
508 static char zynq_help_text[] =
510 #ifdef CONFIG_CMD_ZYNQ_RSA
511 "rsa <baseaddr> - Verifies the authenticated and encrypted\n"
512 " zynq images and loads them back to load\n"
513 " addresses as specified in BOOT image(BOOT.BIN)\n"
515 #ifdef CONFIG_CMD_ZYNQ_AES
516 "aes <srcaddr> <srclen> <dstaddr> <dstlen>\n"
517 " - Decrypts the encrypted image present in source\n"
518 " address and places the decrypted image at\n"
519 " destination address\n"
524 U_BOOT_CMD(zynq, 6, 0, do_zynq,
525 "Zynq specific commands", zynq_help_text