Anjali K K | 4a694f6 | 2018-07-12 19:09:19 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-present Open Networking Laboratory |
| 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 org.onlab.packet; |
| 18 | |
| 19 | import java.nio.ByteBuffer; |
| 20 | import java.util.ArrayList; |
| 21 | import java.util.Arrays; |
| 22 | import java.util.List; |
| 23 | |
| 24 | /** |
| 25 | * Class representing MKPDU Live/Potential Peer List Parameter Set. |
| 26 | * IEEE 802.1X Clause 11; Figure 11-9 |
| 27 | */ |
| 28 | public class EAPOLMkpduPeerListParameterSet extends BasePacket implements EAPOLMkpduParameterSet { |
| 29 | |
| 30 | // Member Details |
| 31 | public static class MemberDetails { |
| 32 | byte[] memberID; |
| 33 | int messageNo; |
| 34 | |
| 35 | public MemberDetails(byte[] memberID, int messageNo) { |
| 36 | this.memberID = memberID; |
| 37 | this.messageNo = messageNo; |
| 38 | } |
| 39 | |
| 40 | public byte[] getMemberID() { |
| 41 | return memberID; |
| 42 | } |
| 43 | |
| 44 | public int getMessageNo() { |
| 45 | return messageNo; |
| 46 | } |
| 47 | } |
| 48 | |
| 49 | // Peer List Types |
Ray Milkey | fe6afd8 | 2018-11-26 14:03:20 -0800 | [diff] [blame] | 50 | private static final byte PEER_LIST_TYPE_LIVE = 1; |
| 51 | private static final byte PEER_LIST_TYPE_POTENTIAL = 2; |
Anjali K K | 4a694f6 | 2018-07-12 19:09:19 +0530 | [diff] [blame] | 52 | |
| 53 | // Type for distinguishing Live & Potential Lists. |
Ray Milkey | fe6afd8 | 2018-11-26 14:03:20 -0800 | [diff] [blame] | 54 | private byte peerListType = 1; |
| 55 | private short bodyLength; |
Anjali K K | 4a694f6 | 2018-07-12 19:09:19 +0530 | [diff] [blame] | 56 | |
| 57 | //Members |
| 58 | protected List<MemberDetails> members = new ArrayList<>(); |
| 59 | |
| 60 | @Override |
| 61 | public byte[] serialize() { |
| 62 | |
| 63 | // Don't Serialize if no members are available. |
| 64 | if (members.size() == 0) { |
| 65 | return null; |
| 66 | } |
| 67 | |
| 68 | // Serialize PeerList Parameter Set. IEEE 802.1x, Figure 11.9 |
| 69 | short length = getTotalLength(); |
| 70 | ByteBuffer data = ByteBuffer.wrap(new byte[length]); |
| 71 | |
| 72 | /* |
| 73 | *Populate fields |
| 74 | * Octet 1 |
| 75 | */ |
| 76 | data.put(peerListType); |
| 77 | |
| 78 | // Octet 2. Reserved. |
| 79 | byte octet = 0x00; |
| 80 | data.put(octet); |
| 81 | |
| 82 | // Octet 3 |
| 83 | length -= EAPOLMkpduParameterSet.BODY_LENGTH_OCTET_OFFSET; |
| 84 | octet |= (byte) (length >> BODY_LENGTH_MSB_SHIFT & BODY_LENGTH_MSB_MASK); |
| 85 | data.put(octet); |
| 86 | |
| 87 | // Octet 4 |
| 88 | data.put((byte) length); |
| 89 | |
| 90 | // Member details. |
| 91 | members.forEach(a -> { |
| 92 | data.put(a.getMemberID()); |
| 93 | data.putInt(a.getMessageNo()); |
| 94 | } |
| 95 | ); |
| 96 | |
| 97 | return data.array(); |
| 98 | } |
| 99 | |
| 100 | |
| 101 | /** |
| 102 | * Deserializer function for Peer List Parameter Set. |
| 103 | * |
| 104 | * @return deserializer function |
| 105 | */ |
| 106 | public static Deserializer<EAPOLMkpduPeerListParameterSet> deserializer() { |
| 107 | return (data, offset, length) -> { |
| 108 | |
| 109 | // Ensure buffer has enough details. |
| 110 | if (data == null) { |
| 111 | return null; |
| 112 | } |
| 113 | |
| 114 | // Deserialize Basic Parameter Set. |
| 115 | final ByteBuffer bb = ByteBuffer.wrap(data, offset, length); |
| 116 | EAPOLMkpduPeerListParameterSet peerListParameterSet = |
| 117 | new EAPOLMkpduPeerListParameterSet(); |
| 118 | |
| 119 | // Parse Peer List Fields/ |
| 120 | byte[] mbField = new byte[1]; |
| 121 | // mbField[0] = bb.get(); // Skip Type. Already processed in EAPOL-MKPDU de-serializer. |
| 122 | bb.get(); // Skip Reserved. |
| 123 | |
| 124 | // Length |
| 125 | mbField[0] = bb.get(); |
| 126 | short bodyLength = (short) (((short) (mbField[0] & EAPOLMkpduParameterSet.BODY_LENGTH_MSB_MASK)) |
| 127 | << EAPOLMkpduParameterSet.BODY_LENGTH_OCTET_OFFSET); |
| 128 | bodyLength |= (short) (bb.get()); |
| 129 | peerListParameterSet.setBodyLength(bodyLength); |
| 130 | |
| 131 | // Member details |
| 132 | while (bodyLength > 0) { |
| 133 | mbField = new byte[FIELD_MI_LENGTH]; |
| 134 | bb.get(mbField, 0, FIELD_MI_LENGTH); |
| 135 | peerListParameterSet.addMember(mbField, bb.getInt()); |
| 136 | bodyLength -= FIELD_MI_LENGTH + FIELD_MN_LENGTH; |
| 137 | } |
| 138 | return peerListParameterSet; |
| 139 | }; |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Setting List Type. |
| 144 | * |
| 145 | * @param peerListType type - PEERLIST_TYPE_LIVE or PEERLIST_TYPE_POTENTIAL for live |
| 146 | * and potential peer lists |
| 147 | */ |
| 148 | public void setPeerListType(byte peerListType) { |
Ray Milkey | fe6afd8 | 2018-11-26 14:03:20 -0800 | [diff] [blame] | 149 | if ((peerListType != EAPOLMkpduPeerListParameterSet.PEER_LIST_TYPE_LIVE) && |
| 150 | (peerListType != EAPOLMkpduPeerListParameterSet.PEER_LIST_TYPE_POTENTIAL)) { |
Anjali K K | 4a694f6 | 2018-07-12 19:09:19 +0530 | [diff] [blame] | 151 | throw new IllegalArgumentException("Unknown PeerList Type specified."); |
| 152 | } |
| 153 | this.peerListType = peerListType; |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Member details adding. |
| 158 | * |
| 159 | * @param mi ,type byte[] |
| 160 | * @param mn , type int |
| 161 | */ |
| 162 | public void addMember(byte[] mi, int mn) { |
| 163 | if (mi != null) { |
| 164 | members.add(new MemberDetails(mi, mn)); |
| 165 | } |
| 166 | return; |
| 167 | } |
| 168 | |
| 169 | /** |
| 170 | * Searching Member details. |
| 171 | * |
| 172 | * @param mi ,type byte[] |
| 173 | * @return boolean based on the value of member. |
| 174 | */ |
| 175 | public boolean memberExists(byte[] mi) { |
| 176 | MemberDetails member = members.stream() |
| 177 | .filter(m -> Arrays.equals(m.getMemberID(), mi)) |
| 178 | .findAny() |
| 179 | .orElse(null); |
| 180 | return (member != null) ? true : false; |
| 181 | } |
| 182 | |
| 183 | /** |
| 184 | * Member details. |
| 185 | * |
| 186 | * @return members |
| 187 | */ |
| 188 | public List<MemberDetails> getMembers() { |
| 189 | return members; |
| 190 | } |
| 191 | |
| 192 | @Override |
| 193 | public byte getParameterSetType() { |
| 194 | return peerListType; |
| 195 | } |
| 196 | |
| 197 | @Override |
| 198 | public short getTotalLength() { |
| 199 | return (short) (EAPOLMkpduParameterSet.BODY_LENGTH_OCTET_OFFSET + |
| 200 | members.size() * (EAPOLMkpduParameterSet.FIELD_MI_LENGTH + |
| 201 | EAPOLMkpduParameterSet.FIELD_MN_LENGTH)); |
| 202 | } |
| 203 | |
| 204 | @Override |
| 205 | public short getBodyLength() { |
| 206 | return bodyLength; |
| 207 | } |
| 208 | |
| 209 | /** |
| 210 | * Body Length. |
| 211 | * |
| 212 | * @param length ,type short |
| 213 | */ |
| 214 | public void setBodyLength(short length) { |
| 215 | this.bodyLength = length; |
| 216 | } |
| 217 | } |
| 218 | |