1 /*
2  * Copyright (C) 2020 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package android.net.ipsec.ike.exceptions;
17 
18 import android.net.ipsec.ike.ChildSessionCallback;
19 import android.net.ipsec.ike.IkeSessionCallback;
20 
21 /**
22  * This exception is thrown if the remote server received a request for a nonexistent Child SA.
23  *
24  * <p>This exception is usually caused by a request collision. IKE library will handle it internally
25  * by deleting the Child SA (if it still exists).
26  *
27  * @see <a href="https://tools.ietf.org/html/rfc7296#section-2.25">RFC 7296, Internet Key Exchange
28  *     Protocol Version 2 (IKEv2)</a>
29  * @hide
30  */
31 public final class ChildSaNotFoundException extends IkeProtocolException {
32     private static final int EXPECTED_ERROR_DATA_LEN = 0;
33 
34     private final int mIpSecSpi;
35 
36     /**
37      * Construct an instance of ChildSaNotFoundException.
38      *
39      * <p>Except for testing, IKE library users normally do not instantiate this object themselves
40      * but instead get a reference via {@link IkeSessionCallback} or {@link ChildSessionCallback}.
41      *
42      * @param spi the SPI of the Child SA (IPsec SA) that does not exist.
43      */
ChildSaNotFoundException(int spi)44     public ChildSaNotFoundException(int spi) {
45         super(ERROR_TYPE_CHILD_SA_NOT_FOUND);
46         mIpSecSpi = spi;
47     }
48 
49     /**
50      * Construct a instance of ChildSaNotFoundException from a notify payload.
51      *
52      * @param spi the SPI of the Child SA (IPsec SA) that does not exist.
53      * @param notifyData the notify data included in the payload.
54      * @hide
55      */
ChildSaNotFoundException(int spi, byte[] notifyData)56     public ChildSaNotFoundException(int spi, byte[] notifyData) {
57         super(ERROR_TYPE_CHILD_SA_NOT_FOUND, notifyData);
58         mIpSecSpi = spi;
59     }
60 
61     /** @hide */
62     @Override
isValidDataLength(int dataLen)63     protected boolean isValidDataLength(int dataLen) {
64         return EXPECTED_ERROR_DATA_LEN == dataLen;
65     }
66 
67     /** Returns the SPI of the Child SA (IPsec SA) that does not exist. */
getIpSecSpi()68     public int getIpSecSpi() {
69         return mIpSecSpi;
70     }
71 }
72