• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2019 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 
17 package com.android.internal.net.eap;
18 
19 /**
20  * IEapCallback represents a Callback interface to be implemented by clients of the
21  * {@link EapAuthenticator}.
22  *
23  * <p>Exactly one of these callbacks will be called for each message processed by the
24  * {@link EapAuthenticator}.
25  *
26  * @see <a href="https://tools.ietf.org/html/rfc3748#section-4">RFC 3748, Extensible Authentication
27  * Protocol (EAP)</a>
28  */
29 public interface IEapCallback {
30     /**
31      * Callback used to indicate that the EAP Authentication session was successful.
32      *
33      * @param msk The Master Session Key (MSK) generated in the session
34      * @param emsk The Extended Master Session Key (EMSK) generated in the session
35      */
onSuccess(byte[] msk, byte[] emsk)36     void onSuccess(byte[] msk, byte[] emsk);
37 
38     /**
39      * Callback used to indicate that the EAP Authentication Session was unsuccessful.
40      */
onFail()41     void onFail();
42 
43     /**
44      * Callback used to return an EAP-Response message for the message being processed.
45      *
46      * @param eapMsg byte-array encoded EAP-Response message to be sent to the Authentication server
47      */
onResponse(byte[] eapMsg)48     void onResponse(byte[] eapMsg);
49 
50     /**
51      * Callback used to indicate that there was an error processing the current EAP message.
52      *
53      * @param cause The cause of the processing error
54      */
onError(Throwable cause)55     void onError(Throwable cause);
56 }
57