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
|
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.rnp-op-generate-key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>rnp_op_generate_key</refname>
<refpurpose>Generate key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>rnp_op_generate_key</methodname>
<methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam>
<methodparam><type>string</type><parameter>userid</parameter></methodparam>
<methodparam><type>string</type><parameter>key_alg</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>sub_alg</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>userid</parameter></term>
<listitem>
<para>
PGP User ID - text that is intended to represent
the name and email address of the key holder.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key_alg</parameter></term>
<listitem>
<para>
Primary key algorithm (i.e. 'RSA', 'DSA', etc).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sub_alg</parameter></term>
<listitem>
<para>
Subkey algorithm. If not set, subkey will not be generated.
</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>"bits"</literal></entry>
<entry>integer</entry>
<entry>Primary key size in bits. Applicable only to RSA, DSA and El-Gamal keys.</entry>
</row>
<row>
<entry><literal>"hash"</literal></entry>
<entry>string</entry>
<entry>Hash algorithm used in self signature or subkey binding signature.</entry>
</row>
<row>
<entry><literal>"dsa_qbits"</literal></entry>
<entry>integer</entry>
<entry>Set size of a <literal>q</literal> parameter for DSA key.
Note: appropriate default value will be set, depending on key bits. However you may
override it if needed.</entry>
</row>
<row>
<entry><literal>"curve"</literal></entry>
<entry>string</entry>
<entry>Set the curve used for ECC key. Note: this is only applicable for ECDSA, ECDH and SM2 keys.</entry>
</row>
<row>
<entry><literal>"request_password"</literal></entry>
<entry>boolean</entry>
<entry>Enable requesting password via password provider. This password
will be used for key encryption. Password provider callback function should be set in
advance by calling <function>rnp_ffi_set_pass_provider</function>.
Note: this setting will be ignored if password was set via<literal>"password"</literal></entry>
</row>
<row>
<entry><literal>"password"</literal></entry>
<entry>string</entry>
<entry>Set the password used to encrypt the secret key data.</entry>
</row>
<row>
<entry><literal>"expiration"</literal></entry>
<entry>integer</entry>
<entry>Set the key and subkey expiration time in seconds.</entry>
</row>
<row>
<entry><literal>"sub_bits"</literal></entry>
<entry>integer</entry>
<entry>Subkey size in bits. Applicable only to RSA, DSA and El-Gamal keys.</entry>
</row>
<row>
<entry><literal>"sub_hash"</literal></entry>
<entry>string</entry>
<entry>Hash algorithm used in subkey self signature or subkey binding signature.</entry>
</row>
<row>
<entry><literal>"sub_curve"</literal></entry>
<entry>string</entry>
<entry>Set the curve used for ECC subkey. Note: this is only applicable for ECDSA, ECDH and SM2 keys.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Fingerprint of the generated primary key&return.falseforfailure;. This fingerprint can be used
later to reference the key in sign and encrypt operations. The key data is stored in FFI
memory context and can be saved using
<function>rnp_save_keys</function> or <function>rnp_save_keys_to_path</function>.
</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
-->
|
