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
|
<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="mysql_ssl_set" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
xmlns:db="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysql_ssl_set</refname>
<refpurpose>mysql_ssl_set is used for establishing secure connections using SSL.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>affected_rows = mysql_ssl_set(mysql, key, cert, ca, capath, cipher)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para><literal>mysql_ssl_set</literal> is used for establishing
secure connections using SSL. It must be called before
<literal>mysql_real_connect</literal>.</para>
<para><literal>mysql_ssl_set</literal> does nothing unless SSL
support is enabled in the client library.</para>
<para>mysql is the connection handler returned from
<literal>mysql_init</literal>. The other parameters
are specified as follows:</para>
<itemizedlist>
<listitem><para><literal>key</literal> is the path name to the key file.</para></listitem>
<listitem><para><literal>cert</literal> is the path name to the certificate file.</para></listitem>
<listitem><para><literal>ca</literal> is the path name to the certificate authority file.</para></listitem>
<listitem><para><literal>capath</literal> is the path
name to a directory that contains trusted SSL CA certificates in pem format.</para></listitem>
<listitem><para><literal>cipher</literal> is a list of allowable ciphers to use for SSL encryption.</para></listitem>
</itemizedlist>
<para>Any unused SSL parameters may be given as empty.</para>
</refsection>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>mysql</term>
<listitem>
<para>a MySQL pointer</para>
</listitem>
</varlistentry>
<varlistentry>
<term>key</term>
<listitem>
<para>the path name to the key file</para>
</listitem>
</varlistentry>
<varlistentry>
<term>cert</term>
<listitem>
<para>the path name to the certificate file</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ca</term>
<listitem>
<para>the path name to the certificate authority file</para>
</listitem>
</varlistentry>
<varlistentry>
<term>capath</term>
<listitem>
<para>the path name to a directory that contains trusted SSL CA certificates in pem format</para>
</listitem>
</varlistentry>
<varlistentry>
<term>cipher</term>
<listitem>
<para>a list of allowable ciphers to use for SSL encryption</para>
</listitem>
</varlistentry>
<varlistentry>
<term>result</term>
<listitem>
<para>This function always returns 0. If SSL setup is incorrect,
<literal>mysql_real_connect</literal> returns an error
when you attempt to connect.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member><link linkend="mysql_init">mysql_init</link></member>
<member><link linkend="mysql_real_connect">mysql_real_connect</link></member>
<member><link linkend="mysql_close">mysql_close</link></member>
</simplelist>
</refsection>
<refsection>
<title>Authors</title>
<simplelist type="vert">
<member>Yann COLLETTE</member>
</simplelist>
</refsection>
</refentry>
|
