ONOS-512: Implement IPv6 Extension Headers
* Create IExtensionHeader interface
- setNextHeader, getNextHeader interface for all extension header classes
- Except EncapSecurityPayload, in which the nextHeader field is encrypted
* Create BaseOptions class
- Super class of HopByHopOptions and DestinationOptions, since these two are very similar
* Implement following classes with unit test
- HopByHopOptions
- DestinationOptions
- Fragment
- Routing
- Authentication
- EncapSecurityPayload
Change-Id: If65894eccf20ac90f04bc2b0cb42aac6dd5a9674
diff --git a/utils/misc/src/main/java/org/onlab/packet/ipv6/Authentication.java b/utils/misc/src/main/java/org/onlab/packet/ipv6/Authentication.java
new file mode 100644
index 0000000..d4c741f
--- /dev/null
+++ b/utils/misc/src/main/java/org/onlab/packet/ipv6/Authentication.java
@@ -0,0 +1,262 @@
+/*
+ * Copyright 2014-2015 Open Networking Laboratory
+ *
+ * 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 org.onlab.packet.ipv6;
+
+import org.onlab.packet.BasePacket;
+import org.onlab.packet.Data;
+import org.onlab.packet.IPacket;
+import org.onlab.packet.IPv6;
+import java.nio.ByteBuffer;
+import java.util.Arrays;
+
+/**
+ * Implements IPv6 authentication extension header format. (RFC 4302)
+ */
+public class Authentication extends BasePacket implements IExtensionHeader {
+ public static final byte FIXED_HEADER_LENGTH = 12; // bytes
+ public static final byte LENGTH_UNIT = 4; // bytes per unit
+ public static final byte MINUS = 2;
+
+ protected byte nextHeader;
+ protected byte payloadLength;
+ protected int securityParamIndex;
+ protected int sequence;
+ protected byte[] integrityCheck;
+
+ @Override
+ public byte getNextHeader() {
+ return this.nextHeader;
+ }
+
+ @Override
+ public Authentication setNextHeader(final byte nextHeader) {
+ this.nextHeader = nextHeader;
+ return this;
+ }
+
+ /**
+ * Gets the payload length of this header.
+ *
+ * @return the payload length
+ */
+ public byte getPayloadLength() {
+ return this.payloadLength;
+ }
+
+ /**
+ * Sets the payload length of this header.
+ *
+ * @param payloadLength the payload length to set
+ * @return this
+ */
+ public Authentication setPayloadLength(final byte payloadLength) {
+ this.payloadLength = payloadLength;
+ return this;
+ }
+
+ /**
+ * Gets the security parameter index of this header.
+ *
+ * @return the security parameter index
+ */
+ public int getSecurityParamIndex() {
+ return this.securityParamIndex;
+ }
+
+ /**
+ * Sets the security parameter index of this header.
+ *
+ * @param securityParamIndex the security parameter index to set
+ * @return this
+ */
+ public Authentication setSecurityParamIndex(final int securityParamIndex) {
+ this.securityParamIndex = securityParamIndex;
+ return this;
+ }
+
+ /**
+ * Gets the sequence number of this header.
+ *
+ * @return the sequence number
+ */
+ public int getSequence() {
+ return this.sequence;
+ }
+
+ /**
+ * Sets the sequence number of this header.
+ *
+ * @param sequence the sequence number to set
+ * @return this
+ */
+ public Authentication setSequence(final int sequence) {
+ this.sequence = sequence;
+ return this;
+ }
+
+ /**
+ * Gets the integrity check value of this header.
+ *
+ * @return the integrity check value
+ */
+ public byte[] getIntegrityCheck() {
+ return this.integrityCheck;
+ }
+
+ /**
+ * Sets the integrity check value of this header.
+ *
+ * @param integrityCheck the integrity check value to set
+ * @return this
+ */
+ public Authentication setIngegrityCheck(final byte[] integrityCheck) {
+ this.integrityCheck =
+ Arrays.copyOfRange(integrityCheck, 0, integrityCheck.length);
+ return this;
+ }
+
+ /**
+ * Gets the total length of this header.
+ * According to spec, payload length should be the total length of this AH
+ * in 4-octet unit, minus 2
+ *
+ * @return the total length
+ */
+ public int getTotalLength() {
+ return (this.payloadLength + MINUS) * LENGTH_UNIT;
+ }
+
+ @Override
+ public byte[] serialize() {
+ byte[] payloadData = null;
+ if (this.payload != null) {
+ this.payload.setParent(this);
+ payloadData = this.payload.serialize();
+ }
+
+ int headerLength = FIXED_HEADER_LENGTH + integrityCheck.length;
+ int payloadLength = 0;
+ if (payloadData != null) {
+ payloadLength = payloadData.length;
+ }
+
+ final byte[] data = new byte[headerLength + payloadLength];
+ final ByteBuffer bb = ByteBuffer.wrap(data);
+
+ bb.put(this.nextHeader);
+ bb.put(this.payloadLength);
+ bb.putShort((short) 0);
+ bb.putInt(this.securityParamIndex);
+ bb.putInt(this.sequence);
+ bb.put(this.integrityCheck, 0, integrityCheck.length);
+
+ if (payloadData != null) {
+ bb.put(payloadData);
+ }
+
+ if (this.parent != null && this.parent instanceof IExtensionHeader) {
+ ((IExtensionHeader) this.parent).setNextHeader(IPv6.PROTOCOL_AH);
+ }
+ return data;
+ }
+
+ @Override
+ public IPacket deserialize(byte[] data, int offset, int length) {
+ final ByteBuffer bb = ByteBuffer.wrap(data, offset, length);
+ this.nextHeader = bb.get();
+ this.payloadLength = bb.get();
+ bb.getShort();
+ this.securityParamIndex = bb.getInt();
+ this.sequence = bb.getInt();
+ int icvLength = getTotalLength() - FIXED_HEADER_LENGTH;
+ this.integrityCheck = new byte[icvLength];
+ bb.get(this.integrityCheck, 0, icvLength);
+
+ IPacket payload;
+ if (IPv6.PROTOCOL_CLASS_MAP.containsKey(this.nextHeader)) {
+ final Class<? extends IPacket> clazz = IPv6.PROTOCOL_CLASS_MAP
+ .get(this.nextHeader);
+ try {
+ payload = clazz.newInstance();
+ } catch (final Exception e) {
+ throw new RuntimeException(
+ "Error parsing payload for Authentication packet", e);
+ }
+ } else {
+ payload = new Data();
+ }
+ this.payload = payload.deserialize(data, bb.position(),
+ bb.limit() - bb.position());
+ this.payload.setParent(this);
+
+ return this;
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see java.lang.Object#hashCode()
+ */
+ @Override
+ public int hashCode() {
+ final int prime = 5807;
+ int result = super.hashCode();
+ result = prime * result + this.nextHeader;
+ result = prime * result + this.payloadLength;
+ result = prime * result + this.securityParamIndex;
+ result = prime * result + this.sequence;
+ for (byte b : this.integrityCheck) {
+ result = prime * result + b;
+ }
+ return result;
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see java.lang.Object#equals(java.lang.Object)
+ */
+ @Override
+ public boolean equals(final Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (!super.equals(obj)) {
+ return false;
+ }
+ if (!(obj instanceof Authentication)) {
+ return false;
+ }
+ final Authentication other = (Authentication) obj;
+ if (this.nextHeader != other.nextHeader) {
+ return false;
+ }
+ if (this.payloadLength != other.payloadLength) {
+ return false;
+ }
+ if (this.securityParamIndex != other.securityParamIndex) {
+ return false;
+ }
+ if (this.sequence != other.sequence) {
+ return false;
+ }
+ if (!Arrays.equals(this.integrityCheck, other.integrityCheck)) {
+ return false;
+ }
+ return true;
+ }
+}