ACJoinState.c

/*******************************************************************************************
 * Copyright (c) 2006-7 Laboratorio di Sistemi di Elaborazione e Bioingegneria Informatica *
 *                      Universita' Campus BioMedico - Italy                               *
 *                                                                                         *
 * This program is free software; you can redistribute it and/or modify it under the terms *
 * of the GNU General Public License as published by the Free Software Foundation; either  *
 * version 2 of the License, or (at your option) any later version.                        *
 *                                                                                         *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY         *
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A         *
 * PARTICULAR PURPOSE. See the GNU General Public License for more details.                *
 *                                                                                         *
 * You should have received a copy of the GNU General Public License along with this       *
 * program; if not, write to the:                                                          *
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,                    *
 * MA  02111-1307, USA.                                                                    *
 *                                                                                         *
 * --------------------------------------------------------------------------------------- *
 * Project:  Capwap                                                                        *
 *                                                                                         *
 * Author :  Ludovico Rossi (ludo@bluepixysw.com)                                          *
 *           Del Moro Andrea (andrea_delmoro@libero.it)                                    *
 *           Giovannini Federica (giovannini.federica@gmail.com)                           *
 *           Massimo Vellucci (m.vellucci@unicampus.it)                                    *
 *           Mauro Bisson (mauro.bis@gmail.com)                                            *
 *******************************************************************************************/

#include "CWAC.h"

#ifdef DMALLOC
#include "../dmalloc-5.5.0/dmalloc.h"
#endif

CWBool CWAssembleJoinResponse(CWProtocolMessage ** messagesPtr,
			      int *fragmentsNumPtr, int PMTU, int seqNum, CWList msgElemList);

CWBool CWParseJoinRequestMessage(unsigned char *msg, int len, int *seqNumPtr, CWProtocolJoinRequestValues * valuesPtr);

CWBool CWSaveJoinRequestMessage(CWProtocolJoinRequestValues * joinRequest, CWWTPProtocolManager * WTPProtocolManager);

CWBool ACEnterJoin(int WTPIndex, CWProtocolMessage * msgPtr)
{
	int seqNum;
	CWProtocolJoinRequestValues joinRequest;
	CWList msgElemList = NULL;

	CWLog("\n");
	CWLog("######### Join State #########");

	if (msgPtr == NULL)
		return CWErrorRaise(CW_ERROR_WRONG_ARG, NULL);

	if (!(CWParseJoinRequestMessage(msgPtr->msg, msgPtr->offset, &seqNum, &joinRequest))) {
		/* note: we can kill our thread in case of out-of-memory
		 * error to free some space.
		 * we can see this just calling CWErrorGetLastErrorCode()
		 */
		return CW_FALSE;
	}
	// cancel waitJoin timer
	if (!CWTimerCancel(&(gWTPs[WTPIndex].currentTimer))) {
		return CW_FALSE;
	}

	CWBool ACIpv4List = CW_FALSE;
	CWBool ACIpv6List = CW_FALSE;
	CWBool resultCode = CW_TRUE;
	int resultCodeValue = CW_PROTOCOL_SUCCESS;
	/* CWBool sessionID = CW_FALSE; */

	if (!(CWSaveJoinRequestMessage(&joinRequest, &(gWTPs[WTPIndex].WTPProtocolManager)))) {

		resultCodeValue = CW_PROTOCOL_FAILURE_RES_DEPLETION;
	}

	CWMsgElemData *auxData;
	if (ACIpv4List) {
		CW_CREATE_OBJECT_ERR(auxData, CWMsgElemData, return CWErrorRaise(CW_ERROR_OUT_OF_MEMORY, NULL);
		    );
		auxData->type = CW_MSG_ELEMENT_AC_IPV4_LIST_CW_TYPE;
		auxData->value = 0;
		CWAddElementToList(&msgElemList, auxData);
	}
	if (ACIpv6List) {
		CW_CREATE_OBJECT_ERR(auxData, CWMsgElemData, return CWErrorRaise(CW_ERROR_OUT_OF_MEMORY, NULL);
		    );
		auxData->type = CW_MSG_ELEMENT_AC_IPV6_LIST_CW_TYPE;
		auxData->value = 0;
		CWAddElementToList(&msgElemList, auxData);
	}
	if (resultCode) {
		CW_CREATE_OBJECT_ERR(auxData, CWMsgElemData, return CWErrorRaise(CW_ERROR_OUT_OF_MEMORY, NULL);
		    );
		auxData->type = CW_MSG_ELEMENT_RESULT_CODE_CW_TYPE;
		auxData->value = resultCodeValue;
		CWAddElementToList(&msgElemList, auxData);
	}
	/*
	   if(sessionID){
	   CW_CREATE_OBJECT_ERR(auxData, CWMsgElemData, return CWErrorRaise(CW_ERROR_OUT_OF_MEMORY, NULL););
	   auxData->type =  CW_MSG_ELEMENT_SESSION_ID_CW_TYPE;
	   auxData->value = CWRandomIntInRange(0, INT_MAX);
	   CWAddElementToList(&msgElemList,auxData);
	   }
	 */

	/* random session ID */
	if (!(CWAssembleJoinResponse(&(gWTPs[WTPIndex].messages),
				     &(gWTPs[WTPIndex].messagesCount), gWTPs[WTPIndex].pathMTU, seqNum, msgElemList))) {

		CWDeleteList(&msgElemList, CWProtocolDestroyMsgElemData);
		return CW_FALSE;
	}

	CWDeleteList(&msgElemList, CWProtocolDestroyMsgElemData);

	if (!CWACSendFragments(WTPIndex)) {
		return CW_FALSE;
	}

	gWTPs[WTPIndex].currentState = CW_ENTER_CONFIGURE;

	return CW_TRUE;
}

/*
 * Assemble Join Response.
 */
CWBool CWAssembleJoinResponse(CWProtocolMessage ** messagesPtr,
			      int *fragmentsNumPtr, int PMTU, int seqNum, CWList msgElemList)
{

	CWProtocolMessage *msgElems = NULL;
	int msgElemCount = 0;
	/* Result code is not included because it's already
	 * in msgElemList. Control IPv6 to be added.
	 */
	const int mandatoryMsgElemCount = 4;
	CWProtocolMessage *msgElemsBinding = NULL;
	const int msgElemBindingCount = 0;
	int i;
	CWListElement *current;
	int k = -1;

	if (messagesPtr == NULL || fragmentsNumPtr == NULL || msgElemList == NULL)
		return CWErrorRaise(CW_ERROR_WRONG_ARG, NULL);

	msgElemCount = CWCountElementInList(msgElemList);

	CW_CREATE_PROTOCOL_MSG_ARRAY_ERR(msgElems,
					 msgElemCount + mandatoryMsgElemCount,
					 return CWErrorRaise(CW_ERROR_OUT_OF_MEMORY, NULL);
	    );

	CWDebugLog("Assembling Join Response...");

	if ((!(CWAssembleMsgElemACDescriptor(&(msgElems[++k])))) ||
	    (!(CWAssembleMsgElemACName(&(msgElems[++k])))) ||
	    (!(CWAssembleMsgElemCWControlIPv4Addresses(&(msgElems[++k])))) ||
	    (!(CWAssembleMsgElemACWTPRadioInformation(&(msgElems[++k]))))
	    ) {
		CWErrorHandleLast();
		int i;
		for (i = 0; i <= k; i++) {
			CW_FREE_PROTOCOL_MESSAGE(msgElems[i]);
		}
		CW_FREE_OBJECT(msgElems);
		/* error will be handled by the caller */
		return CW_FALSE;
	}

	current = msgElemList;
	for (i = 0; i < msgElemCount; i++) {

		switch (((CWMsgElemData *) (current->data))->type) {

		case CW_MSG_ELEMENT_AC_IPV4_LIST_CW_TYPE:
			if (!(CWAssembleMsgElemACIPv4List(&(msgElems[++k]))))
				goto cw_assemble_error;
			break;
		case CW_MSG_ELEMENT_AC_IPV6_LIST_CW_TYPE:
			if (!(CWAssembleMsgElemACIPv6List(&(msgElems[++k]))))
				goto cw_assemble_error;
			break;
		case CW_MSG_ELEMENT_RESULT_CODE_CW_TYPE:
			if (!(CWAssembleMsgElemResultCode(&(msgElems[++k]), ((CWMsgElemData *) current->data)->value)))
				goto cw_assemble_error;
			break;
			/*
			   case CW_MSG_ELEMENT_SESSION_ID_CW_TYPE:
			   if (!(CWAssembleMsgElemSessionID(&(msgElems[++k]), ((CWMsgElemData *) current->data)->value)))
			   goto cw_assemble_error;
			   break;
			 */
		default:{
				int j;
				for (j = 0; j <= k; j++) {
					CW_FREE_PROTOCOL_MESSAGE(msgElems[j]);
				}
				CW_FREE_OBJECT(msgElems);
				return CWErrorRaise(CW_ERROR_INVALID_FORMAT,
						    "Unrecognized Message Element for Join Response Message");
				break;
			}
		}
		current = current->next;
	}

	if (!(CWAssembleMessage(messagesPtr,
				fragmentsNumPtr,
				PMTU,
				seqNum,
				CW_MSG_TYPE_VALUE_JOIN_RESPONSE,
				msgElems, msgElemCount + mandatoryMsgElemCount, msgElemsBinding, msgElemBindingCount)))
	    return CW_FALSE;

	CWDebugLog("Join Response Assembled");

	return CW_TRUE;

 cw_assemble_error:{
		int i;
		for (i = 0; i <= k; i++) {
			CW_FREE_PROTOCOL_MESSAGE(msgElems[i]);
		}
		CW_FREE_OBJECT(msgElems);
		/* error will be handled by the caller */
		return CW_FALSE;
	}
	return CW_TRUE;
}

/*
 * Parses Join Request.
 */
CWBool CWParseJoinRequestMessage(unsigned char *msg, int len, int *seqNumPtr, CWProtocolJoinRequestValues * valuesPtr)
{

	CWControlHeaderValues controlVal;
	int offsetTillMessages;
	CWProtocolMessage completeMsg;
	unsigned char RadioInfoABGN;

	if (msg == NULL || seqNumPtr == NULL || valuesPtr == NULL)
		return CWErrorRaise(CW_ERROR_WRONG_ARG, NULL);

	CWDebugLog("Parse Join Request");

	completeMsg.msg = msg;
	completeMsg.offset = 0;

	if (!(CWParseControlHeader(&completeMsg, &controlVal)))
		/* will be handled by the caller */
		return CW_FALSE;

	/* different type */
	if (controlVal.messageTypeValue != CW_MSG_TYPE_VALUE_JOIN_REQUEST)
		return CWErrorRaise(CW_ERROR_INVALID_FORMAT, "Message is not Join Request as Expected");

	*seqNumPtr = controlVal.seqNum;
	/* skip timestamp */
	controlVal.msgElemsLen -= CW_CONTROL_HEADER_OFFSET_FOR_MSG_ELEMS;
	offsetTillMessages = completeMsg.offset;

	/* parse message elements */
	while ((completeMsg.offset - offsetTillMessages) < controlVal.msgElemsLen) {

		unsigned short int elemType = 0;	/* = CWProtocolRetrieve32(&completeMsg); */
		unsigned short int elemLen = 0;	/* = CWProtocolRetrieve16(&completeMsg); */

		CWParseFormatMsgElem(&completeMsg, &elemType, &elemLen);

		/* CWDebugLog("Parsing Message Element: %u, elemLen: %u", elemType, elemLen); */

		switch (elemType) {
		case CW_MSG_ELEMENT_LOCATION_DATA_CW_TYPE:
			if (!(CWParseLocationData(&completeMsg, elemLen, &(valuesPtr->location))))
				/* will be handled by the caller */
				return CW_FALSE;
			break;

		case CW_MSG_ELEMENT_WTP_BOARD_DATA_CW_TYPE:
			if (!(CWParseWTPBoardData(&completeMsg, elemLen, &(valuesPtr->WTPBoardData))))
				/* will be handled by the caller */
				return CW_FALSE;
			break;

		case CW_MSG_ELEMENT_SESSION_ID_CW_TYPE:
			valuesPtr->sessionID = CWParseSessionID(&completeMsg, elemLen);
			break;

		case CW_MSG_ELEMENT_WTP_DESCRIPTOR_CW_TYPE:
			if (!(CWParseWTPDescriptor(&completeMsg, elemLen, &(valuesPtr->WTPDescriptor))))
				/* will be handled by the caller */
				return CW_FALSE;
			break;

		case CW_MSG_ELEMENT_WTP_IPV4_ADDRESS_CW_TYPE:
			if (!(CWParseWTPIPv4Address(&completeMsg, elemLen, valuesPtr)))
				/* will be handled by the caller */
				return CW_FALSE;
			break;

		case CW_MSG_ELEMENT_WTP_NAME_CW_TYPE:
			if (!(CWParseWTPName(&completeMsg, elemLen, &(valuesPtr->name))))
				/* will be handled by the caller */
				return CW_FALSE;
			break;

		case CW_MSG_ELEMENT_WTP_FRAME_TUNNEL_MODE_CW_TYPE:
			if (!(CWParseWTPFrameTunnelMode(&completeMsg, elemLen, &(valuesPtr->frameTunnelMode))))
				/* will be handled by the caller */
				return CW_FALSE;
			break;

		case CW_MSG_ELEMENT_WTP_MAC_TYPE_CW_TYPE:
			if (!(CWParseWTPMACType(&completeMsg, elemLen, &(valuesPtr->MACType))))
				/* will be handled by the caller */
				return CW_FALSE;
			break;

		case CW_MSG_ELEMENT_IEEE80211_WTP_RADIO_INFORMATION_CW_TYPE:
			if (!(CWParseWTPRadioInformation(&completeMsg, elemLen, &RadioInfoABGN)))
				return CW_FALSE;
			break;

		default:
			completeMsg.offset += elemLen;
			CWLog("Unrecognized Message Element(%d) in Discovery response", elemType);
			break;
		}
		/*CWDebugLog("bytes: %d/%d", (completeMsg.offset-offsetTillMessages), controlVal.msgElemsLen); */
	}

	if (completeMsg.offset != len)
		return CWErrorRaise(CW_ERROR_INVALID_FORMAT, "Garbage at the End of the Message");

	return CW_TRUE;
}

CWBool CWSaveJoinRequestMessage(CWProtocolJoinRequestValues * joinRequest, CWWTPProtocolManager * WTPProtocolManager)
{

	CWDebugLog("Saving Join Request...");

	if (joinRequest == NULL || WTPProtocolManager == NULL)
		return CWErrorRaise(CW_ERROR_WRONG_ARG, NULL);

	if ((joinRequest->location) != NULL) {

		CW_FREE_OBJECT(WTPProtocolManager->locationData);
		WTPProtocolManager->locationData = joinRequest->location;
	} else
		return CWErrorRaise(CW_ERROR_WRONG_ARG, NULL);

	if ((joinRequest->name) != NULL) {

		CW_FREE_OBJECT(WTPProtocolManager->name);
		WTPProtocolManager->name = joinRequest->name;
	} else
		return CWErrorRaise(CW_ERROR_WRONG_ARG, NULL);

	CW_FREE_OBJECT((WTPProtocolManager->WTPBoardData).vendorInfos);
	WTPProtocolManager->WTPBoardData = joinRequest->WTPBoardData;

	WTPProtocolManager->sessionID = joinRequest->sessionID;
	WTPProtocolManager->ipv4Address = joinRequest->addr;

	WTPProtocolManager->descriptor = joinRequest->WTPDescriptor;
	WTPProtocolManager->radiosInfo.radioCount = (joinRequest->WTPDescriptor).radiosInUse;
	CW_FREE_OBJECT(WTPProtocolManager->radiosInfo.radiosInfo);

	CW_CREATE_ARRAY_ERR(WTPProtocolManager->radiosInfo.radiosInfo,
			    WTPProtocolManager->radiosInfo.radioCount,
			    CWWTPRadioInfoValues, return CWErrorRaise(CW_ERROR_OUT_OF_MEMORY, NULL);
	    );

	int i;

	for (i = 0; i < WTPProtocolManager->radiosInfo.radioCount; i++) {

		WTPProtocolManager->radiosInfo.radiosInfo[i].radioID = i;
		/*WTPProtocolManager->radiosInfo.radiosInfo[i].stationCount = 0; */
		/* default value for CAPWAP */
		WTPProtocolManager->radiosInfo.radiosInfo[i].adminState = ENABLED;
		WTPProtocolManager->radiosInfo.radiosInfo[i].adminCause = AD_NORMAL;
		WTPProtocolManager->radiosInfo.radiosInfo[i].operationalState = DISABLED;
		WTPProtocolManager->radiosInfo.radiosInfo[i].operationalCause = OP_NORMAL;
		WTPProtocolManager->radiosInfo.radiosInfo[i].TxQueueLevel = 0;
		WTPProtocolManager->radiosInfo.radiosInfo[i].wirelessLinkFramesPerSec = 0;
	}
	CWDebugLog("Join Request Saved");
	return CW_TRUE;
}