-
Notifications
You must be signed in to change notification settings - Fork 0
/
IDSAKeyPairGenerator.xml
193 lines (188 loc) · 13.2 KB
/
IDSAKeyPairGenerator.xml
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<Type Name="IDSAKeyPairGenerator" FullName="Java.Security.Interfaces.IDSAKeyPairGenerator">
<TypeSignature Language="C#" Value="public interface IDSAKeyPairGenerator : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IDSAKeyPairGenerator implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Java.Security.Interfaces.IDSAKeyPairGenerator" />
<TypeSignature Language="F#" Value="type IDSAKeyPairGenerator = interface
 interface IJavaObject
 interface IDisposable
 interface IJavaPeerable" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("java/security/interfaces/DSAKeyPairGenerator", "", "Java.Security.Interfaces.IDSAKeyPairGeneratorInvoker")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("java/security/interfaces/DSAKeyPairGenerator", "", "Java.Security.Interfaces.IDSAKeyPairGeneratorInvoker")>]</AttributeName>
</Attribute>
</Attributes>
<Docs since="1">
<summary>An interface to an object capable of generating DSA key pairs.</summary>
<remarks>
<para>An interface to an object capable of generating DSA key pairs.</para>
<para>The <c>initialize</c> methods may each be called any number
of times. If no <c>initialize</c> method is called on a
DSAKeyPairGenerator, each provider that implements this interface
should supply (and document) a default initialization. Note that
defaults may vary across different providers. Additionally, the default
value for a provider may change in a future version. Therefore, it is
recommended to explicitly initialize the DSAKeyPairGenerator instead
of relying on provider-specific defaults.</para>
<para>Users wishing to indicate DSA-specific parameters, and to generate a key
pair suitable for use with the DSA algorithm typically
<ol>
<li>Get a key pair generator for the DSA algorithm by calling the
KeyPairGenerator <c>getInstance</c> method with "DSA"
as its argument.
<li>Check if the returned key pair generator is an instance of
DSAKeyPairGenerator before casting the result to a DSAKeyPairGenerator
and calling one of the <c>initialize</c> methods from this
DSAKeyPairGenerator interface.
<li>Generate a key pair by calling the <c>generateKeyPair</c>
method of the KeyPairGenerator class.
</ol></para>
<para>Note: it is not always necessary to do algorithm-specific
initialization for a DSA key pair generator. That is, it is not always
necessary to call an <c>initialize</c> method in this interface.
Algorithm-independent initialization using the <c>initialize</c> method
in the KeyPairGenerator
interface is all that is needed when you accept defaults for algorithm-specific
parameters.</para>
<para>Note: Some earlier implementations of this interface may not support
larger values of DSA parameters such as 3072-bit.</para>
<para>Added in 1.1.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/security/interfaces/DSAKeyPairGenerator" title="Reference documentation">Java documentation for <code>java.security.interfaces.DSAKeyPairGenerator</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
<Members>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public void Initialize (Java.Security.Interfaces.IDSAParams? params, Java.Security.SecureRandom? random);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Initialize(class Java.Security.Interfaces.IDSAParams params, class Java.Security.SecureRandom random) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Security.Interfaces.IDSAKeyPairGenerator.Initialize(Java.Security.Interfaces.IDSAParams,Java.Security.SecureRandom)" />
<MemberSignature Language="F#" Value="abstract member Initialize : Java.Security.Interfaces.IDSAParams * Java.Security.SecureRandom -> unit" Usage="iDSAKeyPairGenerator.Initialize (params, random)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("initialize", "(Ljava/security/interfaces/DSAParams;Ljava/security/SecureRandom;)V", "GetInitialize_Ljava_security_interfaces_DSAParams_Ljava_security_SecureRandom_Handler:Java.Security.Interfaces.IDSAKeyPairGeneratorInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("initialize", "(Ljava/security/interfaces/DSAParams;Ljava/security/SecureRandom;)V", "GetInitialize_Ljava_security_interfaces_DSAParams_Ljava_security_SecureRandom_Handler:Java.Security.Interfaces.IDSAKeyPairGeneratorInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="params" Type="Java.Security.Interfaces.IDSAParams" />
<Parameter Name="random" Type="Java.Security.SecureRandom" />
</Parameters>
<Docs>
<param name="params">the parameters to use to generate the keys.</param>
<param name="random">the random bit source to use to generate key bits;
can be null.</param>
<summary>Initializes the key pair generator using the DSA family parameters
(p,q and g) and an optional SecureRandom bit source.</summary>
<remarks>
<para>Initializes the key pair generator using the DSA family parameters
(p,q and g) and an optional SecureRandom bit source. If a
SecureRandom bit source is needed but not supplied, i.e. null, a
default SecureRandom instance will be used.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/security/interfaces/DSAKeyPairGenerator#initialize(java.security.interfaces.DSAParams,%20java.security.SecureRandom)" title="Reference documentation">Java documentation for <code>java.security.interfaces.DSAKeyPairGenerator.initialize(java.security.interfaces.DSAParams, java.security.SecureRandom)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<exception cref="T:Java.Security.InvalidParameterException">if the specified parameter values are <c>null</c> or
invalid.
</exception>
</Docs>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public void Initialize (int modlen, bool genParams, Java.Security.SecureRandom? random);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Initialize(int32 modlen, bool genParams, class Java.Security.SecureRandom random) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Security.Interfaces.IDSAKeyPairGenerator.Initialize(System.Int32,System.Boolean,Java.Security.SecureRandom)" />
<MemberSignature Language="F#" Value="abstract member Initialize : int * bool * Java.Security.SecureRandom -> unit" Usage="iDSAKeyPairGenerator.Initialize (modlen, genParams, random)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("initialize", "(IZLjava/security/SecureRandom;)V", "GetInitialize_IZLjava_security_SecureRandom_Handler:Java.Security.Interfaces.IDSAKeyPairGeneratorInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("initialize", "(IZLjava/security/SecureRandom;)V", "GetInitialize_IZLjava_security_SecureRandom_Handler:Java.Security.Interfaces.IDSAKeyPairGeneratorInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modlen" Type="System.Int32" />
<Parameter Name="genParams" Type="System.Boolean" />
<Parameter Name="random" Type="Java.Security.SecureRandom" />
</Parameters>
<Docs>
<param name="modlen">the modulus length in bits. Valid values are any
multiple of 64 between 512 and 1024, inclusive, 2048, and 3072.</param>
<param name="random">the random bit source to use to generate key bits;
can be null.</param>
<param name="genParams">whether or not to generate new parameters for
the modulus length requested.</param>
<summary>Initializes the key pair generator for a given modulus length
(instead of parameters), and an optional SecureRandom bit source.</summary>
<remarks>
<para>Initializes the key pair generator for a given modulus length
(instead of parameters), and an optional SecureRandom bit source.
If a SecureRandom bit source is needed but not supplied, i.e.
null, a default SecureRandom instance will be used.</para>
<para>If <c>genParams</c> is true, this method generates new
p, q and g parameters. If it is false, the method uses precomputed
parameters for the modulus length requested. If there are no
precomputed parameters for that modulus length, an exception will be
thrown.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/security/interfaces/DSAKeyPairGenerator#initialize(int,%20boolean,%20java.security.SecureRandom)" title="Reference documentation">Java documentation for <code>java.security.interfaces.DSAKeyPairGenerator.initialize(int, boolean, java.security.SecureRandom)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<exception cref="T:Java.Security.InvalidParameterException">if the specified modulus length is not valid, or if there are
no pre-calculated values and <c>genParams</c> is <c>false</c>.
</exception>
</Docs>
</Member>
</Members>
</Type>