1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright © 2010 Red Hat, Inc.
4 * Copyright © 2015 Collabora, Ltd.
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General
17 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef __G_DTLS_CONNECTION_H__
21#define __G_DTLS_CONNECTION_H__
22
23#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24#error "Only <gio/gio.h> can be included directly."
25#endif
26
27#include <gio/gdatagrambased.h>
28
29G_BEGIN_DECLS
30
31#define G_TYPE_DTLS_CONNECTION (g_dtls_connection_get_type ())
32#define G_DTLS_CONNECTION(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), G_TYPE_DTLS_CONNECTION, GDtlsConnection))
33#define G_IS_DTLS_CONNECTION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_DTLS_CONNECTION))
34#define G_DTLS_CONNECTION_GET_INTERFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), G_TYPE_DTLS_CONNECTION, GDtlsConnectionInterface))
35
36typedef struct _GDtlsConnectionInterface GDtlsConnectionInterface;
37
38/**
39 * GDtlsConnectionInterface:
40 * @g_iface: The parent interface.
41 * @accept_certificate: Check whether to accept a certificate.
42 * @handshake: Perform a handshake operation.
43 * @handshake_async: Start an asynchronous handshake operation.
44 * @handshake_finish: Finish an asynchronous handshake operation.
45 * @shutdown: Shut down one or both directions of the connection.
46 * @shutdown_async: Start an asynchronous shutdown operation.
47 * @shutdown_finish: Finish an asynchronous shutdown operation.
48 * @set_advertised_protocols: Set APLN protocol list
49 * @get_negotiated_protocol: Retrieve ALPN-negotiated protocol
50 *
51 * Virtual method table for a #GDtlsConnection implementation.
52 *
53 * Since: 2.48
54 */
55struct _GDtlsConnectionInterface
56{
57 GTypeInterface g_iface;
58
59 /* signals */
60 gboolean (*accept_certificate) (GDtlsConnection *connection,
61 GTlsCertificate *peer_cert,
62 GTlsCertificateFlags errors);
63
64 /* methods */
65 gboolean (*handshake) (GDtlsConnection *conn,
66 GCancellable *cancellable,
67 GError **error);
68
69 void (*handshake_async) (GDtlsConnection *conn,
70 int io_priority,
71 GCancellable *cancellable,
72 GAsyncReadyCallback callback,
73 gpointer user_data);
74 gboolean (*handshake_finish) (GDtlsConnection *conn,
75 GAsyncResult *result,
76 GError **error);
77
78 gboolean (*shutdown) (GDtlsConnection *conn,
79 gboolean shutdown_read,
80 gboolean shutdown_write,
81 GCancellable *cancellable,
82 GError **error);
83
84 void (*shutdown_async) (GDtlsConnection *conn,
85 gboolean shutdown_read,
86 gboolean shutdown_write,
87 int io_priority,
88 GCancellable *cancellable,
89 GAsyncReadyCallback callback,
90 gpointer user_data);
91 gboolean (*shutdown_finish) (GDtlsConnection *conn,
92 GAsyncResult *result,
93 GError **error);
94
95 void (*set_advertised_protocols) (GDtlsConnection *conn,
96 const gchar * const *protocols);
97 const gchar *(*get_negotiated_protocol) (GDtlsConnection *conn);
98
99G_GNUC_BEGIN_IGNORE_DEPRECATIONS
100 gboolean (*get_binding_data) (GDtlsConnection *conn,
101 GTlsChannelBindingType type,
102 GByteArray *data,
103 GError **error);
104G_GNUC_END_IGNORE_DEPRECATIONS
105};
106
107GLIB_AVAILABLE_IN_2_48
108GType g_dtls_connection_get_type (void) G_GNUC_CONST;
109
110GLIB_AVAILABLE_IN_2_48
111void g_dtls_connection_set_database (GDtlsConnection *conn,
112 GTlsDatabase *database);
113GLIB_AVAILABLE_IN_2_48
114GTlsDatabase *g_dtls_connection_get_database (GDtlsConnection *conn);
115
116GLIB_AVAILABLE_IN_2_48
117void g_dtls_connection_set_certificate (GDtlsConnection *conn,
118 GTlsCertificate *certificate);
119GLIB_AVAILABLE_IN_2_48
120GTlsCertificate *g_dtls_connection_get_certificate (GDtlsConnection *conn);
121
122GLIB_AVAILABLE_IN_2_48
123void g_dtls_connection_set_interaction (GDtlsConnection *conn,
124 GTlsInteraction *interaction);
125GLIB_AVAILABLE_IN_2_48
126GTlsInteraction *g_dtls_connection_get_interaction (GDtlsConnection *conn);
127
128GLIB_AVAILABLE_IN_2_48
129GTlsCertificate *g_dtls_connection_get_peer_certificate (GDtlsConnection *conn);
130GLIB_AVAILABLE_IN_2_48
131GTlsCertificateFlags g_dtls_connection_get_peer_certificate_errors (GDtlsConnection *conn);
132
133GLIB_AVAILABLE_IN_2_48
134void g_dtls_connection_set_require_close_notify (GDtlsConnection *conn,
135 gboolean require_close_notify);
136GLIB_AVAILABLE_IN_2_48
137gboolean g_dtls_connection_get_require_close_notify (GDtlsConnection *conn);
138
139G_GNUC_BEGIN_IGNORE_DEPRECATIONS
140GLIB_DEPRECATED_IN_2_60
141void g_dtls_connection_set_rehandshake_mode (GDtlsConnection *conn,
142 GTlsRehandshakeMode mode);
143GLIB_DEPRECATED_IN_2_60
144GTlsRehandshakeMode g_dtls_connection_get_rehandshake_mode (GDtlsConnection *conn);
145G_GNUC_END_IGNORE_DEPRECATIONS
146
147GLIB_AVAILABLE_IN_2_48
148gboolean g_dtls_connection_handshake (GDtlsConnection *conn,
149 GCancellable *cancellable,
150 GError **error);
151
152GLIB_AVAILABLE_IN_2_48
153void g_dtls_connection_handshake_async (GDtlsConnection *conn,
154 int io_priority,
155 GCancellable *cancellable,
156 GAsyncReadyCallback callback,
157 gpointer user_data);
158GLIB_AVAILABLE_IN_2_48
159gboolean g_dtls_connection_handshake_finish (GDtlsConnection *conn,
160 GAsyncResult *result,
161 GError **error);
162
163GLIB_AVAILABLE_IN_2_48
164gboolean g_dtls_connection_shutdown (GDtlsConnection *conn,
165 gboolean shutdown_read,
166 gboolean shutdown_write,
167 GCancellable *cancellable,
168 GError **error);
169
170GLIB_AVAILABLE_IN_2_48
171void g_dtls_connection_shutdown_async (GDtlsConnection *conn,
172 gboolean shutdown_read,
173 gboolean shutdown_write,
174 int io_priority,
175 GCancellable *cancellable,
176 GAsyncReadyCallback callback,
177 gpointer user_data);
178GLIB_AVAILABLE_IN_2_48
179gboolean g_dtls_connection_shutdown_finish (GDtlsConnection *conn,
180 GAsyncResult *result,
181 GError **error);
182
183GLIB_AVAILABLE_IN_2_48
184gboolean g_dtls_connection_close (GDtlsConnection *conn,
185 GCancellable *cancellable,
186 GError **error);
187
188GLIB_AVAILABLE_IN_2_48
189void g_dtls_connection_close_async (GDtlsConnection *conn,
190 int io_priority,
191 GCancellable *cancellable,
192 GAsyncReadyCallback callback,
193 gpointer user_data);
194GLIB_AVAILABLE_IN_2_48
195gboolean g_dtls_connection_close_finish (GDtlsConnection *conn,
196 GAsyncResult *result,
197 GError **error);
198
199/*< protected >*/
200GLIB_AVAILABLE_IN_2_48
201gboolean g_dtls_connection_emit_accept_certificate (GDtlsConnection *conn,
202 GTlsCertificate *peer_cert,
203 GTlsCertificateFlags errors);
204GLIB_AVAILABLE_IN_2_60
205void g_dtls_connection_set_advertised_protocols (GDtlsConnection *conn,
206 const gchar * const *protocols);
207
208GLIB_AVAILABLE_IN_2_60
209const gchar * g_dtls_connection_get_negotiated_protocol (GDtlsConnection *conn);
210
211G_GNUC_BEGIN_IGNORE_DEPRECATIONS
212GLIB_AVAILABLE_IN_2_66
213gboolean g_dtls_connection_get_channel_binding_data (GDtlsConnection *conn,
214 GTlsChannelBindingType type,
215 GByteArray *data,
216 GError **error);
217G_GNUC_END_IGNORE_DEPRECATIONS
218
219G_END_DECLS
220
221#endif /* __G_DTLS_CONNECTION_H__ */
222

source code of gtk/subprojects/glib/gio/gdtlsconnection.h