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

Commit 4949493f authored by sandeepbandaru's avatar sandeepbandaru Committed by Sandeep Bandaru
Browse files

Add hasBinders() to Bundle 

This is an extension to the existing `hasFileDescriptors` method, with
the exception that we do not support this check in cases where the
Bundle data is modified after unparcelling.

Test: will add unit tests after initial review
Bug: 326032074

Change-Id: Ide1b61aa9cb792facc042f2c03017bcfbde0921b
parent 874d8163

core/java/android/os/Bundle.java

+99 −6
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ package android.os; 


import static java.util.Objects.requireNonNull;



import android.annotation.IntDef;

import android.annotation.NonNull;

import android.annotation.Nullable;

import android.annotation.SuppressLint;
@@ -31,6 +32,8 @@ import android.util.proto.ProtoOutputStream; 
import com.android.internal.annotations.VisibleForTesting;



import java.io.Serializable;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.util.ArrayList;

import java.util.List;
@@ -53,6 +56,53 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
    @VisibleForTesting

    static final int FLAG_ALLOW_FDS = 1 << 10;



    @VisibleForTesting

    static final int FLAG_HAS_BINDERS_KNOWN = 1 << 11;



    @VisibleForTesting

    static final int FLAG_HAS_BINDERS = 1 << 12;





    /**

     * Status when the Bundle can <b>assert</b> that the underlying Parcel DOES NOT contain

     * Binder object(s).

     *

     * @hide

     */

    public static final int STATUS_BINDERS_NOT_PRESENT = 0;



    /**

     * Status when the Bundle can <b>assert</b> that there are Binder object(s) in the Parcel.

     *

     * @hide

     */

    public static final int STATUS_BINDERS_PRESENT = 1;



    /**

     * Status when the Bundle cannot be checked for Binders and there is no parcelled data

     * available to check either.

     * <p> This could happen when a Bundle is unparcelled or was never parcelled, and modified such

     * that it is not possible to assert if the Bundle has any Binder objects in the current state.

     *

     * For e.g. calling {@link #putParcelable} or {@link #putBinder} could have added a Binder

     * object to the Bundle but it is not possible to assert this fact unless the Bundle is written

     * to a Parcel.

     * </p>

     *

     * @hide

     */

    public static final int STATUS_BINDERS_UNKNOWN = 2;



    /** @hide */

    @IntDef(flag = true, prefix = {"STATUS_BINDERS_"}, value = {

            STATUS_BINDERS_PRESENT,

            STATUS_BINDERS_UNKNOWN,

            STATUS_BINDERS_NOT_PRESENT

    })

    @Retention(RetentionPolicy.SOURCE)

    public @interface HasBinderStatus {

    }



    /** An unmodifiable {@code Bundle} that is always {@link #isEmpty() empty}. */

    public static final Bundle EMPTY;
@@ -75,7 +125,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
     */

    public Bundle() {

        super();

        mFlags = FLAG_HAS_FDS_KNOWN | FLAG_ALLOW_FDS;

        mFlags = FLAG_HAS_FDS_KNOWN | FLAG_HAS_BINDERS_KNOWN | FLAG_ALLOW_FDS;

    }



    /**
@@ -111,7 +161,6 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
     *

     * @param from The bundle to be copied.

     * @param deep Whether is a deep or shallow copy.

     *

     * @hide

     */

    Bundle(Bundle from, boolean deep) {
@@ -143,7 +192,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
     */

    public Bundle(ClassLoader loader) {

        super(loader);

        mFlags = FLAG_HAS_FDS_KNOWN | FLAG_ALLOW_FDS;

        mFlags = FLAG_HAS_FDS_KNOWN | FLAG_HAS_BINDERS_KNOWN | FLAG_ALLOW_FDS;

    }



    /**
@@ -154,7 +203,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
     */

    public Bundle(int capacity) {

        super(capacity);

        mFlags = FLAG_HAS_FDS_KNOWN | FLAG_ALLOW_FDS;

        mFlags = FLAG_HAS_FDS_KNOWN | FLAG_HAS_BINDERS_KNOWN | FLAG_ALLOW_FDS;

    }



    /**
@@ -180,7 +229,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
     */

    public Bundle(PersistableBundle b) {

        super(b);

        mFlags = FLAG_HAS_FDS_KNOWN | FLAG_ALLOW_FDS;

        mFlags = FLAG_HAS_FDS_KNOWN | FLAG_HAS_BINDERS_KNOWN | FLAG_ALLOW_FDS;

    }



    /**
@@ -292,6 +341,9 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
        if ((mFlags & FLAG_HAS_FDS) != 0) {

            mFlags &= ~FLAG_HAS_FDS_KNOWN;

        }

        if ((mFlags & FLAG_HAS_BINDERS) != 0) {

            mFlags &= ~FLAG_HAS_BINDERS_KNOWN;

        }

    }



    /**
@@ -306,13 +358,20 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
        bundle.mOwnsLazyValues = false;

        mMap.putAll(bundle.mMap);



        // FD state is now known if and only if both bundles already knew

        // FD and Binders state is now known if and only if both bundles already knew

        if ((bundle.mFlags & FLAG_HAS_FDS) != 0) {

            mFlags |= FLAG_HAS_FDS;

        }

        if ((bundle.mFlags & FLAG_HAS_FDS_KNOWN) == 0) {

            mFlags &= ~FLAG_HAS_FDS_KNOWN;

        }



        if ((bundle.mFlags & FLAG_HAS_BINDERS) != 0) {

            mFlags |= FLAG_HAS_BINDERS;

        }

        if ((bundle.mFlags & FLAG_HAS_BINDERS_KNOWN) == 0) {

            mFlags &= ~FLAG_HAS_BINDERS_KNOWN;

        }

    }



    /**
@@ -343,6 +402,33 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
        return (mFlags & FLAG_HAS_FDS) != 0;

    }



    /**

     * Returns a status indicating whether the bundle contains any parcelled Binder objects.

     * @hide

     */

    public @HasBinderStatus int hasBinders() {

        if ((mFlags & FLAG_HAS_BINDERS_KNOWN) != 0) {

            if ((mFlags & FLAG_HAS_BINDERS) != 0) {

                return STATUS_BINDERS_PRESENT;

            } else {

                return STATUS_BINDERS_NOT_PRESENT;

            }

        }



        final Parcel p = mParcelledData;

        if (p == null) {

            return STATUS_BINDERS_UNKNOWN;

        }

        if (p.hasBinders()) {

            mFlags = mFlags | FLAG_HAS_BINDERS | FLAG_HAS_BINDERS_KNOWN;

            return STATUS_BINDERS_PRESENT;

        } else {

            mFlags = mFlags & ~FLAG_HAS_BINDERS;

            mFlags |= FLAG_HAS_BINDERS_KNOWN;

            return STATUS_BINDERS_NOT_PRESENT;

        }

    }



    /** {@hide} */

    @Override

    public void putObject(@Nullable String key, @Nullable Object value) {
@@ -464,6 +550,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
        unparcel();

        mMap.put(key, value);

        mFlags &= ~FLAG_HAS_FDS_KNOWN;

        mFlags &= ~FLAG_HAS_BINDERS_KNOWN;

    }



    /**
@@ -502,6 +589,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
        unparcel();

        mMap.put(key, value);

        mFlags &= ~FLAG_HAS_FDS_KNOWN;

        mFlags &= ~FLAG_HAS_BINDERS_KNOWN;

    }



    /**
@@ -517,6 +605,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
        unparcel();

        mMap.put(key, value);

        mFlags &= ~FLAG_HAS_FDS_KNOWN;

        mFlags &= ~FLAG_HAS_BINDERS_KNOWN;

    }



    /** {@hide} */
@@ -525,6 +614,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
        unparcel();

        mMap.put(key, value);

        mFlags &= ~FLAG_HAS_FDS_KNOWN;

        mFlags &= ~FLAG_HAS_BINDERS_KNOWN;

    }



    /**
@@ -540,6 +630,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
        unparcel();

        mMap.put(key, value);

        mFlags &= ~FLAG_HAS_FDS_KNOWN;

        mFlags &= ~FLAG_HAS_BINDERS_KNOWN;

    }



    /**
@@ -680,6 +771,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
    public void putBinder(@Nullable String key, @Nullable IBinder value) {

        unparcel();

        mMap.put(key, value);

        mFlags &= ~FLAG_HAS_BINDERS_KNOWN;

    }



    /**
@@ -697,6 +789,7 @@ public final class Bundle extends BaseBundle implements Cloneable, Parcelable { 
    public void putIBinder(@Nullable String key, @Nullable IBinder value) {

        unparcel();

        mMap.put(key, value);

        mFlags &= ~FLAG_HAS_BINDERS_KNOWN;

    }



    /**

core/tests/coretests/src/android/os/BundleTest.java

+38 −0
Original line number Diff line number Diff line
@@ -24,6 +24,7 @@ import static org.junit.Assert.assertNotNull; 
import static org.junit.Assert.assertThrows;

import static org.junit.Assert.assertTrue;



import android.platform.test.annotations.DisabledOnRavenwood;

import android.platform.test.annotations.IgnoreUnderRavenwood;

import android.platform.test.annotations.Presubmit;

import android.platform.test.ravenwood.RavenwoodRule;
@@ -445,6 +446,42 @@ public class BundleTest { 
        assertThat(bundle.size()).isEqualTo(0);

    }



    @Test

    @DisabledOnRavenwood(blockedBy = Parcel.class)

    public void parcelledBundleWithBinder_shouldReturnHasBindersTrue() throws Exception {

        Bundle bundle = new Bundle();

        bundle.putParcelable("test", new CustomParcelable(13, "Tiramisu"));

        bundle.putBinder("test_binder",

                new IBinderWorkSourceNestedService.Stub() {



                    public int[] nestedCallWithWorkSourceToSet(int uidToBlame) {

                        return new int[0];

                    }



                    public int[] nestedCall() {

                        return new int[0];

                    }

                });

        Bundle bundle2 = new Bundle(getParcelledBundle(bundle));

        assertEquals(bundle2.hasBinders(), Bundle.STATUS_BINDERS_PRESENT);



        bundle2.putParcelable("test2", new CustomParcelable(13, "Tiramisu"));

        assertEquals(bundle2.hasBinders(), Bundle.STATUS_BINDERS_UNKNOWN);

    }



    @Test

    @DisabledOnRavenwood(blockedBy = Parcel.class)

    public void parcelledBundleWithoutBinder_shouldReturnHasBindersFalse() throws Exception {

        Bundle bundle = new Bundle();

        bundle.putParcelable("test", new CustomParcelable(13, "Tiramisu"));

        Bundle bundle2 = new Bundle(getParcelledBundle(bundle));

        //Should fail to load with framework classloader.

        assertEquals(bundle2.hasBinders(), Bundle.STATUS_BINDERS_NOT_PRESENT);



        bundle2.putParcelable("test2", new CustomParcelable(13, "Tiramisu"));

        assertEquals(bundle2.hasBinders(), Bundle.STATUS_BINDERS_UNKNOWN);

    }



    private Bundle getMalformedBundle() {

        Parcel p = Parcel.obtain();

        p.writeInt(BaseBundle.BUNDLE_MAGIC);
@@ -520,6 +557,7 @@ public class BundleTest { 
            public CustomParcelable createFromParcel(Parcel in) {

                return new CustomParcelable(in);

            }



            @Override

            public CustomParcelable[] newArray(int size) {

                return new CustomParcelable[size];