/* GIO - GLib Input, Output and Streaming Library
*
* Copyright (C) 2010 Red Hat, Inc.
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, see .
*/
#ifndef __G_TLS_CONNECTION_H__
#define __G_TLS_CONNECTION_H__
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only can be included directly."
#endif
#include
G_BEGIN_DECLS
#define G_TYPE_TLS_CONNECTION (g_tls_connection_get_type ())
#define G_TLS_CONNECTION(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), G_TYPE_TLS_CONNECTION, GTlsConnection))
#define G_TLS_CONNECTION_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_TLS_CONNECTION, GTlsConnectionClass))
#define G_IS_TLS_CONNECTION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_TLS_CONNECTION))
#define G_IS_TLS_CONNECTION_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_TLS_CONNECTION))
#define G_TLS_CONNECTION_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), G_TYPE_TLS_CONNECTION, GTlsConnectionClass))
typedef struct _GTlsConnectionClass GTlsConnectionClass;
typedef struct _GTlsConnectionPrivate GTlsConnectionPrivate;
struct _GTlsConnection {
GIOStream parent_instance;
GTlsConnectionPrivate *priv;
};
/**
* GTlsConnectionClass:
* @parent_class: The parent class.
* @accept_certificate: Check whether to accept a certificate.
* @handshake: Perform a handshake operation.
* @handshake_async: Start an asynchronous handshake operation.
* @handshake_finish: Finish an asynchronous handshake operation.
* @get_binding_data: Retrieve TLS channel binding data (Since: 2.66)
* @get_negotiated_protocol: Get ALPN-negotiated protocol (Since: 2.70)
*
* The class structure for the #GTlsConnection type.
*
* Since: 2.28
*/
struct _GTlsConnectionClass
{
GIOStreamClass parent_class;
/* signals */
gboolean ( *accept_certificate) (GTlsConnection *connection,
GTlsCertificate *peer_cert,
GTlsCertificateFlags errors);
/* methods */
gboolean ( *handshake ) (GTlsConnection *conn,
GCancellable *cancellable,
GError **error);
void ( *handshake_async ) (GTlsConnection *conn,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean ( *handshake_finish ) (GTlsConnection *conn,
GAsyncResult *result,
GError **error);
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
gboolean ( *get_binding_data) (GTlsConnection *conn,
GTlsChannelBindingType type,
GByteArray *data,
GError **error);
G_GNUC_END_IGNORE_DEPRECATIONS
const gchar *(*get_negotiated_protocol) (GTlsConnection *conn);
/*< private >*/
/* Padding for future expansion */
gpointer padding[6];
};
GIO_AVAILABLE_IN_ALL
GType g_tls_connection_get_type (void) G_GNUC_CONST;
GIO_DEPRECATED
void g_tls_connection_set_use_system_certdb (GTlsConnection *conn,
gboolean use_system_certdb);
GIO_DEPRECATED
gboolean g_tls_connection_get_use_system_certdb (GTlsConnection *conn);
GIO_AVAILABLE_IN_ALL
void g_tls_connection_set_database (GTlsConnection *conn,
GTlsDatabase *database);
GIO_AVAILABLE_IN_ALL
GTlsDatabase * g_tls_connection_get_database (GTlsConnection *conn);
GIO_AVAILABLE_IN_ALL
void g_tls_connection_set_certificate (GTlsConnection *conn,
GTlsCertificate *certificate);
GIO_AVAILABLE_IN_ALL
GTlsCertificate *g_tls_connection_get_certificate (GTlsConnection *conn);
GIO_AVAILABLE_IN_ALL
void g_tls_connection_set_interaction (GTlsConnection *conn,
GTlsInteraction *interaction);
GIO_AVAILABLE_IN_ALL
GTlsInteraction * g_tls_connection_get_interaction (GTlsConnection *conn);
GIO_AVAILABLE_IN_ALL
GTlsCertificate *g_tls_connection_get_peer_certificate (GTlsConnection *conn);
GIO_AVAILABLE_IN_ALL
GTlsCertificateFlags g_tls_connection_get_peer_certificate_errors (GTlsConnection *conn);
GIO_AVAILABLE_IN_ALL
void g_tls_connection_set_require_close_notify (GTlsConnection *conn,
gboolean require_close_notify);
GIO_AVAILABLE_IN_ALL
gboolean g_tls_connection_get_require_close_notify (GTlsConnection *conn);
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
GIO_DEPRECATED_IN_2_60
void g_tls_connection_set_rehandshake_mode (GTlsConnection *conn,
GTlsRehandshakeMode mode);
GIO_DEPRECATED_IN_2_60
GTlsRehandshakeMode g_tls_connection_get_rehandshake_mode (GTlsConnection *conn);
G_GNUC_END_IGNORE_DEPRECATIONS
GIO_AVAILABLE_IN_2_60
void g_tls_connection_set_advertised_protocols (GTlsConnection *conn,
const gchar * const *protocols);
GIO_AVAILABLE_IN_2_60
const gchar * g_tls_connection_get_negotiated_protocol (GTlsConnection *conn);
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
GIO_AVAILABLE_IN_2_66
gboolean g_tls_connection_get_channel_binding_data (GTlsConnection *conn,
GTlsChannelBindingType type,
GByteArray *data,
GError **error);
G_GNUC_END_IGNORE_DEPRECATIONS
GIO_AVAILABLE_IN_ALL
gboolean g_tls_connection_handshake (GTlsConnection *conn,
GCancellable *cancellable,
GError **error);
GIO_AVAILABLE_IN_ALL
void g_tls_connection_handshake_async (GTlsConnection *conn,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GIO_AVAILABLE_IN_ALL
gboolean g_tls_connection_handshake_finish (GTlsConnection *conn,
GAsyncResult *result,
GError **error);
GIO_AVAILABLE_IN_2_70
GTlsProtocolVersion g_tls_connection_get_protocol_version (GTlsConnection *conn);
GIO_AVAILABLE_IN_2_70
gchar * g_tls_connection_get_ciphersuite_name (GTlsConnection *conn);
/**
* G_TLS_ERROR:
*
* Error domain for TLS. Errors in this domain will be from the
* #GTlsError enumeration. See #GError for more information on error
* domains.
*/
#define G_TLS_ERROR (g_tls_error_quark ())
GIO_AVAILABLE_IN_ALL
GQuark g_tls_error_quark (void);
/**
* G_TLS_CHANNEL_BINDING_ERROR:
*
* Error domain for TLS channel binding. Errors in this domain will be from the
* #GTlsChannelBindingError enumeration. See #GError for more information on error
* domains.
*
* Since: 2.66
*/
#define G_TLS_CHANNEL_BINDING_ERROR (g_tls_channel_binding_error_quark ())
GIO_AVAILABLE_IN_2_66
GQuark g_tls_channel_binding_error_quark (void);
/*< protected >*/
GIO_AVAILABLE_IN_ALL
gboolean g_tls_connection_emit_accept_certificate (GTlsConnection *conn,
GTlsCertificate *peer_cert,
GTlsCertificateFlags errors);
G_END_DECLS
#endif /* __G_TLS_CONNECTION_H__ */