1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright © 2010 Red Hat, Inc
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.
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.
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.
24 #include "gtlsbackend.h"
25 #include "gdummytlsbackend.h"
26 #include "gioenumtypes.h"
27 #include "giomodule-priv.h"
31 * @title: TLS Overview
32 * @short_description: TLS (aka SSL) support for GSocketConnection
35 * #GTlsConnection and related classes provide TLS (Transport Layer
36 * Security, previously known as SSL, Secure Sockets Layer) support for
37 * gio-based network streams.
39 * In the simplest case, for a client connection, you can just set the
40 * #GSocketClient:tls flag on a #GSocketClient, and then any
41 * connections created by that client will have TLS negotiated
42 * automatically, using appropriate default settings, and rejecting
43 * any invalid or self-signed certificates (unless you change that
44 * default by setting the #GSocketClient:tls-validation-flags
45 * property). The returned object will be a #GTcpWrapperConnection,
46 * which wraps the underlying #GTlsClientConnection.
48 * For greater control, you can create your own #GTlsClientConnection,
49 * wrapping a #GSocketConnection (or an arbitrary #GIOStream with
50 * pollable input and output streams) and then connect to its signals,
51 * such as #GTlsConnection::accept-certificate, before starting the
54 * Server-side TLS is similar, using #GTlsServerConnection. At the
55 * moment, there is no support for automatically wrapping server-side
56 * connections in the way #GSocketClient does for client-side
63 * @short_description: TLS backend implementation
70 * Type implemented by TLS #GIOModules to provide access to additional
76 G_DEFINE_INTERFACE (GTlsBackend, g_tls_backend, G_TYPE_OBJECT);
79 g_tls_backend_default_init (GTlsBackendInterface *iface)
84 * g_tls_backend_get_default:
86 * Gets the default #GTlsBackend for the system.
88 * Returns: (transfer none): a #GTlsBackend
93 g_tls_backend_get_default (void)
95 return _g_io_module_get_default (G_TLS_BACKEND_EXTENSION_POINT_NAME,
100 * g_tls_backend_supports_tls:
101 * @backend: the #GTlsBackend
103 * Checks if TLS is supported; if this returns %FALSE for the default
104 * #GTlsBackend, it means no "real" TLS backend is available.
106 * Return value: whether or not TLS is supported
111 g_tls_backend_supports_tls (GTlsBackend *backend)
113 if (G_TLS_BACKEND_GET_INTERFACE (backend)->supports_tls)
114 return G_TLS_BACKEND_GET_INTERFACE (backend)->supports_tls (backend);
115 else if (G_IS_DUMMY_TLS_BACKEND (backend))
122 * g_tls_backend_get_default_database:
123 * @backend: the #GTlsBackend
125 * Gets the default #GTlsDatabase used to verify TLS connections.
127 * Return value: (transfer full): the default database, which should be
128 * unreffed when done.
133 g_tls_backend_get_default_database (GTlsBackend *backend)
135 g_return_val_if_fail (G_IS_TLS_BACKEND (backend), NULL);
137 /* This method was added later, so accept the (remote) possibility it can be NULL */
138 if (!G_TLS_BACKEND_GET_INTERFACE (backend)->get_default_database)
141 return G_TLS_BACKEND_GET_INTERFACE (backend)->get_default_database (backend);
145 * g_tls_backend_get_certificate_type:
146 * @backend: the #GTlsBackend
148 * Gets the #GType of @backend's #GTlsCertificate implementation.
150 * Return value: the #GType of @backend's #GTlsCertificate
156 g_tls_backend_get_certificate_type (GTlsBackend *backend)
158 return G_TLS_BACKEND_GET_INTERFACE (backend)->get_certificate_type ();
162 * g_tls_backend_get_client_connection_type:
163 * @backend: the #GTlsBackend
165 * Gets the #GType of @backend's #GTlsClientConnection implementation.
167 * Return value: the #GType of @backend's #GTlsClientConnection
173 g_tls_backend_get_client_connection_type (GTlsBackend *backend)
175 return G_TLS_BACKEND_GET_INTERFACE (backend)->get_client_connection_type ();
179 * g_tls_backend_get_server_connection_type:
180 * @backend: the #GTlsBackend
182 * Gets the #GType of @backend's #GTlsServerConnection implementation.
184 * Return value: the #GType of @backend's #GTlsServerConnection
190 g_tls_backend_get_server_connection_type (GTlsBackend *backend)
192 return G_TLS_BACKEND_GET_INTERFACE (backend)->get_server_connection_type ();
196 * g_tls_backend_get_file_database_type:
197 * @backend: the #GTlsBackend
199 * Gets the #GTyep of @backend's #GTlsFileDatabase implementation.
201 * Return value: the #GType of backend's #GTlsFileDatabase implementation.
206 g_tls_backend_get_file_database_type (GTlsBackend *backend)
208 g_return_val_if_fail (G_IS_TLS_BACKEND (backend), 0);
210 /* This method was added later, so accept the (remote) possibility it can be NULL */
211 if (!G_TLS_BACKEND_GET_INTERFACE (backend)->get_file_database_type)
214 return G_TLS_BACKEND_GET_INTERFACE (backend)->get_file_database_type ();