Struct apple_codesign::MachOBinary
source · pub struct MachOBinary<'a> {
pub index: Option<usize>,
pub macho: MachO<'a>,
pub data: &'a [u8],
}
Expand description
A Mach-O binary.
Fields§
§index: Option<usize>
Index within a fat binary this Mach-O resides at.
If None
, this is not inside a fat binary.
macho: MachO<'a>
The parsed Mach-O binary.
data: &'a [u8]
The raw data backing the Mach-O binary.
Implementations§
source§impl<'a> MachOBinary<'a>
impl<'a> MachOBinary<'a>
sourcepub fn parse(data: &'a [u8]) -> Result<Self, AppleCodesignError>
pub fn parse(data: &'a [u8]) -> Result<Self, AppleCodesignError>
Parse a non-universal Mach-O binary from raw data.
source§impl<'a> MachOBinary<'a>
impl<'a> MachOBinary<'a>
sourcepub fn linkedit_index_and_segment(&self) -> Option<(usize, &Segment<'a>)>
pub fn linkedit_index_and_segment(&self) -> Option<(usize, &Segment<'a>)>
Find the __LINKEDIT segment and its segment index.
sourcepub fn linkedit_segment(&self) -> Option<&Segment<'a>>
pub fn linkedit_segment(&self) -> Option<&Segment<'a>>
Find the __LINKEDIT segment.
sourcepub fn linkedit_segment_assert_last(
&self
) -> Result<&Segment<'a>, AppleCodesignError>
pub fn linkedit_segment_assert_last( &self ) -> Result<&Segment<'a>, AppleCodesignError>
Find the __LINKEDIT segment, asserting it exists and it is the final segment.
sourcepub fn find_signature_data(
&self
) -> Result<Option<MachOSignatureData<'a>>, AppleCodesignError>
pub fn find_signature_data( &self ) -> Result<Option<MachOSignatureData<'a>>, AppleCodesignError>
Attempt to extract a reference to raw signature data in a Mach-O binary.
An LC_CODE_SIGNATURE
load command in the Mach-O file header points to
signature data in the __LINKEDIT
segment.
This function is used as part of parsing signature data. You probably want to use a function that parses referenced data.
sourcepub fn code_signature(
&self
) -> Result<Option<EmbeddedSignature<'_>>, AppleCodesignError>
pub fn code_signature( &self ) -> Result<Option<EmbeddedSignature<'_>>, AppleCodesignError>
Obtain the code signature in the entity.
Returns Ok(None)
if no signature exists, Ok(Some)
if it does, or
Err
if there is a parse error.
sourcepub fn executable_segment_boundary(
&self
) -> Result<(u64, u64), AppleCodesignError>
pub fn executable_segment_boundary( &self ) -> Result<(u64, u64), AppleCodesignError>
Determine the start and end offset of the executable segment of a binary.
sourcepub fn is_executable(&self) -> bool
pub fn is_executable(&self) -> bool
Whether this is an executable Mach-O file.
sourcepub fn code_signature_linkedit_start_offset(&self) -> Option<u32>
pub fn code_signature_linkedit_start_offset(&self) -> Option<u32>
The start offset of the code signature data within the __LINKEDIT segment.
sourcepub fn code_signature_linkedit_end_offset(&self) -> Option<u32>
pub fn code_signature_linkedit_end_offset(&self) -> Option<u32>
The end offset of the code signature data within the __LINKEDIT segment.
sourcepub fn segments_by_file_offset(&self) -> Vec<&Segment<'a>>
pub fn segments_by_file_offset(&self) -> Vec<&Segment<'a>>
Obtain Mach-O segments by file offset order.
The header-defined order may vary by the file layout order. This ensures the ordering is by file layout.
sourcepub fn code_limit_binary_offset(&self) -> Result<u64, AppleCodesignError>
pub fn code_limit_binary_offset(&self) -> Result<u64, AppleCodesignError>
The byte offset within the binary at which point “code” stops.
If a signature is present, this is the offset of the start of the signature. Else it represents the end of the binary.
sourcepub fn linkedit_data_before_signature(&self) -> Option<&[u8]>
pub fn linkedit_data_before_signature(&self) -> Option<&[u8]>
Obtain __LINKEDIT segment data before the signature data.
If there is no signature, returns all the data for the __LINKEDIT segment.
sourcepub fn digested_code_data(&self) -> Result<&[u8], AppleCodesignError>
pub fn digested_code_data(&self) -> Result<&[u8], AppleCodesignError>
Obtain Mach-O binary data to be digested in code digests.
Returns the raw data whose digests will be captured by the Code Directory code digests.
sourcepub fn code_digests_size(
&self,
digest: DigestType,
page_size: usize
) -> Result<usize, AppleCodesignError>
pub fn code_digests_size( &self, digest: DigestType, page_size: usize ) -> Result<usize, AppleCodesignError>
Obtain the size in bytes of all code digests given a digest type and page size.
sourcepub fn code_digests(
&self,
digest: DigestType,
page_size: usize
) -> Result<Vec<Vec<u8>>, AppleCodesignError>
pub fn code_digests( &self, digest: DigestType, page_size: usize ) -> Result<Vec<Vec<u8>>, AppleCodesignError>
Compute digests over code in this binary.
sourcepub fn code_signature_load_command(&self) -> Option<LinkeditDataCommand>
pub fn code_signature_load_command(&self) -> Option<LinkeditDataCommand>
Resolve the load command for the code signature.
sourcepub fn embedded_info_plist(&self) -> Result<Option<Vec<u8>>, AppleCodesignError>
pub fn embedded_info_plist(&self) -> Result<Option<Vec<u8>>, AppleCodesignError>
Attempt to locate embedded Info.plist data.
sourcepub fn check_signing_capability(&self) -> Result<(), AppleCodesignError>
pub fn check_signing_capability(&self) -> Result<(), AppleCodesignError>
Determines whether this crate is capable of signing a given Mach-O binary.
Code in this crate is limited in the amount of Mach-O binary manipulation it can perform (supporting rewriting all valid Mach-O binaries effectively requires low-level awareness of all Mach-O constructs in order to perform offset manipulation). This function can be used to test signing compatibility.
We currently only support signing Mach-O files already containing an embedded signature. Often linked binaries automatically contain an embedded signature containing just the code directory (without a cryptographically signed signature), so this limitation hopefully isn’t impactful.
sourcepub fn find_targeting(&self) -> Result<Option<MachoTarget>, AppleCodesignError>
pub fn find_targeting(&self) -> Result<Option<MachoTarget>, AppleCodesignError>
Attempt to resolve the mach-o targeting settings.
Auto Trait Implementations§
impl<'a> RefUnwindSafe for MachOBinary<'a>
impl<'a> Send for MachOBinary<'a>
impl<'a> Sync for MachOBinary<'a>
impl<'a> Unpin for MachOBinary<'a>
impl<'a> UnwindSafe for MachOBinary<'a>
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§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.§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.§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.§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.§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.§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.§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.§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.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute
] value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
[Quirk
] value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition
] value
applies. Replaces any previous condition.
See the crate level docs for more details.
Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§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 more§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 more§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
§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
§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.§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.§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.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§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 more§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 more§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 more§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 more§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 more§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 more§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.§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.§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.§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.§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.§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.§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.