/** @file
 * A header file for input.c.
 * 
 * @author  Janne Lundberg
 * @author  Miika Komu
 * @author  Mika Kousa
 * @author  Kristian Slavov
 * @author  Anthony D. Joseph
 * @author  Bing Zhou
 * @author  Tobias Heer
 * @note    Distributed under <a href="http://www.gnu.org/licenses/gpl.txt">GNU/GPL</a>.
 */
#ifndef HIP_INPUT_H
#define HIP_INPUT_H

#ifdef CONFIG_HIP_RVS
#  include "rvs.h"
#endif

#include "oppdb.h"
#include "user.h"
#include "debug.h"
#include "beet.h"
#include "hadb.h"
#include "keymat.h"
#include "crypto.h"
#include "builder.h"
#include "misc.h"
#include "hidb.h"
#include "cookie.h"
#include "output.h"
#include "pk.h"
#include "netdev.h"
#include "beet.h"
#include "util.h"
#include "state.h"
#if defined CONFIG_HIP_HI3
#include "i3_client_api.h"

struct hi3_ipv4_addr {
	u8 sin_family;
	struct in_addr sin_addr;
};

struct hi3_ipv6_addr {
	u8 sin6_family;
	struct in6_addr sin6_addr;
};

#endif


struct pseudo_header6
{
        unsigned char src_addr[16];
        unsigned char dst_addr[16];
        u32 packet_length;
        char zero[3];
        u8 next_hdr;
};

struct pseudo_header
{
        unsigned char src_addr[4];
        unsigned char dst_addr[4];
        u8 zero;
        u8 protocol;
        u16 packet_length;
};

#ifdef CONFIG_HIP_HI3
void hip_inbound(cl_trigger *t, void *data, void *ctx);
u16 checksum_packet(char *data, struct sockaddr *src, struct sockaddr *dst);
int hip_verify_network_header(struct hip_common *hip_common,
			      struct sockaddr *src, struct sockaddr *dst, int len);
#endif

/**
 * Gets name for a message type
 * @param type the msg type
 *
 * @return HIP message type as a string.
 */
static inline const char *hip_msg_type_str(int type) 
{
        const char *str = "UNKNOWN";
        static const char *types[] =
		{ "", "I1", "R1", "I2", "R2", "CER", "UPDATE", 
		  "NOTIFY", "CLOSE", "CLOSE_ACK", "UNKNOWN", "BOS" };
        if (type >= 1 && type < ARRAY_SIZE(types))
                str = types[type];
        else if (type == HIP_PAYLOAD) {
		str = "PAYLOAD";
	}

	return str;
}

/**
 * Checks for illegal controls
 *
 * Controls are given in host byte order.
 *
 * @param controls control value to be checked
 * @param legal   legal control values to check @c controls against
 * @return        1 if there are no illegal control values in @c controls,
 *                otherwise 0.
 */
static inline int hip_controls_sane(u16 controls, u16 legal)
{
	HIP_DEBUG("hip_controls_sane() invoked.\n");
	return ((controls & (   HIP_CONTROL_HIT_ANON
#ifdef CONFIG_HIP_RVS
				| HIP_CONTROL_RVS_CAPABLE //XX:FIXME
#endif
			 )) | legal) == legal;
}

int hip_check_hip_ri_opportunistic_mode(struct hip_common *, struct in6_addr *,
					struct in6_addr *, hip_portpair_t *,
					hip_ha_t *);
int hip_verify_packet_hmac(struct hip_common *, struct hip_crypto_key *);
int hip_verify_packet_rvs_hmac(struct hip_common *, struct hip_crypto_key *);
int hip_receive_control_packet(struct hip_common *, struct in6_addr *,
			       struct in6_addr *, hip_portpair_t *);
int hip_receive_udp_control_packet(struct hip_common *, struct in6_addr *,
				   struct in6_addr *, hip_portpair_t *);
			  
/**
 * @addtogroup receive_functions
 * @{ 
 */		   
int hip_receive_i1(struct hip_common *, struct in6_addr *, struct in6_addr *,
		   hip_ha_t *, hip_portpair_t *);
int hip_receive_r1(struct hip_common *, struct in6_addr *, struct in6_addr *,
		   hip_ha_t *, hip_portpair_t *);
int hip_receive_i2(struct hip_common *, struct in6_addr *, struct in6_addr *,
		   hip_ha_t *, hip_portpair_t *);
int hip_receive_r2(struct hip_common *, struct in6_addr *, struct in6_addr *,
		   hip_ha_t *, hip_portpair_t *);
int hip_receive_notify(const struct hip_common *, const struct in6_addr *,
		       const struct in6_addr *, hip_ha_t*);
int hip_receive_bos(struct hip_common *, struct in6_addr *, struct in6_addr *,
		    hip_ha_t*, hip_portpair_t *);
int hip_receive_close(struct hip_common *, hip_ha_t*);
int hip_receive_close_ack(struct hip_common *, hip_ha_t*);
/* @} */
			  	  
/**
 * @addtogroup handle_functions
 * @{ 
 */
int hip_handle_i1(struct hip_common *, struct in6_addr *, struct in6_addr *,
		  hip_ha_t *, hip_portpair_t *);
int hip_handle_r1(struct hip_common *, struct in6_addr *, struct in6_addr *,
		  hip_ha_t *, hip_portpair_t *);  
int hip_handle_i2(struct hip_common *, struct in6_addr *, struct in6_addr *,  
		  hip_ha_t *, hip_portpair_t *);
int hip_handle_r2(struct hip_common *, struct in6_addr *, struct in6_addr *,
		  hip_ha_t *, hip_portpair_t *);
int hip_handle_notify(const struct hip_common *, const struct in6_addr *,
		      const struct in6_addr *, hip_ha_t*);
int hip_handle_close(struct hip_common *, hip_ha_t *);
int hip_handle_close_ack(struct hip_common *, hip_ha_t *);	  
/* @} */

int hip_produce_keying_material(struct hip_common *, struct hip_context *,
				uint64_t, uint64_t );
int hip_create_i2(struct hip_context *, uint64_t, struct in6_addr *,
		  struct in6_addr *, hip_ha_t *, hip_portpair_t *);
int hip_create_r2(struct hip_context *, struct in6_addr *,
		  struct in6_addr *, hip_ha_t *, hip_portpair_t *);
 
#endif /* HIP_INPUT_H */