gio.TlsClientConnectionIF source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD 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
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.TlsClientConnectionIF;
26 
27 private import gio.IOStream;
28 private import gio.SocketConnectable;
29 private import gio.SocketConnectableIF;
30 private import glib.ConstructionException;
31 private import glib.ErrorG;
32 private import glib.GException;
33 private import glib.ListG;
34 private import gobject.ObjectG;
35 private import gtkc.gio;
36 public  import gtkc.giotypes;
37 
38 
39 /**
40  * #GTlsClientConnection is the client-side subclass of
41  * #GTlsConnection, representing a client-side TLS connection.
42  *
43  * Since: 2.28
44  */
45 public interface TlsClientConnectionIF{
46 	/** Get the main Gtk struct */
47 	public GTlsClientConnection* getTlsClientConnectionStruct();
48 
49 	/** the main Gtk struct as a void* */
50 	protected void* getStruct();
51 
52 	/**
53 	 */
54 
55 	/**
56 	 * Gets the list of distinguished names of the Certificate Authorities
57 	 * that the server will accept certificates from. This will be set
58 	 * during the TLS handshake if the server requests a certificate.
59 	 * Otherwise, it will be %NULL.
60 	 *
61 	 * Each item in the list is a #GByteArray which contains the complete
62 	 * subject DN of the certificate authority.
63 	 *
64 	 * Return: the list of
65 	 *     CA DNs. You should unref each element with g_byte_array_unref() and then
66 	 *     the free the list with g_list_free().
67 	 *
68 	 * Since: 2.28
69 	 */
70 	public ListG getAcceptedCas();
71 
72 	/**
73 	 * Gets @conn's expected server identity
74 	 *
75 	 * Return: a #GSocketConnectable describing the
76 	 *     expected server identity, or %NULL if the expected identity is not
77 	 *     known.
78 	 *
79 	 * Since: 2.28
80 	 */
81 	public SocketConnectableIF getServerIdentity();
82 
83 	/**
84 	 * Gets whether @conn will use SSL 3.0 rather than the
85 	 * highest-supported version of TLS; see
86 	 * g_tls_client_connection_set_use_ssl3().
87 	 *
88 	 * Return: whether @conn will use SSL 3.0
89 	 *
90 	 * Since: 2.28
91 	 */
92 	public bool getUseSsl3();
93 
94 	/**
95 	 * Gets @conn's validation flags
96 	 *
97 	 * Return: the validation flags
98 	 *
99 	 * Since: 2.28
100 	 */
101 	public GTlsCertificateFlags getValidationFlags();
102 
103 	/**
104 	 * Sets @conn's expected server identity, which is used both to tell
105 	 * servers on virtual hosts which certificate to present, and also
106 	 * to let @conn know what name to look for in the certificate when
107 	 * performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled.
108 	 *
109 	 * Params:
110 	 *     identity = a #GSocketConnectable describing the expected server identity
111 	 *
112 	 * Since: 2.28
113 	 */
114 	public void setServerIdentity(SocketConnectableIF identity);
115 
116 	/**
117 	 * If @use_ssl3 is %TRUE, this forces @conn to use SSL 3.0 rather than
118 	 * trying to properly negotiate the right version of TLS or SSL to use.
119 	 * This can be used when talking to servers that do not implement the
120 	 * fallbacks correctly and which will therefore fail to handshake with
121 	 * a "modern" TLS handshake attempt.
122 	 *
123 	 * Params:
124 	 *     useSsl3 = whether to use SSL 3.0
125 	 *
126 	 * Since: 2.28
127 	 */
128 	public void setUseSsl3(bool useSsl3);
129 
130 	/**
131 	 * Sets @conn's validation flags, to override the default set of
132 	 * checks performed when validating a server certificate. By default,
133 	 * %G_TLS_CERTIFICATE_VALIDATE_ALL is used.
134 	 *
135 	 * Params:
136 	 *     flags = the #GTlsCertificateFlags to use
137 	 *
138 	 * Since: 2.28
139 	 */
140 	public void setValidationFlags(GTlsCertificateFlags flags);
141 }