/*
 * Copyright (c) 2001-2008, 2011 Apple Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

#ifndef _EAP8021X_EAPOL_H
#define _EAP8021X_EAPOL_H

/* 
 * Modification History
 *
 * November 1, 2001	Dieter Siegmund (dieter@apple.com)
 * - created
 */

/*
 * EAPOL.h
 * - 802.1X EAPOL protocol definitions
 */
#include <stdint.h>
#include <string.h>

#define EAPOL_802_1_X_ETHERTYPE		0x888e
#define IEEE80211_PREAUTH_ETHERTYPE	0x88c7
#define EAPOL_802_1_X_PROTOCOL_VERSION	1
#define EAPOL_802_1_X_GROUP_ADDRESS	{ 0x01, 0x80, 0xc2, 0x00, 0x00, 0x03 }

typedef struct {
    uint8_t	protocol_version;
    uint8_t	packet_type;
    uint8_t	body_length[2];
    uint8_t	body[0];
} EAPOLPacket, * EAPOLPacketRef;

void
EAPOLPacketSetLength(EAPOLPacketRef pkt, uint16_t length);

uint16_t
EAPOLPacketGetLength(const EAPOLPacketRef pkt);

enum {
    kEAPOLPacketTypeEAPPacket = 0,
    kEAPOLPacketTypeStart = 1,
    kEAPOLPacketTypeLogoff = 2,
    kEAPOLPacketTypeKey = 3,
    kEAPOLPacketTypeEncapsulatedASFAlert = 4
};
typedef uint32_t EAPOLPacketType;

enum {
    kEAPOLKeyDescriptorTypeRC4 = 1,
    kEAPOLKeyDescriptorTypeIEEE80211 = 2
};
typedef uint32_t EAPOLKeyDescriptorType;

typedef struct {
    uint8_t		descriptor_type;
    uint8_t		key_length[2];
    uint8_t		replay_counter[8];
    uint8_t		key_IV[16];
    uint8_t		key_index;
    uint8_t		key_signature[16];
    uint8_t		key[0];
} EAPOLRC4KeyDescriptor, * EAPOLRC4KeyDescriptorRef;

typedef EAPOLRC4KeyDescriptor EAPOLKeyDescriptor, * EAPOLKeyDescriptorRef;

void
EAPOLRC4KeyDescriptorSetLength(EAPOLRC4KeyDescriptorRef pkt, uint16_t length);

void
EAPOLKeyDescriptorSetLength(EAPOLKeyDescriptorRef pkt, uint16_t length);

uint16_t
EAPOLRC4KeyDescriptorGetLength(const EAPOLRC4KeyDescriptorRef pkt);

uint16_t
EAPOLKeyDescriptorGetLength(const EAPOLKeyDescriptorRef pkt);

enum {
    kEAPOLKeyDescriptorIndexUnicastFlag = 0x80,
    kEAPOLKeyDescriptorIndexMask = 0x7f
};
typedef uint32_t EAPOLKeyDescriptorIndex;

typedef struct {
    uint8_t		descriptor_type;
    uint8_t		key_information[2];
    uint8_t		key_length[2];
    uint8_t		replay_counter[8];
    uint8_t		key_nonce[32];
    uint8_t		EAPOL_key_IV[16];
    uint8_t		key_RSC[8];
    uint8_t		key_reserved[8];
    uint8_t		key_MIC[16];
    uint8_t		key_data_length[2];
    uint8_t		key_data[0];
} EAPOLIEEE80211KeyDescriptor, * EAPOLIEEE80211KeyDescriptorRef;

uint16_t
EAPOLIEEE80211KeyDescriptorGetLength(const EAPOLIEEE80211KeyDescriptorRef pkt);

uint16_t
EAPOLIEEE80211KeyDescriptorGetInformation(const EAPOLIEEE80211KeyDescriptorRef pkt);

uint16_t
EAPOLIEEE80211KeyDescriptorGetKeyDataLength(const EAPOLIEEE80211KeyDescriptorRef pkt);

#endif /* _EAP8021X_EAPOL_H */