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 import android.annotation.Nullable; 20 import android.net.eap.EapInfo; 21 22 /** 23 * IEapCallback represents a Callback interface to be implemented by clients of the 24 * {@link EapAuthenticator}. 25 * 26 * <p>Exactly one of these callbacks will be called for each message processed by the 27 * {@link EapAuthenticator}. 28 * 29 * @see <a href="https://tools.ietf.org/html/rfc3748#section-4">RFC 3748, Extensible Authentication 30 * Protocol (EAP)</a> 31 */ 32 public interface IEapCallback { 33 /** 34 * Callback used to indicate that the EAP Authentication session was successful. 35 * 36 * @param msk The Master Session Key (MSK) generated in the session 37 * @param emsk The Extended Master Session Key (EMSK) generated in the session 38 * @param eapInfo EAP information {@link EapInfo} 39 */ onSuccess(byte[] msk, byte[] emsk, @Nullable EapInfo eapInfo)40 void onSuccess(byte[] msk, byte[] emsk, @Nullable EapInfo eapInfo); 41 42 /** 43 * Callback used to indicate that the EAP Authentication Session was unsuccessful. 44 */ onFail()45 void onFail(); 46 47 /** 48 * Callback used to return an EAP-Response message for the message being processed. 49 * 50 * @param eapMsg byte-array encoded EAP-Response message to be sent to the Authentication server 51 * @param flagMask contains flags that convey additional high level EAP state information that 52 * is relevant to the clients. Clients can use 53 * {@link com.android.internal.net.eap.EapResult.EapResponse.hasFlag() to check if a 54 * specific flag is set in the flagMask. The flagMask is set 0 when no flags are set. 55 */ onResponse(byte[] eapMsg, int flagMask)56 void onResponse(byte[] eapMsg, int flagMask); 57 58 /** 59 * Callback used to indicate that there was an error processing the current EAP message. 60 * 61 * @param cause The cause of the processing error 62 */ onError(Throwable cause)63 void onError(Throwable cause); 64 } 65