src/core/sipe-svc.h

   1 /**
   2  * @file sipe-svc.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2011 SIPE Project <http://sipe.sourceforge.net/>
   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  */
  29
  30 /* Forward declarations */
  31 struct sipe_core_private;
  32 struct sipe_tls_random;
  33 struct _sipe_xml;
  34
  35 /**
  36  * Service XML callback
  37  *
  38  * @param sipe_private  SIPE core private data
  39  * @param uri           service URI     (NULL when request aborted)
  40  * @param raw           raw XML data    (NULL when request failed)
  41  * @param xml           parsed XML data (NULL when request failed)
  42  * @param callback_data callback data
  43  */
  44 typedef void (sipe_svc_callback)(struct sipe_core_private *sipe_private,
  45                                  const gchar *uri,
  46                                  const gchar *raw,
  47                                  struct _sipe_xml *xml,
  48                                  gpointer callback_data);
  49
  50 /**
  51  * Trigger fetch of Get & Publish certificate
  52  *
  53  * @param sipe_private  SIPE core private data
  54  * @param uri           service URI
  55  * @param wsse_security predefined authentication token
  56  * @param certreq       certificate request (Base64 encoded)
  57  * @param callback      callback function
  58  * @param callback_data callback data
  59  * @return              @c TRUE if certificate fetch was triggered
  60  */
  61 gboolean sipe_svc_get_and_publish_cert(struct sipe_core_private *sipe_private,
  62                                        const gchar *uri,
  63                                        const gchar *wsse_security,
  64                                        const gchar *certreq,
  65                                        sipe_svc_callback *callback,
  66                                        gpointer callback_data);
  67
  68 /**
  69  * Trigger [MS-DLX] address book entry search
  70  *
  71  * @param sipe_private  SIPE core private data
  72  * @param uri           service URI
  73  * @param wsse_security predefined authentication token
  74  * @param search        [MS-DLX] AbEntryRequest.ChangeSearchQuery in XML
  75  * @param entries       array entries in search XML string
  76  * @param max_returns   how many entries to return
  77  * @param callback      callback function
  78  * @param callback_data callback data
  79  * @return              @c TRUE if search was triggered
  80  */
  81 gboolean sipe_svc_ab_entry_request(struct sipe_core_private *sipe_private,
  82                                    const gchar *uri,
  83                                    const gchar *wsse_security,
  84                                    const gchar *search,
  85                                    guint entries,
  86                                    guint max_returns,
  87                                    sipe_svc_callback *callback,
  88                                    gpointer callback_data);
  89
  90 /**
  91  * Trigger fetch of WebTicket security token
  92  *
  93  * @param sipe_private  SIPE core private data
  94  * @param uri           service URI
  95  * @param wsse_security predefined authentication token. May be @c NULL
  96  * @param service_uri   request token for this service URI
  97  * @param entropy       random bytes buffer for entropy
  98  * @param callback      callback function
  99  * @param callback_data callback data
 100  * @return              @c TRUE if token fetch was triggered
 101  */
 102 gboolean sipe_svc_webticket(struct sipe_core_private *sipe_private,
 103                             const gchar *uri,
 104                             const gchar *wsse_security,
 105                             const gchar *service_uri,
 106                             const struct sipe_tls_random *entropy,
 107                             sipe_svc_callback *callback,
 108                             gpointer callback_data);
 109
 110 /**
 111  * Trigger fetch of WebTicket security token from login.microsoftonline.com
 112  *
 113  * @param sipe_private  SIPE core private data
 114  * @param service_uri   request token for this service URI
 115  * @param callback      callback function
 116  * @param callback_data callback data
 117  * @return              @c TRUE if token fetch was triggered
 118  */
 119 gboolean sipe_svc_webticket_lmc(struct sipe_core_private *sipe_private,
 120                                 const gchar *service_uri,
 121                                 sipe_svc_callback *callback,
 122                                 gpointer callback_data);
 123
 124 /**
 125  * Trigger fetch of service metadata
 126  *
 127  * @param sipe_private  SIPE core private data
 128  * @param uri           service URI
 129  * @param callback      callback function
 130  * @param callback_data callback data
 131  * @return              @c TRUE if metadata fetch was triggered
 132  */
 133 gboolean sipe_svc_metadata(struct sipe_core_private *sipe_private,
 134                            const gchar *uri,
 135                            sipe_svc_callback *callback,
 136                            gpointer callback_data);
 137
 138 /**
 139  * Free service data
 140  *
 141  * @param sipe_private SIPE core private data
 142  */
 143 void sipe_svc_free(struct sipe_core_private *sipe_private);