imgalign

Documentation

Overview

Copyright 2023 Meta Platforms, Inc. and affiliates.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright 2023 Meta Platforms, Inc. and affiliates.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

• func GetAlignedImage(ctx context.Context, fullImage *uefi.UEFI, partialImage []byte) (firmware *uefi.UEFI, offset uint64, err error)
• type ErrImageLengthDoesNotMatch
  • func (err ErrImageLengthDoesNotMatch) Error() string
• type ErrNoOrigImageToCompareWith
  • func (ErrNoOrigImageToCompareWith) Error() string
• type ErrUnableToFindBIOSRegion
  • func (err ErrUnableToFindBIOSRegion) Error() string
  • func (err ErrUnableToFindBIOSRegion) Unwrap() error
• type ErrUnexpectedAmountOfBIOSRegions
  • func (err ErrUnexpectedAmountOfBIOSRegions) Error() string

Functions

func GetAlignedImage

func GetAlignedImage(
	ctx context.Context,
	fullImage *uefi.UEFI,
	partialImage []byte,
) (firmware *uefi.UEFI, offset uint64, err error)

GetAlignedImage returns a part of fullImage which is aligned (and ready to be compared) with partialImage.

Some images might contain only the BIOS region instead of the whole image, and to properly compare two BIOS regions we return the same regios of originalFirmware as we have in receivedImage.

Types

type ErrImageLengthDoesNotMatch

type ErrImageLengthDoesNotMatch struct {
	ExpectedLength uint
	ReceivedLength uint
}

ErrImageLengthDoesNotMatch is returned when the size of the UEFI image is not as expected.

func (ErrImageLengthDoesNotMatch) Error

func (err ErrImageLengthDoesNotMatch) Error() string

type ErrNoOrigImageToCompareWith

type ErrNoOrigImageToCompareWith struct{}

ErrNoOrigImageToCompareWith is returned on attempt to make a diff report if nil original image.

func (ErrNoOrigImageToCompareWith) Error

func (ErrNoOrigImageToCompareWith) Error() string

type ErrUnableToFindBIOSRegion

type ErrUnableToFindBIOSRegion struct {
	Err error
}

ErrUnableToFindBIOSRegion is returned if BIOSRegion is not found

func (ErrUnableToFindBIOSRegion) Error

func (err ErrUnableToFindBIOSRegion) Error() string

func (ErrUnableToFindBIOSRegion) Unwrap

func (err ErrUnableToFindBIOSRegion) Unwrap() error

type ErrUnexpectedAmountOfBIOSRegions

type ErrUnexpectedAmountOfBIOSRegions struct {
	FoundCount uint
}

ErrUnexpectedAmountOfBIOSRegions is returned when an UEFI image contains an amount of BIOS regions not equals to one.

func (ErrUnexpectedAmountOfBIOSRegions) Error

func (err ErrUnexpectedAmountOfBIOSRegions) Error() string