tests/unit/src/android/net/dhcp6/Dhcp6PacketTest.kt

/*
 * Copyright (C) 2023 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.dhcp6

import androidx.test.filters.SmallTest
import androidx.test.runner.AndroidJUnit4
import com.android.net.module.util.HexDump
import com.android.testutils.assertThrows
import kotlin.test.assertEquals
import kotlin.test.assertTrue
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(AndroidJUnit4::class)
@SmallTest
class Dhcp6PacketTest {
    @Test
    fun testDecodeDhcp6PacketWithoutIaPdOption() {
        val solicitHex =
                // Solicit, Transaction ID
                "01000F51" +
                        // client identifier option(option_len=12)
                        "0001000C0003001B024CCBFFFE5F6EA9" +
                        // elapsed time option(option_len=2)
                        "000800020000"
        val bytes = HexDump.hexStringToByteArray(solicitHex)
        assertThrows(Dhcp6Packet.ParseException::class.java) {
            Dhcp6Packet.decode(bytes, bytes.size)
        }
    }

    @Test
    fun testDecodeDhcp6SolicitPacket() {
        val solicitHex =
                // Solicit, Transaction ID
                "01000F51" +
                // client identifier option(option_len=12)
                "0001000C0003001B024CCBFFFE5F6EA9" +
                // elapsed time option(option_len=2)
                "000800020000" +
                // IA_PD option(option_len=41, including IA prefix option)
                "00190029DE3570F50000000000000000" +
                // IA prefix option(option_len=25)
                "001A001900000000000000004000000000000000000000000000000000"
        val bytes = HexDump.hexStringToByteArray(solicitHex)
        val packet = Dhcp6Packet.decode(bytes, bytes.size)
        assertTrue(packet is Dhcp6SolicitPacket)
    }

    @Test
    fun testDecodeDhcp6SolicitPacket_incorrectOptionLength() {
        val solicitHex =
                // Solicit, Transaction ID
                "01000F51" +
                // client identifier option(option_len=12)
                "0001000C0003001B024CCBFFFE5F6EA9" +
                // elapsed time option(wrong option_len=4)
                "000800040000" +
                // IA_PD option(option_len=41, including IA prefix option)
                "00190029DE3570F50000000000000000" +
                // IA prefix option(option_len=25)
                "001A001900000000000000004000000000000000000000000000000000"
        val bytes = HexDump.hexStringToByteArray(solicitHex)
        assertThrows(Dhcp6Packet.ParseException::class.java) {
                Dhcp6Packet.decode(bytes, bytes.size)
        }
    }

    @Test
    fun testDecodeDhcp6SolicitPacket_lastTruncatedOption() {
        val solicitHex =
                // Solicit, Transaction ID
                "01000F51" +
                // client identifier option(option_len=12)
                "0001000C0003001B024CCBFFFE5F6EA9" +
                // elapsed time option(option_len=2)
                "000800020000" +
                // IA_PD option(option_len=41, including IA prefix option)
                "00190029DE3570F50000000000000000" +
                // IA prefix option(option_len=25, missing one byte)
                "001A0019000000000000000040000000000000000000000000000000"
        val bytes = HexDump.hexStringToByteArray(solicitHex)
        assertThrows(Dhcp6Packet.ParseException::class.java) {
                Dhcp6Packet.decode(bytes, bytes.size)
        }
    }

    @Test
    fun testDecodeDhcp6SolicitPacket_middleTruncatedOption() {
        val solicitHex =
                // Solicit, Transaction ID
                "01000F51" +
                // client identifier option(option_len=12, missing one byte)
                "0001000C0003001B024CCBFFFE5F6E" +
                // elapsed time option(option_len=2)
                "000800020000" +
                // IA_PD option(option_len=41, including IA prefix option)
                "00190029DE3570F50000000000000000" +
                // IA prefix option(option_len=25)
                "001A001900000000000000004000000000000000000000000000000000"
        val bytes = HexDump.hexStringToByteArray(solicitHex)
        assertThrows(Dhcp6Packet.ParseException::class.java) {
                Dhcp6Packet.decode(bytes, bytes.size)
        }
    }

    @Test
    fun testDecodeDhcp6AdvertisePacket() {
        val advertiseHex =
                // Advertise, Transaction ID
                "0200078A" +
                // server identifier option(option_len=10)
                "0002000A0003000186C9B26AED4D" +
                // client identifier option(option_len=12)
                "0001000C0003001B024CCBFFFE5F6EA9" +
                // IA_PD option(option_len=70, including IA prefix option)
                "001900460CDDCA0C000000CF0000014C" +
                // IA prefix option(option_len=25, prefix="2401:fa00:49c:412::/64")
                "001A00190000019F0000064F402401FA00049C04810000000000000000" +
                // IA prefix option(option_len=25, prefix="fdfd:9ed6:7950:2::/64")
                "001A00190000019F0000A8C040FDFD9ED6795000010000000000000000"
        val bytes = HexDump.hexStringToByteArray(advertiseHex)
        val packet = Dhcp6Packet.decode(bytes, bytes.size)
        assertTrue(packet is Dhcp6AdvertisePacket)
    }

    @Test
    fun testDecodeDhcp6SolicitPacket_unsupportedOption() {
        val advertiseHex =
                // Advertise, Transaction ID
                "0200078A" +
                // server identifier option(option_len=10)
                "0002000A0003000186C9B26AED4D" +
                // client identifier option(option_len=12)
                "0001000C0003001B024CCBFFFE5F6EA9" +
                // SOL_MAX_RT (don't support this option yet)
                "005200040000003C" +
                // IA_PD option(option_len=70, including IA prefix option)
                "001900460CDDCA0C000000CF0000014C" +
                // IA prefix option(option_len=25, prefix="2401:fa00:49c:412::/64")
                "001A00190000019F0000064F402401FA00049C04810000000000000000" +
                // IA prefix option(option_len=25, prefix="fdfd:9ed6:7950:2::/64")
                "001A00190000019F0000A8C040FDFD9ED6795000010000000000000000"
        val bytes = HexDump.hexStringToByteArray(advertiseHex)
        // The unsupported option will be skipped normally and won't throw ParseException.
        val packet = Dhcp6Packet.decode(bytes, bytes.size)
        assertTrue(packet is Dhcp6AdvertisePacket)
    }

    @Test
    fun testDecodeDhcp6ReplyPacket() {
        val replyHex =
            // Reply, Transaction ID
            "07000A47" +
            // server identifier option(option_len=10)
            "0002000A0003000186C9B26AED4D" +
            // client identifier option(option_len=12)
            "0001000C0003001B02FBBAFFFEB7BC71" +
            // SOL_MAX_RT (don't support this option yet)
            "005200040000003c" +
            // Rapid Commit
            "000e0000" +
            // DNS recursive server (don't support this opton yet)
            "00170010fdfd9ed6795000000000000000000001" +
            // IA_PD option(option_len=70, including IA prefix option)
            "0019004629cc56c7000000d300000152" +
            // IA prefix option(option_len=25, prefix="2401:fa00:49c:412::/64", preferred=400,
            // valid=1623)
            "001a00190000019000000657402401fa00049c04120000000000000000" +
            // IA prefix option(option_len=25, prefix="fdfd:9ed6:7950:2::/64", preferred=423,
            // valid=43200)
            "001a0019000001a70000a8c040fdfd9ed6795000020000000000000000"
        val bytes = HexDump.hexStringToByteArray(replyHex)
        val packet = Dhcp6Packet.decode(bytes, bytes.size)
        assertTrue(packet is Dhcp6ReplyPacket)
        assertEquals(400, packet.prefixDelegation.minimalPreferredLifetime)
        assertEquals(1623, packet.prefixDelegation.minimalValidLifetime)
    }

    @Test
    fun testGetMinimalPreferredValidLifetime() {
        val replyHex =
            // Reply, Transaction ID
            "07000A47" +
            // server identifier option(option_len=10)
            "0002000A0003000186C9B26AED4D" +
            // client identifier option(option_len=12)
            "0001000C0003001B02FBBAFFFEB7BC71" +
            // SOL_MAX_RT (don't support this option yet)
            "005200040000003c" +
            // Rapid Commit
            "000e0000" +
            // DNS recursive server (don't support this opton yet)
            "00170010fdfd9ed6795000000000000000000001" +
            // IA_PD option(option_len=70, including IA prefix option)
            "0019004629cc56c7000000d300000152" +
            // IA prefix option(option_len=25, prefix="2401:fa00:49c:412::/64", preferred=0,
            // valid=0)
            "001a00190000000000000000402401fa00049c04120000000000000000" +
            // IA prefix option(option_len=25, prefix="fdfd:9ed6:7950:2::/64", preferred=423,
            // valid=43200)
            "001a0019000001a70000a8c040fdfd9ed6795000020000000000000000"
        val bytes = HexDump.hexStringToByteArray(replyHex)
        val packet = Dhcp6Packet.decode(bytes, bytes.size)
        assertTrue(packet is Dhcp6ReplyPacket)
        assertEquals(423, packet.prefixDelegation.minimalPreferredLifetime)
        assertEquals(43200, packet.prefixDelegation.minimalValidLifetime)
    }
}