sbc/opt/cisco-vpnclient/include/vpnapi.h

Go to the documentation of this file.

/* 
    note: the comments in this header file are used for automatic 
   documentation generation using doxygen (www.doxygen.org)
*/
#ifndef VPNAPI_H
#define VPNAPI_H

#ifdef __cplusplus
// *INDENT-OFF*
extern "C"
{
// *INDENT-ON*
#endif
#ifdef _WIN32
#include "windows_stdint.h"
#include <winsock.h>
#else
#include <inttypes.h>
#include <sys/types.h>
#include <netinet/in.h>
#endif

#ifdef _MSC_VER
/* disable warning: 
    nonstandard extension used: zero-sized array in struct/union
*/
#pragma warning( disable : 4200 )
#endif

#ifdef _WIN32
#define DLL_EXPORT_NAME __declspec(dllexport)
#define CDECLAPI __cdecl
#else
typedef int SOCKET;

#define CDECLAPI
#define DLL_EXPORT_NAME
#endif

#define VPNAPI_VERSION 0x00010000




#define VPN_MSGTYPE_AUTH   (1<<1)


#define VPN_MSGTYPE_STATE_CHANGE (1<<2)

#define VPN_MSGTYPE_MASK (VPN_MSGTYPE_AUTH | VPN_MSGTYPE_STATE_CHANGE)


#define VPN_AUTH_MESSAGE      (1<<0)

#define VPN_AUTH_USERNAME     (1<<1)

#define VPN_AUTH_PASSWORD     (1<<2)

#define VPN_AUTH_PASSCODE     (1<<3)

#define VPN_AUTH_ANSWER       (1<<4)

#define VPN_AUTH_NEXTPIN      (1<<5)

#define VPN_AUTH_NEXTPASSWORD (1<<6)

#define VPN_AUTH_DOMAIN       (1<<7)

#define VPN_AUTH_PIN          (1<<8)

#define VPN_AUTH_TOKENCODE    (1<<9)

#define VPN_AUTH_MASK (VPN_AUTH_MESSAGE | VPN_AUTH_USERNAME | \
                       VPN_AUTH_PASSWORD | VPN_AUTH_PASSCODE | \
                       VPN_AUTH_ANSWER |  VPN_AUTH_NEXTPIN | \
                       VPN_AUTH_NEXT_PASSWORD | VPN_AUTH_DOMAIN \ \
                       VPN_AUTH_PIN | VPN_AUTH_TOKENCODE)


#define VPN_STATGROUP_COUNTERS      (1L<<0)

#define VPN_STATGROUP_TUNNEL_INFO   (1L<<1)

#define VPN_STATGROUP_ROUTES        (1L<<2)

#define VPN_STATGROUP_PROFILE       (1L<<3)

#define VPN_STATGROUP_MASK (VPN_STATGROUP_COUNTERS | \
        VPN_STATGROUP_TUNNEL_INFO | \
        VPN_STATGROUP_ROUTES | \
        VPN_STATGROUP_PROFILE)


#define VPN_OPT_SILENT_DISCONNECT   (1L<<0)
#define VPN_OPT_MASK (VPN_OPT_SILENT_DISCONNECT)


typedef int32_t vpn_error_t;

typedef enum
{
    VPN_MIN_STATE = -1,
    VPN_STATE_IDLE,
    VPN_STATE_WAIT_PPP,
    VPN_STATE_WAIT_CTCP,
    VPN_STATE_WAIT_PHASE1,
    VPN_STATE_WAIT_AUTH,
    VPN_STATE_WAIT_MODECFG,
    VPN_STATE_WAIT_PHASE2,
    VPN_STATE_CONNECTED, 
    VPN_MAX_STATE,
} vpn_state_t;

typedef enum
{
    VPN_MIN_CRYPTO_ALG = 0,
    VPN_CRYPTO_DES,
    VPN_CRYPTO_3DES,
    VPN_CRYPTO_NULL,
    VPN_CRYPTO_AES,
    VPN_MAX_CRYPTO_ALG
} vpn_crypto_t;

typedef enum
{
    VPN_MIN_HASH = 0,
    VPN_HASH_MD5,
    VPN_HASH_SHA,
    VPN_MAX_HASH
} vpn_hash_t;

typedef enum
{ 
    VPN_MIN_COMPRESS_ALG = 0,
    VPN_COMPRESS_NONE,
    VPN_COMPRESS_LZS, 
    VPN_MAX_COMPRESS_ALG,
} vpn_compress_t;

typedef enum
{ 
    VPN_MIN_NAT_MODE = 0,
    VPN_NAT_NONE,
    VPN_NAT_IPSEC_OVER_UDP,
    VPN_NAT_IPSEC_OVER_CTCP,
    VPN_MAX_NAT_MODE
} vpn_nat_mode_t;


typedef void *vpn_channel_t;


typedef void *vpn_stats_t;


typedef void *vpn_auth_t;


typedef union
{
    struct
    {
        uint32_t pad[3];

        struct in_addr addr;
    } ipv4;

#ifdef NOT_IMPLEMENTED
    struct
    {
        struct in6_addr addr;
    } ipv6;

#endif                          /*  */
} vpn_ip_addr_t;

struct vpn_route
{

    vpn_ip_addr_t network;

    vpn_ip_addr_t mask;

    uint32_t bytes;

    uint16_t haskeys;

    uint32_t reserved[2];
};

struct vpn_routes
{

    uint32_t num_routes;

    uint32_t reserved[2];

    struct vpn_route routes[];
};

struct vpn_counters
{

    uint32_t time_connected;

    uint32_t total_bytes;

    uint32_t bytes_sent;

    uint32_t bytes_recieved;

    uint32_t packets_transformed;

    uint32_t packets_encrypted;

    uint32_t packets_decrypted;

    uint32_t packets_bypassed;

    uint32_t packets_discarded;

    uint32_t reserved[2];
};

struct vpn_tunnel_info
{

    vpn_ip_addr_t internal_addr;

    vpn_ip_addr_t peer_addr;

    uint8_t local_lan_enabled;

    vpn_nat_mode_t nat_mode;

    uint16_t nat_port;

    vpn_crypto_t crypto_algorithm;

    uint16_t crypto_key_length;

    vpn_hash_t hash_algorithm;

    vpn_compress_t compress_algorithm;

    uint32_t reserved[2];
};

struct vpn_connect_error
{
    vpn_error_t error;
    uint32_t is_remote;
    char * delete_reason;

    uint32_t reserved[2];
};

#ifndef VPN_API_DATATYPES_ONLY



typedef void (*vpn_connect_cb) (const struct vpn_connect_error *,
                                const char *banner);


typedef void (*vpn_disconnect_cb) (vpn_error_t error);


typedef void (*vpn_state_change_cb) (vpn_state_t state,
                                     const vpn_ip_addr_t * peer,
                                     const struct vpn_connect_error*);


typedef void (*vpn_stats_cb) (vpn_error_t error, uint32_t stats_groups,
                              vpn_stats_t stats);


typedef void (*vpn_auth_cb) (vpn_auth_t auth, uint32_t auth_attrs,
                             uint32_t allowed_save_attrs,
                             const char *profile_name);


typedef void (*vpn_auth_stop_cb) (void);


struct vpn_callback_table
{

    vpn_connect_cb fp_connect;

    vpn_disconnect_cb fp_disconnect;

    vpn_state_change_cb fp_state_change;

    vpn_stats_cb fp_stats;

    vpn_auth_cb fp_auth;

    vpn_auth_stop_cb fp_auth_stop;
};



DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_api_init(uint32_t * version);

DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_api_destroy(void);



DLL_EXPORT_NAME vpn_error_t CDECLAPI
    vpn_channel_init(vpn_channel_t * channel,
                     uint32_t * msgtypes,
                     const struct vpn_callback_table *callbacks);


DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_channel_destroy(vpn_channel_t channel);


DLL_EXPORT_NAME SOCKET CDECLAPI vpn_channel_get_socket(vpn_channel_t channel);


DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_channel_event(vpn_channel_t channel);

DLL_EXPORT_NAME vpn_error_t CDECLAPI
    vpn_process_events(vpn_channel_t channel, unsigned int max_wait);


DLL_EXPORT_NAME uint32_t CDECLAPI
    vpn_channel_get_msgtypes(vpn_channel_t channel);



DLL_EXPORT_NAME vpn_error_t CDECLAPI
    vpn_connect(vpn_channel_t channel,
                const char *profile,
                const char *group_name,
                const char *password,
                uint32_t option_flags);


DLL_EXPORT_NAME vpn_error_t CDECLAPI
    vpn_acknowledge_banner(vpn_channel_t channel,
                           int banner_accepted);


DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_disconnect(vpn_channel_t channel);


DLL_EXPORT_NAME vpn_error_t CDECLAPI
    vpn_get_stats(vpn_channel_t channel,
                  uint32_t stats_groups);


DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_reset_stats(vpn_channel_t channel);


DLL_EXPORT_NAME vpn_error_t CDECLAPI
    vpn_auth_respond(vpn_channel_t channel,
                     vpn_auth_t auth,
                     uint32_t save_attrs);


DLL_EXPORT_NAME vpn_error_t CDECLAPI
    vpn_auth_abort(vpn_channel_t channel,
                   vpn_auth_t auth);


DLL_EXPORT_NAME const struct vpn_routes * CDECLAPI
    vpn_stats_get_local_lan_routes(vpn_stats_t stats);

DLL_EXPORT_NAME const struct vpn_routes * CDECLAPI
    vpn_stats_get_secure_routes(vpn_stats_t stats);

DLL_EXPORT_NAME const struct vpn_tunnel_info * CDECLAPI
    vpn_stats_get_tunnel_info(vpn_stats_t stats);

DLL_EXPORT_NAME const struct vpn_counters * CDECLAPI
    vpn_stats_get_counters(vpn_stats_t stats);

DLL_EXPORT_NAME const char * CDECLAPI
    vpn_stats_get_profile_name(vpn_stats_t stats);

DLL_EXPORT_NAME const char * CDECLAPI
    vpn_auth_get_attribute(vpn_auth_t auth,
                           uint32_t auth_attr);

DLL_EXPORT_NAME vpn_error_t CDECLAPI
    vpn_auth_set_attribute(vpn_auth_t auth,
                           uint32_t auth_attr,
                           const char *value);

#ifdef _WIN32
DLL_EXPORT_NAME HANDLE CDECLAPI vpn_get_service_start_event(void);
DLL_EXPORT_NAME HANDLE CDECLAPI vpn_get_gui_start_event(void);
#endif

#endif //VPN_API_DATATYPES_ONLY

#ifdef _MSC_VER
/* re-enable warning: 
    nonstandard extension used: zero-sized array in struct/union
*/
#pragma warning( default: 4200 )
#endif

#ifdef __cplusplus
// *INDENT-OFF*
}
// *INDENT-ON*
#endif
#endif // VPNAPI_H

---