Struct apple_codesign::CodeDirectoryBlob

pub struct CodeDirectoryBlob<'a> {

    pub version: u32,
    pub flags: CodeSignatureFlags,
    pub code_limit: u32,
    pub digest_size: u8,
    pub digest_type: DigestType,
    pub platform: u8,
    pub page_size: u32,
    pub spare2: u32,
    pub scatter_offset: Option<u32>,
    pub spare3: Option<u32>,
    pub code_limit_64: Option<u64>,
    pub exec_seg_base: Option<u64>,
    pub exec_seg_limit: Option<u64>,
    pub exec_seg_flags: Option<ExecutableSegmentFlags>,
    pub runtime: Option<u32>,
    pub pre_encrypt_offset: Option<u32>,
    pub linkage_hash_type: Option<u8>,
    pub linkage_truncated: Option<u8>,
    pub spare4: Option<u16>,
    pub linkage_offset: Option<u32>,
    pub linkage_size: Option<u32>,
    pub ident: Cow<'a, str>,
    pub team_name: Option<Cow<'a, str>>,
    pub code_digests: Vec<Digest<'a>>,
    pub special_digests: HashMap<CodeSigningSlot, Digest<'a>>,
}

Represents a code directory blob entry.

This struct is versioned and has been extended over time.

The struct here represents a superset of all fields in all versions.

The parser will set Option<T> fields to None for instances where the version is lower than the version that field was introduced in.

Fields

version: u32

Compatibility version.

flags: CodeSignatureFlags

Setup and mode flags.

code_limit: u32

Limit to main image signature range.

This is the file-level offset to stop digesting code data at. It likely corresponds to the file-offset offset where the embedded signature data starts in the __LINKEDIT segment.

digest_size: u8

Size of each slot/code digest in bytes.

digest_type: DigestType

Type of content digest being used.

platform: u8

Platform identifier. 0 if not platform binary.

page_size: u32

Page size in bytes. (stored as log u8)

spare2: u32

Unused (must be 0).

scatter_offset: Option<u32>

Offset of optional scatter vector.

spare3: Option<u32>

Unused (must be 0).

code_limit_64: Option<u64>

Limit to main image signature range, 64 bits.

exec_seg_base: Option<u64>

Offset of executable segment.

exec_seg_limit: Option<u64>

Limit of executable segment.

exec_seg_flags: Option<ExecutableSegmentFlags>

Executable segment flags.

runtime: Option<u32>

pre_encrypt_offset: Option<u32>

linkage_hash_type: Option<u8>

linkage_truncated: Option<u8>

spare4: Option<u16>

linkage_offset: Option<u32>

linkage_size: Option<u32>

ident: Cow<'a, str>

team_name: Option<Cow<'a, str>>

code_digests: Vec<Digest<'a>>

special_digests: HashMap<CodeSigningSlot, Digest<'a>>

Implementations

impl<'a> CodeDirectoryBlob<'a>

pub fn slot_digests(&self) -> &HashMap<CodeSigningSlot, Digest<'a>>

Obtain the mapping of slots to digests.

pub fn slot_digest(&self, slot: CodeSigningSlot) -> Option<&Digest<'a>>

Obtain the recorded digest for a given CodeSigningSlot.

pub fn set_slot_digest(
    &mut self,
    slot: CodeSigningSlot,
    digest: impl Into<Digest<'a>>
) -> Result<(), AppleCodesignError>

Set the digest for a given slot.

pub fn adjust_version(&mut self, target: Option<MachoTarget>) -> u32

Adjust the version of the data structure according to what fields are set.

Returns the old version.

pub fn clear_newer_fields(&mut self)

Clears optional fields that are newer than the current version.

The C structure is versioned and our Rust struct is a superset of all versions. While our serializer should omit too new fields for a given version, it is possible for some optional fields to be set when they wouldn’t get serialized.

Calling this function will set fields not present in the current version to None.

pub fn to_owned(&self) -> CodeDirectoryBlob<'static>

Trait Implementations

impl<'a> Blob<'a> for CodeDirectoryBlob<'a>

fn magic() -> u32

The header magic that identifies this format.

fn from_blob_bytes(data: &'a [u8]) -> Result<Self, AppleCodesignError>

Attempt to construct an instance by parsing a bytes slice.

fn serialize_payload(&self) -> Result<Vec<u8>, AppleCodesignError>

Serialize the payload of this blob to bytes.

fn to_blob_bytes(&self) -> Result<Vec<u8>, AppleCodesignError>

Serialize this blob to bytes.

fn digest_with(
    &self,
    hash_type: DigestType
) -> Result<Vec<u8>, AppleCodesignError>

Obtain the digest of the blob using the specified hasher.

impl<'a> Debug for CodeDirectoryBlob<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for CodeDirectoryBlob<'a>

fn default() -> CodeDirectoryBlob<'a>

Returns the “default value” for a type.

impl<'a> From<CodeDirectoryBlob<'a>> for BlobData<'a>

fn from(b: CodeDirectoryBlob<'a>) -> Self

Converts to this type from the input type.

impl<'a> TryFrom<CodeDirectoryBlob<'a>> for CodeDirectory

type Error = AppleCodesignError

The type returned in the event of a conversion error.

fn try_from(cd: CodeDirectoryBlob<'a>) -> Result<Self, Self::Error>

Performs the conversion.