lib/gnutls_extensions.h

   1 /*
   2  * Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2010
   3  * Free Software Foundation, Inc.
   4  *
   5  * Author: Nikos Mavrogiannopoulos
   6  *
   7  * This file is part of GnuTLS.
   8  *
   9  * The GnuTLS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  22  * USA
  23  *
  24  */
  25
  26 #ifndef GNUTLS_EXTENSIONS_H
  27 #define GNUTLS_EXTENSIONS_H
  28
  29 #include <gnutls_str.h>
  30
  31 typedef int (*gnutls_ext_recv_func) (gnutls_session_t session,
  32                                        const unsigned char *data, size_t len);
  33 typedef int (*gnutls_ext_send_func) (gnutls_session_t session,
  34                                        gnutls_buffer_st *extdata);
  35
  36 int _gnutls_parse_extensions (gnutls_session_t session,
  37                               gnutls_ext_parse_type_t parse_type,
  38                               const opaque * data, int data_size);
  39 int _gnutls_gen_extensions (gnutls_session_t session, gnutls_buffer_st * extdata,
  40                             gnutls_ext_parse_type_t);
  41 int _gnutls_ext_init (void);
  42 void _gnutls_ext_deinit (void);
  43
  44 void _gnutls_extension_list_add (gnutls_session_t session, uint16_t type);
  45
  46 typedef void (*gnutls_ext_deinit_data_func) (extension_priv_data_t data);
  47 typedef int (*gnutls_ext_pack_func) (extension_priv_data_t data,
  48                                      gnutls_buffer_st * packed_data);
  49 typedef int (*gnutls_ext_unpack_func) (gnutls_buffer_st * packed_data,
  50                                        extension_priv_data_t * data);
  51
  52 void _gnutls_ext_free_session_data (gnutls_session_t session);
  53
  54 /* functions to be used by extensions internally
  55  */
  56 void _gnutls_ext_unset_session_data (gnutls_session_t session, uint16_t type);
  57 void _gnutls_ext_set_session_data (gnutls_session_t session, uint16_t type,
  58                                    extension_priv_data_t);
  59 int _gnutls_ext_get_session_data (gnutls_session_t session,
  60                                   uint16_t type, extension_priv_data_t *);
  61 int _gnutls_ext_get_resumed_session_data (gnutls_session_t session,
  62                                           uint16_t type,
  63                                           extension_priv_data_t * data);
  64
  65 void _gnutls_ext_restore_resumed_session (gnutls_session_t session);
  66
  67 /* for session packing */
  68 int _gnutls_ext_pack (gnutls_session_t session, gnutls_buffer_st * packed);
  69 int _gnutls_ext_unpack (gnutls_session_t session, gnutls_buffer_st * packed);
  70
  71 typedef struct
  72 {
  73   const char *name;
  74   uint16_t type;
  75   gnutls_ext_parse_type_t parse_type;
  76
  77   /* this function must return 0 when Not Applicable
  78    * size of extension data if ok
  79    * < 0 on other error.
  80    */
  81   gnutls_ext_recv_func recv_func;
  82
  83   /* this function must return 0 when Not Applicable
  84    * size of extension data if ok
  85    * GNUTLS_E_INT_RET_0 if extension data size is zero
  86    * < 0 on other error.
  87    */
  88   gnutls_ext_send_func send_func;
  89
  90   gnutls_ext_deinit_data_func deinit_func;      /* this will be called to deinitialize
  91                                                  * internal data
  92                                                  */
  93   gnutls_ext_pack_func pack_func;       /* packs internal data to machine independent format */
  94   gnutls_ext_unpack_func unpack_func;   /* unpacks internal data */
  95
  96 } extension_entry_st;
  97
  98 int _gnutls_ext_register (extension_entry_st *);
  99
 100 #endif