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

Commit 19ce70b0 authored by Nathan Harold's avatar Nathan Harold
Browse files

Add equals() for IpSecAlgorithm and IpSecConfig 

Add equality testing methods to support tests
for parceling and un-parceling IpSecConfig.

Bug: 38397094
Test: runtest -x IpSecConfigTest.java
Change-Id: I31e318334d39ed6e9daf5ec8f3be7dcec75e12ad
parent a10003d5

core/java/android/net/IpSecAlgorithm.java

+10 −7
Original line number Diff line number Diff line
@@ -24,6 +24,7 @@ import com.android.internal.util.HexDump; 


import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.util.Arrays;



/**

 * IpSecAlgorithm specifies a single algorithm that can be applied to an IpSec Transform. Refer to
@@ -75,13 +76,7 @@ public final class IpSecAlgorithm implements Parcelable { 
    public static final String AUTH_HMAC_SHA512 = "hmac(sha512)";



    /** @hide */

    @StringDef({

        CRYPT_AES_CBC,

        AUTH_HMAC_MD5,

        AUTH_HMAC_SHA1,

        AUTH_HMAC_SHA256,

        AUTH_HMAC_SHA512

    })

    @StringDef({CRYPT_AES_CBC, AUTH_HMAC_MD5, AUTH_HMAC_SHA1, AUTH_HMAC_SHA256, AUTH_HMAC_SHA512})

    @Retention(RetentionPolicy.SOURCE)

    public @interface AlgorithmName {}
@@ -197,4 +192,12 @@ public final class IpSecAlgorithm implements Parcelable { 
                .append("}")

                .toString();

    }



    /** package */

    static boolean equals(IpSecAlgorithm lhs, IpSecAlgorithm rhs) {

        if (lhs == null || rhs == null) return (lhs == rhs);

        return (lhs.mName.equals(rhs.mName)

                && Arrays.equals(lhs.mKey, rhs.mKey)

                && lhs.mTruncLenBits == rhs.mTruncLenBits);

    }

};

core/java/android/net/IpSecConfig.java

+27 −0
Original line number Diff line number Diff line
@@ -62,6 +62,13 @@ public final class IpSecConfig implements Parcelable { 
                    .append("}")

                    .toString();

        }



        static boolean equals(IpSecConfig.Flow lhs, IpSecConfig.Flow rhs) {

            if (lhs == null || rhs == null) return (lhs == rhs);

            return (lhs.mSpiResourceId == rhs.mSpiResourceId

                    && IpSecAlgorithm.equals(lhs.mEncryption, rhs.mEncryption)

                    && IpSecAlgorithm.equals(lhs.mAuthentication, rhs.mAuthentication));

        }

    }



    private final Flow[] mFlow = new Flow[] {new Flow(), new Flow()};
@@ -198,6 +205,7 @@ public final class IpSecConfig implements Parcelable { 
        out.writeInt(mEncapType);

        out.writeInt(mEncapSocketResourceId);

        out.writeInt(mEncapRemotePort);

        out.writeInt(mNattKeepaliveInterval);

    }



    @VisibleForTesting
@@ -221,6 +229,7 @@ public final class IpSecConfig implements Parcelable { 
        mEncapType = in.readInt();

        mEncapSocketResourceId = in.readInt();

        mEncapRemotePort = in.readInt();

        mNattKeepaliveInterval = in.readInt();

    }



    @Override
@@ -262,4 +271,22 @@ public final class IpSecConfig implements Parcelable { 
                    return new IpSecConfig[size];

                }

            };



    @VisibleForTesting

    public static boolean equals(IpSecConfig lhs, IpSecConfig rhs) {

        if (lhs == null || rhs == null) return (lhs == rhs);

        return (lhs.mMode == rhs.mMode

                && lhs.mLocalAddress.equals(rhs.mLocalAddress)

                && lhs.mRemoteAddress.equals(rhs.mRemoteAddress)

                && ((lhs.mNetwork != null && lhs.mNetwork.equals(rhs.mNetwork))

                        || (lhs.mNetwork == rhs.mNetwork))

                && lhs.mEncapType == rhs.mEncapType

                && lhs.mEncapSocketResourceId == rhs.mEncapSocketResourceId

                && lhs.mEncapRemotePort == rhs.mEncapRemotePort

                && lhs.mNattKeepaliveInterval == rhs.mNattKeepaliveInterval

                && IpSecConfig.Flow.equals(lhs.mFlow[IpSecTransform.DIRECTION_OUT],

                        rhs.mFlow[IpSecTransform.DIRECTION_OUT])

                && IpSecConfig.Flow.equals(lhs.mFlow[IpSecTransform.DIRECTION_IN],

                        rhs.mFlow[IpSecTransform.DIRECTION_IN]));

    }

}

tests/net/java/android/net/IpSecConfigTest.java

0 → 100644
+98 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2017 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.net;



import static org.junit.Assert.assertEquals;

import static org.junit.Assert.assertNull;

import static org.junit.Assert.assertTrue;



import android.os.Parcel;

import android.support.test.filters.SmallTest;



import org.junit.Test;

import org.junit.runner.RunWith;

import org.junit.runners.JUnit4;



/** Unit tests for {@link IpSecConfig}. */

@SmallTest

@RunWith(JUnit4.class)

public class IpSecConfigTest {



    @Test

    public void testDefaults() throws Exception {

        IpSecConfig c = new IpSecConfig();

        assertEquals(IpSecTransform.MODE_TRANSPORT, c.getMode());

        assertEquals("", c.getLocalAddress());

        assertEquals("", c.getRemoteAddress());

        assertNull(c.getNetwork());

        assertEquals(IpSecTransform.ENCAP_NONE, c.getEncapType());

        assertEquals(IpSecManager.INVALID_RESOURCE_ID, c.getEncapSocketResourceId());

        assertEquals(0, c.getEncapRemotePort());

        assertEquals(0, c.getNattKeepaliveInterval());

        for (int direction :

                new int[] {IpSecTransform.DIRECTION_OUT, IpSecTransform.DIRECTION_IN}) {

            assertNull(c.getEncryption(direction));

            assertNull(c.getAuthentication(direction));

            assertEquals(IpSecManager.INVALID_RESOURCE_ID, c.getSpiResourceId(direction));

        }

    }



    @Test

    public void testParcelUnparcel() throws Exception {

        assertParcelingIsLossless(new IpSecConfig());



        IpSecConfig c = new IpSecConfig();

        c.setMode(IpSecTransform.MODE_TUNNEL);

        c.setLocalAddress("0.0.0.0");

        c.setRemoteAddress("1.2.3.4");

        c.setEncapType(android.system.OsConstants.UDP_ENCAP_ESPINUDP);

        c.setEncapSocketResourceId(7);

        c.setEncapRemotePort(22);

        c.setNattKeepaliveInterval(42);

        c.setEncryption(

                IpSecTransform.DIRECTION_OUT,

                new IpSecAlgorithm(

                        IpSecAlgorithm.CRYPT_AES_CBC,

                        new byte[] {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0xA, 0xB, 0xC, 0xD, 0xE, 0xF}));

        c.setAuthentication(

                IpSecTransform.DIRECTION_OUT,

                new IpSecAlgorithm(

                        IpSecAlgorithm.AUTH_HMAC_SHA1,

                        new byte[] {1, 2, 3, 4, 5, 6, 7, 8, 9, 0xA, 0xB, 0xC, 0xD, 0xE, 0xF, 0}));

        c.setSpiResourceId(IpSecTransform.DIRECTION_OUT, 1984);

        c.setEncryption(

                IpSecTransform.DIRECTION_IN,

                new IpSecAlgorithm(

                        IpSecAlgorithm.CRYPT_AES_CBC,

                        new byte[] {2, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0xA, 0xB, 0xC, 0xD, 0xE, 0xF}));

        c.setAuthentication(

                IpSecTransform.DIRECTION_IN,

                new IpSecAlgorithm(

                        IpSecAlgorithm.AUTH_HMAC_SHA1,

                        new byte[] {1, 2, 3, 4, 5, 6, 7, 8, 9, 0xA, 0xB, 0xC, 0xD, 0xE, 0xF, 1}));

        c.setSpiResourceId(IpSecTransform.DIRECTION_IN, 99);

        assertParcelingIsLossless(c);

    }



    private void assertParcelingIsLossless(IpSecConfig ci) throws Exception {

        Parcel p = Parcel.obtain();

        ci.writeToParcel(p, 0);

        p.setDataPosition(0);

        IpSecConfig co = IpSecConfig.CREATOR.createFromParcel(p);

        assertTrue(IpSecConfig.equals(co, ci));

    }

}