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 typedef struct {
  32         gsize   length;
  33         guint8 *value;
  34 } SipSecBuffer;
  35
  36 typedef SipSecContext
  37 (*sip_sec_create_context_func)(guint type);
  38
  39 typedef gboolean
  40 (*sip_sec_acquire_cred_func)(SipSecContext context,
  41                              const gchar *domain,
  42                              const gchar *username,
  43                              const gchar *password);
  44
  45 typedef gboolean
  46 (*sip_sec_init_context_func)(SipSecContext context,
  47                              SipSecBuffer in_buff,
  48                              SipSecBuffer *out_buff,
  49                              const gchar *service_name);
  50
  51 typedef void
  52 (*sip_sec_destroy_context_func)(SipSecContext context);
  53
  54 typedef gboolean
  55 (*sip_sec_make_signature_func)(SipSecContext context,
  56                                const gchar *message,
  57                                SipSecBuffer *signature);
  58
  59 typedef gboolean
  60 (*sip_sec_verify_signature_func)(SipSecContext context,
  61                                  const gchar *message,
  62                                  SipSecBuffer signature);
  63
  64 typedef gboolean (*sip_sec_password_func)(void);
  65
  66
  67 struct sip_sec_context {
  68         sip_sec_acquire_cred_func     acquire_cred_func;
  69         sip_sec_init_context_func     init_context_func;
  70         sip_sec_destroy_context_func  destroy_context_func;
  71         sip_sec_make_signature_func   make_signature_func;
  72         sip_sec_verify_signature_func verify_signature_func;
  73         /** Security Context expiration interval in seconds */
  74         guint expires;
  75         guint flags;
  76 };
  77
  78 /**
  79  * sip_sec_context.flags
  80  *
  81  * 0x00000001 - 0x00008000: common flags
  82  * 0x00010000 - 0x80000000: mechanism private flags
  83  *
  84  * NOTE: private flags must be set in acquire_cred_func()!
  85  */
  86 #define SIP_SEC_FLAG_COMMON_SSO   0x00000001
  87 #define SIP_SEC_FLAG_COMMON_HTTP  0x00000002
  88 #define SIP_SEC_FLAG_COMMON_READY 0x00000004