Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit c18d4886 authored by Zhomart Mukhamejanov's avatar Zhomart Mukhamejanov
Browse files

Add verification before downloading whole package 

UpdateEngine has a feature that verifies
payload without downloading the whole update package.

If UpdateEngine detects invalid payload,
the sample app aborts the update.

No JUnit tests, because it accesses files on the
device and migrating tests to robolectric
is not worth for this sample app.

Bug: 77150191
Test: device
Change-Id: Ib8ce73508a02cf5fdcb326d8ba46c1d05ed5efe5
parent 2e33cbeb

updater_sample/README.md

+1 −1
Original line number Diff line number Diff line
@@ -220,7 +220,7 @@ privileged system app, so it's granted the required permissions to access 
- [x] Add Sample app update state (separate from update_engine status)

- [x] Add smart update completion detection using onStatusUpdate

- [x] Add pause/resume demo

- [-] Verify system partition checksum for package

- [x] Verify system partition checksum for package





## Running tests

updater_sample/src/com/example/android/systemupdatersample/services/PrepareUpdateService.java

+51 −0
Original line number Diff line number Diff line
@@ -42,7 +42,9 @@ import com.google.common.collect.ImmutableSet; 
import java.io.File;

import java.io.IOException;

import java.nio.file.Files;

import java.nio.file.Path;

import java.nio.file.Paths;

import java.util.Arrays;

import java.util.Optional;



/**
@@ -144,6 +146,13 @@ public class PrepareUpdateService extends IntentService { 
    private PayloadSpec execute(UpdateConfig config)

            throws IOException, PreparationFailedException {



        if (config.getAbConfig().getVerifyPayloadMetadata()) {

            Log.i(TAG, "Verifying payload metadata with UpdateEngine.");

            if (!verifyPayloadMetadata(config)) {

                throw new PreparationFailedException("Payload metadata is not compatible");

            }

        }



        if (config.getInstallType() == UpdateConfig.AB_INSTALL_TYPE_NON_STREAMING) {

            return mPayloadSpecs.forNonStreaming(config.getUpdatePackageFile());

        }
@@ -178,6 +187,48 @@ public class PrepareUpdateService extends IntentService { 
                Paths.get(OTA_PACKAGE_DIR, PAYLOAD_PROPERTIES_FILE_NAME).toFile());

    }



    /**

     * Downloads only payload_metadata.bin and verifies with

     * {@link UpdateEngine#verifyPayloadMetadata}.

     * Returns {@code true} if the payload is verified or the result is unknown because of

     * exception from UpdateEngine.

     * By downloading only small portion of the package, it allows to verify if UpdateEngine

     * will install the update.

     */

    private boolean verifyPayloadMetadata(UpdateConfig config) {

        Optional<UpdateConfig.PackageFile> metadataPackageFile =

                Arrays.stream(config.getAbConfig().getPropertyFiles())

                        .filter(p -> p.getFilename().equals(

                                PackageFiles.PAYLOAD_METADATA_FILE_NAME))

                        .findFirst();

        if (!metadataPackageFile.isPresent()) {

            Log.w(TAG, String.format("ab_config.property_files doesn't contain %s",

                    PackageFiles.PAYLOAD_METADATA_FILE_NAME));

            return true;

        }

        Path metadataPath = Paths.get(OTA_PACKAGE_DIR, PackageFiles.PAYLOAD_METADATA_FILE_NAME);

        try {

            Files.deleteIfExists(metadataPath);

            FileDownloader d = new FileDownloader(

                    config.getUrl(),

                    metadataPackageFile.get().getOffset(),

                    metadataPackageFile.get().getSize(),

                    metadataPath.toFile());

            d.download();

        } catch (IOException e) {

            Log.w(TAG, String.format("Downloading %s from %s failed",

                    PackageFiles.PAYLOAD_METADATA_FILE_NAME,

                    config.getUrl()), e);

            return true;

        }

        try {

            return mUpdateEngine.verifyPayloadMetadata(metadataPath.toAbsolutePath().toString());

        } catch (Exception e) {

            Log.w(TAG, "UpdateEngine#verifyPayloadMetadata failed", e);

            return true;

        }

    }



    /**

     * Downloads files defined in {@link UpdateConfig#getAbConfig()}

     * and exists in {@code PRE_STREAMING_FILES_SET}, and put them