sign-file.c 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. /* Sign a module file using the given key.
  2. *
  3. * Copyright © 2014-2016 Red Hat, Inc. All Rights Reserved.
  4. * Copyright © 2015 Intel Corporation.
  5. * Copyright © 2016 Hewlett Packard Enterprise Development LP
  6. *
  7. * Authors: David Howells <[email protected]>
  8. * David Woodhouse <[email protected]>
  9. * Juerg Haefliger <[email protected]>
  10. *
  11. * This program is free software; you can redistribute it and/or
  12. * 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.
  15. */
  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>
  25. #include <openssl/opensslv.h>
  26. #include <openssl/bio.h>
  27. #include <openssl/evp.h>
  28. #include <openssl/pem.h>
  29. #include <openssl/err.h>
  30. #include <openssl/engine.h>
  31. /*
  32. * OpenSSL 3.0 deprecates the OpenSSL's ENGINE API.
  33. *
  34. * Remove this if/when that API is no longer used
  35. */
  36. #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
  37. /*
  38. * Use CMS if we have openssl-1.0.0 or newer available - otherwise we have to
  39. * assume that it's not available and its header file is missing and that we
  40. * should use PKCS#7 instead. Switching to the older PKCS#7 format restricts
  41. * the options we have on specifying the X.509 certificate we want.
  42. *
  43. * Further, older versions of OpenSSL don't support manually adding signers to
  44. * the PKCS#7 message so have to accept that we get a certificate included in
  45. * the signature message. Nor do such older versions of OpenSSL support
  46. * signing with anything other than SHA1 - so we're stuck with that if such is
  47. * the case.
  48. */
  49. #if defined(LIBRESSL_VERSION_NUMBER) || \
  50. OPENSSL_VERSION_NUMBER < 0x10000000L || \
  51. defined(OPENSSL_NO_CMS)
  52. #define USE_PKCS7
  53. #endif
  54. #ifndef USE_PKCS7
  55. #include <openssl/cms.h>
  56. #else
  57. #include <openssl/pkcs7.h>
  58. #endif
  59. struct module_signature {
  60. uint8_t algo; /* Public-key crypto algorithm [0] */
  61. uint8_t hash; /* Digest algorithm [0] */
  62. uint8_t id_type; /* Key identifier type [PKEY_ID_PKCS7] */
  63. uint8_t signer_len; /* Length of signer's name [0] */
  64. uint8_t key_id_len; /* Length of key identifier [0] */
  65. uint8_t __pad[3];
  66. uint32_t sig_len; /* Length of signature data */
  67. };
  68. #define PKEY_ID_PKCS7 2
  69. static char magic_number[] = "~Module signature appended~\n";
  70. static __attribute__((noreturn))
  71. void format(void)
  72. {
  73. fprintf(stderr,
  74. "Usage: scripts/sign-file [-dp] <hash algo> <key> <x509> <module> [<dest>]\n");
  75. fprintf(stderr,
  76. " scripts/sign-file -s <raw sig> <hash algo> <x509> <module> [<dest>]\n");
  77. exit(2);
  78. }
  79. static void display_openssl_errors(int l)
  80. {
  81. const char *file;
  82. char buf[120];
  83. int e, line;
  84. if (ERR_peek_error() == 0)
  85. return;
  86. fprintf(stderr, "At main.c:%d:\n", l);
  87. while ((e = ERR_get_error_line(&file, &line))) {
  88. ERR_error_string(e, buf);
  89. fprintf(stderr, "- SSL %s: %s:%d\n", buf, file, line);
  90. }
  91. }
  92. static void drain_openssl_errors(void)
  93. {
  94. const char *file;
  95. int line;
  96. if (ERR_peek_error() == 0)
  97. return;
  98. while (ERR_get_error_line(&file, &line)) {}
  99. }
  100. #define ERR(cond, fmt, ...) \
  101. do { \
  102. bool __cond = (cond); \
  103. display_openssl_errors(__LINE__); \
  104. if (__cond) { \
  105. err(1, fmt, ## __VA_ARGS__); \
  106. } \
  107. } while(0)
  108. static const char *key_pass;
  109. static int pem_pw_cb(char *buf, int len, int w, void *v)
  110. {
  111. int pwlen;
  112. if (!key_pass)
  113. return -1;
  114. pwlen = strlen(key_pass);
  115. if (pwlen >= len)
  116. return -1;
  117. strcpy(buf, key_pass);
  118. /* If it's wrong, don't keep trying it. */
  119. key_pass = NULL;
  120. return pwlen;
  121. }
  122. static EVP_PKEY *read_private_key(const char *private_key_name)
  123. {
  124. EVP_PKEY *private_key;
  125. if (!strncmp(private_key_name, "pkcs11:", 7)) {
  126. ENGINE *e;
  127. ENGINE_load_builtin_engines();
  128. drain_openssl_errors();
  129. e = ENGINE_by_id("pkcs11");
  130. ERR(!e, "Load PKCS#11 ENGINE");
  131. if (ENGINE_init(e))
  132. drain_openssl_errors();
  133. else
  134. ERR(1, "ENGINE_init");
  135. if (key_pass)
  136. ERR(!ENGINE_ctrl_cmd_string(e, "PIN", key_pass, 0),
  137. "Set PKCS#11 PIN");
  138. private_key = ENGINE_load_private_key(e, private_key_name,
  139. NULL, NULL);
  140. ERR(!private_key, "%s", private_key_name);
  141. } else {
  142. BIO *b;
  143. b = BIO_new_file(private_key_name, "rb");
  144. ERR(!b, "%s", private_key_name);
  145. private_key = PEM_read_bio_PrivateKey(b, NULL, pem_pw_cb,
  146. NULL);
  147. ERR(!private_key, "%s", private_key_name);
  148. BIO_free(b);
  149. }
  150. return private_key;
  151. }
  152. static X509 *read_x509(const char *x509_name)
  153. {
  154. unsigned char buf[2];
  155. X509 *x509;
  156. BIO *b;
  157. int n;
  158. b = BIO_new_file(x509_name, "rb");
  159. ERR(!b, "%s", x509_name);
  160. /* Look at the first two bytes of the file to determine the encoding */
  161. n = BIO_read(b, buf, 2);
  162. if (n != 2) {
  163. if (BIO_should_retry(b)) {
  164. fprintf(stderr, "%s: Read wanted retry\n", x509_name);
  165. exit(1);
  166. }
  167. if (n >= 0) {
  168. fprintf(stderr, "%s: Short read\n", x509_name);
  169. exit(1);
  170. }
  171. ERR(1, "%s", x509_name);
  172. }
  173. ERR(BIO_reset(b) != 0, "%s", x509_name);
  174. if (buf[0] == 0x30 && buf[1] >= 0x81 && buf[1] <= 0x84)
  175. /* Assume raw DER encoded X.509 */
  176. x509 = d2i_X509_bio(b, NULL);
  177. else
  178. /* Assume PEM encoded X.509 */
  179. x509 = PEM_read_bio_X509(b, NULL, NULL, NULL);
  180. BIO_free(b);
  181. ERR(!x509, "%s", x509_name);
  182. return x509;
  183. }
  184. int main(int argc, char **argv)
  185. {
  186. struct module_signature sig_info = { .id_type = PKEY_ID_PKCS7 };
  187. char *hash_algo = NULL;
  188. char *private_key_name = NULL, *raw_sig_name = NULL;
  189. char *x509_name, *module_name, *dest_name;
  190. bool save_sig = false, replace_orig;
  191. bool sign_only = false;
  192. bool raw_sig = false;
  193. unsigned char buf[4096];
  194. unsigned long module_size, sig_size;
  195. unsigned int use_signed_attrs;
  196. const EVP_MD *digest_algo;
  197. EVP_PKEY *private_key;
  198. #ifndef USE_PKCS7
  199. CMS_ContentInfo *cms = NULL;
  200. unsigned int use_keyid = 0;
  201. #else
  202. PKCS7 *pkcs7 = NULL;
  203. #endif
  204. X509 *x509;
  205. BIO *bd, *bm;
  206. int opt, n;
  207. OpenSSL_add_all_algorithms();
  208. ERR_load_crypto_strings();
  209. ERR_clear_error();
  210. key_pass = getenv("KBUILD_SIGN_PIN");
  211. #ifndef USE_PKCS7
  212. use_signed_attrs = CMS_NOATTR;
  213. #else
  214. use_signed_attrs = PKCS7_NOATTR;
  215. #endif
  216. do {
  217. opt = getopt(argc, argv, "sdpk");
  218. switch (opt) {
  219. case 's': raw_sig = true; break;
  220. case 'p': save_sig = true; break;
  221. case 'd': sign_only = true; save_sig = true; break;
  222. #ifndef USE_PKCS7
  223. case 'k': use_keyid = CMS_USE_KEYID; break;
  224. #endif
  225. case -1: break;
  226. default: format();
  227. }
  228. } while (opt != -1);
  229. argc -= optind;
  230. argv += optind;
  231. if (argc < 4 || argc > 5)
  232. format();
  233. if (raw_sig) {
  234. raw_sig_name = argv[0];
  235. hash_algo = argv[1];
  236. } else {
  237. hash_algo = argv[0];
  238. private_key_name = argv[1];
  239. }
  240. x509_name = argv[2];
  241. module_name = argv[3];
  242. if (argc == 5 && strcmp(argv[3], argv[4]) != 0) {
  243. dest_name = argv[4];
  244. replace_orig = false;
  245. } else {
  246. ERR(asprintf(&dest_name, "%s.~signed~", module_name) < 0,
  247. "asprintf");
  248. replace_orig = true;
  249. }
  250. #ifdef USE_PKCS7
  251. if (strcmp(hash_algo, "sha1") != 0) {
  252. fprintf(stderr, "sign-file: %s only supports SHA1 signing\n",
  253. OPENSSL_VERSION_TEXT);
  254. exit(3);
  255. }
  256. #endif
  257. /* Open the module file */
  258. bm = BIO_new_file(module_name, "rb");
  259. ERR(!bm, "%s", module_name);
  260. if (!raw_sig) {
  261. /* Read the private key and the X.509 cert the PKCS#7 message
  262. * will point to.
  263. */
  264. private_key = read_private_key(private_key_name);
  265. x509 = read_x509(x509_name);
  266. /* Digest the module data. */
  267. OpenSSL_add_all_digests();
  268. display_openssl_errors(__LINE__);
  269. digest_algo = EVP_get_digestbyname(hash_algo);
  270. ERR(!digest_algo, "EVP_get_digestbyname");
  271. #ifndef USE_PKCS7
  272. /* Load the signature message from the digest buffer. */
  273. cms = CMS_sign(NULL, NULL, NULL, NULL,
  274. CMS_NOCERTS | CMS_PARTIAL | CMS_BINARY |
  275. CMS_DETACHED | CMS_STREAM);
  276. ERR(!cms, "CMS_sign");
  277. ERR(!CMS_add1_signer(cms, x509, private_key, digest_algo,
  278. CMS_NOCERTS | CMS_BINARY |
  279. CMS_NOSMIMECAP | use_keyid |
  280. use_signed_attrs),
  281. "CMS_add1_signer");
  282. ERR(CMS_final(cms, bm, NULL, CMS_NOCERTS | CMS_BINARY) < 0,
  283. "CMS_final");
  284. #else
  285. pkcs7 = PKCS7_sign(x509, private_key, NULL, bm,
  286. PKCS7_NOCERTS | PKCS7_BINARY |
  287. PKCS7_DETACHED | use_signed_attrs);
  288. ERR(!pkcs7, "PKCS7_sign");
  289. #endif
  290. if (save_sig) {
  291. char *sig_file_name;
  292. BIO *b;
  293. ERR(asprintf(&sig_file_name, "%s.p7s", module_name) < 0,
  294. "asprintf");
  295. b = BIO_new_file(sig_file_name, "wb");
  296. ERR(!b, "%s", sig_file_name);
  297. #ifndef USE_PKCS7
  298. ERR(i2d_CMS_bio_stream(b, cms, NULL, 0) < 0,
  299. "%s", sig_file_name);
  300. #else
  301. ERR(i2d_PKCS7_bio(b, pkcs7) < 0,
  302. "%s", sig_file_name);
  303. #endif
  304. BIO_free(b);
  305. }
  306. if (sign_only) {
  307. BIO_free(bm);
  308. return 0;
  309. }
  310. }
  311. /* Open the destination file now so that we can shovel the module data
  312. * across as we read it.
  313. */
  314. bd = BIO_new_file(dest_name, "wb");
  315. ERR(!bd, "%s", dest_name);
  316. /* Append the marker and the PKCS#7 message to the destination file */
  317. ERR(BIO_reset(bm) < 0, "%s", module_name);
  318. while ((n = BIO_read(bm, buf, sizeof(buf))),
  319. n > 0) {
  320. ERR(BIO_write(bd, buf, n) < 0, "%s", dest_name);
  321. }
  322. BIO_free(bm);
  323. ERR(n < 0, "%s", module_name);
  324. module_size = BIO_number_written(bd);
  325. if (!raw_sig) {
  326. #ifndef USE_PKCS7
  327. ERR(i2d_CMS_bio_stream(bd, cms, NULL, 0) < 0, "%s", dest_name);
  328. #else
  329. ERR(i2d_PKCS7_bio(bd, pkcs7) < 0, "%s", dest_name);
  330. #endif
  331. } else {
  332. BIO *b;
  333. /* Read the raw signature file and write the data to the
  334. * destination file
  335. */
  336. b = BIO_new_file(raw_sig_name, "rb");
  337. ERR(!b, "%s", raw_sig_name);
  338. while ((n = BIO_read(b, buf, sizeof(buf))), n > 0)
  339. ERR(BIO_write(bd, buf, n) < 0, "%s", dest_name);
  340. BIO_free(b);
  341. }
  342. sig_size = BIO_number_written(bd) - module_size;
  343. sig_info.sig_len = htonl(sig_size);
  344. ERR(BIO_write(bd, &sig_info, sizeof(sig_info)) < 0, "%s", dest_name);
  345. ERR(BIO_write(bd, magic_number, sizeof(magic_number) - 1) < 0, "%s", dest_name);
  346. ERR(BIO_free(bd) < 0, "%s", dest_name);
  347. /* Finally, if we're signing in place, replace the original. */
  348. if (replace_orig)
  349. ERR(rename(dest_name, module_name) < 0, "%s", dest_name);
  350. return 0;
  351. }