blob: b2dd2b8e41f560f6d1fafd6abd6fb9d0f200529d [file] [log] [blame]
David Browne2acfae2020-01-21 16:45:01 -07001// Copyright (c) 2017-2019 Linaro LTD
2// Copyright (c) 2017-2019 JUUL Labs
Salome Thirot6fdbf552021-05-14 16:46:14 +01003// Copyright (c) 2019-2021 Arm Limited
David Browne2acfae2020-01-21 16:45:01 -07004//
5// SPDX-License-Identifier: Apache-2.0
6
7//! Interface wrappers to C API entering to the bootloader
David Brownde7729e2017-01-09 10:41:35 -07008
David Brown65de6d12019-01-02 11:38:38 -07009use crate::area::AreaDesc;
David Brown76101572019-02-28 11:29:03 -070010use simflash::SimMultiFlash;
David Brown65de6d12019-01-02 11:38:38 -070011use crate::api;
David Brownde7729e2017-01-09 10:41:35 -070012
David Brownc423ac42021-06-04 13:47:34 -060013/// The result of an invocation of `boot_go`. This is intentionally opaque so that we can provide
14/// accessors for everything we need from this.
15#[derive(Debug)]
David Brown6d47d422021-06-04 14:41:33 -060016pub enum BootGoResult {
17 /// This run was stopped by the flash simulation mechanism.
18 Stopped,
19 /// The bootloader ran to completion with the following data.
20 Normal {
21 result: i32,
22 asserts: u8,
David Brownd82de8c2021-06-04 15:08:25 -060023
24 resp: api::BootRsp,
David Brown6d47d422021-06-04 14:41:33 -060025 },
David Brownc423ac42021-06-04 13:47:34 -060026}
27
28impl BootGoResult {
29 /// Was this run interrupted.
30 pub fn interrupted(&self) -> bool {
David Brown6d47d422021-06-04 14:41:33 -060031 matches!(self, BootGoResult::Stopped)
David Brownc423ac42021-06-04 13:47:34 -060032 }
33
34 /// Was this boot run successful (returned 0)
35 pub fn success(&self) -> bool {
David Brown6d47d422021-06-04 14:41:33 -060036 matches!(self, BootGoResult::Normal { result: 0, .. })
David Brownc423ac42021-06-04 13:47:34 -060037 }
38
39 /// Success, but also no asserts.
40 pub fn success_no_asserts(&self) -> bool {
David Brown6d47d422021-06-04 14:41:33 -060041 matches!(self, BootGoResult::Normal {
42 result: 0,
43 asserts: 0,
David Brownd82de8c2021-06-04 15:08:25 -060044 ..
David Brown6d47d422021-06-04 14:41:33 -060045 })
David Brownc423ac42021-06-04 13:47:34 -060046 }
47
David Brown6d47d422021-06-04 14:41:33 -060048 /// Get the asserts count. An interrupted run will be considered to have no asserts.
David Brownc423ac42021-06-04 13:47:34 -060049 pub fn asserts(&self) -> u8 {
David Brown6d47d422021-06-04 14:41:33 -060050 match self {
51 BootGoResult::Normal { asserts, .. } => *asserts,
52 _ => 0,
53 }
David Brownc423ac42021-06-04 13:47:34 -060054 }
David Brownd82de8c2021-06-04 15:08:25 -060055
56 /// Retrieve the 'resp' field that is filled in.
57 pub fn resp(&self) -> Option<&api::BootRsp> {
58 match self {
59 BootGoResult::Normal { resp, .. } => Some(resp),
60 _ => None,
61 }
62 }
David Brownc423ac42021-06-04 13:47:34 -060063}
64
David Brownde7729e2017-01-09 10:41:35 -070065/// Invoke the bootloader on this flash device.
David Brown76101572019-02-28 11:29:03 -070066pub fn boot_go(multiflash: &mut SimMultiFlash, areadesc: &AreaDesc,
Raef Coles3fd3ecc2021-10-15 11:14:12 +010067 counter: Option<&mut i32>, image_index: Option<i32>,
68 catch_asserts: bool) -> BootGoResult {
David Brown7cc45262021-03-10 05:13:44 -070069 for (&dev_id, flash) in multiflash.iter_mut() {
70 api::set_flash(dev_id, flash);
Fabio Utzig8000e322019-08-05 08:14:32 -030071 }
72 let mut sim_ctx = api::CSimContext {
73 flash_counter: match counter {
David Brownee61c832017-11-06 11:13:25 -070074 None => 0,
75 Some(ref c) => **c as libc::c_int
Fabio Utzig8000e322019-08-05 08:14:32 -030076 },
77 jumped: 0,
78 c_asserts: 0,
79 c_catch_asserts: if catch_asserts { 1 } else { 0 },
80 boot_jmpbuf: [0; 16],
81 };
David Brownd216b202021-06-04 10:14:33 -060082 let mut rsp = api::BootRsp {
83 br_hdr: std::ptr::null(),
84 flash_dev_id: 0,
85 image_off: 0,
86 };
Raef Coles3fd3ecc2021-10-15 11:14:12 +010087 let result: i32 = unsafe {
88 match image_index {
89 None => raw::invoke_boot_go(&mut sim_ctx as *mut _,
90 &areadesc.get_c() as *const _,
91 &mut rsp as *mut _, -1) as i32,
92 Some(i) => raw::invoke_boot_go(&mut sim_ctx as *mut _,
93 &areadesc.get_c() as *const _,
94 &mut rsp as *mut _,
95 i as i32) as i32
96 }
Fabio Utzig8000e322019-08-05 08:14:32 -030097 };
98 let asserts = sim_ctx.c_asserts;
David Brown8608c532021-03-10 05:18:11 -070099 if let Some(c) = counter {
100 *c = sim_ctx.flash_counter;
101 }
David Brown7cc45262021-03-10 05:13:44 -0700102 for &dev_id in multiflash.keys() {
103 api::clear_flash(dev_id);
104 }
David Brown6d47d422021-06-04 14:41:33 -0600105 if result == -0x13579 {
106 BootGoResult::Stopped
107 } else {
David Brownd82de8c2021-06-04 15:08:25 -0600108 BootGoResult::Normal { result, asserts, resp: rsp }
David Brown6d47d422021-06-04 14:41:33 -0600109 }
David Brownde7729e2017-01-09 10:41:35 -0700110}
111
Fabio Utzig3fbbdac2019-12-19 15:18:23 -0300112pub fn boot_trailer_sz(align: u32) -> u32 {
Christopher Collins2adef702019-05-22 14:37:31 -0700113 unsafe { raw::boot_trailer_sz(align) }
David Brownde7729e2017-01-09 10:41:35 -0700114}
115
Fabio Utzig3fbbdac2019-12-19 15:18:23 -0300116pub fn boot_status_sz(align: u32) -> u32 {
117 unsafe { raw::boot_status_sz(align) }
118}
119
Fabio Utziga0bc9b52017-06-28 09:19:55 -0300120pub fn boot_magic_sz() -> usize {
David Brown2b8a6952019-10-01 16:14:53 -0600121 unsafe { raw::boot_magic_sz() as usize }
Fabio Utziga0bc9b52017-06-28 09:19:55 -0300122}
123
124pub fn boot_max_align() -> usize {
David Browne0bb1f92019-10-01 15:57:01 -0600125 unsafe { raw::boot_max_align() as usize }
Fabio Utziga0bc9b52017-06-28 09:19:55 -0300126}
127
Fabio Utzig1e48b912018-09-18 09:04:18 -0300128pub fn rsa_oaep_encrypt(pubkey: &[u8], seckey: &[u8]) -> Result<[u8; 256], &'static str> {
129 unsafe {
130 let mut encbuf: [u8; 256] = [0; 256];
131 if raw::rsa_oaep_encrypt_(pubkey.as_ptr(), pubkey.len() as u32,
132 seckey.as_ptr(), seckey.len() as u32,
133 encbuf.as_mut_ptr()) == 0 {
134 return Ok(encbuf);
135 }
David Brownc20bbb22021-03-10 05:19:14 -0700136 Err("Failed to encrypt buffer")
Fabio Utzig1e48b912018-09-18 09:04:18 -0300137 }
138}
139
Salome Thirot6fdbf552021-05-14 16:46:14 +0100140pub fn kw_encrypt(kek: &[u8], seckey: &[u8], keylen: u32) -> Result<Vec<u8>, &'static str> {
Fabio Utzig1e48b912018-09-18 09:04:18 -0300141 unsafe {
Salome Thirot6fdbf552021-05-14 16:46:14 +0100142 let mut encbuf = vec![0u8; 24];
143 if keylen == 32 {
144 encbuf = vec![0u8; 40];
145 }
Fabio Utzig1e48b912018-09-18 09:04:18 -0300146 if raw::kw_encrypt_(kek.as_ptr(), seckey.as_ptr(), encbuf.as_mut_ptr()) == 0 {
147 return Ok(encbuf);
148 }
David Brownc20bbb22021-03-10 05:19:14 -0700149 Err("Failed to encrypt buffer")
Fabio Utzig1e48b912018-09-18 09:04:18 -0300150 }
151}
152
David Brownde7729e2017-01-09 10:41:35 -0700153mod raw {
David Brown65de6d12019-01-02 11:38:38 -0700154 use crate::area::CAreaDesc;
David Brownd216b202021-06-04 10:14:33 -0600155 use crate::api::{BootRsp, CSimContext};
David Brownde7729e2017-01-09 10:41:35 -0700156
157 extern "C" {
158 // This generates a warning about `CAreaDesc` not being foreign safe. There doesn't appear to
159 // be any way to get rid of this warning. See https://github.com/rust-lang/rust/issues/34798
160 // for information and tracking.
David Brownd216b202021-06-04 10:14:33 -0600161 pub fn invoke_boot_go(sim_ctx: *mut CSimContext, areadesc: *const CAreaDesc,
Raef Coles3fd3ecc2021-10-15 11:14:12 +0100162 rsp: *mut BootRsp, image_index: libc::c_int) -> libc::c_int;
David Brownde7729e2017-01-09 10:41:35 -0700163
Fabio Utzig3fbbdac2019-12-19 15:18:23 -0300164 pub fn boot_trailer_sz(min_write_sz: u32) -> u32;
165 pub fn boot_status_sz(min_write_sz: u32) -> u32;
Fabio Utziga0bc9b52017-06-28 09:19:55 -0300166
David Brown2b8a6952019-10-01 16:14:53 -0600167 pub fn boot_magic_sz() -> u32;
David Browne0bb1f92019-10-01 15:57:01 -0600168 pub fn boot_max_align() -> u32;
Fabio Utzig92be3fb2017-12-05 08:52:53 -0200169
Fabio Utzig1e48b912018-09-18 09:04:18 -0300170 pub fn rsa_oaep_encrypt_(pubkey: *const u8, pubkey_len: libc::c_uint,
171 seckey: *const u8, seckey_len: libc::c_uint,
172 encbuf: *mut u8) -> libc::c_int;
173
174 pub fn kw_encrypt_(kek: *const u8, seckey: *const u8,
175 encbuf: *mut u8) -> libc::c_int;
David Brownde7729e2017-01-09 10:41:35 -0700176 }
177}