src/core/sipe-cert-crypto.h

   1 /**
   2  * @file sipe-cert-crypto.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2011-12 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  * Internal interface between sipe-certificate/sipe-tls
  26  * and the certificate crypto implementation
  27  */
  28
  29 /*
  30  * Interface dependencies:
  31  *
  32  * <glib.h>
  33  */
  34
  35 /* Forward declarations */
  36 struct sipe_cert_crypto;
  37
  38 /**
  39  * Free certificate crypto backend data
  40  *
  41  * @return opaque pointer to backend private data
  42  */
  43 struct sipe_cert_crypto *sipe_cert_crypto_init(void);
  44
  45 /**
  46  * Free certificate crypto backend data
  47  *
  48  * @param scc opaque pointer to backend private data
  49  */
  50 void sipe_cert_crypto_free(struct sipe_cert_crypto *scc);
  51
  52 /**
  53  * Create a certificate request as Base64 encoded string
  54  *
  55  * @param scc     opaque pointer to backend private data
  56  * @param subject subject for certificate request
  57  *
  58  * @return Base64 encoded string. Must be @g_free'd()
  59  */
  60 gchar *sipe_cert_crypto_request(struct sipe_cert_crypto *scc,
  61                                 const gchar *subject);
  62
  63 /**
  64  * Destroy certificate (this is a @GDestroyNotify)
  65  *
  66  * @param certificate opaque pointer to backend certificate structure
  67  *                    May be @c NULL
  68  */
  69 void sipe_cert_crypto_destroy(gpointer certificate);
  70
  71 /**
  72  * Decode a client certificate from Base64 string
  73  *
  74  * @param base64 Base64 encoded DER data
  75  *
  76  * @return opaque pointer to certificate. Must be @sipe_cert_crypto_destroy()'d.
  77  */
  78 gpointer sipe_cert_crypto_decode(struct sipe_cert_crypto *scc,
  79                                  const gchar *base64);
  80
  81 /**
  82  * Import a server certificate from DER data
  83  *
  84  * @param raw    DER data
  85  * @param length length of DER data
  86  *
  87  * @return opaque pointer to certificate. Must be @sipe_cert_crypto_destroy()'d.
  88  */
  89 gpointer sipe_cert_crypto_import(const guchar *raw, gsize length);
  90
  91 /**
  92  * Check if certificate is valid until @c offset seconds from now
  93  *
  94  * @param certificate opaque pointer to backend certificate structure
  95  * @param offset      seconds from now
  96  *
  97  * @return @c TRUE if certificate is still valid at that time
  98  */
  99 gboolean sipe_cert_crypto_valid(gpointer certificate,
 100                                 guint offset);
 101
 102 /**
 103  * Return how many seconds until the certificate expires
 104  *
 105  * @param certificate opaque pointer to backend certificate structure
 106  *
 107  * @return offset in seconds
 108  */
 109 guint sipe_cert_crypto_expires(gpointer certificate);
 110
 111 /**
 112  * Return length of certificate in DER form
 113  *
 114  * @param certificate opaque pointer to backend certificate structure
 115  *
 116  * @return length in bytes
 117  */
 118 gsize sipe_cert_crypto_raw_length(gpointer certificate);
 119
 120 /**
 121  * Return certificate in DER form
 122  *
 123  * @param certificate opaque pointer to backend certificate structure
 124  *
 125  * @return pointer to DER data
 126  */
 127 const guchar *sipe_cert_crypto_raw(gpointer certificate);
 128
 129 /**
 130  * Get public key for certificate
 131  *
 132  * @param certificate opaque pointer to backend certificate structure
 133  *
 134  * @return opaque pointer to backend public key structure
 135  */
 136 gpointer sipe_cert_crypto_public_key(gpointer certificate);
 137
 138 /**
 139  * Get public key modulus length for server certificate
 140  *
 141  * @param certificate opaque pointer to backend certificate structure
 142  *
 143  * @return server public key strength
 144  */
 145 gsize sipe_cert_crypto_modulus_length(gpointer certificate);
 146
 147 /**
 148  * Get private key for client certificate
 149  *
 150  * @param certificate opaque pointer to backend certificate structure
 151  *
 152  * @return opaque pointer to backend private key structure
 153  */
 154 gpointer sipe_cert_crypto_private_key(gpointer certificate);
 155
 156 /**
 157  * Create test certificate for internal key pair (ONLY USE FOR TEST CODE!!!)
 158  *
 159  * @param scc opaque pointer to backend private data
 160  *
 161  * @return opaque pointer to backend certificate structure
 162  */
 163 gpointer sipe_cert_crypto_test_certificate(struct sipe_cert_crypto *scc);