vpn_interface.h

Radius PNE 3.3 source code, running at more than vxworks6.x version.

/* vpn_interface.h - vpn interface */

/* Copyright 1999 - 2005 Wind River Systems, Inc. */

#include "copyright_wrs.h"

/*
modification history
--------------------
01a,25feb05,ijm moved to radius directory
*/


/*
  $Log: vpn_interface.h,v $
  Revision 1.1.1.1.2.1  2002/12/11 15:11:27  ramesh
  o Contains SPR fixes

  Revision 1.1.1.1	2002/06/18 06:49:23  rashanmu
  Checking in WindRiver L2TP base. The structure under WRSL2TP_BASE directory 
  is as follows

   a.	 WrsL2TP - Source Code, Release nodes and guide.
   b.	 WrsRadius - Source Code, Release nodes and guide.
   c.	 WrsIPv6  - Release Notes and Guide of IPv6
   d.	 WrsZip - Contains PPP Setup Zip and Patch. Also L2tp, Radius Zips.
   e.	 WrsGeneral - Contains all the other Project related documents and Mails.

  -- Updated by Ramesh, 12.30PM Jun 18th 2002 --


 * 
 * 1	 9/21/00 5:23p Mduong
 * 5	 6/22/00 2:00p Minh
 * Remove destination ip address parameter from fp_open_incoming_vpn()
 * 
 * 4	 8/20/99 4:25p Nishit
 * Data exchange functions use BYTE* now instead of void*
 * 
 * 3	 2/11/99 11:16a Nishit
 * Support added for passing the Result code to VPN user in case of tunnel/session termination
 * 
 * 2	 2/03/99 8:26a Nishit
 * Added prototype for l2tp_get_vpn_interface()
 * 
 * 1	 10/08/98 4:36p Nishit
 * Initial check-in
*/
/************************************************************************/
/*	Copyright (C) 1998 RouterWare, Inc. 									  */
/*	Unpublished - rights reserved under the Copyright Laws of the			*/
/*	United States.	Use, duplication, or disclosure by the					*/
/*	Government is subject to restrictions as set forth in					*/
/*	subparagraph (c)(1)(ii) of the Rights in Technical Data and 			*/
/*	Computer Software clause at 252.227-7013.										*/
/*	RouterWare, Inc., 3961 MacArthur Suite 212 Newport Beach, CA 92660	*/
/************************************************************************/
#if !defined (__VPN_INTERFACE_H__)
	#define __VPN_INTERFACE_H__

enum VPN_TERMINATION_REASON
{
	VPN_INVALID_SESSION_TERMINATION_CODE = 1,
	VPN_SESSION_TERMINATED_BY_PEER,
	VPN_SESSION_TERMINATED_BY_USER,
	VPN_SESSION_TERMINATED_DUE_TO_BAD_CONTROL_PACKET_RECEIVED,
	VPN_TUNNEL_INVALID_LNS,
	VPN_TUNNEL_AUTHENTICATION_ERROR,
	VPN_TUNNEL_OTHER_ERROR,
	VPN_TUNNEL_TERMINATED_BY_PEER,
	VPN_TUNNEL_TERMINATED_BY_LOCAL_ADMIN,
	VPN_TUNNEL_TIMEOUT,
	VPN_OUT_OF_RESOURCES,
	/* Added the dummy enum to initialize PPP LAC's termination
	   reason field on stack construction */
	VPN_TERMINATION_REASON_UNUSED
};

enum TUNNEL_SELECTOR
{
	NO_SELECTOR=0,
	RADIUS_ATTRIBUTES,
	LNS_IP_ADDRESS,
	LOCAL_TUNNEL_ID
};

typedef struct L2TP_PPP_CONFIG
{
	BOOL ppp_attributes_available;
	BOOL proxy_lcp_available;
	BOOL proxy_auth_available;
} L2TP_PPP_CONFIG;

typedef struct VPN_INTERFACE_CALLBACK_FUNCTIONS
{
	TEST		(*fp_incoming_vpn_open_complete) (UINT vpn_user_handle, UINT vpn_protocol_handle);
	TEST		(*fp_close_vpn_session) (UINT vpn_user_handle, enum VPN_TERMINATION_REASON reason, const char* cp_peer_message, 
							UINT message_length); /* when termination initiated by the VPN protocol */
	TEST		(*fp_send_data_to_vpn_user) (UINT vpn_user_handle, M_BLK_ID p_mblk_data);
} VPN_INTERFACE_CALLBACK_FUNCTIONS;

/* following implemented in the VPN protocol */

typedef struct VPN_INTERFACE
{
	TEST (*fp_open_incoming_vpn) (UINT vpn_user_handle, enum TUNNEL_SELECTOR selector, void *pSelectionInfo,
			L2TP_PPP_CONFIG *pPPPConfig, const VPN_INTERFACE_CALLBACK_FUNCTIONS *p_callback_functions);
	TEST	(*fp_user_initiated_vpn_session_termination) (UINT vpn_protocol_handle); /* when termination initiated by the VPN user protocol */
	TEST	(*fp_send_data_to_vpn) (UINT vpn_protocol_handle, M_BLK_ID p_mblk_data);
} VPN_INTERFACE;

VPN_INTERFACE *l2tp_get_vpn_interface (void);

#endif /* __VPN_INTERFACE_H__ */