1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libsoup-soup-ssl">
<refmeta>
<refentrytitle role="top_of_page">soup-ssl</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBSOUP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>soup-ssl</refname>
<refpurpose>SSL/TLS handling</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
extern gboolean <link linkend="soup-ssl-supported">soup_ssl_supported</link>;
enum <link linkend="SoupSSLType">SoupSSLType</link>;
<link linkend="gpointer">gpointer</link> <link linkend="soup-ssl-get-client-credentials">soup_ssl_get_client_credentials</link> (const <link linkend="char">char</link> *ca_file);
<link linkend="void">void</link> <link linkend="soup-ssl-free-client-credentials">soup_ssl_free_client_credentials</link>
(<link linkend="gpointer">gpointer</link> creds);
<link linkend="gpointer">gpointer</link> <link linkend="soup-ssl-get-server-credentials">soup_ssl_get_server_credentials</link> (const <link linkend="char">char</link> *cert_file,
const <link linkend="char">char</link> *key_file);
<link linkend="void">void</link> <link linkend="soup-ssl-free-server-credentials">soup_ssl_free_server_credentials</link>
(<link linkend="gpointer">gpointer</link> creds);
<link linkend="GIOChannel">GIOChannel</link>* <link linkend="soup-ssl-wrap-iochannel">soup_ssl_wrap_iochannel</link> (<link linkend="GIOChannel">GIOChannel</link> *sock,
<link linkend="SoupSSLType">SoupSSLType</link> type,
const <link linkend="char">char</link> *remote_host,
<link linkend="gpointer">gpointer</link> credentials);
#define <link linkend="SOUP-SSL-ERROR:CAPS">SOUP_SSL_ERROR</link>
<link linkend="GQuark">GQuark</link> <link linkend="soup-ssl-error-quark">soup_ssl_error_quark</link> (void);
enum <link linkend="SoupSocketError">SoupSocketError</link>;
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="soup-ssl-supported" role="variable"/>soup_ssl_supported</title>
<indexterm><primary>soup_ssl_supported</primary></indexterm><programlisting>extern gboolean soup_ssl_supported;
</programlisting>
<para>
Can be used to test if libsoup was compiled with ssl support.</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="SoupSSLType" role="enum"/>enum SoupSSLType</title>
<indexterm><primary>SoupSSLType</primary></indexterm><programlisting>typedef enum {
SOUP_SSL_TYPE_CLIENT = 0,
SOUP_SSL_TYPE_SERVER
} SoupSSLType;
</programlisting>
<para>
What kind of SSL connection this is.</para>
<para>
</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SOUP-SSL-TYPE-CLIENT:CAPS" role="constant"/><literal>SOUP_SSL_TYPE_CLIENT</literal></term>
<listitem><simpara> the client side of an SSL connection
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-SSL-TYPE-SERVER:CAPS" role="constant"/><literal>SOUP_SSL_TYPE_SERVER</literal></term>
<listitem><simpara> the server side of an SSL connection
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-ssl-get-client-credentials" role="function"/>soup_ssl_get_client_credentials ()</title>
<indexterm><primary>soup_ssl_get_client_credentials</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> soup_ssl_get_client_credentials (const <link linkend="char">char</link> *ca_file);</programlisting>
<para>
Creates an opaque client credentials object which can later be
passed to <link linkend="soup-ssl-wrap-iochannel"><function>soup_ssl_wrap_iochannel()</function></link>.
</para>
<para>
If <parameter>ca_file</parameter> is non-<link linkend="NULL:CAPS"><literal>NULL</literal></link>, any certificate received from a server
must be signed by one of the CAs in the file, or an error will
be returned.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ca_file</parameter> :</term>
<listitem><simpara> path to a file containing X509-encoded Certificate
Authority certificates.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the client credentials, which must be freed with
<link linkend="soup-ssl-free-client-credentials"><function>soup_ssl_free_client_credentials()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-ssl-free-client-credentials" role="function"/>soup_ssl_free_client_credentials ()</title>
<indexterm><primary>soup_ssl_free_client_credentials</primary></indexterm><programlisting><link linkend="void">void</link> soup_ssl_free_client_credentials
(<link linkend="gpointer">gpointer</link> creds);</programlisting>
<para>
Frees <parameter>client_creds</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>creds</parameter> :</term>
<listitem><simpara> a client credentials structure returned by
<link linkend="soup-ssl-get-client-credentials"><function>soup_ssl_get_client_credentials()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-ssl-get-server-credentials" role="function"/>soup_ssl_get_server_credentials ()</title>
<indexterm><primary>soup_ssl_get_server_credentials</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> soup_ssl_get_server_credentials (const <link linkend="char">char</link> *cert_file,
const <link linkend="char">char</link> *key_file);</programlisting>
<para>
Creates an opaque server credentials object which can later be
passed to <link linkend="soup-ssl-wrap-iochannel"><function>soup_ssl_wrap_iochannel()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cert_file</parameter> :</term>
<listitem><simpara> path to a file containing an X509-encoded server
certificate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key_file</parameter> :</term>
<listitem><simpara> path to a file containing an X509-encoded key for
<parameter>cert_file</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the server credentials, which must be freed with
<link linkend="soup-ssl-free-server-credentials"><function>soup_ssl_free_server_credentials()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-ssl-free-server-credentials" role="function"/>soup_ssl_free_server_credentials ()</title>
<indexterm><primary>soup_ssl_free_server_credentials</primary></indexterm><programlisting><link linkend="void">void</link> soup_ssl_free_server_credentials
(<link linkend="gpointer">gpointer</link> creds);</programlisting>
<para>
Frees <parameter>server_creds</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>creds</parameter> :</term>
<listitem><simpara> a server credentials structure returned by
<link linkend="soup-ssl-get-server-credentials"><function>soup_ssl_get_server_credentials()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-ssl-wrap-iochannel" role="function"/>soup_ssl_wrap_iochannel ()</title>
<indexterm><primary>soup_ssl_wrap_iochannel</primary></indexterm><programlisting><link linkend="GIOChannel">GIOChannel</link>* soup_ssl_wrap_iochannel (<link linkend="GIOChannel">GIOChannel</link> *sock,
<link linkend="SoupSSLType">SoupSSLType</link> type,
const <link linkend="char">char</link> *remote_host,
<link linkend="gpointer">gpointer</link> credentials);</programlisting>
<para>
This attempts to wrap a new <link linkend="GIOChannel"><type>GIOChannel</type></link> around <parameter>sock</parameter> that
will SSL-encrypt/decrypt all traffic through it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>sock</parameter> :</term>
<listitem><simpara> a <link linkend="GIOChannel"><type>GIOChannel</type></link> wrapping a TCP socket.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> whether this is a client or server socket
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>remote_host</parameter> :</term>
<listitem><simpara> the hostname of the remote machine
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>credentials</parameter> :</term>
<listitem><simpara> a client or server credentials structure
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an SSL-encrypting <link linkend="GIOChannel"><type>GIOChannel</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on
failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SOUP-SSL-ERROR:CAPS" role="macro"/>SOUP_SSL_ERROR</title>
<indexterm><primary>SOUP_SSL_ERROR</primary></indexterm><programlisting>#define SOUP_SSL_ERROR soup_ssl_error_quark()
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="soup-ssl-error-quark" role="function"/>soup_ssl_error_quark ()</title>
<indexterm><primary>soup_ssl_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> soup_ssl_error_quark (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The quark used as <link linkend="SOUP-SSL-ERROR:CAPS"><literal>SOUP_SSL_ERROR</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SoupSocketError" role="enum"/>enum SoupSocketError</title>
<indexterm><primary>SoupSocketError</primary></indexterm><programlisting>typedef enum {
SOUP_SSL_ERROR_HANDSHAKE_NEEDS_READ,
SOUP_SSL_ERROR_HANDSHAKE_NEEDS_WRITE,
SOUP_SSL_ERROR_CERTIFICATE,
} SoupSocketError;
</programlisting>
<para>
</para></refsect2>
</refsect1>
</refentry>
|
