doc/uImage.FIT/signature.txt

   1 U-Boot FIT Signature Verification
   2 =================================
   3
   4 Introduction
   5 ------------
   6 FIT supports hashing of images so that these hashes can be checked on
   7 loading. This protects against corruption of the image. However it does not
   8 prevent the substitution of one image for another.
   9
  10 The signature feature allows the hash to be signed with a private key such
  11 that it can be verified using a public key later. Provided that the private
  12 key is kept secret and the public key is stored in a non-volatile place,
  13 any image can be verified in this way.
  14
  15 See verified-boot.txt for more general information on verified boot.
  16
  17
  18 Concepts
  19 --------
  20 Some familiarity with public key cryptography is assumed in this section.
  21
  22 The 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
  28 The 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
  37 The signing is generally performed by mkimage, as part of making a firmware
  38 image for the device. The verification is normally done in U-Boot on the
  39 device.
  40
  41
  42 Algorithms
  43 ----------
  44 In principle any suitable algorithm can be used to sign and verify a hash.
  45 At present only one class of algorithms is supported: SHA1 hashing with RSA.
  46 This works by hashing the image to produce a 20-byte hash.
  47
  48 While it is acceptable to bring in large cryptographic libraries such as
  49 openssl on the host side (e.g. mkimage), it is not desirable for U-Boot.
  50 For the run-time verification side, it is important to keep code and data
  51 size as small as possible.
  52
  53 For this reason the RSA image verification uses pre-processed public keys
  54 which can be used with a very small amount of code - just some extraction
  55 of data from the FDT and exponentiation mod n. Code size impact is a little
  56 under 5KB on Tegra Seaboard, for example.
  57
  58 It is relatively straightforward to add new algorithms if required. If
  59 another RSA variant is needed, then it can be added to the table in
  60 image-sig.c. If another algorithm is needed (such as DSA) then it can be
  61 placed alongside rsa.c, and its functions added to the table in image-sig.c
  62 also.
  63
  64
  65 Creating an RSA key pair and certificate
  66 ----------------------------------------
  67 To 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
  72 To 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
  76 If you like you can look at the public key also:
  77
  78 $ openssl rsa -in keys/dev.key -pubout
  79
  80
  81 Device Tree Bindings
  82 --------------------
  83 The following properties are required in the FIT's signature node(s) to
  84 allow the signer to operate. These should be added to the .its file.
  85 Signature nodes sit at the same level as hash nodes and are called
  86 signature-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
  91 a single directory (parameter -k to mkimage). For a given key <name>, its
  92 private key is stored in <name>.key and the certificate is stored in
  93 <name>.crt.
  94
  95 When 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
  99 When 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
 112 For config bindings (see Signed Configurations below), the following
 113 additional properties are optional:
 114
 115 - sign-images: A list of images to sign, each being a property of the conf
 116 node that contains then. The default is "kernel,fdt" which means that these
 117 two images will be looked up in the config and signed if present.
 118
 119 For 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
 131 Example: See sign-images.its for an example image tree source file and
 132 sign-configs.its for config signing.
 133
 134
 135 Public Key Storage
 136 ------------------
 137 In order to verify an image that has been signed with a public key we need to
 138 have a trusted public key. This cannot be stored in the signed image, since
 139 it would be easy to alter. For this implementation we choose to store the
 140 public key in U-Boot's control FDT (using CONFIG_OF_CONTROL).
 141
 142 Public keys should be stored as sub-nodes in a /signature node. Required
 143 properties are:
 144
 145 - algo: Algorithm name (e.g. "sha1,rsa2048")
 146
 147 Optional properties are:
 148
 149 - key-name-hint: Name of key used for signing. This is only a hint since it
 150 is possible for the name to be changed. Verification can proceed by checking
 151 all available signing keys until one matches.
 152
 153 - required: If present this indicates that the key must be verified for the
 154 image / configuration to be considered valid. Only required keys are
 155 normally verified by the FIT image booting algorithm. Valid values are
 156 "image" to force verification of all images, and "conf" to force verification
 157 of the selected configuration (which then relies on hashes in the images to
 158 verify those).
 159
 160 Each signing algorithm has its own additional properties.
 161
 162 For 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
 170
 171 Signed Configurations
 172 ---------------------
 173 While signing images is useful, it does not provide complete protection
 174 against several types of attack. For example, it it possible to create a
 175 FIT with the same signed images, but with the configuration changed such
 176 that a different one is selected (mix and match attack). It is also possible
 177 to substitute a signed image from an older FIT version into a newer FIT
 178 (roll-back attack).
 179
 180 As an example, consider this FIT:
 181
 182 / {
 183         images {
 184                 kernel-1 {
 185                         data = <data for kernel1>
 186                         signature-1 {
 187                                 algo = "sha1,rsa2048";
 188                                 value = <...kernel signature 1...>
 189                         };
 190                 };
 191                 kernel-2 {
 192                         data = <data for kernel2>
 193                         signature-1 {
 194                                 algo = "sha1,rsa2048";
 195                                 value = <...kernel signature 2...>
 196                         };
 197                 };
 198                 fdt-1 {
 199                         data = <data for fdt1>;
 200                         signature-1 {
 201                                 algo = "sha1,rsa2048";
 202                                 vaue = <...fdt signature 1...>
 203                         };
 204                 };
 205                 fdt-2 {
 206                         data = <data for fdt2>;
 207                         signature-1 {
 208                                 algo = "sha1,rsa2048";
 209                                 vaue = <...fdt signature 2...>
 210                         };
 211                 };
 212         };
 213         configurations {
 214                 default = "conf-1";
 215                 conf-1 {
 216                         kernel = "kernel-1";
 217                         fdt = "fdt-1";
 218                 };
 219                 conf-1 {
 220                         kernel = "kernel-2";
 221                         fdt = "fdt-2";
 222                 };
 223         };
 224 };
 225
 226 Since both kernels are signed it is easy for an attacker to add a new
 227 configuration 3 with kernel 1 and fdt 2:
 228
 229         configurations {
 230                 default = "conf-1";
 231                 conf-1 {
 232                         kernel = "kernel-1";
 233                         fdt = "fdt-1";
 234                 };
 235                 conf-1 {
 236                         kernel = "kernel-2";
 237                         fdt = "fdt-2";
 238                 };
 239                 conf-3 {
 240                         kernel = "kernel-1";
 241                         fdt = "fdt-2";
 242                 };
 243         };
 244
 245 With signed images, nothing protects against this. Whether it gains an
 246 advantage for the attacker is debatable, but it is not secure.
 247
 248 To solve this problem, we support signed configurations. In this case it
 249 is the configurations that are signed, not the image. Each image has its
 250 own hash, and we include the hash in the configuration signature.
 251
 252 So the above example is adjusted to look like this:
 253
 254 / {
 255         images {
 256                 kernel-1 {
 257                         data = <data for kernel1>
 258                         hash-1 {
 259                                 algo = "sha1";
 260                                 value = <...kernel hash 1...>
 261                         };
 262                 };
 263                 kernel-2 {
 264                         data = <data for kernel2>
 265                         hash-1 {
 266                                 algo = "sha1";
 267                                 value = <...kernel hash 2...>
 268                         };
 269                 };
 270                 fdt-1 {
 271                         data = <data for fdt1>;
 272                         hash-1 {
 273                                 algo = "sha1";
 274                                 value = <...fdt hash 1...>
 275                         };
 276                 };
 277                 fdt-2 {
 278                         data = <data for fdt2>;
 279                         hash-1 {
 280                                 algo = "sha1";
 281                                 value = <...fdt hash 2...>
 282                         };
 283                 };
 284         };
 285         configurations {
 286                 default = "conf-1";
 287                 conf-1 {
 288                         kernel = "kernel-1";
 289                         fdt = "fdt-1";
 290                         signature-1 {
 291                                 algo = "sha1,rsa2048";
 292                                 value = <...conf 1 signature...>;
 293                         };
 294                 };
 295                 conf-2 {
 296                         kernel = "kernel-2";
 297                         fdt = "fdt-2";
 298                         signature-1 {
 299                                 algo = "sha1,rsa2048";
 300                                 value = <...conf 1 signature...>;
 301                         };
 302                 };
 303         };
 304 };
 305
 306
 307 You can see that we have added hashes for all images (since they are no
 308 longer signed), and a signature to each configuration. In the above example,
 309 mkimage will sign configurations/conf-1, the kernel and fdt that are
 310 pointed to by the configuration (/images/kernel-1, /images/kernel-1/hash-1,
 311 /images/fdt-1, /images/fdt-1/hash-1) and the root structure of the image
 312 (so that it isn't possible to add or remove root nodes). The signature is
 313 written into /configurations/conf-1/signature-1/value. It can easily be
 314 verified later even if the FIT has been signed with other keys in the
 315 meantime.
 316
 317
 318 Verification
 319 ------------
 320 FITs are verified when loaded. After the configuration is selected a list
 321 of required images is produced. If there are 'required' public keys, then
 322 each image must be verified against those keys. This means that every image
 323 that might be used by the target needs to be signed with 'required' keys.
 324
 325 This happens automatically as part of a bootm command when FITs are used.
 326
 327
 328 Enabling FIT Verification
 329 -------------------------
 330 In addition to the options to enable FIT itself, the following CONFIGs must
 331 be enabled:
 332
 333 CONFIG_FIT_SIGNATURE - enable signing and verification in FITs
 334 CONFIG_RSA - enable RSA algorithm for signing
 335
 336 WARNING: When relying on signed FIT images with required signature check
 337 the legacy image format is default disabled by not defining
 338 CONFIG_LEGACY_IMAGE_FORMAT
 339
 340 Testing
 341 -------
 342 An easy way to test signing and verification is to use the test script
 343 provided in test/vboot/vboot_test.sh. This uses sandbox (a special version
 344 of U-Boot which runs under Linux) to show the operation of a 'bootm'
 345 command loading and verifying images.
 346
 347 A sample run is show below:
 348
 349 $ make O=sandbox sandbox_config
 350 $ make O=sandbox
 351 $ O=sandbox ./test/vboot/vboot_test.sh
 352 Simple Verified Boot Test
 353 =========================
 354
 355 Please see doc/uImage.FIT/verified-boot.txt for more information
 356
 357 /home/hs/ids/u-boot/sandbox/tools/mkimage -D -I dts -O dtb -p 2000
 358 Build keys
 359 do sha1 test
 360 Build FIT with signed images
 361 Test Verified Boot Run: unsigned signatures:: OK
 362 Sign images
 363 Test Verified Boot Run: signed images: OK
 364 Build FIT with signed configuration
 365 Test Verified Boot Run: unsigned config: OK
 366 Sign images
 367 Test Verified Boot Run: signed config: OK
 368 check signed config on the host
 369 Signature check OK
 370 OK
 371 Test Verified Boot Run: signed config: OK
 372 Test Verified Boot Run: signed config with bad hash: OK
 373 do sha256 test
 374 Build FIT with signed images
 375 Test Verified Boot Run: unsigned signatures:: OK
 376 Sign images
 377 Test Verified Boot Run: signed images: OK
 378 Build FIT with signed configuration
 379 Test Verified Boot Run: unsigned config: OK
 380 Sign images
 381 Test Verified Boot Run: signed config: OK
 382 check signed config on the host
 383 Signature check OK
 384 OK
 385 Test Verified Boot Run: signed config: OK
 386 Test Verified Boot Run: signed config with bad hash: OK
 387
 388 Test passed
 389
 390
 391 Hardware Signing with PKCS#11 or with HSM
 392 -----------------------------------------
 393
 394 Securely managing private signing keys can challenging, especially when the
 395 keys are stored on the file system of a computer that is connected to the
 396 Internet. If an attacker is able to steal the key, they can sign malicious FIT
 397 images which will appear genuine to your devices.
 398
 399 An alternative solution is to keep your signing key securely stored on hardware
 400 device like a smartcard, USB token or Hardware Security Module (HSM) and have
 401 them perform the signing. PKCS#11 is standard for interfacing with these crypto
 402 device.
 403
 404 Requirements:
 405 Smartcard/USB token/HSM which can work with some openssl engine
 406 openssl
 407
 408 For pkcs11 engine usage:
 409 libp11 (provides pkcs11 engine)
 410 p11-kit (recommended to simplify setup)
 411 opensc (for smartcards and smartcard like USB devices)
 412 gnutls (recommended for key generation, p11tool)
 413
 414 For generic HSMs respective openssl engine must be installed and locateable by
 415 openssl. This may require setting up LD_LIBRARY_PATH if engine is not installed
 416 to openssl's default search paths.
 417
 418 PKCS11 engine support forms "key id" based on "keydir" and with
 419 "key-name-hint". "key-name-hint" is used as "object" name and "keydir" if
 420 defined is used to define (prefix for) which PKCS11 source is being used for
 421 lookup up for the key.
 422
 423 PKCS11 engine key ids:
 424    "pkcs11:<keydir>;object=<key-name-hint>;type=<public|private>"
 425 or
 426    "pkcs11:object=<key-name-hint>;type=<public|private>",
 427
 428 Generic HSM engine support forms "key id" based on "keydir" and with
 429 "key-name-hint". If "keydir" is specified for mkimage it is used as a prefix in
 430 "key id" and is appended with "key-name-hint".
 431
 432 Generic engine key ids:
 433   "<keydir><key-name-hint>"
 434 or
 435   "<key-name-hint>"
 436
 437 As mkimage does not at this time support prompting for passwords HSM may need
 438 key preloading wrapper to be used when invoking mkimage.
 439
 440 The following examples use the Nitrokey Pro using pkcs11 engine. Instructions
 441 for other devices may vary.
 442
 443 Notes on pkcs11 engine setup:
 444
 445 Make sure p11-kit, opensc are installed and that p11-kit is setup to use opensc.
 446 /usr/share/p11-kit/modules/opensc.module should be present on your system.
 447
 448
 449 Generating Keys On the Nitrokey:
 450
 451 $ gpg --card-edit
 452
 453 Reader ...........: Nitrokey Nitrokey Pro (xxxxxxxx0000000000000000) 00 00
 454 Application ID ...: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 455 Version ..........: 2.1
 456 Manufacturer .....: ZeitControl
 457 Serial number ....: xxxxxxxx
 458 Name of cardholder: [not set]
 459 Language prefs ...: de
 460 Sex ..............: unspecified
 461 URL of public key : [not set]
 462 Login data .......: [not set]
 463 Signature PIN ....: forced
 464 Key attributes ...: rsa2048 rsa2048 rsa2048
 465 Max. PIN lengths .: 32 32 32
 466 PIN retry counter : 3 0 3
 467 Signature counter : 0
 468 Signature key ....: [none]
 469 Encryption key....: [none]
 470 Authentication key: [none]
 471 General key info..: [none]
 472
 473 gpg/card> generate
 474 Make off-card backup of encryption key? (Y/n) n
 475
 476 Please note that the factory settings of the PINs are
 477   PIN = '123456' Admin PIN = '12345678'
 478 You should change them using the command --change-pin
 479
 480 What keysize do you want for the Signature key? (2048) 4096
 481 The card will now be re-configured to generate a key of 4096 bits
 482 Note: There is no guarantee that the card supports the requested size.
 483   If the key generation does not succeed, please check the
 484   documentation of your card to see what sizes are allowed.
 485 What keysize do you want for the Encryption key? (2048) 4096
 486 The card will now be re-configured to generate a key of 4096 bits
 487 What keysize do you want for the Authentication key? (2048) 4096
 488 The card will now be re-configured to generate a key of 4096 bits
 489 Please specify how long the key should be valid.
 490   0 = key does not expire
 491   <n> = key expires in n days
 492   <n>w = key expires in n weeks
 493   <n>m = key expires in n months
 494   <n>y = key expires in n years
 495 Key is valid for? (0)
 496 Key does not expire at all
 497 Is this correct? (y/N) y
 498
 499 GnuPG needs to construct a user ID to identify your key.
 500
 501 Real name: John Doe
 502 Email address: john.doe@email.com
 503 Comment:
 504 You selected this USER-ID:
 505   "John Doe <john.doe@email.com>"
 506
 507 Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? o
 508
 509
 510 Using p11tool to get the token URL:
 511
 512 Depending on system configuration, gpg-agent may need to be killed first.
 513
 514 $ p11tool --provider /usr/lib/opensc-pkcs11.so --list-tokens
 515 Token 0:
 516 URL: pkcs11:model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%20%28sig%29%29
 517 Label: OpenPGP card (User PIN (sig))
 518 Type: Hardware token
 519 Manufacturer: ZeitControl
 520 Model: PKCS#15 emulated
 521 Serial: 000xxxxxxxxx
 522 Module: (null)
 523
 524
 525 Token 1:
 526 URL: pkcs11:model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%29
 527 Label: OpenPGP card (User PIN)
 528 Type: Hardware token
 529 Manufacturer: ZeitControl
 530 Model: PKCS#15 emulated
 531 Serial: 000xxxxxxxxx
 532 Module: (null)
 533
 534 Use the portion of the signature token URL after "pkcs11:" as the keydir argument (-k) to mkimage below.
 535
 536
 537 Use the URL of the token to list the private keys:
 538
 539 $ p11tool --login --provider /usr/lib/opensc-pkcs11.so --list-privkeys \
 540 "pkcs11:model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%20%28sig%29%29"
 541 Token '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
 542 Enter PIN:
 543 Object 0:
 544 URL: 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
 545 Type: Private key
 546 Label: Signature key
 547 Flags: CKA_PRIVATE; CKA_NEVER_EXTRACTABLE; CKA_SENSITIVE;
 548 ID: 01
 549
 550 Use the label, in this case "Signature key" as the key-name-hint in your FIT.
 551
 552 Create the fitImage:
 553 $ ./tools/mkimage -f fit-image.its fitImage
 554
 555
 556 Sign the fitImage with the hardware key:
 557
 558 $ ./tools/mkimage -F -k \
 559 "model=PKCS%2315%20emulated;manufacturer=ZeitControl;serial=000xxxxxxxxx;token=OpenPGP%20card%20%28User%20PIN%20%28sig%29%29" \
 560 -K u-boot.dtb -N pkcs11 -r fitImage
 561
 562
 563 Future Work
 564 -----------
 565 - Roll-back protection using a TPM is done using the tpm command. This can
 566 be scripted, but we might consider a default way of doing this, built into
 567 bootm.
 568
 569
 570 Possible Future Work
 571 --------------------
 572 - Add support for other RSA/SHA variants, such as rsa4096,sha512.
 573 - Other algorithms besides RSA
 574 - More sandbox tests for failure modes
 575 - Passwords for keys/certificates
 576 - Perhaps implement OAEP
 577 - Enhance bootm to permit scripted signature verification (so that a script
 578 can verify an image but not actually boot it)
 579
 580
 581 Simon Glass
 582 sjg@chromium.org
 583 1-1-13