services/core/java/com/android/server/om/PackageManagerHelper.java

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.server.om;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.content.om.OverlayableInfo;
import android.content.pm.PackageManager;
import android.content.pm.PackageManagerInternal;
import android.util.ArrayMap;

import com.android.server.pm.PackageManagerServiceUtils;
import com.android.server.pm.pkg.PackageState;

import java.io.IOException;
import java.util.Map;

/**
 * Delegate for {@link PackageManager} and {@link PackageManagerInternal} functionality,
 * separated for easy testing.
 *
 * @hide
 */
interface PackageManagerHelper {

    /**
     * Initializes the helper for the user. This only needs to be invoked one time before
     * packages of this user are queried.
     * @param userId the user id to initialize
     * @return a map of package name to all packages installed in the user
     */
    @NonNull
    ArrayMap<String, PackageState> initializeForUser(final int userId);

    /**
     * Retrieves the package information if it is installed for the user.
     */
    @Nullable
    PackageState getPackageStateForUser(@NonNull final String packageName, final int userId);

    /**
     * Returns whether the package is an instant app.
     */
    boolean isInstantApp(@NonNull final String packageName, final int userId);

    /**
     * @see PackageManager#getPackagesForUid(int)
     */
    @Nullable
    String[] getPackagesForUid(int uid);

    /**
     * @return true if the target package has declared an overlayable
     */
    boolean doesTargetDefineOverlayable(String targetPackageName, int userId) throws IOException;

    /**
     * @throws SecurityException containing message if the caller doesn't have the given
     *                           permission
     */
    void enforcePermission(String permission, String message) throws SecurityException;

    /**
     * Returns the package name of the reference package defined in 'overlay-config-signature' tag
     * of SystemConfig. This package is vetted on scan by PackageManagerService that it's a system
     * package and is used to check if overlay matches its signature in order to fulfill the
     * config_signature policy.
     */
    @Nullable
    String getConfigSignaturePackage();

    /**
     * @return map of system pre-defined, uniquely named actors; keys are namespace,
     * value maps actor name to package name
     */
    @NonNull
    Map<String, Map<String, String>> getNamedActors();

    /**
     * Read from the APK and AndroidManifest of a package to return the overlayable defined for
     * a given name.
     *
     * @throws IOException if the target can't be read
     */
    @Nullable
    OverlayableInfo getOverlayableForTarget(@NonNull String packageName,
            @NonNull String targetOverlayableName, int userId)
            throws IOException;

    /**
     * @return true if {@link PackageManagerServiceUtils#compareSignatures} run on both packages
     *     in the system returns {@link PackageManager#SIGNATURE_MATCH}
     */
    boolean signaturesMatching(@NonNull String pkgName1, @NonNull String pkgName2, int userId);
}