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
|
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.rnp-ffi-set-pass-provider" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>rnp_ffi_set_pass_provider</refname>
<refpurpose>Set password provider callback function</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>rnp_ffi_set_pass_provider</methodname>
<methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam>
<methodparam><type>callable</type><parameter>password_callback</parameter></methodparam>
</methodsynopsis>
<para>
Sets password provider function. This function can ask for the password on a standard input
(if PHP script is executed in a command line environment), display GUI dialog or provide
password in any other possible ways. Requested passwords are used to encrypt or decrypt
secret keys or perform symmetric encryption/decryption operations.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>ffi</parameter></term>
<listitem>
<para>
&rnp.parameter.ffi-description;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password_callback</parameter></term>
<listitem>
<para>
The function that is to be called for every password request. It has the following signature:
<methodsynopsis>
<type>bool</type><methodname><replaceable>password_callback</replaceable></methodname>
<methodparam><type>string</type><parameter>key_fp</parameter></methodparam>
<methodparam><type>string</type><parameter>pgp_context</parameter></methodparam>
<methodparam><type>string</type><parameter role="reference">password</parameter></methodparam>
</methodsynopsis>
<simplelist>
<member><literal>$key_fp</literal> - The key fingerprint, if any. Can be empty.</member>
<member><literal>$pgp_context</literal> - String describing why the key is being requested.</member>
<member><literal>$password</literal> - Password string reference where provided password should be stored to.</member>
</simplelist>
Callback function should return &true; if password was successfully set&return.falseforfailure;.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>simple callback function example</title>
<programlisting role="php">
<![CDATA[
<?php
function password_callback(string $key_fp, string $pgp_context, string &$password)
{
$password = "password";
return true;
}
$ffi = rnp_ffi_create('GPG', 'GPG');
rnp_ffi_set_pass_provider($ffi, 'password_callback');
]]>
</programlisting>
</example>
</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
-->
|
