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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Stef Walter <stefw@collabora.co.uk>
  19  */
  20
  21 #ifndef __G_TLS_PASSWORD_H__
  22 #define __G_TLS_PASSWORD_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/giotypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_TLS_PASSWORD         (g_tls_password_get_type ())
  33 #define G_TLS_PASSWORD(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_TLS_PASSWORD, GTlsPassword))
  34 #define G_TLS_PASSWORD_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_TLS_PASSWORD, GTlsPasswordClass))
  35 #define G_IS_TLS_PASSWORD(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_TLS_PASSWORD))
  36 #define G_IS_TLS_PASSWORD_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_TLS_PASSWORD))
  37 #define G_TLS_PASSWORD_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_TLS_PASSWORD, GTlsPasswordClass))
  38
  39 typedef struct _GTlsPasswordClass   GTlsPasswordClass;
  40 typedef struct _GTlsPasswordPrivate GTlsPasswordPrivate;
  41
  42 struct _GTlsPassword
  43 {
  44   GObject parent_instance;
  45
  46   GTlsPasswordPrivate *priv;
  47 };
  48
  49 struct _GTlsPasswordClass
  50 {
  51   GObjectClass parent_class;
  52
  53   /* methods */
  54
  55   const guchar *    ( *get_value)            (GTlsPassword  *password,
  56                                               gsize         *length);
  57
  58   void              ( *set_value)            (GTlsPassword  *password,
  59                                               guchar        *value,
  60                                               gssize         length,
  61                                               GDestroyNotify destroy);
  62
  63   const gchar*      ( *get_default_warning)  (GTlsPassword  *password);
  64
  65   /*< private >*/
  66   /* Padding for future expansion */
  67   gpointer padding[4];
  68 };
  69
  70 GLIB_AVAILABLE_IN_ALL
  71 GType             g_tls_password_get_type            (void) G_GNUC_CONST;
  72
  73 GLIB_AVAILABLE_IN_ALL
  74 GTlsPassword *    g_tls_password_new                 (GTlsPasswordFlags  flags,
  75                                                       const gchar       *description);
  76
  77 GLIB_AVAILABLE_IN_ALL
  78 const guchar *    g_tls_password_get_value           (GTlsPassword      *password,
  79                                                       gsize             *length);
  80 GLIB_AVAILABLE_IN_ALL
  81 void              g_tls_password_set_value           (GTlsPassword      *password,
  82                                                       const guchar      *value,
  83                                                       gssize             length);
  84 GLIB_AVAILABLE_IN_ALL
  85 void              g_tls_password_set_value_full      (GTlsPassword      *password,
  86                                                       guchar            *value,
  87                                                       gssize             length,
  88                                                       GDestroyNotify     destroy);
  89
  90 GLIB_AVAILABLE_IN_ALL
  91 GTlsPasswordFlags g_tls_password_get_flags           (GTlsPassword      *password);
  92 GLIB_AVAILABLE_IN_ALL
  93 void              g_tls_password_set_flags           (GTlsPassword      *password,
  94                                                       GTlsPasswordFlags  flags);
  95
  96 GLIB_AVAILABLE_IN_ALL
  97 const gchar*      g_tls_password_get_description     (GTlsPassword      *password);
  98 GLIB_AVAILABLE_IN_ALL
  99 void              g_tls_password_set_description     (GTlsPassword      *password,
 100                                                       const gchar       *description);
 101
 102 GLIB_AVAILABLE_IN_ALL
 103 const gchar *     g_tls_password_get_warning         (GTlsPassword      *password);
 104 GLIB_AVAILABLE_IN_ALL
 105 void              g_tls_password_set_warning         (GTlsPassword      *password,
 106                                                       const gchar       *warning);
 107
 108 G_END_DECLS
 109
 110 #endif /* __G_TLS_PASSWORD_H__ */