1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*
* Copyright (C) 2019 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.internal.net.eap.message;
import android.annotation.IntDef;
import android.annotation.NonNull;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
/**
* EapData represents the data-bytes of an EAP-Packet.
*
* <p>EapData objects will always have a Type-value and the Type-Data bytes that follow.
*
* EapData objects should be parsed from the Type and Type-Data sections of an EAP Packet, as shown
* below:
*
* +-----------------+-----------------+----------------------------------+
* | Code (1B) | Identifier (1B) | Length (2B) |
* +-----------------+-----------------+----------------------------------+
* | Type (1B) | Type-Data ...
* +-----------------+-----
*
* @see <a href="https://tools.ietf.org/html/rfc3748#section-4">RFC 3748, Extensible Authentication
* Protocol (EAP)</a>
*/
public class EapData {
@Retention(RetentionPolicy.SOURCE)
@IntDef({
EAP_IDENTITY,
EAP_NOTIFICATION,
EAP_NAK,
EAP_TYPE_SIM,
EAP_TYPE_AKA,
EAP_TYPE_MSCHAP_V2,
EAP_TYPE_AKA_PRIME
})
public @interface EapType {}
@Retention(RetentionPolicy.SOURCE)
@IntDef({
EAP_TYPE_SIM,
EAP_TYPE_AKA,
EAP_TYPE_MSCHAP_V2,
EAP_TYPE_AKA_PRIME
})
public @interface EapMethod {}
// EAP Type values defined by IANA
// https://www.iana.org/assignments/eap-numbers/eap-numbers.xhtml
public static final int EAP_IDENTITY = 1;
public static final int EAP_NOTIFICATION = 2;
public static final int EAP_NAK = 3;
// EAP_MD5_CHALLENGE unsupported, allowable based on RFC 3748, Section 5.4
public static final int EAP_TYPE_SIM = 18;
public static final int EAP_TYPE_AKA = 23;
public static final int EAP_TYPE_MSCHAP_V2 = 26;
public static final int EAP_TYPE_AKA_PRIME = 50;
public static final Map<Integer, String> EAP_TYPE_STRING = new HashMap<>();
static {
EAP_TYPE_STRING.put(EAP_IDENTITY, "Identity");
EAP_TYPE_STRING.put(EAP_NOTIFICATION, "Notification");
EAP_TYPE_STRING.put(EAP_NAK, "Nak");
EAP_TYPE_STRING.put(EAP_TYPE_SIM, "EAP-SIM");
EAP_TYPE_STRING.put(EAP_TYPE_AKA, "EAP-AKA");
EAP_TYPE_STRING.put(EAP_TYPE_MSCHAP_V2, "EAP-MSCHAP-V2");
EAP_TYPE_STRING.put(EAP_TYPE_AKA_PRIME, "EAP-AKA-PRIME");
}
private static final Set<Integer> SUPPORTED_TYPES = new HashSet<>();
static {
SUPPORTED_TYPES.add(EAP_IDENTITY);
SUPPORTED_TYPES.add(EAP_NOTIFICATION);
SUPPORTED_TYPES.add(EAP_NAK);
// supported EAP Method types
SUPPORTED_TYPES.add(EAP_TYPE_SIM);
SUPPORTED_TYPES.add(EAP_TYPE_AKA);
SUPPORTED_TYPES.add(EAP_TYPE_MSCHAP_V2);
SUPPORTED_TYPES.add(EAP_TYPE_AKA_PRIME);
}
@EapType public final int eapType;
public final byte[] eapTypeData;
public static final EapData NOTIFICATION_DATA = new EapData(EAP_NOTIFICATION, new byte[0]);
/**
* Constructs a new EapData instance.
*
* @param eapType the {@link EapType} for this EapData instance
* @param eapTypeData the Type-Data for this EapData instance
* @throws IllegalArgumentException if eapTypeData is null or if
* {@link EapData#isSupportedEapType} is false for the given eapType
*/
public EapData(@EapType int eapType, @NonNull byte[] eapTypeData) {
this.eapType = eapType;
this.eapTypeData = eapTypeData;
validate();
}
/**
* Gets the length of this EapData object.
*
* @return int for the number of bytes this EapData object represents
*/
public int getLength() {
// length of byte-array + 1 (for 1B type field)
return eapTypeData.length + 1;
}
/**
* Returns whether this instance is equal to the given Object o.
*
* @param o the Object to be tested for equality
* @return true iff this instance is equal to the given o
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || !(o instanceof EapData)) {
return false;
}
EapData eapData = (EapData) o;
return eapType == eapData.eapType
&& Arrays.equals(eapTypeData, eapData.eapTypeData);
}
/**
* Returns the hashCode value for this instance.
*
* @return the hashCode value for this instance
*/
@Override
public int hashCode() {
return Objects.hash(eapType, Arrays.hashCode(eapTypeData));
}
/**
* Puts the byte-encoding for this EapData instance into the given ByteBuffer.
*
* @param b the ByteBuffer to write this EapData instance to
*/
public void encodeToByteBuffer(ByteBuffer b) {
b.put((byte) eapType);
b.put(eapTypeData);
}
/**
* Returns whether the given eapType is a supported {@link EapType} value.
*
* @param eapType the value to be checked
* @return true iff the given eapType is a supported EAP Type
*/
public static boolean isSupportedEapType(int eapType) {
return SUPPORTED_TYPES.contains(eapType);
}
private void validate() {
if (this.eapTypeData == null) {
throw new IllegalArgumentException("EapTypeData byte[] must be non-null");
}
if (!isSupportedEapType(this.eapType)) {
throw new IllegalArgumentException("eapType must be be a valid @EapType value");
}
}
}
|
