proto.h

Go to the documentation of this file.

/*
 ** Copyright (C) 2002-2007 - INL
 ** Written by Eric Leblond <regit@inL.fr>
 ** INL http://www.inl.fr/
 **
 ** $Id: proto.h 5285 2008-11-21 15:39:55Z pollux $
 **
 ** 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, version 3 of the License.
 **
 ** 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.
 */

#ifndef NUFW_PROTOCOL_H
#define NUFW_PROTOCOL_H

#ifdef HAVE_CONFIG_H
#  include "config.h"
#endif

#ifdef LINUX
#  include <endian.h>
#else
#  include <machine/endian.h>
#endif

#define AUTHREQ_PORT 4128
#define USERPCKT_PORT 4129
#define USERPCKT_SERVICE "4129"

/* define here last proto */

#define PROTO_STRING "PROTO"
#define PROTO_UNKNOWN 0

enum proto_type_t {
        NUFW_PROTO = 0,
        CLIENT_PROTO
};

enum proto_client_version_t {
        PROTO_VERSION_V20 = 3,
        PROTO_VERSION_V22,
        PROTO_VERSION_V22_1
};

#define PROTO_VERSION PROTO_VERSION_V22

enum proto_nufw_version_t {
        PROTO_VERSION_NUFW_V20 = 3,
        PROTO_VERSION_NUFW_V22,
        PROTO_VERSION_NUFW_V22_2
};

#define PROTO_NUFW_VERSION PROTO_VERSION_NUFW_V22_2

/* header common for all packets
   1         4            8            16          24     32
   |         |            |            |           |      |
   |  Proto  |Msg Type    | Msg option |    packet length |

   message type is one of :

AUTHREQ : user send packet

*/

struct nu_header {
#ifdef WORDS_BIGENDIAN
        uint8_t msg_type:4;
        uint8_t proto:4;
#else
        uint8_t proto:4;
        uint8_t msg_type:4;
#endif
        uint8_t option;
        uint16_t length;
};



typedef struct {
        uint8_t protocol_version;

        uint8_t msg_type;

        uint16_t msg_length;
} nufw_to_nuauth_message_header_t;

#define OS_SRV 0x1

#define APP_TYPE_NAME 0x1 
#define APP_TYPE_SHA1 0x2

typedef enum {
        DECISION_DROP = 0,      
        DECISION_ACCEPT,        
        DECISION_NODECIDE,      
        DECISION_REJECT         
} decision_t;


typedef enum {
        AUTH_REQUEST = 0x1,
        AUTH_ANSWER,
        USER_REQUEST,
        AUTH_CONTROL,
        USER_HELLO,
        AUTH_CONN_DESTROY,
        AUTH_CONN_UPDATE,
        AUTH_CONN_FIXED_TIMEOUT
} nufw_message_t;


typedef enum {
        IPV4_FIELD = 1,
        IPV6_FIELD,
        APP_FIELD,
        OS_FIELD,
        USERNAME_FIELD,
        HELLO_FIELD
} nu_field_identifier_t;

struct nu_authreq {
        uint16_t packet_seq;
        uint16_t packet_length; 
};

struct nu_authfield {
        uint8_t type;           
        uint8_t option;         
        uint16_t length;        
};

struct nu_authfield_ipv6 {
        uint8_t type;
        uint8_t option;
        uint16_t length;        
        struct in6_addr src;
        struct in6_addr dst;
        uint8_t proto;
        uint8_t flags;
        uint16_t FUSE;
        uint16_t sport;
        uint16_t dport;
};

struct nu_authfield_ipv4 {
        uint8_t type;
        uint8_t option;
        uint16_t length;        
        uint32_t src;
        uint32_t dst;
        uint8_t proto;
        uint8_t flags;
        uint16_t FUSE;
        uint16_t sport;
        uint16_t dport;
};



struct nu_authfield_app {
        uint8_t type;
        uint8_t option;
        uint16_t length;        
        /* after that is the application content */
};

struct nu_authfield_hello {
        uint8_t type;
        uint8_t option;
        uint16_t length;
        uint32_t helloid;       
};


/* sender to client message */

/* type message */
typedef enum {
        SRV_TYPE = 1,           
        SRV_REQUIRED_PACKET,
        SRV_REQUIRED_DISCONNECT,
        SRV_REQUIRED_HELLO
} nu_type_t;

typedef enum {
        SRV_TYPE_POLL = 0,      
        SRV_TYPE_PUSH           
} nu_server_mode_t;

struct nu_srv_message {
        uint8_t type;
        uint8_t option;
        uint16_t length;
};

struct nu_srv_helloreq {
        uint8_t type, option;
        uint16_t length;
        uint32_t helloid;
};

/* include definition for NuFW 2.0 */
#include <proto_v3.h>

/* include definition for NuFW 2.2 */
#include <proto_v4.h>

#endif

---