chap.h

Go to the documentation of this file.

 
#ifndef _CHAP_H
#define _CHAP_H
 
//Dependencies
#include "core/net.h"
#include "ppp/ppp.h"
 
//CHAP authentication support
#ifndef CHAP_SUPPORT
   #define CHAP_SUPPORT DISABLED
#elif (CHAP_SUPPORT != ENABLED && CHAP_SUPPORT != DISABLED)
   #error CHAP_SUPPORT parameter is not valid
#endif
 
//Restart timer
#ifndef CHAP_RESTART_TIMER
   #define CHAP_RESTART_TIMER 3000
#elif (CHAP_RESTART_TIMER < 1000)
   #error CHAP_RESTART_TIMER parameter is not valid
#endif
 
//Maximum number of retransmissions for Challenge packets
#ifndef CHAP_MAX_CHALLENGES
   #define CHAP_MAX_CHALLENGES 5
#elif (CHAP_MAX_CHALLENGES < 1)
   #error CHAP_MAX_CHALLENGES parameter is not valid
#endif
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
   CHAP_STATE_0_INITIAL        = 0,
   CHAP_STATE_1_STARTED        = 1,
   CHAP_STATE_2_CHALLENGE_SENT = 2,
   CHAP_STATE_3_CHALLENGE_RCVD = 3,
   CHAP_STATE_4_RESPONSE_SENT  = 4,
   CHAP_STATE_5_RESPONSE_RCVD  = 5,
   CHAP_STATE_6_SUCCESS_SENT   = 6,
   CHAP_STATE_7_SUCCESS_RCVD   = 7,
   CHAP_STATE_8_FAILURE_SENT   = 8,
   CHAP_STATE_9_FAILURE_RCVD   = 9
} ChapState;
 
 
typedef enum
{
   CHAP_CODE_CHALLENGE = 1, 
   CHAP_CODE_RESPONSE  = 2, 
   CHAP_CODE_SUCCESS   = 3, 
   CHAP_CODE_FAILURE   = 4  
} ChapCode;
 
 
typedef enum
{
   CHAP_ALGO_ID_CHAP_MD5   = 5,   //CHAP with MD5
   CHAP_ALGO_ID_MS_CHAP    = 128, //MS-CHAP
   CHAP_ALGO_ID_MS_CHAP_V2 = 129  //MS-CHAP-2
} ChapAlgoId;
 
 
//CodeWarrior or Win32 compiler?
#if defined(__CWCC__) || defined(_WIN32)
   #pragma pack(push, 1)
#endif
 
 
typedef __packed_struct
{
   uint8_t code;       //0
   uint8_t identifier; //1
   uint16_t length;    //2-3
   uint8_t valueSize;  //4
   uint8_t value[];    //5
} ChapChallengePacket;
 
 
typedef __packed_struct
{
   uint8_t code;       //0
   uint8_t identifier; //1
   uint16_t length;    //2-3
   uint8_t valueSize;  //4
   uint8_t value[];    //5
} ChapResponsePacket;
 
 
typedef __packed_struct
{
   uint8_t code;       //0
   uint8_t identifier; //1
   uint16_t length;    //2-3
   uint8_t message[];  //4
} ChapSuccessPacket;
 
 
typedef __packed_struct
{
   uint8_t code;       //0
   uint8_t identifier; //1
   uint16_t length;    //2-3
   uint8_t message[];  //4
} ChapFailurePacket;
 
 
//CodeWarrior or Win32 compiler?
#if defined(__CWCC__) || defined(_WIN32)
   #pragma pack(pop)
#endif
 
 
typedef struct
{
   uint_t localState;       
   uint8_t localIdentifier; 
   uint_t peerState;        
   uint8_t peerIdentifier;  
   uint_t restartCounter;   
   systime_t timestamp;     
   uint8_t challenge[16];   
   const uint8_t *response; 
} ChapFsm;
 
 
//CHAP related functions
error_t chapStartAuth(PppContext *context);
error_t chapAbortAuth(PppContext *context);
 
void chapTick(PppContext *context);
 
void chapProcessPacket(PppContext *context,
   const PppPacket *packet, size_t length);
 
error_t chapProcessChallenge(PppContext *context,
   const ChapChallengePacket *challengePacket, size_t length);
 
error_t chapProcessResponse(PppContext *context,
   const ChapResponsePacket *responsePacket, size_t length);
 
error_t chapProcessSuccess(PppContext *context,
   const ChapSuccessPacket *successPacket, size_t length);
 
error_t chapProcessFailure(PppContext *context,
   const ChapFailurePacket *failurePacket, size_t length);
 
error_t chapSendChallenge(PppContext *context);
error_t chapSendResponse(PppContext *context, const uint8_t *value);
error_t chapSendSuccess(PppContext *context);
error_t chapSendFailure(PppContext *context);
 
bool_t chapCheckPassword(PppContext *context, const char_t *password);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif