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.1 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
30G_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
39typedef struct _GTlsPasswordClass GTlsPasswordClass;
40typedef struct _GTlsPasswordPrivate GTlsPasswordPrivate;
41
42struct _GTlsPassword
43{
44 GObject parent_instance;
45
46 GTlsPasswordPrivate *priv;
47};
48
49/**
50 * GTlsPasswordClass:
51 * @get_value: virtual method for g_tls_password_get_value()
52 * @set_value: virtual method for g_tls_password_set_value()
53 * @get_default_warning: virtual method for g_tls_password_get_warning() if no
54 * value has been set using g_tls_password_set_warning()
55 *
56 * Class structure for #GTlsPassword.
57 */
58struct _GTlsPasswordClass
59{
60 GObjectClass parent_class;
61
62 /* methods */
63
64 const guchar * ( *get_value) (GTlsPassword *password,
65 gsize *length);
66
67 void ( *set_value) (GTlsPassword *password,
68 guchar *value,
69 gssize length,
70 GDestroyNotify destroy);
71
72 const gchar* ( *get_default_warning) (GTlsPassword *password);
73
74 /*< private >*/
75 /* Padding for future expansion */
76 gpointer padding[4];
77};
78
79GLIB_AVAILABLE_IN_ALL
80GType g_tls_password_get_type (void) G_GNUC_CONST;
81
82GLIB_AVAILABLE_IN_ALL
83GTlsPassword * g_tls_password_new (GTlsPasswordFlags flags,
84 const gchar *description);
85
86GLIB_AVAILABLE_IN_ALL
87const guchar * g_tls_password_get_value (GTlsPassword *password,
88 gsize *length);
89GLIB_AVAILABLE_IN_ALL
90void g_tls_password_set_value (GTlsPassword *password,
91 const guchar *value,
92 gssize length);
93GLIB_AVAILABLE_IN_ALL
94void g_tls_password_set_value_full (GTlsPassword *password,
95 guchar *value,
96 gssize length,
97 GDestroyNotify destroy);
98
99GLIB_AVAILABLE_IN_ALL
100GTlsPasswordFlags g_tls_password_get_flags (GTlsPassword *password);
101GLIB_AVAILABLE_IN_ALL
102void g_tls_password_set_flags (GTlsPassword *password,
103 GTlsPasswordFlags flags);
104
105GLIB_AVAILABLE_IN_ALL
106const gchar* g_tls_password_get_description (GTlsPassword *password);
107GLIB_AVAILABLE_IN_ALL
108void g_tls_password_set_description (GTlsPassword *password,
109 const gchar *description);
110
111GLIB_AVAILABLE_IN_ALL
112const gchar * g_tls_password_get_warning (GTlsPassword *password);
113GLIB_AVAILABLE_IN_ALL
114void g_tls_password_set_warning (GTlsPassword *password,
115 const gchar *warning);
116
117G_END_DECLS
118
119#endif /* __G_TLS_PASSWORD_H__ */
120