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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 327381 $ -->
<refentry xml:id="mysqlnduhconnection.sslset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MysqlndUhConnection::sslSet</refname>
<refpurpose>Used for establishing secure connections using SSL</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>MysqlndUhConnection::sslSet</methodname>
<methodparam><type>mysqlnd_connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>cert</parameter></methodparam>
<methodparam><type>string</type><parameter>ca</parameter></methodparam>
<methodparam><type>string</type><parameter>capath</parameter></methodparam>
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
<para>
Used for establishing secure connections using SSL.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
Mysqlnd connection handle. Do not modify!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
The path name to the key file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cert</parameter></term>
<listitem>
<para>
The path name to the certificate file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ca</parameter></term>
<listitem>
<para>
The path name to the certificate authority file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>capath</parameter></term>
<listitem>
<para>
The pathname to a directory that contains trusted SSL CA certificates in PEM format.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cipher</parameter></term>
<listitem>
<para>
A list of allowable ciphers to use for SSL encryption.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success.
Otherwise, returns &false;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>MysqlndUhConnection::sslSet</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
class proxy extends MysqlndUhConnection {
public function sslSet($conn, $key, $cert, $ca, $capath, $cipher) {
printf("%s(%s)\n", __METHOD__, var_export(func_get_args(), true));
$ret = parent::sslSet($conn, $key, $cert, $ca, $capath, $cipher);
printf("%s returns %s\n", __METHOD__, var_export($ret, true));
return $ret;
}
}
mysqlnd_uh_set_connection_proxy(new proxy());
$mysqli = new mysqli("localhost", "root", "", "test");
$mysqli->ssl_set("key", "cert", "ca", "capath", "cipher");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
proxy::sslSet(array (
0 => NULL,
1 => 'key',
2 => 'cert',
3 => 'ca',
4 => 'capath',
5 => 'cipher',
))
proxy::sslSet returns true
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
<function>mysqlnd_uh_set_connection_proxy</function>
</member>
<member>
<function>mysqli_ssl_set</function>
</member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
