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
|
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.rnp-op-sign" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>rnp_op_sign</refname>
<refpurpose>Perform signing operation on a binary data, return embedded signature(s)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>rnp_op_sign</methodname>
<methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>array</type><parameter>keys_fp</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
</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>data</parameter></term>
<listitem>
<para>
Data to be signed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>keys_fp</parameter></term>
<listitem>
<para>
Array with key fingerprints. At least one key must be provided.
Keys should be present in <parameter>ffi</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An associative array with options.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Key</entry>
<entry>Data type</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>"compression_alg"</literal></entry>
<entry>string</entry>
<entry>Compression algorithm. Both
<literal>"compression_alg"</literal> and <literal>"compression_level"</literal>
must be set in order to enable data compression.
</entry>
</row>
<row>
<entry><literal>"compression_level"</literal></entry>
<entry>integer</entry>
<entry>Compression level, 0-9. 0 disables compression.</entry>
</row>
<row>
<entry><literal>"armor"</literal></entry>
<entry>boolean</entry>
<entry>Enable ASCII-armored output. Disabled by default.</entry>
</row>
<row>
<entry><literal>"hash"</literal></entry>
<entry>string</entry>
<entry>Set hash algorithm used during signature calculation.</entry>
</row>
<row>
<entry><literal>"creation_time"</literal></entry>
<entry>integer</entry>
<entry>Set signature creation time in seconds since Jan, 1 1970 UTC. By default current time is used.</entry>
</row>
<row>
<entry><literal>"expiration_time"</literal></entry>
<entry>integer</entry>
<entry>Set signature expiration time in seconds since the creation time. 0 value is used to mark
signature as non-expiring (default value).</entry>
</row>
<row>
<entry><literal>"file_name"</literal></entry>
<entry>string</entry>
<entry>Set input file name.Special value _CONSOLE may be used to mark message
as 'for your eyes only', i.e. it should not be stored anywhere but only displayed
to the receiver. Default is the empty string.</entry>
</row>
<row>
<entry><literal>"file_mtime"</literal></entry>
<entry>integer</entry>
<entry>Set input file modification date in seconds since Jan, 1 1970 UTC.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Data with embedded signature(s) on success&return.falseforfailure;.
</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
-->
|
