pub struct Job<'a> {
pub device: Option<Rc<RefCell<Device>>>,
pub cache: &'a mut VtpmCache<'a>,
pub auth_list: &'a [Auth],
pub writer: &'a mut dyn Write,
}Fields§
§device: Option<Rc<RefCell<Device>>>§cache: &'a mut VtpmCache<'a>§auth_list: &'a [Auth]§writer: &'a mut dyn WriteImplementations§
Source§impl<'a> Job<'a>
impl<'a> Job<'a>
Sourcepub fn new(
device: Option<Rc<RefCell<Device>>>,
cache: &'a mut VtpmCache<'a>,
auth_list: &'a [Auth],
writer: &'a mut dyn Write,
) -> Self
pub fn new( device: Option<Rc<RefCell<Device>>>, cache: &'a mut VtpmCache<'a>, auth_list: &'a [Auth], writer: &'a mut dyn Write, ) -> Self
Creates a new Job.
Sourcepub fn load_context(
&mut self,
device: &mut Device,
target: &Handle,
) -> Result<TpmHandle, JobError>
pub fn load_context( &mut self, device: &mut Device, target: &Handle, ) -> Result<TpmHandle, JobError>
Loads a TPM context from a handle, recursively loading its ancestors first.
§Errors
Returns HandleNotFound when the
target handle or any parent handle cannot be found, or if the chain is empty.
Returns ParentNotFound when a
necessary parent handle isn’t found in cache or persistent storage.
Returns Device or
TpmProtocol when TPM commands fail.
Returns Vtpm when tracking the loaded
handle fails.
Returns InvalidParent if a
loaded key’s parent does not match the expected parent in the chain.
Sourcepub fn execute<C: TpmCommandObject>(
&mut self,
device: &mut Device,
command: &C,
handles: &[u32],
auth_list: &[Auth],
) -> Result<(TpmResponseBody, TpmAuthResponses), JobError>
pub fn execute<C: TpmCommandObject>( &mut self, device: &mut Device, command: &C, handles: &[u32], auth_list: &[Auth], ) -> Result<(TpmResponseBody, TpmAuthResponses), JobError>
Executes a TPM command with full authorization session handling.
This function encapsulates the prepare, build, execute, and teardown sequence for authorized commands.
§Errors
Returns JobError if any stage of the session management or
command execution fails. This includes errors from prepare_sessions,
build_auth_area, device.execute, or teardown_sessions.
Sourcepub fn evict_control(
&mut self,
auth_handle: TpmHandle,
object_to_evict: TpmHandle,
persistent_handle: TpmHandle,
auths: &[Auth],
) -> Result<(), JobError>
pub fn evict_control( &mut self, auth_handle: TpmHandle, object_to_evict: TpmHandle, persistent_handle: TpmHandle, auths: &[Auth], ) -> Result<(), JobError>
Evicts a persistent object or makes a transient object persistent using Job::execute.
§Errors
Returns Device when the underlying
with_device fails.
Returns ResponseMismatch when
the TPM command returns an unexpected response type.
Returns JobError from the underlying execute call on failure.
Sourcepub fn import_key(
&mut self,
device: &mut Device,
parent_handle: TpmHandle,
input_bytes: &[u8],
auths: &[Auth],
) -> Result<TpmKey, JobError>
pub fn import_key( &mut self, device: &mut Device, parent_handle: TpmHandle, input_bytes: &[u8], auths: &[Auth], ) -> Result<TpmKey, JobError>
Imports an external key under a TPM parent, creating a new TpmKey.
§Errors
Returns InvalidFormat when the
input bytes represent a TPM key, not an external key.
Returns Key when converting the external
key or building the TPM key fails.
Returns JobError from the underlying TpmKey::from_external_key call
on failure.
Sourcepub fn read_certificate(
&mut self,
device: &mut Device,
auths: &[Auth],
handle: u32,
max_read_size: usize,
) -> Result<Option<Vec<u8>>, JobError>
pub fn read_certificate( &mut self, device: &mut Device, auths: &[Auth], handle: u32, max_read_size: usize, ) -> Result<Option<Vec<u8>>, JobError>
Reads a certificate from a given NV index.
§Errors
Returns ResponseMismatch when
TPM commands return unexpected response types.
Returns IntDecode when converting
chunk size or offset fails.
Returns JobError from the underlying execute calls on failure.
Trait Implementations§
Auto Trait Implementations§
impl<'a> Freeze for Job<'a>
impl<'a> !RefUnwindSafe for Job<'a>
impl<'a> !Send for Job<'a>
impl<'a> !Sync for Job<'a>
impl<'a> Unpin for Job<'a>
impl<'a> !UnwindSafe for Job<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.