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

Commit 2641e601 authored by Winson's avatar Winson
Browse files

Add domain verification API classes 

Includes the request class sent to the verification agent and the 2
data classes returned by the to-be-added DomainVerificationManager.

Exempt-From-Owner-Approval: Already approved by owners on main branch

Bug: 163565712
CTS-Coverage-Bug: 179382047

Test: atest DomainVerificationCoreApiTest

Change-Id: If9f1b987f0d06c930f6c44b58af101b83947acb9
parent 1e8c37a0

core/api/system-current.txt

+31 −0
Original line number Diff line number Diff line
@@ -2696,6 +2696,37 @@ package android.content.pm.dex { 














}



























package android.content.pm.domain.verify {

























  public final class DomainVerificationRequest implements android.os.Parcelable {













    method public int describeContents();













    method @NonNull public java.util.Set<java.lang.String> getPackageNames();













    method public void writeToParcel(@NonNull android.os.Parcel, int);













    field @NonNull public static final android.os.Parcelable.Creator<android.content.pm.domain.verify.DomainVerificationRequest> CREATOR;













  }

























  public final class DomainVerificationSet implements android.os.Parcelable {













    method public int describeContents();













    method @NonNull public java.util.Map<java.lang.String,java.lang.Integer> getHostToStateMap();













    method @NonNull public java.util.UUID getIdentifier();













    method @NonNull public String getPackageName();













    method public void writeToParcel(@NonNull android.os.Parcel, int);













    field @NonNull public static final android.os.Parcelable.Creator<android.content.pm.domain.verify.DomainVerificationSet> CREATOR;













  }

























  public final class DomainVerificationUserSelection implements android.os.Parcelable {













    method public int describeContents();













    method @NonNull public java.util.Map<java.lang.String,java.lang.Boolean> getHostToUserSelectionMap();













    method @NonNull public java.util.UUID getIdentifier();













    method @NonNull public String getPackageName();













    method @NonNull public android.os.UserHandle getUser();













    method @NonNull public boolean isLinkHandlingAllowed();













    method public void writeToParcel(@NonNull android.os.Parcel, int);













    field @NonNull public static final android.os.Parcelable.Creator<android.content.pm.domain.verify.DomainVerificationUserSelection> CREATOR;













  }

























}



























package android.content.pm.permission {





























  @Deprecated public final class RuntimePermissionPresentationInfo implements android.os.Parcelable {

































core/java/android/content/pm/domain/verify/DomainVerificationRequest.java
0 → 100644



+190
−0






























Original line number
Diff line number
Diff line













/*













 * 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 android.content.pm.domain.verify;



























import android.annotation.NonNull;













import android.annotation.SystemApi;













import android.content.Intent;













import android.os.Parcelable;



























import com.android.internal.util.DataClass;













import com.android.internal.util.Parcelling;



























import java.util.Set;



























/**













 * Request object sent in the {@link Intent} that's broadcast to the domain verification













 * agent, retrieved through {@link DomainVerificationManager#EXTRA_VERIFICATION_REQUEST}.













 * <p>













 * This contains the set of packages which have been invalidated and will require













 * re-verification. The exact domains can be retrieved with













 * {@link DomainVerificationManager#getDomainVerificationSet(String)}













 *













 * @hide













 */













@SuppressWarnings("DefaultAnnotationParam")













@DataClass(genHiddenConstructor = true, genAidl = false, genEqualsHashCode = true)













@SystemApi













public final class DomainVerificationRequest implements Parcelable {



























    /**













     * The package names of the apps that need to be verified. The receiver should call













     * {@link DomainVerificationManager#getDomainVerificationSet(String)} with each of













     * these values to get the actual set of domains that need to be acted on.













     */













    @NonNull













    @DataClass.ParcelWith(Parcelling.BuiltIn.ForStringSet.class)













    private final Set<String> mPackageNames;























































    // Code below generated by codegen v1.0.22.













    //













    // DO NOT MODIFY!













    // CHECKSTYLE:OFF Generated code













    //













    // To regenerate run:













    // $ codegen $ANDROID_BUILD_TOP/frameworks/base/core/java/android/content/pm/domain/verify/DomainVerificationRequest.java













    //













    // To exclude the generated code from IntelliJ auto-formatting enable (one-time):













    //   Settings > Editor > Code Style > Formatter Control













    //@formatter:off









































    /**













     * Creates a new DomainVerificationRequest.













     *













     * @param packageNames













     *   The package names of the apps that need to be verified. The receiver should call













     *   {@link DomainVerificationManager#getDomainVerificationSet(String)} with each of













     *   these values to get the actual set of domains that need to be acted on.













     * @hide













     */













    @DataClass.Generated.Member













    public DomainVerificationRequest(













            @NonNull Set<String> packageNames) {













        this.mPackageNames = packageNames;













        com.android.internal.util.AnnotationValidations.validate(













                NonNull.class, null, mPackageNames);



























        // onConstructed(); // You can define this method to get a callback













    }



























    /**













     * The package names of the apps that need to be verified. The receiver should call













     * {@link DomainVerificationManager#getDomainVerificationSet(String)} with each of













     * these values to get the actual set of domains that need to be acted on.













     */













    @DataClass.Generated.Member













    public @NonNull Set<String> getPackageNames() {













        return mPackageNames;













    }



























    @Override













    @DataClass.Generated.Member













    public boolean equals(@android.annotation.Nullable Object o) {













        // You can override field equality logic by defining either of the methods like:













        // boolean fieldNameEquals(DomainVerificationRequest other) { ... }













        // boolean fieldNameEquals(FieldType otherValue) { ... }



























        if (this == o) return true;













        if (o == null || getClass() != o.getClass()) return false;













        @SuppressWarnings("unchecked")













        DomainVerificationRequest that = (DomainVerificationRequest) o;













        //noinspection PointlessBooleanExpression













        return true













                && java.util.Objects.equals(mPackageNames, that.mPackageNames);













    }



























    @Override













    @DataClass.Generated.Member













    public int hashCode() {













        // You can override field hashCode logic by defining methods like:













        // int fieldNameHashCode() { ... }



























        int _hash = 1;













        _hash = 31 * _hash + java.util.Objects.hashCode(mPackageNames);













        return _hash;













    }



























    @DataClass.Generated.Member













    static Parcelling<Set<String>> sParcellingForPackageNames =













            Parcelling.Cache.get(













                    Parcelling.BuiltIn.ForStringSet.class);













    static {













        if (sParcellingForPackageNames == null) {













            sParcellingForPackageNames = Parcelling.Cache.put(













                    new Parcelling.BuiltIn.ForStringSet());













        }













    }



























    @Override













    @DataClass.Generated.Member













    public void writeToParcel(@NonNull android.os.Parcel dest, int flags) {













        // You can override field parcelling by defining methods like:













        // void parcelFieldName(Parcel dest, int flags) { ... }



























        sParcellingForPackageNames.parcel(mPackageNames, dest, flags);













    }



























    @Override













    @DataClass.Generated.Member













    public int describeContents() { return 0; }



























    /** @hide */













    @SuppressWarnings({"unchecked", "RedundantCast"})













    @DataClass.Generated.Member













    /* package-private */ DomainVerificationRequest(@NonNull android.os.Parcel in) {













        // You can override field unparcelling by defining methods like:













        // static FieldType unparcelFieldName(Parcel in) { ... }



























        Set<String> packageNames = sParcellingForPackageNames.unparcel(in);



























        this.mPackageNames = packageNames;













        com.android.internal.util.AnnotationValidations.validate(













                NonNull.class, null, mPackageNames);



























        // onConstructed(); // You can define this method to get a callback













    }



























    @DataClass.Generated.Member













    public static final @NonNull Parcelable.Creator<DomainVerificationRequest> CREATOR













            = new Parcelable.Creator<DomainVerificationRequest>() {













        @Override













        public DomainVerificationRequest[] newArray(int size) {













            return new DomainVerificationRequest[size];













        }



























        @Override













        public DomainVerificationRequest createFromParcel(@NonNull android.os.Parcel in) {













            return new DomainVerificationRequest(in);













        }













    };



























    @DataClass.Generated(













            time = 1611795646938L,













            codegenVersion = "1.0.22",













            sourceFile = "frameworks/base/core/java/android/content/pm/domain/verify/DomainVerificationRequest.java",













            inputSignatures = "private final @android.annotation.NonNull @com.android.internal.util.DataClass.ParcelWith(com.android.internal.util.Parcelling.BuiltIn.ForStringSet.class) java.util.Set<java.lang.String> mPackageNames\nclass DomainVerificationRequest extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genHiddenConstructor=true, genAidl=false, genEqualsHashCode=true)")













    @Deprecated













    private void __metadata() {}









































    //@formatter:on













    // End of generated code



























}
























core/java/android/content/pm/domain/verify/DomainVerificationSet.aidl
0 → 100644



+19
−0






























Original line number
Diff line number
Diff line













/*













 * 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 android.content.pm.domain.verify;



























parcelable DomainVerificationSet;
























core/java/android/content/pm/domain/verify/DomainVerificationSet.java
0 → 100644



+336
−0






























Original line number
Diff line number
Diff line













/*













 * 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 android.content.pm.domain.verify;



























import android.annotation.NonNull;













import android.annotation.SystemApi;













import android.content.pm.PackageManager;













import android.os.Parcelable;



























import com.android.internal.util.DataClass;













import com.android.internal.util.Parcelling;



























import java.util.Map;













import java.util.Set;













import java.util.UUID;



























/**













 * Contains the state of all domains for a given package on device. Used by the domain verification













 * agent to determine the domains declared by a package that need to be verified by comparing













 * against the digital asset links response from the server hosting that domain.













 * <p>













 * These values for each domain can be modified through













 * {@link DomainVerificationManager#setDomainVerificationStatus(UUID, Set, int)}.













 *













 * @hide













 */













@SystemApi













@SuppressWarnings("DefaultAnnotationParam")













@DataClass(genAidl = true, genHiddenConstructor = true, genParcelable = true, genToString = true,













        genEqualsHashCode = true)













public final class DomainVerificationSet implements Parcelable {



























    /**













     * A domain verification ID for use in later API calls. This represents the snapshot













     * of the domains for a package on device, and will be invalidated whenever the













     * package changes.













     * <p>













     * An exception will be thrown at the next API call that receives the ID if it is no













     * longer valid.













     * <p>













     * The caller may also be notified with a broadcast whenever a package and ID is













     * invalidated, at which point it can use the package name to evict existing













     * requests with an invalid set ID. If the caller wants to manually check if any













     * IDs have been invalidate, the {@link PackageManager#getChangedPackages(int)}













     * API will allow tracking the packages changed since the last query of this













     * method, prompting the caller to re-query.













     * <p>













     * This allows the caller to arbitrarily grant or revoke domain verification













     * status, through













     * {@link DomainVerificationManager#setDomainVerificationStatus(UUID, Set, int)}.













     */













    @NonNull













    @DataClass.ParcelWith(Parcelling.BuiltIn.ForUUID.class)













    private final UUID mIdentifier;



























    /**













     * The package name that this data corresponds to.













     */













    @NonNull













    private final String mPackageName;



























    /**













     * Map of host names to their current state. State is an integer, which defaults to













     * {@link DomainVerificationManager#STATE_NO_RESPONSE}. State can be modified by the













     * domain verification agent (the intended consumer of this API), which can be equal













     * to {@link DomainVerificationManager#STATE_SUCCESS} when verified, or equal to or













     * greater than {@link DomainVerificationManager#STATE_FIRST_VERIFIER_DEFINED} for













     * any unsuccessful response.













     * <p>













     * Any value non-inclusive between those 2 values are reserved for use by the system.













     * The domain verification agent may be able to act on these reserved values, and this













     * ability can be queried using {@link DomainVerificationManager#isStateModifiable(int)}.













     * It is expected that the agent attempt to verify all domains that it can modify the













     * state of, even if it does not understand the meaning of those values.













     */













    @NonNull













    private final Map<String, Integer> mHostToStateMap;























































    // Code below generated by codegen v1.0.22.













    //













    // DO NOT MODIFY!













    // CHECKSTYLE:OFF Generated code













    //













    // To regenerate run:













    // $ codegen $ANDROID_BUILD_TOP/frameworks/base/core/java/android/content/pm/domain/verify/DomainVerificationSet.java













    //













    // To exclude the generated code from IntelliJ auto-formatting enable (one-time):













    //   Settings > Editor > Code Style > Formatter Control













    //@formatter:off









































    /**













     * Creates a new DomainVerificationSet.













     *













     * @param identifier













     *   A domain verification ID for use in later API calls. This represents the snapshot













     *   of the domains for a package on device, and will be invalidated whenever the













     *   package changes.













     *   <p>













     *   An exception will be thrown at the next API call that receives the ID if it is no













     *   longer valid.













     *   <p>













     *   The caller may also be notified with a broadcast whenever a package and ID is













     *   invalidated, at which point it can use the package name to evict existing













     *   requests with an invalid set ID. If the caller wants to manually check if any













     *   IDs have been invalidate, the {@link PackageManager#getChangedPackages(int)}













     *   API will allow tracking the packages changed since the last query of this













     *   method, prompting the caller to re-query.













     *   <p>













     *   This allows the caller to arbitrarily grant or revoke domain verification













     *   status, through













     *   {@link DomainVerificationManager#setDomainVerificationStatus(UUID, Set, int)}.













     * @param packageName













     *   The package name that this data corresponds to.













     * @param hostToStateMap













     *   Map of host names to their current state. State is an integer, which defaults to













     *   {@link DomainVerificationManager#STATE_NO_RESPONSE}. State can be modified by the













     *   domain verification agent (the intended consumer of this API), which can be equal













     *   to {@link DomainVerificationManager#STATE_SUCCESS} when verified, or equal to or













     *   greater than {@link DomainVerificationManager#STATE_FIRST_VERIFIER_DEFINED} for













     *   any unsuccessful response.













     *   <p>













     *   Any value non-inclusive between those 2 values are reserved for use by the system.













     *   The domain verification agent may be able to act on these reserved values, and this













     *   ability can be queried using {@link DomainVerificationManager#isStateModifiable(int)}.













     *   It is expected that the agent attempt to verify all domains that it can modify the













     *   state of, even if it does not understand the meaning of those values.













     * @hide













     */













    @DataClass.Generated.Member













    public DomainVerificationSet(













            @NonNull UUID identifier,













            @NonNull String packageName,













            @NonNull Map<String,Integer> hostToStateMap) {













        this.mIdentifier = identifier;













        com.android.internal.util.AnnotationValidations.validate(













                NonNull.class, null, mIdentifier);













        this.mPackageName = packageName;













        com.android.internal.util.AnnotationValidations.validate(













                NonNull.class, null, mPackageName);













        this.mHostToStateMap = hostToStateMap;













        com.android.internal.util.AnnotationValidations.validate(













                NonNull.class, null, mHostToStateMap);



























        // onConstructed(); // You can define this method to get a callback













    }



























    /**













     * A domain verification ID for use in later API calls. This represents the snapshot













     * of the domains for a package on device, and will be invalidated whenever the













     * package changes.













     * <p>













     * An exception will be thrown at the next API call that receives the ID if it is no













     * longer valid.













     * <p>













     * The caller may also be notified with a broadcast whenever a package and ID is













     * invalidated, at which point it can use the package name to evict existing













     * requests with an invalid set ID. If the caller wants to manually check if any













     * IDs have been invalidate, the {@link PackageManager#getChangedPackages(int)}













     * API will allow tracking the packages changed since the last query of this













     * method, prompting the caller to re-query.













     * <p>













     * This allows the caller to arbitrarily grant or revoke domain verification













     * status, through













     * {@link DomainVerificationManager#setDomainVerificationStatus(UUID, Set, int)}.













     */













    @DataClass.Generated.Member













    public @NonNull UUID getIdentifier() {













        return mIdentifier;













    }



























    /**













     * The package name that this data corresponds to.













     */













    @DataClass.Generated.Member













    public @NonNull String getPackageName() {













        return mPackageName;













    }



























    /**













     * Map of host names to their current state. State is an integer, which defaults to













     * {@link DomainVerificationManager#STATE_NO_RESPONSE}. State can be modified by the













     * domain verification agent (the intended consumer of this API), which can be equal













     * to {@link DomainVerificationManager#STATE_SUCCESS} when verified, or equal to or













     * greater than {@link DomainVerificationManager#STATE_FIRST_VERIFIER_DEFINED} for













     * any unsuccessful response.













     * <p>













     * Any value non-inclusive between those 2 values are reserved for use by the system.













     * The domain verification agent may be able to act on these reserved values, and this













     * ability can be queried using {@link DomainVerificationManager#isStateModifiable(int)}.













     * It is expected that the agent attempt to verify all domains that it can modify the













     * state of, even if it does not understand the meaning of those values.













     */













    @DataClass.Generated.Member













    public @NonNull Map<String,Integer> getHostToStateMap() {













        return mHostToStateMap;













    }



























    @Override













    @DataClass.Generated.Member













    public String toString() {













        // You can override field toString logic by defining methods like:













        // String fieldNameToString() { ... }



























        return "DomainVerificationSet { " +













                "identifier = " + mIdentifier + ", " +













                "packageName = " + mPackageName + ", " +













                "hostToStateMap = " + mHostToStateMap +













        " }";













    }



























    @Override













    @DataClass.Generated.Member













    public boolean equals(@android.annotation.Nullable Object o) {













        // You can override field equality logic by defining either of the methods like:













        // boolean fieldNameEquals(DomainVerificationSet other) { ... }













        // boolean fieldNameEquals(FieldType otherValue) { ... }



























        if (this == o) return true;













        if (o == null || getClass() != o.getClass()) return false;













        @SuppressWarnings("unchecked")













        DomainVerificationSet that = (DomainVerificationSet) o;













        //noinspection PointlessBooleanExpression













        return true













                && java.util.Objects.equals(mIdentifier, that.mIdentifier)













                && java.util.Objects.equals(mPackageName, that.mPackageName)













                && java.util.Objects.equals(mHostToStateMap, that.mHostToStateMap);













    }



























    @Override













    @DataClass.Generated.Member













    public int hashCode() {













        // You can override field hashCode logic by defining methods like:













        // int fieldNameHashCode() { ... }



























        int _hash = 1;













        _hash = 31 * _hash + java.util.Objects.hashCode(mIdentifier);













        _hash = 31 * _hash + java.util.Objects.hashCode(mPackageName);













        _hash = 31 * _hash + java.util.Objects.hashCode(mHostToStateMap);













        return _hash;













    }



























    @DataClass.Generated.Member













    static Parcelling<UUID> sParcellingForIdentifier =













            Parcelling.Cache.get(













                    Parcelling.BuiltIn.ForUUID.class);













    static {













        if (sParcellingForIdentifier == null) {













            sParcellingForIdentifier = Parcelling.Cache.put(













                    new Parcelling.BuiltIn.ForUUID());













        }













    }



























    @Override













    @DataClass.Generated.Member













    public void writeToParcel(@NonNull android.os.Parcel dest, int flags) {













        // You can override field parcelling by defining methods like:













        // void parcelFieldName(Parcel dest, int flags) { ... }



























        sParcellingForIdentifier.parcel(mIdentifier, dest, flags);













        dest.writeString(mPackageName);













        dest.writeMap(mHostToStateMap);













    }



























    @Override













    @DataClass.Generated.Member













    public int describeContents() { return 0; }



























    /** @hide */













    @SuppressWarnings({"unchecked", "RedundantCast"})













    @DataClass.Generated.Member













    /* package-private */ DomainVerificationSet(@NonNull android.os.Parcel in) {













        // You can override field unparcelling by defining methods like:













        // static FieldType unparcelFieldName(Parcel in) { ... }



























        UUID identifier = sParcellingForIdentifier.unparcel(in);













        String packageName = in.readString();













        Map<String,Integer> hostToStateMap = new java.util.LinkedHashMap<>();













        in.readMap(hostToStateMap, Integer.class.getClassLoader());



























        this.mIdentifier = identifier;













        com.android.internal.util.AnnotationValidations.validate(













                NonNull.class, null, mIdentifier);













        this.mPackageName = packageName;













        com.android.internal.util.AnnotationValidations.validate(













                NonNull.class, null, mPackageName);













        this.mHostToStateMap = hostToStateMap;













        com.android.internal.util.AnnotationValidations.validate(













                NonNull.class, null, mHostToStateMap);



























        // onConstructed(); // You can define this method to get a callback













    }



























    @DataClass.Generated.Member













    public static final @NonNull Parcelable.Creator<DomainVerificationSet> CREATOR













            = new Parcelable.Creator<DomainVerificationSet>() {













        @Override













        public DomainVerificationSet[] newArray(int size) {













            return new DomainVerificationSet[size];













        }



























        @Override













        public DomainVerificationSet createFromParcel(@NonNull android.os.Parcel in) {













            return new DomainVerificationSet(in);













        }













    };



























    @DataClass.Generated(













            time = 1611795504275L,













            codegenVersion = "1.0.22",













            sourceFile = "frameworks/base/core/java/android/content/pm/domain/verify/DomainVerificationSet.java",













            inputSignatures = "private final @android.annotation.NonNull @com.android.internal.util.DataClass.ParcelWith(com.android.internal.util.Parcelling.BuiltIn.ForUUID.class) java.util.UUID mIdentifier\nprivate final @android.annotation.NonNull java.lang.String mPackageName\nprivate final @android.annotation.NonNull java.util.Map<java.lang.String,java.lang.Integer> mHostToStateMap\nclass DomainVerificationSet extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genAidl=true, genHiddenConstructor=true, genParcelable=true, genToString=true, genEqualsHashCode=true)")













    @Deprecated













    private void __metadata() {}









































    //@formatter:on













    // End of generated code



























}
























core/java/android/content/pm/domain/verify/DomainVerificationUserSelection.aidl
0 → 100644



+19
−0




























File added.
Preview size limit exceeded, changes collapsed.