src/core/sip-sec-mech.h

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