gio/gtlspassword.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2011 Collabora, Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Stef Walter <stefw@collabora.co.uk>
  21  */
  22
  23 #ifndef __G_TLS_PASSWORD_H__
  24 #define __G_TLS_PASSWORD_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_TLS_PASSWORD         (g_tls_password_get_type ())
  35 #define G_TLS_PASSWORD(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_TLS_PASSWORD, GTlsPassword))
  36 #define G_TLS_PASSWORD_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_TLS_PASSWORD, GTlsPasswordClass))
  37 #define G_IS_TLS_PASSWORD(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_TLS_PASSWORD))
  38 #define G_IS_TLS_PASSWORD_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_TLS_PASSWORD))
  39 #define G_TLS_PASSWORD_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_TLS_PASSWORD, GTlsPasswordClass))
  40
  41 typedef struct _GTlsPasswordClass   GTlsPasswordClass;
  42 typedef struct _GTlsPasswordPrivate GTlsPasswordPrivate;
  43
  44 struct _GTlsPassword
  45 {
  46   GObject parent_instance;
  47
  48   GTlsPasswordPrivate *priv;
  49 };
  50
  51 struct _GTlsPasswordClass
  52 {
  53   GObjectClass parent_class;
  54
  55   /* methods */
  56
  57   const guchar *    ( *get_value)            (GTlsPassword  *password,
  58                                               gsize         *length);
  59
  60   void              ( *set_value)            (GTlsPassword  *password,
  61                                               guchar        *value,
  62                                               gssize         length,
  63                                               GDestroyNotify destroy);
  64
  65   const gchar*      ( *get_default_warning)  (GTlsPassword  *password);
  66
  67   /*< private >*/
  68   /* Padding for future expansion */
  69   gpointer padding[4];
  70 };
  71
  72 GLIB_AVAILABLE_IN_ALL
  73 GType             g_tls_password_get_type            (void) G_GNUC_CONST;
  74
  75 GLIB_AVAILABLE_IN_ALL
  76 GTlsPassword *    g_tls_password_new                 (GTlsPasswordFlags  flags,
  77                                                       const gchar       *description);
  78
  79 GLIB_AVAILABLE_IN_ALL
  80 const guchar *    g_tls_password_get_value           (GTlsPassword      *password,
  81                                                       gsize             *length);
  82 GLIB_AVAILABLE_IN_ALL
  83 void              g_tls_password_set_value           (GTlsPassword      *password,
  84                                                       const guchar      *value,
  85                                                       gssize             length);
  86 GLIB_AVAILABLE_IN_ALL
  87 void              g_tls_password_set_value_full      (GTlsPassword      *password,
  88                                                       guchar            *value,
  89                                                       gssize             length,
  90                                                       GDestroyNotify     destroy);
  91
  92 GLIB_AVAILABLE_IN_ALL
  93 GTlsPasswordFlags g_tls_password_get_flags           (GTlsPassword      *password);
  94 GLIB_AVAILABLE_IN_ALL
  95 void              g_tls_password_set_flags           (GTlsPassword      *password,
  96                                                       GTlsPasswordFlags  flags);
  97
  98 GLIB_AVAILABLE_IN_ALL
  99 const gchar*      g_tls_password_get_description     (GTlsPassword      *password);
 100 GLIB_AVAILABLE_IN_ALL
 101 void              g_tls_password_set_description     (GTlsPassword      *password,
 102                                                       const gchar       *description);
 103
 104 GLIB_AVAILABLE_IN_ALL
 105 const gchar *     g_tls_password_get_warning         (GTlsPassword      *password);
 106 GLIB_AVAILABLE_IN_ALL
 107 void              g_tls_password_set_warning         (GTlsPassword      *password,
 108                                                       const gchar       *warning);
 109
 110 G_END_DECLS
 111
 112 #endif /* __G_TLS_PASSWORD_H__ */