Skip to content

Improve usage of unwrap and expect #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 18, 2019
Merged

Improve usage of unwrap and expect #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/abstraction/transient.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ impl TransientObjectContext {
if root_key_auth_size > 32 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}
if root_key_size < 1024 {
if root_key_size < 1024 || root_key_size > 4096 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}
let mut context = Context::new(tcti)?;
Expand All @@ -50,7 +50,7 @@ impl TransientObjectContext {

let root_key_handle = context.create_primary_key(
ESYS_TR_RH_OWNER,
&get_rsa_public(true, true, false, root_key_size.try_into().unwrap()),
&get_rsa_public(true, true, false, root_key_size.try_into().unwrap()), // should not fail on supported targets, given the checks above
&root_key_auth,
&[],
&[],
Expand Down Expand Up @@ -83,7 +83,7 @@ impl TransientObjectContext {
if auth_size > 32 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}
if key_size < 1024 {
if key_size < 1024 || key_size > 4096 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}
let key_auth = if auth_size > 0 {
Expand All @@ -95,7 +95,7 @@ impl TransientObjectContext {
self.set_session_attrs()?;
let (key_priv, key_pub) = self.context.create_key(
self.root_key_handle,
&get_rsa_public(false, false, true, key_size.try_into().unwrap()),
&get_rsa_public(false, false, true, key_size.try_into().unwrap()), // should not fail on valid targets, given the checks above
&key_auth,
&[],
&[],
Expand All @@ -122,7 +122,7 @@ impl TransientObjectContext {

let pk = TPMU_PUBLIC_ID {
rsa: TPM2B_PUBLIC_KEY_RSA {
size: public_key.len().try_into().unwrap(),
size: public_key.len().try_into().unwrap(), // should not fail on valid targets, given the checks above
buffer: pk_buffer,
},
};
Expand All @@ -131,7 +131,7 @@ impl TransientObjectContext {
false,
false,
true,
u16::try_from(public_key.len()).unwrap() * 8u16,
u16::try_from(public_key.len()).unwrap() * 8u16, // should not fail on valid targets, given the checks above
);
public.publicArea.unique = pk;

Expand Down Expand Up @@ -160,7 +160,7 @@ impl TransientObjectContext {
let key = match PublicIdUnion::from_public(&key_pub_id) {
PublicIdUnion::Rsa(pub_key) => {
let mut key = pub_key.buffer.to_vec();
key.truncate(pub_key.size.try_into().unwrap());
key.truncate(pub_key.size.try_into().unwrap()); // should not fail on supported targets
key
}
_ => unimplemented!(),
Expand Down Expand Up @@ -257,7 +257,7 @@ mod tests {
let mut ctx = TransientObjectContext::new(Tcti::Mssim, 2048, 32, &[]).unwrap();
for _ in 0..4 {
let (key, auth) = ctx.create_rsa_signing_key(2048, 16).unwrap();
let mut signature = ctx.sign(key.clone(), &auth, &HASH).unwrap();
let signature = ctx.sign(key.clone(), &auth, &HASH).unwrap();
let pub_key = ctx.read_public_key(key.clone()).unwrap();
let pub_key = ctx.load_external_rsa_public_key(&pub_key).unwrap();
ctx.verify_signature(pub_key, &HASH, signature).unwrap();
Expand Down
68 changes: 25 additions & 43 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,13 @@ use utils::{Signature, TpmaSession, TpmsContext};
#[macro_use]
macro_rules! wrap_buffer {
($buf:expr, $buf_type:ty, $buf_size:expr) => {{
if $buf.len() > $buf_size {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}
let mut buffer = [0u8; $buf_size];
buffer[..$buf.len()].clone_from_slice(&$buf[..$buf.len()]);
let mut buf_struct: $buf_type = Default::default();
buf_struct.size = $buf.len().try_into().unwrap();
buf_struct.size = $buf.len().try_into().unwrap(); // should not fail since the length is checked above
buf_struct.buffer = buffer;
buf_struct
}};
Expand Down Expand Up @@ -115,7 +118,7 @@ impl Context {
let ret = unsafe {
tss2_esys::Esys_Initialize(
&mut esys_context,
tcti_context.as_mut().unwrap().as_mut_ptr(),
tcti_context.as_mut().unwrap().as_mut_ptr(), // will not panic as per how tcti_context is initialised
null_mut(),
)
};
Expand Down Expand Up @@ -162,10 +165,6 @@ impl Context {
symmetric: TPMT_SYM_DEF,
auth_hash: TPMI_ALG_HASH,
) -> Result<ESYS_TR> {
if nonce.len() > 64 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}

let nonce_caller = wrap_buffer!(nonce, TPM2B_NONCE, 64);
let mut sess = ESYS_TR_NONE;

Expand Down Expand Up @@ -218,30 +217,26 @@ impl Context {
outside_info: &[u8],
creation_pcrs: &[TPMS_PCR_SELECTION],
) -> Result<ESYS_TR> {
if auth_value.len() > 64
|| initial_data.len() > 256
|| outside_info.len() > 64
|| creation_pcrs.len() > 16
{
return Err(Error::local_error(ErrorKind::WrongParamSize));
}

let sensitive_create = TPM2B_SENSITIVE_CREATE {
size: std::mem::size_of::<TPMS_SENSITIVE_CREATE>()
.try_into()
.unwrap(),
.unwrap(), // will not fail on targets of at least 16 bits
sensitive: TPMS_SENSITIVE_CREATE {
userAuth: wrap_buffer!(auth_value, TPM2B_AUTH, 64),
data: wrap_buffer!(initial_data, TPM2B_SENSITIVE_DATA, 256),
},
};

let outside_info = wrap_buffer!(outside_info, TPM2B_DATA, 64);

if creation_pcrs.len() > 16 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}

let mut creation_pcrs_buffer = [Default::default(); 16];
creation_pcrs_buffer[..creation_pcrs.len()]
.clone_from_slice(&creation_pcrs[..creation_pcrs.len()]);
let creation_pcrs = TPML_PCR_SELECTION {
count: creation_pcrs.len().try_into().unwrap(),
count: creation_pcrs.len().try_into().unwrap(), // will not fail given the len checks above
pcrSelections: creation_pcrs_buffer,
};

Expand Down Expand Up @@ -297,18 +292,10 @@ impl Context {
outside_info: &[u8],
creation_pcrs: &[TPMS_PCR_SELECTION],
) -> Result<(TPM2B_PRIVATE, TPM2B_PUBLIC)> {
if auth_value.len() > 64
|| initial_data.len() > 256
|| outside_info.len() > 64
|| creation_pcrs.len() > 16
{
return Err(Error::local_error(ErrorKind::WrongParamSize));
}

let sensitive_create = TPM2B_SENSITIVE_CREATE {
size: std::mem::size_of::<TPMS_SENSITIVE_CREATE>()
.try_into()
.unwrap(),
.unwrap(), // will not fail on targets of at least 16 bits
sensitive: TPMS_SENSITIVE_CREATE {
userAuth: wrap_buffer!(auth_value, TPM2B_AUTH, 64),
data: wrap_buffer!(initial_data, TPM2B_SENSITIVE_DATA, 256),
Expand All @@ -317,11 +304,14 @@ impl Context {

let outside_info = wrap_buffer!(outside_info, TPM2B_DATA, 64);

if creation_pcrs.len() > 16 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}
let mut creation_pcrs_buffer = [Default::default(); 16];
creation_pcrs_buffer[..creation_pcrs.len()]
.clone_from_slice(&creation_pcrs[..creation_pcrs.len()]);
let creation_pcrs = TPML_PCR_SELECTION {
count: creation_pcrs.len().try_into().unwrap(),
count: creation_pcrs.len().try_into().unwrap(), // will not fail given the len checks above
pcrSelections: creation_pcrs_buffer,
};

Expand Down Expand Up @@ -403,9 +393,6 @@ impl Context {
scheme: TPMT_SIG_SCHEME,
validation: &TPMT_TK_HASHCHECK,
) -> Result<Signature> {
if digest.len() > 64 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}
let mut signature = null_mut();
let digest = wrap_buffer!(digest, TPM2B_DIGEST, 64);
let ret = unsafe {
Expand Down Expand Up @@ -438,9 +425,6 @@ impl Context {
digest: &[u8],
signature: &TPMT_SIGNATURE,
) -> Result<TPMT_TK_VERIFIED> {
if digest.len() > 64 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}
let mut validation = null_mut();
let digest = wrap_buffer!(digest, TPM2B_DIGEST, 64);
let ret = unsafe {
Expand Down Expand Up @@ -577,7 +561,7 @@ impl Context {
let ret = Error::from_tss_rc(ret);
if ret.is_success() {
let context = unsafe { MBox::<TPMS_CONTEXT>::from_raw(context) };
Ok((*context).into())
Ok((*context).try_into()?)
} else {
error!("Error in saving context: {}.", ret);
Err(ret)
Expand Down Expand Up @@ -612,7 +596,9 @@ impl Context {
self.sessions.0,
self.sessions.1,
self.sessions.2,
num_bytes.try_into().unwrap(),
num_bytes
.try_into()
.or_else(|_| Err(Error::local_error(ErrorKind::WrongParamSize)))?,
&mut buffer,
)
};
Expand All @@ -621,7 +607,7 @@ impl Context {
if ret.is_success() {
let buffer = unsafe { MBox::from_raw(buffer) };
let mut random = buffer.buffer.to_vec();
random.truncate(buffer.size.try_into().unwrap());
random.truncate(buffer.size.try_into().unwrap()); // should not panic given the TryInto above
Ok(random)
} else {
error!("Error in flushing context: {}.", ret);
Expand All @@ -630,10 +616,6 @@ impl Context {
}

pub fn set_handle_auth(&mut self, handle: ESYS_TR, auth_value: &[u8]) -> Result<()> {
if auth_value.len() > 64 {
return Err(Error::local_error(ErrorKind::WrongParamSize));
}

let auth = wrap_buffer!(auth_value, TPM2B_AUTH, 64);
let ret = unsafe { Esys_TR_SetAuth(self.mut_context(), handle, &auth) };
let ret = Error::from_tss_rc(ret);
Expand All @@ -657,7 +639,7 @@ impl Context {
}

fn mut_context(&mut self) -> *mut ESYS_CONTEXT {
self.esys_context.as_mut().unwrap().as_mut_ptr()
self.esys_context.as_mut().unwrap().as_mut_ptr() // will only fail if called from Drop after .take()
}
}

Expand All @@ -673,8 +655,8 @@ impl Drop for Context {
}
});

let esys_context = self.esys_context.take().unwrap();
let tcti_context = self.tcti_context.take().unwrap();
let esys_context = self.esys_context.take().unwrap(); // should not fail based on how the context is initialised/used
let tcti_context = self.tcti_context.take().unwrap(); // should not fail based on how the context is initialised/used

// Close the TCTI context.
unsafe {
Expand Down
11 changes: 10 additions & 1 deletion src/response_code.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ impl std::fmt::Display for Tss2ResponseCode {
if kind.is_none() {
return write!(f, "response code not recognized");
}
match self.kind().unwrap() {
match self.kind().unwrap() { // should not panic, given the check above
Tss2ResponseCodeKind::Success => write!(f, "success"),
Tss2ResponseCodeKind::TpmVendorSpecific => write!(f, "vendor specific error: {}", self.error_number()),
// Format Zero
Expand Down Expand Up @@ -475,6 +475,8 @@ impl std::fmt::Display for Error {
#[derive(Copy, Clone, PartialEq, Debug)]
pub enum WrapperErrorKind {
WrongParamSize,
ParamsMissing,
InconsistentParams,
}

impl std::fmt::Display for WrapperErrorKind {
Expand All @@ -483,6 +485,13 @@ impl std::fmt::Display for WrapperErrorKind {
WrapperErrorKind::WrongParamSize => {
write!(f, "parameter provided is of the wrong size")
}
WrapperErrorKind::ParamsMissing => {
write!(f, "some of the required parameters were not provided")
}
WrapperErrorKind::InconsistentParams => write!(
f,
"the provided parameters have inconsistent values or variants"
),
}
}
}
Loading