src/core/sip-sec-mech.h

   1 /**
   2  * @file sip-sec-mech.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2011-2013 SIPE Project <http://sipe.sourceforge.net/>
   7  * Copyright (C) 2009 pier11 <pier11@operamail.com>
   8  *
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 /* Mechanism wrappers API  (Inspired by GSS-API)
  26  * All mechanisms should implement this API
  27  *
  28  * Current mechanisms are: Kerberos/GSS-API, sipe's NTLM and SSPI.
  29  */
  30
  31 #define SIP_SEC_E_OK 0
  32 #define SIP_SEC_E_INTERNAL_ERROR -1
  33
  34 typedef unsigned long sip_uint32;
  35
  36 typedef struct {
  37         gsize   length;
  38         guint8 *value;
  39 } SipSecBuffer;
  40
  41 typedef SipSecContext
  42 (*sip_sec_create_context_func)(guint type);
  43
  44 typedef sip_uint32
  45 (*sip_sec_acquire_cred_func)(SipSecContext context,
  46                              const char *domain,
  47                              const char *username,
  48                              const char *password);
  49
  50 typedef sip_uint32
  51 (*sip_sec_init_context_func)(SipSecContext context,
  52                              SipSecBuffer in_buff,
  53                              SipSecBuffer *out_buff,
  54                              const char *service_name);
  55
  56 typedef void
  57 (*sip_sec_destroy_context_func)(SipSecContext context);
  58
  59 typedef sip_uint32
  60 (*sip_sec_make_signature_func)(SipSecContext context,
  61                                const char *message,
  62                                SipSecBuffer *signature);
  63
  64 typedef sip_uint32
  65 (*sip_sec_verify_signature_func)(SipSecContext context,
  66                                  const char *message,
  67                                  SipSecBuffer signature);
  68
  69 typedef gboolean (*sip_sec_password_func)(void);
  70
  71
  72 struct sip_sec_context {
  73         sip_sec_acquire_cred_func     acquire_cred_func;
  74         sip_sec_init_context_func     init_context_func;
  75         sip_sec_destroy_context_func  destroy_context_func;
  76         sip_sec_make_signature_func   make_signature_func;
  77         sip_sec_verify_signature_func verify_signature_func;
  78         /** Single Sign-On request flag 0=FALSE */
  79         int sso;
  80         /** Security Context expiration interval in seconds */
  81         int expires;
  82         /** 0 - FALSE; otherwise TRUE */
  83         int is_connection_based;
  84         /** 0 - FALSE, otherwise TRUE */
  85         int is_ready;
  86 };