1U-Boot FIT Signature Verification 2================================= 3 4Introduction 5------------ 6FIT supports hashing of images so that these hashes can be checked on 7loading. This protects against corruption of the image. However it does not 8prevent the substitution of one image for another. 9 10The signature feature allows the hash to be signed with a private key such 11that it can be verified using a public key later. Provided that the private 12key is kept secret and the public key is stored in a non-volatile place, 13any image can be verified in this way. 14 15See verified-boot.txt for more general information on verified boot. 16 17 18Concepts 19-------- 20Some familiarity with public key cryptography is assumed in this section. 21 22The procedure for signing is as follows: 23 24 - hash an image in the FIT 25 - sign the hash with a private key to produce a signature 26 - store the resulting signature in the FIT 27 28The procedure for verification is: 29 30 - read the FIT 31 - obtain the public key 32 - extract the signature from the FIT 33 - hash the image from the FIT 34 - verify (with the public key) that the extracted signature matches the 35 hash 36 37The signing is generally performed by mkimage, as part of making a firmware 38image for the device. The verification is normally done in U-Boot on the 39device. 40 41 42Algorithms 43---------- 44In principle any suitable algorithm can be used to sign and verify a hash. 45At present only one class of algorithms is supported: SHA1 hashing with RSA. 46This works by hashing the image to produce a 20-byte hash. 47 48While it is acceptable to bring in large cryptographic libraries such as 49openssl on the host side (e.g. mkimage), it is not desirable for U-Boot. 50For the run-time verification side, it is important to keep code and data 51size as small as possible. 52 53For this reason the RSA image verification uses pre-processed public keys 54which can be used with a very small amount of code - just some extraction 55of data from the FDT and exponentiation mod n. Code size impact is a little 56under 5KB on Tegra Seaboard, for example. 57 58It is relatively straightforward to add new algorithms if required. If 59another RSA variant is needed, then it can be added to the table in 60image-sig.c. If another algorithm is needed (such as DSA) then it can be 61placed alongside rsa.c, and its functions added to the table in image-sig.c 62also. 63 64 65Creating an RSA key pair and certificate 66---------------------------------------- 67To create a new public/private key pair, size 2048 bits: 68 69$ openssl genpkey -algorithm RSA -out keys/dev.key \ 70 -pkeyopt rsa_keygen_bits:2048 -pkeyopt rsa_keygen_pubexp:65537 71 72To create a certificate for this containing the public key: 73 74$ openssl req -batch -new -x509 -key keys/dev.key -out keys/dev.crt 75 76If you like you can look at the public key also: 77 78$ openssl rsa -in keys/dev.key -pubout 79 80 81Device Tree Bindings 82-------------------- 83The following properties are required in the FIT's signature node(s) to 84allow the signer to operate. These should be added to the .its file. 85Signature nodes sit at the same level as hash nodes and are called 86signature-1, signature-2, etc. 87 88- algo: Algorithm name (e.g. "sha1,rsa2048") 89 90- key-name-hint: Name of key to use for signing. The keys will normally be in 91a single directory (parameter -k to mkimage). For a given key <name>, its 92private key is stored in <name>.key and the certificate is stored in 93<name>.crt. 94 95When the image is signed, the following properties are added (mandatory): 96 97- value: The signature data (e.g. 256 bytes for 2048-bit RSA) 98 99When the image is signed, the following properties are optional: 100 101- timestamp: Time when image was signed (standard Unix time_t format) 102 103- signer-name: Name of the signer (e.g. "mkimage") 104 105- signer-version: Version string of the signer (e.g. "2013.01") 106 107- comment: Additional information about the signer or image 108 109- padding: The padding algorithm, it may be pkcs-1.5 or pss, 110 if no value is provided we assume pkcs-1.5 111 112For config bindings (see Signed Configurations below), the following 113additional properties are optional: 114 115- sign-images: A list of images to sign, each being a property of the conf 116node that contains then. The default is "kernel,fdt" which means that these 117two images will be looked up in the config and signed if present. 118 119For config bindings, these properties are added by the signer: 120 121- hashed-nodes: A list of nodes which were hashed by the signer. Each is 122 a string - the full path to node. A typical value might be: 123 124 hashed-nodes = "/", "/configurations/conf-1", "/images/kernel", 125 "/images/kernel/hash-1", "/images/fdt-1", 126 "/images/fdt-1/hash-1"; 127 128- hashed-strings: The start and size of the string region of the FIT that 129 was hashed 130 131Example: See sign-images.its for an example image tree source file and 132sign-configs.its for config signing. 133 134 135Public Key Storage 136------------------ 137In order to verify an image that has been signed with a public key we need to 138have a trusted public key. This cannot be stored in the signed image, since 139it would be easy to alter. For this implementation we choose to store the 140public key in U-Boot's control FDT (using CONFIG_OF_CONTROL). 141 142Public keys should be stored as sub-nodes in a /signature node. Required 143properties are: 144 145- algo: Algorithm name (e.g. "sha1,rsa2048") 146 147Optional properties are: 148 149- key-name-hint: Name of key used for signing. This is only a hint since it 150is possible for the name to be changed. Verification can proceed by checking 151all available signing keys until one matches. 152 153- required: If present this indicates that the key must be verified for the 154image / configuration to be considered valid. Only required keys are 155normally verified by the FIT image booting algorithm. Valid values are 156"image" to force verification of all images, and "conf" to force verification 157of the selected configuration (which then relies on hashes in the images to 158verify those). 159 160Each signing algorithm has its own additional properties. 161 162For RSA the following are mandatory: 163 164- rsa,num-bits: Number of key bits (e.g. 2048) 165- rsa,modulus: Modulus (N) as a big-endian multi-word integer 166- rsa,exponent: Public exponent (E) as a 64 bit unsigned integer 167- rsa,r-squared: (2^num-bits)^2 as a big-endian multi-word integer 168- rsa,n0-inverse: -1 / modulus[0] mod 2^32 169 170These parameters can be added to a binary device tree using parameter -K of the 171mkimage command:: 172 173 tools/mkimage -f fit.its -K control.dtb -k keys -r image.fit 174 175Here is an example of a generated device tree node:: 176 177 signature { 178 key-dev { 179 required = "conf"; 180 algo = "sha256,rsa2048"; 181 rsa,r-squared = <0xb76d1acf 0xa1763ca5 0xeb2f126 182 0x742edc80 0xd3f42177 0x9741d9d9 183 0x35bb476e 0xff41c718 0xd3801430 184 0xf22537cb 0xa7e79960 0xae32a043 185 0x7da1427a 0x341d6492 0x3c2762f5 186 0xaac04726 0x5b262d96 0xf984e86d 187 0xb99443c7 0x17080c33 0x940f6892 188 0xd57a95d1 0x6ea7b691 0xc5038fa8 189 0x6bb48a6e 0x73f1b1ea 0x37160841 190 0xe05715ce 0xa7c45bbd 0x690d82d5 191 0x99c2454c 0x6ff117b3 0xd830683b 192 0x3f81c9cf 0x1ca38a91 0x0c3392e4 193 0xd817c625 0x7b8e9a24 0x175b89ea 194 0xad79f3dc 0x4d50d7b4 0x9d4e90f8 195 0xad9e2939 0xc165d6a4 0x0ada7e1b 196 0xfb1bf495 0xfc3131c2 0xb8c6e604 197 0xc2761124 0xf63de4a6 0x0e9565f9 198 0xc8e53761 0x7e7a37a5 0xe99dcdae 199 0x9aff7e1e 0xbd44b13d 0x6b0e6aa4 200 0x038907e4 0x8e0d6850 0xef51bc20 201 0xf73c94af 0x88bea7b1 0xcbbb1b30 202 0xd024b7f3>; 203 rsa,modulus = <0xc0711d6cb 0x9e86db7f 0x45986dbe 204 0x023f1e8c9 0xe1a4c4d0 0x8a0dfdc9 205 0x023ba0c48 0x06815f6a 0x5caa0654 206 0x07078c4b7 0x3d154853 0x40729023 207 0x0b007c8fe 0x5a3647e5 0x23b41e20 208 0x024720591 0x66915305 0x0e0b29b0 209 0x0de2ad30d 0x8589430f 0xb1590325 210 0x0fb9f5d5e 0x9eba752a 0xd88e6de9 211 0x056b3dcc6 0x9a6b8e61 0x6784f61f 212 0x000f39c21 0x5eec6b33 0xd78e4f78 213 0x0921a305f 0xaa2cc27e 0x1ca917af 214 0x06e1134f4 0xd48cac77 0x4e914d07 215 0x0f707aa5a 0x0d141f41 0x84677f1d 216 0x0ad47a049 0x028aedb6 0xd5536fcf 217 0x03fef1e4f 0x133a03d2 0xfd7a750a 218 0x0f9159732 0xd207812e 0x6a807375 219 0x06434230d 0xc8e22dad 0x9f29b3d6 220 0x07c44ac2b 0xfa2aad88 0xe2429504 221 0x041febd41 0x85d0d142 0x7b194d65 222 0x06e5d55ea 0x41116961 0xf3181dde 223 0x068bf5fbc 0x3dd82047 0x00ee647e 224 0x0d7a44ab3>; 225 rsa,exponent = <0x00 0x10001>; 226 rsa,n0-inverse = <0xb3928b85>; 227 rsa,num-bits = <0x800>; 228 key-name-hint = "dev"; 229 }; 230 }; 231 232 233Signed Configurations 234--------------------- 235While signing images is useful, it does not provide complete protection 236against several types of attack. For example, it it possible to create a 237FIT with the same signed images, but with the configuration changed such 238that a different one is selected (mix and match attack). It is also possible 239to substitute a signed image from an older FIT version into a newer FIT 240(roll-back attack). 241 242As an example, consider this FIT: 243 244/ { 245 images { 246 kernel-1 { 247 data = <data for kernel1> 248 signature-1 { 249 algo = "sha1,rsa2048"; 250 value = <...kernel signature 1...> 251 }; 252 }; 253 kernel-2 { 254 data = <data for kernel2> 255 signature-1 { 256 algo = "sha1,rsa2048"; 257 value = <...kernel signature 2...> 258 }; 259 }; 260 fdt-1 { 261 data = <data for fdt1>; 262 signature-1 { 263 algo = "sha1,rsa2048"; 264 vaue = <...fdt signature 1...> 265 }; 266 }; 267 fdt-2 { 268 data = <data for fdt2>; 269 signature-1 { 270 algo = "sha1,rsa2048"; 271 vaue = <...fdt signature 2...> 272 }; 273 }; 274 }; 275 configurations { 276 default = "conf-1"; 277 conf-1 { 278 kernel = "kernel-1"; 279 fdt = "fdt-1"; 280 }; 281 conf-2 { 282 kernel = "kernel-2"; 283 fdt = "fdt-2"; 284 }; 285 }; 286}; 287 288Since both kernels are signed it is easy for an attacker to add a new 289configuration 3 with kernel 1 and fdt 2: 290 291 configurations { 292 default = "conf-1"; 293 conf-1 { 294 kernel = "kernel-1"; 295 fdt = "fdt-1"; 296 }; 297 conf-2 { 298 kernel = "kernel-2"; 299 fdt = "fdt-2"; 300 }; 301 conf-3 { 302 kernel = "kernel-1"; 303 fdt = "fdt-2"; 304 }; 305 }; 306 307With signed images, nothing protects against this. Whether it gains an 308advantage for the attacker is debatable, but it is not secure. 309 310To solve this problem, we support signed configurations. In this case it 311is the configurations that are signed, not the image. Each image has its 312own hash, and we include the hash in the configuration signature. 313 314So the above example is adjusted to look like this: 315 316/ { 317 images { 318 kernel-1 { 319 data = <data for kernel1> 320 hash-1 { 321 algo = "sha1"; 322 value = <...kernel hash 1...> 323 }; 324 }; 325 kernel-2 { 326 data = <data for kernel2> 327 hash-1 { 328 algo = "sha1"; 329 value = <...kernel hash 2...> 330 }; 331 }; 332 fdt-1 { 333 data = <data for fdt1>; 334 hash-1 { 335 algo = "sha1"; 336 value = <...fdt hash 1...> 337 }; 338 }; 339 fdt-2 { 340 data = <data for fdt2>; 341 hash-1 { 342 algo = "sha1"; 343 value = <...fdt hash 2...> 344 }; 345 }; 346 }; 347 configurations { 348 default = "conf-1"; 349 conf-1 { 350 kernel = "kernel-1"; 351 fdt = "fdt-1"; 352 signature-1 { 353 algo = "sha1,rsa2048"; 354 value = <...conf 1 signature...>; 355 }; 356 }; 357 conf-2 { 358 kernel = "kernel-2"; 359 fdt = "fdt-2"; 360 signature-1 { 361 algo = "sha1,rsa2048"; 362 value = <...conf 1 signature...>; 363 }; 364 }; 365 }; 366}; 367 368 369You can see that we have added hashes for all images (since they are no 370longer signed), and a signature to each configuration. In the above example, 371mkimage will sign configurations/conf-1, the kernel and fdt that are 372pointed to by the configuration (/images/kernel-1, /images/kernel-1/hash-1, 373/images/fdt-1, /images/fdt-1/hash-1) and the root structure of the image 374(so that it isn't possible to add or remove root nodes). The signature is 375written into /configurations/conf-1/signature-1/value. It can easily be 376verified later even if the FIT has been signed with other keys in the 377meantime. 378 379 380Verification 381------------ 382FITs are verified when loaded. After the configuration is selected a list 383of required images is produced. If there are 'required' public keys, then 384each image must be verified against those keys. This means that every image 385that might be used by the target needs to be signed with 'required' keys. 386 387This happens automatically as part of a bootm command when FITs are used. 388 389 390Enabling FIT Verification 391------------------------- 392In addition to the options to enable FIT itself, the following CONFIGs must 393be enabled: 394 395CONFIG_FIT_SIGNATURE - enable signing and verification in FITs 396CONFIG_RSA - enable RSA algorithm for signing 397 398WARNING: When relying on signed FIT images with required signature check 399the legacy image format is default disabled by not defining 400CONFIG_LEGACY_IMAGE_FORMAT 401 402 403Testing 404------- 405An easy way to test signing and verification is to use the test script 406provided in test/vboot/vboot_test.sh. This uses sandbox (a special version 407of U-Boot which runs under Linux) to show the operation of a 'bootm' 408command loading and verifying images. 409 410A sample run is show below: 411 412$ make O=sandbox sandbox_config 413$ make O=sandbox 414$ O=sandbox ./test/vboot/vboot_test.sh 415 416 417Simple Verified Boot Test 418========================= 419 420Please see doc/uImage.FIT/verified-boot.txt for more information 421 422/home/hs/ids/u-boot/sandbox/tools/mkimage -D -I dts -O dtb -p 2000 423Build keys 424do sha1 test 425Build FIT with signed images 426Test Verified Boot Run: unsigned signatures:: OK 427Sign images 428Test Verified Boot Run: signed images: OK 429Build FIT with signed configuration 430Test Verified Boot Run: unsigned config: OK 431Sign images 432Test Verified Boot Run: signed config: OK 433check signed config on the host 434Signature check OK 435OK 436Test Verified Boot Run: signed config: OK 437Test Verified Boot Run: signed config with bad hash: OK 438do sha256 test 439Build FIT with signed images 440Test Verified Boot Run: unsigned signatures:: OK 441Sign images 442Test Verified Boot Run: signed images: OK 443Build FIT with signed configuration 444Test Verified Boot Run: unsigned config: OK 445Sign images 446Test Verified Boot Run: signed config: OK 447check signed config on the host 448Signature check OK 449OK 450Test Verified Boot Run: signed config: OK 451Test Verified Boot Run: signed config with bad hash: OK 452 453Test passed 454 455 456Hardware Signing with PKCS#11 or with HSM 457----------------------------------------- 458 459Securely managing private signing keys can challenging, especially when the 460keys are stored on the file system of a computer that is connected to the 461Internet. If an attacker is able to steal the key, they can sign malicious FIT 462images which will appear genuine to your devices. 463 464An alternative solution is to keep your signing key securely stored on hardware 465device like a smartcard, USB token or Hardware Security Module (HSM) and have 466them perform the signing. PKCS#11 is standard for interfacing with these crypto 467device. 468 469Requirements: 470Smartcard/USB token/HSM which can work with some openssl engine 471openssl 472 473For pkcs11 engine usage: 474libp11 (provides pkcs11 engine) 475p11-kit (recommended to simplify setup) 476opensc (for smartcards and smartcard like USB devices) 477gnutls (recommended for key generation, p11tool) 478 479For generic HSMs respective openssl engine must be installed and locateable by 480openssl. This may require setting up LD_LIBRARY_PATH if engine is not installed 481to openssl's default search paths. 482 483PKCS11 engine support forms "key id" based on "keydir" and with 484"key-name-hint". "key-name-hint" is used as "object" name and "keydir" if 485defined is used to define (prefix for) which PKCS11 source is being used for 486lookup up for the key. 487 488PKCS11 engine key ids: 489 "pkcs11:<keydir>;object=<key-name-hint>;type=<public|private>" 490or 491 "pkcs11:object=<key-name-hint>;type=<public|private>", 492 493Generic HSM engine support forms "key id" based on "keydir" and with 494"key-name-hint". If "keydir" is specified for mkimage it is used as a prefix in 495"key id" and is appended with "key-name-hint". 496 497Generic engine key ids: 498 "<keydir><key-name-hint>" 499or 500 "<key-name-hint>" 501 502As mkimage does not at this time support prompting for passwords HSM may need 503key preloading wrapper to be used when invoking mkimage. 504 505The following examples use the Nitrokey Pro using pkcs11 engine. Instructions 506for other devices may vary. 507 508Notes on pkcs11 engine setup: 509 510Make sure p11-kit, opensc are installed and that p11-kit is setup to use opensc. 511/usr/share/p11-kit/modules/opensc.module should be present on your system. 512 513 514Generating Keys On the Nitrokey: 515 516$ gpg --card-edit 517 518Reader ...........: Nitrokey Nitrokey Pro (xxxxxxxx0000000000000000) 00 00 519Application ID ...: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 520Version ..........: 2.1 521Manufacturer .....: ZeitControl 522Serial number ....: xxxxxxxx 523Name of cardholder: [not set] 524Language prefs ...: de 525Sex ..............: unspecified 526URL of public key : [not set] 527Login data .......: [not set] 528Signature PIN ....: forced 529Key attributes ...: rsa2048 rsa2048 rsa2048 530Max. PIN lengths .: 32 32 32 531PIN retry counter : 3 0 3 532Signature counter : 0 533Signature key ....: [none] 534Encryption key....: [none] 535Authentication key: [none] 536General key info..: [none] 537 538gpg/card> generate 539Make off-card backup of encryption key? (Y/n) n 540 541Please note that the factory settings of the PINs are 542 PIN = '123456' Admin PIN = '12345678' 543You should change them using the command --change-pin 544 545What keysize do you want for the Signature key? (2048) 4096 546The card will now be re-configured to generate a key of 4096 bits 547Note: There is no guarantee that the card supports the requested size. 548 If the key generation does not succeed, please check the 549 documentation of your card to see what sizes are allowed. 550What keysize do you want for the Encryption key? (2048) 4096 551The card will now be re-configured to generate a key of 4096 bits 552What keysize do you want for the Authentication key? (2048) 4096 553The card will now be re-configured to generate a key of 4096 bits 554Please specify how long the key should be valid. 555 0 = key does not expire 556 <n> = key expires in n days 557 <n>w = key expires in n weeks 558 <n>m = key expires in n months 559 <n>y = key expires in n years 560Key is valid for? (0) 561Key does not expire at all 562Is this correct? (y/N) y 563 564GnuPG needs to construct a user ID to identify your key. 565 566Real name: John Doe 567Email address: john.doe@email.com 568Comment: 569You selected this USER-ID: 570 "John Doe <john.doe@email.com>" 571 572Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? o 573 574 575Using p11tool to get the token URL: 576 577Depending on system configuration, gpg-agent may need to be killed first. 578 579$ p11tool --provider /usr/lib/opensc-pkcs11.so --list-tokens 580Token 0: 581URL: pkcs11:model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%20%28sig%29%29 582Label: OpenPGP card (User PIN (sig)) 583Type: Hardware token 584Manufacturer: ZeitControl 585Model: PKCS#15 emulated 586Serial: 000xxxxxxxxx 587Module: (null) 588 589 590Token 1: 591URL: pkcs11:model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%29 592Label: OpenPGP card (User PIN) 593Type: Hardware token 594Manufacturer: ZeitControl 595Model: PKCS#15 emulated 596Serial: 000xxxxxxxxx 597Module: (null) 598 599Use the portion of the signature token URL after "pkcs11:" as the keydir argument (-k) to mkimage below. 600 601 602Use the URL of the token to list the private keys: 603 604$ p11tool --login --provider /usr/lib/opensc-pkcs11.so --list-privkeys \ 605"pkcs11:model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%20%28sig%29%29" 606Token 'OpenPGP card (User PIN (sig))' with URL 'pkcs11:model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%20%28sig%29%29' requires user PIN 607Enter PIN: 608Object 0: 609URL: pkcs11:model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%20%28sig%29%29;id=%01;object=Signature%20key;type=private 610Type: Private key 611Label: Signature key 612Flags: CKA_PRIVATE; CKA_NEVER_EXTRACTABLE; CKA_SENSITIVE; 613ID: 01 614 615Use the label, in this case "Signature key" as the key-name-hint in your FIT. 616 617Create the fitImage: 618$ ./tools/mkimage -f fit-image.its fitImage 619 620 621Sign the fitImage with the hardware key: 622 623$ ./tools/mkimage -F -k \ 624"model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%20%28sig%29%29" \ 625-K u-boot.dtb -N pkcs11 -r fitImage 626 627 628Future Work 629----------- 630- Roll-back protection using a TPM is done using the tpm command. This can 631be scripted, but we might consider a default way of doing this, built into 632bootm. 633 634 635Possible Future Work 636-------------------- 637- Add support for other RSA/SHA variants, such as rsa4096,sha512. 638- Other algorithms besides RSA 639- More sandbox tests for failure modes 640- Passwords for keys/certificates 641- Perhaps implement OAEP 642- Enhance bootm to permit scripted signature verification (so that a script 643can verify an image but not actually boot it) 644 645 646Simon Glass 647sjg@chromium.org 6481-1-13 649