/home/chaser/Zfone/Work/build/zfone-full-0.90.438/zfone3/lib/libzrtp/include/zrtp_iface.h

Go to the documentation of this file.

/*
 * libZRTP SDK library, implements the ZRTP secure VoIP protocol.
 * Copyright (c) 2006-2009 Philip R. Zimmermann.  All rights reserved.
 * Contact: http://philzimmermann.com
 * For licensing and other legal details, see the file zrtp_legal.c.
 * 
 * Viktor Krykun <v.krikun at zfoneproject.com> 
 */



#ifndef __ZRTP_IFACE_H__ 
#define __ZRTP_IFACE_H__

#include "zrtp_config.h"
#include "zrtp_base.h"
#include "zrtp_string.h"
#include "zrtp_error.h"
#include "zrtp_iface_system.h"


#if defined(__cplusplus)
extern "C"
{
#endif
    
/*======================================================================*/
/*    libzrtp interface: Cache                                          */
/*======================================================================*/

typedef struct zrtp_callback_cache_t
{
    zrtp_status_t (*on_init)(zrtp_global_t* zrtp);

    void (*on_down)();
    
    zrtp_status_t (*on_put)( const zrtp_stringn_t* one_zid,
                             const zrtp_stringn_t* another_zid, 
                             zrtp_shared_secret_t *rss);
    
    zrtp_status_t (*on_get)( const zrtp_stringn_t* one_zid,
                             const zrtp_stringn_t* another_zid,
                             zrtp_shared_secret_t *rss,
                             int prev_requested);
    
    zrtp_status_t (*on_set_verified)( const zrtp_stringn_t* one_zid,
                                      const zrtp_stringn_t* another_zid, 
                                      uint32_t verified);
    
    zrtp_status_t (*on_get_verified)( const zrtp_stringn_t* one_zid,
                                      const zrtp_stringn_t* another_zid, 
                                      uint32_t* verified);
    
    zrtp_status_t (*on_reset_since)( const zrtp_stringn_t* one_zid,
                                     const zrtp_stringn_t* another_zid);
    
    zrtp_status_t (*on_put_mitm)( const zrtp_stringn_t* one_zid,
                                  const zrtp_stringn_t* another_zid, 
                                  zrtp_shared_secret_t *rss);
    
    zrtp_status_t (*on_get_mitm)( const zrtp_stringn_t* one_zid,
                                  const zrtp_stringn_t* another_zid,
                                  zrtp_shared_secret_t *rss);
    
    zrtp_status_t (*on_presh_counter_get)( const zrtp_stringn_t* one_zid,
                                           const zrtp_stringn_t* another_zid,
                                           uint32_t* counter);
    
    zrtp_status_t (*on_presh_counter_set)( const zrtp_stringn_t* one_zid,
                                           const zrtp_stringn_t* another_zid,
                                           uint32_t counter);
} zrtp_callback_cache_t;

    
/*======================================================================*/
/*    libzrtp interface: Scheduler                                      */
/*======================================================================*/

typedef void (*zrtp_call_callback_t)(zrtp_stream_t*, zrtp_retry_task_t*);

struct zrtp_retry_task_t
{
    zrtp_call_callback_t    callback;
    
    zrtp_time_t             timeout;
    
    void*                   usr_data;
    
    
    // TODO: hide these elements
    uint8_t                 _is_enabled;
    
    uint32_t                _retrys;
    
    uint8_t                 _is_busy;
};

typedef struct zrtp_callback_scheduler_t
{
    zrtp_status_t (*on_init)(zrtp_global_t* zrtp);
    
    void (*on_down)();

    void (*on_call_later)(zrtp_stream_t *stream, zrtp_retry_task_t* task);
    
    void (*on_cancel_call_later)(zrtp_stream_t* ctx, zrtp_retry_task_t* task);
    
    void (*on_wait_call_later)(zrtp_stream_t* stream);
} zrtp_callback_scheduler_t;

/*======================================================================*/
/*    libzrtp interface: Protocol                                       */
/*======================================================================*/

typedef enum zrtp_protocol_event_t
{
    ZRTP_EVENT_UNSUPPORTED = 0,
    
    ZRTP_EVENT_IS_CLEAR,

    ZRTP_EVENT_IS_INITIATINGSECURE,
    
    ZRTP_EVENT_IS_PENDINGSECURE,
    
    ZRTP_EVENT_IS_PENDINGCLEAR,
    
    ZRTP_EVENT_NO_ZRTP,
    
    ZRTP_EVENT_NO_ZRTP_QUICK,
    
    ZRTP_EVENT_IS_CLIENT_ENROLLMENT,
    
    ZRTP_EVENT_NEW_USER_ENROLLED,
    
    ZRTP_EVENT_USER_ALREADY_ENROLLED,
    
    ZRTP_EVENT_USER_UNENROLLED,
    
    ZRTP_EVENT_LOCAL_SAS_UPDATED,
    
    ZRTP_EVENT_REMOTE_SAS_UPDATED,
    
    ZRTP_EVENT_IS_SECURE,
    
    ZRTP_EVENT_IS_SECURE_DONE,
    
    ZRTP_EVENT_IS_PASSIVE_RESTRICTION,
    
    ZRTP_EVENT_COUNT

} zrtp_protocol_event_t;

typedef enum zrtp_security_event_t
{
    ZRTP_EVENT_PROTOCOL_ERROR = ZRTP_EVENT_COUNT,
    
    ZRTP_EVENT_WRONG_SIGNALING_HASH,
    
    ZRTP_EVENT_WRONG_MESSAGE_HMAC,
    
    ZRTP_EVENT_MITM_WARNING
} zrtp_security_event_t;

typedef struct zrtp_callback_event_t
{
    void (*on_zrtp_protocol_event)(zrtp_stream_t *stream, zrtp_protocol_event_t event);
    
    void (*on_zrtp_security_event)(zrtp_stream_t *stream, zrtp_security_event_t event);
    
    void (*on_zrtp_secure)(zrtp_stream_t *stream);
    
    void (*on_zrtp_not_secure)(zrtp_stream_t *stream);
} zrtp_callback_event_t;

/*======================================================================*/
/*    libzrtp interface: Misc                                           */
/*======================================================================*/

typedef struct zrtp_callback_misc_t
{
    int (*on_send_packet)(const zrtp_stream_t* stream, char* packet, unsigned int length);
} zrtp_callback_misc_t;

typedef struct zrtp_callback_t
{
    zrtp_callback_event_t       event_cb;
    zrtp_callback_scheduler_t   sched_cb;
    zrtp_callback_cache_t       cache_cb;
    zrtp_callback_misc_t        misc_cb;
} zrtp_callback_t;

    
#if defined(__cplusplus)
}
#endif

#endif /*__ZRTP_IFACE_H__*/

---