1 /*
2  * Copyright (C) 2018 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.annotation.NonNull;
19 import android.net.ipsec.ike.ChildSessionCallback;
20 import android.net.ipsec.ike.IkeSessionCallback;
21 
22 import com.android.internal.net.ipsec.ike.utils.IkeMetrics;
23 
24 /**
25  * This exception is thrown if a SA proposal negotiation failed.
26  *
27  * <p>This exception indicates that either none of SA proposals from caller is acceptable or the
28  * negotiated SA proposal from the remote server is invalid.
29  *
30  * @see <a href="https://tools.ietf.org/html/rfc7296#section-2.7">RFC 7296, Internet Key Exchange
31  *     Protocol Version 2 (IKEv2)</a>
32  * @hide
33  */
34 // Include the NO_PROPOSAL_CHOSEN Notify payload in an encrypted response message if received
35 // message is an encrypted request from SA initiator.
36 public final class NoValidProposalChosenException extends IkeProtocolException {
37     private static final int EXPECTED_ERROR_DATA_LEN = 0;
38 
39     /**
40      * Construct an instance of NoValidProposalChosenException.
41      *
42      * <p>Except for testing, IKE library users normally do not instantiate this object themselves
43      * but instead get a reference via {@link IkeSessionCallback} or {@link ChildSessionCallback}.
44      *
45      * @param message the descriptive message (which is saved for later retrieval by the {@link
46      *     #getMessage()} method).
47      */
NoValidProposalChosenException(@onNull String message)48     public NoValidProposalChosenException(@NonNull String message) {
49         super(ERROR_TYPE_NO_PROPOSAL_CHOSEN, message);
50     }
51 
52     /**
53      * Construct an instance of NoValidProposalChosenException.
54      *
55      * <p>Except for testing, IKE library users normally do not instantiate this object themselves
56      * but instead get a reference via {@link IkeSessionCallback} or {@link ChildSessionCallback}.
57      *
58      * @param message the descriptive message (which is saved for later retrieval by the {@link
59      *     #getMessage()} method).
60      * @param cause the cause (which is saved for later retrieval by the {@link #getCause()}
61      *     method).
62      */
NoValidProposalChosenException(@onNull String message, @NonNull Throwable cause)63     public NoValidProposalChosenException(@NonNull String message, @NonNull Throwable cause) {
64         super(ERROR_TYPE_NO_PROPOSAL_CHOSEN, cause);
65     }
66 
67     /**
68      * Construct a instance of NoValidProposalChosenException from a notify payload.
69      *
70      * @param notifyData the notify data included in the payload.
71      * @hide
72      */
NoValidProposalChosenException(byte[] notifyData)73     public NoValidProposalChosenException(byte[] notifyData) {
74         super(ERROR_TYPE_NO_PROPOSAL_CHOSEN, notifyData);
75     }
76 
77     /** @hide */
78     @Override
isValidDataLength(int dataLen)79     protected boolean isValidDataLength(int dataLen) {
80         return EXPECTED_ERROR_DATA_LEN == dataLen;
81     }
82 
83     /**
84      * Returns the error code for metrics
85      *
86      * @hide
87      */
88     @Override
getMetricsErrorCode()89     public int getMetricsErrorCode() {
90         return IkeMetrics.IKE_ERROR_PROTOCOL_NO_PROPOSAL_CHOSEN;
91     }
92 }
93