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, see <http://www.gnu.org/licenses/>.
22 #include "gtlsclientconnection.h"
23 #include "ginitable.h"
24 #include "gioenumtypes.h"
26 #include "gsocketconnectable.h"
27 #include "gtlsbackend.h"
28 #include "gtlscertificate.h"
32 * SECTION:gtlsclientconnection
33 * @short_description: TLS client-side connection
36 * #GTlsClientConnection is the client-side subclass of
37 * #GTlsConnection, representing a client-side TLS connection.
41 * GTlsClientConnection:
43 * Abstract base class for the backend-specific client connection
49 G_DEFINE_INTERFACE (GTlsClientConnection, g_tls_client_connection, G_TYPE_TLS_CONNECTION)
52 g_tls_client_connection_default_init (GTlsClientConnectionInterface *iface)
55 * GTlsClientConnection:validation-flags:
57 * What steps to perform when validating a certificate received from
58 * a server. Server certificates that fail to validate in all of the
59 * ways indicated here will be rejected unless the application
60 * overrides the default via #GTlsConnection::accept-certificate.
64 g_object_interface_install_property (iface,
65 g_param_spec_flags ("validation-flags",
66 P_("Validation flags"),
67 P_("What certificate validation to perform"),
68 G_TYPE_TLS_CERTIFICATE_FLAGS,
69 G_TLS_CERTIFICATE_VALIDATE_ALL,
72 G_PARAM_STATIC_STRINGS));
75 * GTlsClientConnection:server-identity:
77 * A #GSocketConnectable describing the identity of the server that
78 * is expected on the other end of the connection.
80 * If the %G_TLS_CERTIFICATE_BAD_IDENTITY flag is set in
81 * #GTlsClientConnection:validation-flags, this object will be used
82 * to determine the expected identify of the remote end of the
83 * connection; if #GTlsClientConnection:server-identity is not set,
84 * or does not match the identity presented by the server, then the
85 * %G_TLS_CERTIFICATE_BAD_IDENTITY validation will fail.
87 * In addition to its use in verifying the server certificate,
88 * this is also used to give a hint to the server about what
89 * certificate we expect, which is useful for servers that serve
94 g_object_interface_install_property (iface,
95 g_param_spec_object ("server-identity",
96 P_("Server identity"),
97 P_("GSocketConnectable identifying the server"),
98 G_TYPE_SOCKET_CONNECTABLE,
101 G_PARAM_STATIC_STRINGS));
104 * GTlsClientConnection:use-ssl3:
106 * If %TRUE, tells the connection to use a fallback version of TLS
107 * or SSL, rather than trying to negotiate the best version of TLS
108 * to use. This can be used when talking to servers that don't
109 * implement version negotiation correctly and therefore refuse to
110 * handshake at all with a "modern" TLS handshake.
112 * Despite the property name, the fallback version is not
113 * necessarily SSL 3.0; if SSL 3.0 has been disabled, the
114 * #GTlsClientConnection will use the next highest available version
115 * (normally TLS 1.0) as the fallback version.
119 g_object_interface_install_property (iface,
120 g_param_spec_boolean ("use-ssl3",
122 P_("Use fallback version of SSL/TLS rather than most recent version"),
126 G_PARAM_STATIC_STRINGS));
129 * GTlsClientConnection:accepted-cas: (type GLib.List) (element-type GLib.ByteArray):
131 * A list of the distinguished names of the Certificate Authorities
132 * that the server will accept client certificates signed by. If the
133 * server requests a client certificate during the handshake, then
134 * this property will be set after the handshake completes.
136 * Each item in the list is a #GByteArray which contains the complete
137 * subject DN of the certificate authority.
141 g_object_interface_install_property (iface,
142 g_param_spec_pointer ("accepted-cas",
144 P_("Distinguished names of the CAs the server accepts certificates from"),
146 G_PARAM_STATIC_STRINGS));
150 * g_tls_client_connection_new:
151 * @base_io_stream: the #GIOStream to wrap
152 * @server_identity: (allow-none): the expected identity of the server
153 * @error: #GError for error reporting, or %NULL to ignore.
155 * Creates a new #GTlsClientConnection wrapping @base_io_stream (which
156 * must have pollable input and output streams) which is assumed to
157 * communicate with the server identified by @server_identity.
159 * Returns: (transfer full) (type GTlsClientConnection): the new
160 * #GTlsClientConnection, or %NULL on error
165 g_tls_client_connection_new (GIOStream *base_io_stream,
166 GSocketConnectable *server_identity,
170 GTlsBackend *backend;
172 backend = g_tls_backend_get_default ();
173 conn = g_initable_new (g_tls_backend_get_client_connection_type (backend),
175 "base-io-stream", base_io_stream,
176 "server-identity", server_identity,
178 return G_IO_STREAM (conn);
182 * g_tls_client_connection_get_validation_flags:
183 * @conn: the #GTlsClientConnection
185 * Gets @conn's validation flags
187 * Returns: the validation flags
192 g_tls_client_connection_get_validation_flags (GTlsClientConnection *conn)
194 GTlsCertificateFlags flags = 0;
196 g_return_val_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn), 0);
198 g_object_get (G_OBJECT (conn), "validation-flags", &flags, NULL);
203 * g_tls_client_connection_set_validation_flags:
204 * @conn: the #GTlsClientConnection
205 * @flags: the #GTlsCertificateFlags to use
207 * Sets @conn's validation flags, to override the default set of
208 * checks performed when validating a server certificate. By default,
209 * %G_TLS_CERTIFICATE_VALIDATE_ALL is used.
214 g_tls_client_connection_set_validation_flags (GTlsClientConnection *conn,
215 GTlsCertificateFlags flags)
217 g_return_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn));
219 g_object_set (G_OBJECT (conn), "validation-flags", flags, NULL);
223 * g_tls_client_connection_get_server_identity:
224 * @conn: the #GTlsClientConnection
226 * Gets @conn's expected server identity
228 * Returns: (transfer none): a #GSocketConnectable describing the
229 * expected server identity, or %NULL if the expected identity is not
235 g_tls_client_connection_get_server_identity (GTlsClientConnection *conn)
237 GSocketConnectable *identity = NULL;
239 g_return_val_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn), 0);
241 g_object_get (G_OBJECT (conn), "server-identity", &identity, NULL);
243 g_object_unref (identity);
248 * g_tls_client_connection_set_server_identity:
249 * @conn: the #GTlsClientConnection
250 * @identity: a #GSocketConnectable describing the expected server identity
252 * Sets @conn's expected server identity, which is used both to tell
253 * servers on virtual hosts which certificate to present, and also
254 * to let @conn know what name to look for in the certificate when
255 * performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled.
260 g_tls_client_connection_set_server_identity (GTlsClientConnection *conn,
261 GSocketConnectable *identity)
263 g_return_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn));
265 g_object_set (G_OBJECT (conn), "server-identity", identity, NULL);
269 * g_tls_client_connection_get_use_ssl3:
270 * @conn: the #GTlsClientConnection
272 * Gets whether @conn will use SSL 3.0 rather than the
273 * highest-supported version of TLS; see
274 * g_tls_client_connection_set_use_ssl3().
276 * Returns: whether @conn will use SSL 3.0
281 g_tls_client_connection_get_use_ssl3 (GTlsClientConnection *conn)
283 gboolean use_ssl3 = FALSE;
285 g_return_val_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn), 0);
287 g_object_get (G_OBJECT (conn), "use-ssl3", &use_ssl3, NULL);
292 * g_tls_client_connection_set_use_ssl3:
293 * @conn: the #GTlsClientConnection
294 * @use_ssl3: whether to use SSL 3.0
296 * If @use_ssl3 is %TRUE, this forces @conn to use SSL 3.0 rather than
297 * trying to properly negotiate the right version of TLS or SSL to use.
298 * This can be used when talking to servers that do not implement the
299 * fallbacks correctly and which will therefore fail to handshake with
300 * a "modern" TLS handshake attempt.
305 g_tls_client_connection_set_use_ssl3 (GTlsClientConnection *conn,
308 g_return_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn));
310 g_object_set (G_OBJECT (conn), "use-ssl3", use_ssl3, NULL);
314 * g_tls_client_connection_get_accepted_cas:
315 * @conn: the #GTlsClientConnection
317 * Gets the list of distinguished names of the Certificate Authorities
318 * that the server will accept certificates from. This will be set
319 * during the TLS handshake if the server requests a certificate.
320 * Otherwise, it will be %NULL.
322 * Each item in the list is a #GByteArray which contains the complete
323 * subject DN of the certificate authority.
325 * Returns: (element-type GByteArray) (transfer full): the list of
326 * CA DNs. You should unref each element with g_byte_array_unref() and then
327 * the free the list with g_list_free().
332 g_tls_client_connection_get_accepted_cas (GTlsClientConnection *conn)
334 GList *accepted_cas = NULL;
336 g_return_val_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn), NULL);
338 g_object_get (G_OBJECT (conn), "accepted-cas", &accepted_cas, NULL);