gio/gtlsclientconnection.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2010 Red Hat, Inc
   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
  19 #include "config.h"
  20 #include "glib.h"
  21
  22 #include "gtlsclientconnection.h"
  23 #include "ginitable.h"
  24 #include "gioenumtypes.h"
  25 #include "gsocket.h"
  26 #include "gsocketconnectable.h"
  27 #include "gtlsbackend.h"
  28 #include "gtlscertificate.h"
  29 #include "glibintl.h"
  30
  31 /**
  32  * SECTION:gtlsclientconnection
  33  * @short_description: TLS client-side connection
  34  * @include: gio/gio.h
  35  *
  36  * #GTlsClientConnection is the client-side subclass of
  37  * #GTlsConnection, representing a client-side TLS connection.
  38  */
  39
  40 /**
  41  * GTlsClientConnection:
  42  *
  43  * Abstract base class for the backend-specific client connection
  44  * type.
  45  *
  46  * Since: 2.28
  47  */
  48
  49 G_DEFINE_INTERFACE (GTlsClientConnection, g_tls_client_connection, G_TYPE_TLS_CONNECTION)
  50
  51 static void
  52 g_tls_client_connection_default_init (GTlsClientConnectionInterface *iface)
  53 {
  54   /**
  55    * GTlsClientConnection:validation-flags:
  56    *
  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.
  61    *
  62    * Since: 2.28
  63    */
  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,
  70                                                            G_PARAM_READWRITE |
  71                                                            G_PARAM_CONSTRUCT |
  72                                                            G_PARAM_STATIC_STRINGS));
  73
  74   /**
  75    * GTlsClientConnection:server-identity:
  76    *
  77    * A #GSocketConnectable describing the identity of the server that
  78    * is expected on the other end of the connection.
  79    *
  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.
  86    *
  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
  90    * virtual hosts.
  91    *
  92    * Since: 2.28
  93    */
  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,
  99                                                             G_PARAM_READWRITE |
 100                                                             G_PARAM_CONSTRUCT |
 101                                                             G_PARAM_STATIC_STRINGS));
 102
 103   /**
 104    * GTlsClientConnection:use-ssl3:
 105    *
 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.
 111    *
 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.
 116    *
 117    * Since: 2.28
 118    */
 119   g_object_interface_install_property (iface,
 120                                        g_param_spec_boolean ("use-ssl3",
 121                                                              P_("Use fallback"),
 122                                                              P_("Use fallback version of SSL/TLS rather than most recent version"),
 123                                                              FALSE,
 124                                                              G_PARAM_READWRITE |
 125                                                              G_PARAM_CONSTRUCT |
 126                                                              G_PARAM_STATIC_STRINGS));
 127
 128   /**
 129    * GTlsClientConnection:accepted-cas: (type GLib.List) (element-type GLib.ByteArray)
 130    *
 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.
 135    *
 136    * Each item in the list is a #GByteArray which contains the complete
 137    * subject DN of the certificate authority.
 138    *
 139    * Since: 2.28
 140    */
 141   g_object_interface_install_property (iface,
 142                                        g_param_spec_pointer ("accepted-cas",
 143                                                              P_("Accepted CAs"),
 144                                                              P_("Distinguished names of the CAs the server accepts certificates from"),
 145                                                              G_PARAM_READABLE |
 146                                                              G_PARAM_STATIC_STRINGS));
 147 }
 148
 149 /**
 150  * g_tls_client_connection_new:
 151  * @base_io_stream: the #GIOStream to wrap
 152  * @server_identity: (nullable): the expected identity of the server
 153  * @error: #GError for error reporting, or %NULL to ignore.
 154  *
 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.
 158  *
 159  * See the documentation for #GTlsConnection:base-io-stream for restrictions
 160  * on when application code can run operations on the @base_io_stream after
 161  * this function has returned.
 162  *
 163  * Returns: (transfer full) (type GTlsClientConnection): the new
 164  * #GTlsClientConnection, or %NULL on error
 165  *
 166  * Since: 2.28
 167  */
 168 GIOStream *
 169 g_tls_client_connection_new (GIOStream           *base_io_stream,
 170                              GSocketConnectable  *server_identity,
 171                              GError             **error)
 172 {
 173   GObject *conn;
 174   GTlsBackend *backend;
 175
 176   backend = g_tls_backend_get_default ();
 177   conn = g_initable_new (g_tls_backend_get_client_connection_type (backend),
 178                          NULL, error,
 179                          "base-io-stream", base_io_stream,
 180                          "server-identity", server_identity,
 181                          NULL);
 182   return G_IO_STREAM (conn);
 183 }
 184
 185 /**
 186  * g_tls_client_connection_get_validation_flags:
 187  * @conn: the #GTlsClientConnection
 188  *
 189  * Gets @conn's validation flags
 190  *
 191  * Returns: the validation flags
 192  *
 193  * Since: 2.28
 194  */
 195 GTlsCertificateFlags
 196 g_tls_client_connection_get_validation_flags (GTlsClientConnection *conn)
 197 {
 198   GTlsCertificateFlags flags = 0;
 199
 200   g_return_val_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn), 0);
 201
 202   g_object_get (G_OBJECT (conn), "validation-flags", &flags, NULL);
 203   return flags;
 204 }
 205
 206 /**
 207  * g_tls_client_connection_set_validation_flags:
 208  * @conn: the #GTlsClientConnection
 209  * @flags: the #GTlsCertificateFlags to use
 210  *
 211  * Sets @conn's validation flags, to override the default set of
 212  * checks performed when validating a server certificate. By default,
 213  * %G_TLS_CERTIFICATE_VALIDATE_ALL is used.
 214  *
 215  * Since: 2.28
 216  */
 217 void
 218 g_tls_client_connection_set_validation_flags (GTlsClientConnection  *conn,
 219                                               GTlsCertificateFlags   flags)
 220 {
 221   g_return_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn));
 222
 223   g_object_set (G_OBJECT (conn), "validation-flags", flags, NULL);
 224 }
 225
 226 /**
 227  * g_tls_client_connection_get_server_identity:
 228  * @conn: the #GTlsClientConnection
 229  *
 230  * Gets @conn's expected server identity
 231  *
 232  * Returns: (transfer none): a #GSocketConnectable describing the
 233  * expected server identity, or %NULL if the expected identity is not
 234  * known.
 235  *
 236  * Since: 2.28
 237  */
 238 GSocketConnectable *
 239 g_tls_client_connection_get_server_identity (GTlsClientConnection *conn)
 240 {
 241   GSocketConnectable *identity = NULL;
 242
 243   g_return_val_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn), 0);
 244
 245   g_object_get (G_OBJECT (conn), "server-identity", &identity, NULL);
 246   if (identity)
 247     g_object_unref (identity);
 248   return identity;
 249 }
 250
 251 /**
 252  * g_tls_client_connection_set_server_identity:
 253  * @conn: the #GTlsClientConnection
 254  * @identity: a #GSocketConnectable describing the expected server identity
 255  *
 256  * Sets @conn's expected server identity, which is used both to tell
 257  * servers on virtual hosts which certificate to present, and also
 258  * to let @conn know what name to look for in the certificate when
 259  * performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled.
 260  *
 261  * Since: 2.28
 262  */
 263 void
 264 g_tls_client_connection_set_server_identity (GTlsClientConnection *conn,
 265                                              GSocketConnectable   *identity)
 266 {
 267   g_return_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn));
 268
 269   g_object_set (G_OBJECT (conn), "server-identity", identity, NULL);
 270 }
 271
 272 /**
 273  * g_tls_client_connection_get_use_ssl3:
 274  * @conn: the #GTlsClientConnection
 275  *
 276  * Gets whether @conn will use SSL 3.0 rather than the
 277  * highest-supported version of TLS; see
 278  * g_tls_client_connection_set_use_ssl3().
 279  *
 280  * Returns: whether @conn will use SSL 3.0
 281  *
 282  * Since: 2.28
 283  */
 284 gboolean
 285 g_tls_client_connection_get_use_ssl3 (GTlsClientConnection *conn)
 286 {
 287   gboolean use_ssl3 = FALSE;
 288
 289   g_return_val_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn), 0);
 290
 291   g_object_get (G_OBJECT (conn), "use-ssl3", &use_ssl3, NULL);
 292   return use_ssl3;
 293 }
 294
 295 /**
 296  * g_tls_client_connection_set_use_ssl3:
 297  * @conn: the #GTlsClientConnection
 298  * @use_ssl3: whether to use SSL 3.0
 299  *
 300  * If @use_ssl3 is %TRUE, this forces @conn to use SSL 3.0 rather than
 301  * trying to properly negotiate the right version of TLS or SSL to use.
 302  * This can be used when talking to servers that do not implement the
 303  * fallbacks correctly and which will therefore fail to handshake with
 304  * a "modern" TLS handshake attempt.
 305  *
 306  * Since: 2.28
 307  */
 308 void
 309 g_tls_client_connection_set_use_ssl3 (GTlsClientConnection *conn,
 310                                       gboolean              use_ssl3)
 311 {
 312   g_return_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn));
 313
 314   g_object_set (G_OBJECT (conn), "use-ssl3", use_ssl3, NULL);
 315 }
 316
 317 /**
 318  * g_tls_client_connection_get_accepted_cas:
 319  * @conn: the #GTlsClientConnection
 320  *
 321  * Gets the list of distinguished names of the Certificate Authorities
 322  * that the server will accept certificates from. This will be set
 323  * during the TLS handshake if the server requests a certificate.
 324  * Otherwise, it will be %NULL.
 325  *
 326  * Each item in the list is a #GByteArray which contains the complete
 327  * subject DN of the certificate authority.
 328  *
 329  * Returns: (element-type GByteArray) (transfer full): the list of
 330  * CA DNs. You should unref each element with g_byte_array_unref() and then
 331  * the free the list with g_list_free().
 332  *
 333  * Since: 2.28
 334  */
 335 GList *
 336 g_tls_client_connection_get_accepted_cas (GTlsClientConnection *conn)
 337 {
 338   GList *accepted_cas = NULL;
 339
 340   g_return_val_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn), NULL);
 341
 342   g_object_get (G_OBJECT (conn), "accepted-cas", &accepted_cas, NULL);
 343   return accepted_cas;
 344 }
 345
 346 /**
 347  * g_tls_client_connection_copy_session_state:
 348  * @conn: a #GTlsClientConnection
 349  * @source: a #GTlsClientConnection
 350  *
 351  * Copies session state from one connection to another. This is
 352  * not normally needed, but may be used when the same session
 353  * needs to be used between different endpoints as is required
 354  * by some protocols such as FTP over TLS. @source should have
 355  * already completed a handshake, and @conn should not have
 356  * completed a handshake.
 357  *
 358  * Since: 2.46
 359  */
 360 void
 361 g_tls_client_connection_copy_session_state (GTlsClientConnection *conn,
 362                                             GTlsClientConnection *source)
 363 {
 364   g_return_if_fail (G_IS_TLS_CLIENT_CONNECTION (conn));
 365   g_return_if_fail (G_IS_TLS_CLIENT_CONNECTION (source));
 366   g_return_if_fail (G_TLS_CLIENT_CONNECTION_GET_INTERFACE (conn)->copy_session_state != NULL);
 367
 368   G_TLS_CLIENT_CONNECTION_GET_INTERFACE (conn)->copy_session_state (conn,
 369                                                                     source);
 370 }