blob: fa3fa59db666978c72356384b89f98fc78e24c88 [file] [log] [blame]
David Howellsbc1c3732015-07-20 21:16:27 +01001/* Sign a module file using the given key.
2 *
David Howells9552c7a2016-06-14 13:18:33 +01003 * Copyright © 2014-2016 Red Hat, Inc. All Rights Reserved.
David Woodhouse09a77a82015-09-15 16:03:36 +01004 * Copyright © 2015 Intel Corporation.
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +01005 * Copyright © 2016 Hewlett Packard Enterprise Development LP
David Woodhouse09a77a82015-09-15 16:03:36 +01006 *
7 * Authors: David Howells <dhowells@redhat.com>
8 * David Woodhouse <dwmw2@infradead.org>
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +01009 * Juerg Haefliger <juerg.haefliger@hpe.com>
David Howellsbc1c3732015-07-20 21:16:27 +010010 *
11 * This program is free software; you can redistribute it and/or
David Woodhouse09a77a82015-09-15 16:03:36 +010012 * modify it under the terms of the GNU Lesser General Public License
13 * as published by the Free Software Foundation; either version 2.1
14 * of the licence, or (at your option) any later version.
David Howellsbc1c3732015-07-20 21:16:27 +010015 */
16#define _GNU_SOURCE
17#include <stdio.h>
18#include <stdlib.h>
19#include <stdint.h>
20#include <stdbool.h>
21#include <string.h>
22#include <getopt.h>
23#include <err.h>
24#include <arpa/inet.h>
David Howells283e8ba2015-09-25 16:31:46 +010025#include <openssl/opensslv.h>
David Howellsbc1c3732015-07-20 21:16:27 +010026#include <openssl/bio.h>
27#include <openssl/evp.h>
28#include <openssl/pem.h>
David Howellsbc1c3732015-07-20 21:16:27 +010029#include <openssl/err.h>
David Woodhouse6e3e2812015-07-20 21:16:29 +010030#include <openssl/engine.h>
David Howellsbc1c3732015-07-20 21:16:27 +010031
David Howells283e8ba2015-09-25 16:31:46 +010032/*
33 * Use CMS if we have openssl-1.0.0 or newer available - otherwise we have to
34 * assume that it's not available and its header file is missing and that we
35 * should use PKCS#7 instead. Switching to the older PKCS#7 format restricts
36 * the options we have on specifying the X.509 certificate we want.
37 *
38 * Further, older versions of OpenSSL don't support manually adding signers to
39 * the PKCS#7 message so have to accept that we get a certificate included in
40 * the signature message. Nor do such older versions of OpenSSL support
41 * signing with anything other than SHA1 - so we're stuck with that if such is
42 * the case.
43 */
Felix Fietkauf8688012017-02-09 17:17:45 +000044#if defined(LIBRESSL_VERSION_NUMBER) || \
45 OPENSSL_VERSION_NUMBER < 0x10000000L || \
46 defined(OPENSSL_NO_CMS)
David Howells283e8ba2015-09-25 16:31:46 +010047#define USE_PKCS7
48#endif
49#ifndef USE_PKCS7
50#include <openssl/cms.h>
51#else
52#include <openssl/pkcs7.h>
53#endif
54
David Howellsbc1c3732015-07-20 21:16:27 +010055struct module_signature {
56 uint8_t algo; /* Public-key crypto algorithm [0] */
57 uint8_t hash; /* Digest algorithm [0] */
58 uint8_t id_type; /* Key identifier type [PKEY_ID_PKCS7] */
59 uint8_t signer_len; /* Length of signer's name [0] */
60 uint8_t key_id_len; /* Length of key identifier [0] */
61 uint8_t __pad[3];
62 uint32_t sig_len; /* Length of signature data */
63};
64
65#define PKEY_ID_PKCS7 2
66
67static char magic_number[] = "~Module signature appended~\n";
68
69static __attribute__((noreturn))
70void format(void)
71{
72 fprintf(stderr,
73 "Usage: scripts/sign-file [-dp] <hash algo> <key> <x509> <module> [<dest>]\n");
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +010074 fprintf(stderr,
75 " scripts/sign-file -s <raw sig> <hash algo> <x509> <module> [<dest>]\n");
David Howellsbc1c3732015-07-20 21:16:27 +010076 exit(2);
77}
78
79static void display_openssl_errors(int l)
80{
81 const char *file;
82 char buf[120];
83 int e, line;
84
85 if (ERR_peek_error() == 0)
86 return;
87 fprintf(stderr, "At main.c:%d:\n", l);
88
89 while ((e = ERR_get_error_line(&file, &line))) {
90 ERR_error_string(e, buf);
91 fprintf(stderr, "- SSL %s: %s:%d\n", buf, file, line);
92 }
93}
94
95static void drain_openssl_errors(void)
96{
97 const char *file;
98 int line;
99
100 if (ERR_peek_error() == 0)
101 return;
102 while (ERR_get_error_line(&file, &line)) {}
103}
104
105#define ERR(cond, fmt, ...) \
106 do { \
107 bool __cond = (cond); \
108 display_openssl_errors(__LINE__); \
109 if (__cond) { \
110 err(1, fmt, ## __VA_ARGS__); \
111 } \
112 } while(0)
113
David Woodhouseaf1eb292015-07-20 21:16:28 +0100114static const char *key_pass;
115
116static int pem_pw_cb(char *buf, int len, int w, void *v)
117{
118 int pwlen;
119
120 if (!key_pass)
121 return -1;
122
123 pwlen = strlen(key_pass);
124 if (pwlen >= len)
125 return -1;
126
127 strcpy(buf, key_pass);
128
129 /* If it's wrong, don't keep trying it. */
130 key_pass = NULL;
131
132 return pwlen;
133}
134
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100135static EVP_PKEY *read_private_key(const char *private_key_name)
136{
137 EVP_PKEY *private_key;
Lee Jonese9d39632021-10-05 14:33:06 +0100138 BIO *b;
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100139
Lee Jonese9d39632021-10-05 14:33:06 +0100140#ifndef OPENSSL_NO_ENGINE
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100141 if (!strncmp(private_key_name, "pkcs11:", 7)) {
142 ENGINE *e;
143
144 ENGINE_load_builtin_engines();
145 drain_openssl_errors();
146 e = ENGINE_by_id("pkcs11");
147 ERR(!e, "Load PKCS#11 ENGINE");
148 if (ENGINE_init(e))
149 drain_openssl_errors();
150 else
151 ERR(1, "ENGINE_init");
152 if (key_pass)
153 ERR(!ENGINE_ctrl_cmd_string(e, "PIN", key_pass, 0),
154 "Set PKCS#11 PIN");
155 private_key = ENGINE_load_private_key(e, private_key_name,
156 NULL, NULL);
157 ERR(!private_key, "%s", private_key_name);
Lee Jonese9d39632021-10-05 14:33:06 +0100158 return private_key;
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100159 }
Lee Jonese9d39632021-10-05 14:33:06 +0100160#endif
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100161
Lee Jonese9d39632021-10-05 14:33:06 +0100162 b = BIO_new_file(private_key_name, "rb");
163 ERR(!b, "%s", private_key_name);
164 private_key = PEM_read_bio_PrivateKey(b, NULL, pem_pw_cb,
165 NULL);
166 ERR(!private_key, "%s", private_key_name);
167 BIO_free(b);
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100168 return private_key;
169}
170
171static X509 *read_x509(const char *x509_name)
172{
David Howells9552c7a2016-06-14 13:18:33 +0100173 unsigned char buf[2];
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100174 X509 *x509;
175 BIO *b;
David Howells9552c7a2016-06-14 13:18:33 +0100176 int n;
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100177
178 b = BIO_new_file(x509_name, "rb");
179 ERR(!b, "%s", x509_name);
David Howells9552c7a2016-06-14 13:18:33 +0100180
181 /* Look at the first two bytes of the file to determine the encoding */
182 n = BIO_read(b, buf, 2);
183 if (n != 2) {
184 if (BIO_should_retry(b)) {
185 fprintf(stderr, "%s: Read wanted retry\n", x509_name);
186 exit(1);
187 }
188 if (n >= 0) {
189 fprintf(stderr, "%s: Short read\n", x509_name);
190 exit(1);
191 }
192 ERR(1, "%s", x509_name);
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100193 }
David Howells9552c7a2016-06-14 13:18:33 +0100194
195 ERR(BIO_reset(b) != 0, "%s", x509_name);
196
197 if (buf[0] == 0x30 && buf[1] >= 0x81 && buf[1] <= 0x84)
198 /* Assume raw DER encoded X.509 */
199 x509 = d2i_X509_bio(b, NULL);
200 else
201 /* Assume PEM encoded X.509 */
202 x509 = PEM_read_bio_X509(b, NULL, NULL, NULL);
203
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100204 BIO_free(b);
205 ERR(!x509, "%s", x509_name);
206
207 return x509;
208}
209
David Howellsbc1c3732015-07-20 21:16:27 +0100210int main(int argc, char **argv)
211{
212 struct module_signature sig_info = { .id_type = PKEY_ID_PKCS7 };
213 char *hash_algo = NULL;
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100214 char *private_key_name = NULL, *raw_sig_name = NULL;
215 char *x509_name, *module_name, *dest_name;
David Howells283e8ba2015-09-25 16:31:46 +0100216 bool save_sig = false, replace_orig;
Luis R. Rodriguez23dfbba2015-07-20 21:16:27 +0100217 bool sign_only = false;
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100218 bool raw_sig = false;
David Howellsbc1c3732015-07-20 21:16:27 +0100219 unsigned char buf[4096];
David Howells283e8ba2015-09-25 16:31:46 +0100220 unsigned long module_size, sig_size;
221 unsigned int use_signed_attrs;
David Howellsbc1c3732015-07-20 21:16:27 +0100222 const EVP_MD *digest_algo;
223 EVP_PKEY *private_key;
David Howells283e8ba2015-09-25 16:31:46 +0100224#ifndef USE_PKCS7
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100225 CMS_ContentInfo *cms = NULL;
David Howells283e8ba2015-09-25 16:31:46 +0100226 unsigned int use_keyid = 0;
227#else
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100228 PKCS7 *pkcs7 = NULL;
David Howells283e8ba2015-09-25 16:31:46 +0100229#endif
David Howellsbc1c3732015-07-20 21:16:27 +0100230 X509 *x509;
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100231 BIO *bd, *bm;
David Howellsbc1c3732015-07-20 21:16:27 +0100232 int opt, n;
David Woodhouseaf1eb292015-07-20 21:16:28 +0100233 OpenSSL_add_all_algorithms();
David Howellsbc1c3732015-07-20 21:16:27 +0100234 ERR_load_crypto_strings();
235 ERR_clear_error();
236
David Woodhouseaf1eb292015-07-20 21:16:28 +0100237 key_pass = getenv("KBUILD_SIGN_PIN");
238
David Howells283e8ba2015-09-25 16:31:46 +0100239#ifndef USE_PKCS7
240 use_signed_attrs = CMS_NOATTR;
241#else
242 use_signed_attrs = PKCS7_NOATTR;
243#endif
244
David Howellsbc1c3732015-07-20 21:16:27 +0100245 do {
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100246 opt = getopt(argc, argv, "sdpk");
David Howellsbc1c3732015-07-20 21:16:27 +0100247 switch (opt) {
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100248 case 's': raw_sig = true; break;
David Howells283e8ba2015-09-25 16:31:46 +0100249 case 'p': save_sig = true; break;
250 case 'd': sign_only = true; save_sig = true; break;
251#ifndef USE_PKCS7
David Howellsed8c2072015-07-20 21:16:33 +0100252 case 'k': use_keyid = CMS_USE_KEYID; break;
David Howells283e8ba2015-09-25 16:31:46 +0100253#endif
David Howellsbc1c3732015-07-20 21:16:27 +0100254 case -1: break;
255 default: format();
256 }
257 } while (opt != -1);
258
259 argc -= optind;
260 argv += optind;
261 if (argc < 4 || argc > 5)
262 format();
263
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100264 if (raw_sig) {
265 raw_sig_name = argv[0];
266 hash_algo = argv[1];
267 } else {
268 hash_algo = argv[0];
269 private_key_name = argv[1];
270 }
David Howellsbc1c3732015-07-20 21:16:27 +0100271 x509_name = argv[2];
272 module_name = argv[3];
Alex Yashchenkoefcae7c2016-12-13 09:26:25 +0000273 if (argc == 5 && strcmp(argv[3], argv[4]) != 0) {
David Howellsbc1c3732015-07-20 21:16:27 +0100274 dest_name = argv[4];
275 replace_orig = false;
276 } else {
277 ERR(asprintf(&dest_name, "%s.~signed~", module_name) < 0,
278 "asprintf");
279 replace_orig = true;
280 }
281
David Howells283e8ba2015-09-25 16:31:46 +0100282#ifdef USE_PKCS7
283 if (strcmp(hash_algo, "sha1") != 0) {
284 fprintf(stderr, "sign-file: %s only supports SHA1 signing\n",
285 OPENSSL_VERSION_TEXT);
286 exit(3);
287 }
288#endif
289
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100290 /* Open the module file */
291 bm = BIO_new_file(module_name, "rb");
292 ERR(!bm, "%s", module_name);
David Woodhouse6e3e2812015-07-20 21:16:29 +0100293
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100294 if (!raw_sig) {
295 /* Read the private key and the X.509 cert the PKCS#7 message
296 * will point to.
297 */
298 private_key = read_private_key(private_key_name);
299 x509 = read_x509(x509_name);
David Howellsbc1c3732015-07-20 21:16:27 +0100300
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100301 /* Digest the module data. */
302 OpenSSL_add_all_digests();
303 display_openssl_errors(__LINE__);
304 digest_algo = EVP_get_digestbyname(hash_algo);
305 ERR(!digest_algo, "EVP_get_digestbyname");
306
307#ifndef USE_PKCS7
308 /* Load the signature message from the digest buffer. */
309 cms = CMS_sign(NULL, NULL, NULL, NULL,
310 CMS_NOCERTS | CMS_PARTIAL | CMS_BINARY |
311 CMS_DETACHED | CMS_STREAM);
312 ERR(!cms, "CMS_sign");
313
314 ERR(!CMS_add1_signer(cms, x509, private_key, digest_algo,
315 CMS_NOCERTS | CMS_BINARY |
316 CMS_NOSMIMECAP | use_keyid |
317 use_signed_attrs),
318 "CMS_add1_signer");
319 ERR(CMS_final(cms, bm, NULL, CMS_NOCERTS | CMS_BINARY) < 0,
320 "CMS_final");
321
322#else
323 pkcs7 = PKCS7_sign(x509, private_key, NULL, bm,
324 PKCS7_NOCERTS | PKCS7_BINARY |
325 PKCS7_DETACHED | use_signed_attrs);
326 ERR(!pkcs7, "PKCS7_sign");
327#endif
328
329 if (save_sig) {
330 char *sig_file_name;
331 BIO *b;
332
333 ERR(asprintf(&sig_file_name, "%s.p7s", module_name) < 0,
334 "asprintf");
335 b = BIO_new_file(sig_file_name, "wb");
336 ERR(!b, "%s", sig_file_name);
337#ifndef USE_PKCS7
338 ERR(i2d_CMS_bio_stream(b, cms, NULL, 0) < 0,
339 "%s", sig_file_name);
340#else
341 ERR(i2d_PKCS7_bio(b, pkcs7) < 0,
342 "%s", sig_file_name);
343#endif
344 BIO_free(b);
345 }
346
347 if (sign_only) {
348 BIO_free(bm);
349 return 0;
350 }
David Howellsbc1c3732015-07-20 21:16:27 +0100351 }
David Howellsbc1c3732015-07-20 21:16:27 +0100352
353 /* Open the destination file now so that we can shovel the module data
354 * across as we read it.
355 */
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100356 bd = BIO_new_file(dest_name, "wb");
357 ERR(!bd, "%s", dest_name);
Luis R. Rodriguez23dfbba2015-07-20 21:16:27 +0100358
David Howellsbc1c3732015-07-20 21:16:27 +0100359 /* Append the marker and the PKCS#7 message to the destination file */
360 ERR(BIO_reset(bm) < 0, "%s", module_name);
361 while ((n = BIO_read(bm, buf, sizeof(buf))),
362 n > 0) {
363 ERR(BIO_write(bd, buf, n) < 0, "%s", dest_name);
364 }
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100365 BIO_free(bm);
David Howellsbc1c3732015-07-20 21:16:27 +0100366 ERR(n < 0, "%s", module_name);
367 module_size = BIO_number_written(bd);
368
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100369 if (!raw_sig) {
David Howells283e8ba2015-09-25 16:31:46 +0100370#ifndef USE_PKCS7
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100371 ERR(i2d_CMS_bio_stream(bd, cms, NULL, 0) < 0, "%s", dest_name);
David Howells283e8ba2015-09-25 16:31:46 +0100372#else
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100373 ERR(i2d_PKCS7_bio(bd, pkcs7) < 0, "%s", dest_name);
David Howells283e8ba2015-09-25 16:31:46 +0100374#endif
Juerg Haefligere5a2e3c2016-02-04 12:09:25 +0100375 } else {
376 BIO *b;
377
378 /* Read the raw signature file and write the data to the
379 * destination file
380 */
381 b = BIO_new_file(raw_sig_name, "rb");
382 ERR(!b, "%s", raw_sig_name);
383 while ((n = BIO_read(b, buf, sizeof(buf))), n > 0)
384 ERR(BIO_write(bd, buf, n) < 0, "%s", dest_name);
385 BIO_free(b);
386 }
387
David Howells283e8ba2015-09-25 16:31:46 +0100388 sig_size = BIO_number_written(bd) - module_size;
389 sig_info.sig_len = htonl(sig_size);
David Howellsbc1c3732015-07-20 21:16:27 +0100390 ERR(BIO_write(bd, &sig_info, sizeof(sig_info)) < 0, "%s", dest_name);
391 ERR(BIO_write(bd, magic_number, sizeof(magic_number) - 1) < 0, "%s", dest_name);
392
393 ERR(BIO_free(bd) < 0, "%s", dest_name);
394
395 /* Finally, if we're signing in place, replace the original. */
396 if (replace_orig)
397 ERR(rename(dest_name, module_name) < 0, "%s", dest_name);
398
399 return 0;
400}