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 import com.android.internal.net.ipsec.ike.utils.IkeMetrics;
22 
23 /**
24  * This exception is thrown if an IKE message was received with an unrecognized destination SPI.
25  *
26  * <p>This usually indicates that the message recipient has rebooted and forgotten the existence of
27  * an IKE SA.
28  *
29  * @see <a href="https://tools.ietf.org/html/rfc7296#section-2.21">RFC 7296, Internet Key Exchange
30  *     Protocol Version 2 (IKEv2)</a>
31  * @hide
32  */
33 public final class InvalidIkeSpiException extends IkeProtocolException {
34     private static final int EXPECTED_ERROR_DATA_LEN = 0;
35 
36     /**
37      * Construct an instance of InvalidIkeSpiException.
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      */
InvalidIkeSpiException()42     public InvalidIkeSpiException() {
43         super(ERROR_TYPE_INVALID_IKE_SPI);
44     }
45 
46     /**
47      * Construct a instance of InvalidIkeSpiException from a notify payload.
48      *
49      * @param notifyData the notify data included in the payload.
50      * @hide
51      */
InvalidIkeSpiException(byte[] notifyData)52     public InvalidIkeSpiException(byte[] notifyData) {
53         super(ERROR_TYPE_INVALID_IKE_SPI, notifyData);
54     }
55 
56     /** @hide */
57     @Override
isValidDataLength(int dataLen)58     protected boolean isValidDataLength(int dataLen) {
59         return EXPECTED_ERROR_DATA_LEN == dataLen;
60     }
61 
62     /**
63      * Returns the error code for metrics
64      *
65      * @hide
66      */
67     @Override
getMetricsErrorCode()68     public int getMetricsErrorCode() {
69         return IkeMetrics.IKE_ERROR_PROTOCOL_INVALID_IKE_SPI;
70     }
71 }
72