src/core/sipe-certificate.h

   1 /**
   2  * @file sipe-certificate.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
  33 /**
  34  * Find TLS-DSK user certificate for a given target
  35  *
  36  * @param sipe_private SIPE core private data
  37  * @param target       target name from authentication header
  38  *
  39  * @return opaque      pointer to the certificate. The caller does not own
  40  *                     the certificate, i.e. he must not free it!
  41  */
  42 gpointer sipe_certificate_tls_dsk_find(struct sipe_core_private *sipe_private,
  43                                        const gchar *target);
  44
  45
  46 /**
  47  * Trigger the generation of TLS-DSK user certificate for a given target
  48  *
  49  * @param sipe_private SIPE core private data
  50  * @param target       target name from authentication header
  51  * @param authuser     authentication user name
  52  * @param uri          URI for the Certificate Provisioning Service
  53  * @return             @c TRUE if certificate generation was triggered
  54  */
  55 gboolean sipe_certificate_tls_dsk_generate(struct sipe_core_private *sipe_private,
  56                                            const gchar *target,
  57                                            const gchar *authuser,
  58                                            const gchar *uri);
  59
  60 /**
  61  * Free certificate data
  62  *
  63  * @param sipe_private SIPE core private data
  64  */
  65 void sipe_certificate_free(struct sipe_core_private *sipe_private);