2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-02-03 22:00:42 +00:00
|
|
|
<title>GenKey Task</title>
|
2001-02-13 12:32:01 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h2 id="genkey">GenKey</h2>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Description</h3>
|
2018-01-22 23:52:21 +01:00
|
|
|
<p>Generates a key in a keystore.</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2001-02-13 12:32:01 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>alias</td>
|
|
|
|
|
<td>the alias to add under</td>
|
|
|
|
|
<td>Yes.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>storepass</td>
|
|
|
|
|
<td>password for keystore integrity. Must be at least 6 characters long</td>
|
|
|
|
|
<td>Yes.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>keystore</td>
|
|
|
|
|
<td>keystore location</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>storetype</td>
|
|
|
|
|
<td>keystore type</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>keypass</td>
|
|
|
|
|
<td>password for private key (if different)</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>sigalg</td>
|
|
|
|
|
<td>the algorithm to use in signing</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>keyalg</td>
|
|
|
|
|
<td>the method to use when generating name-value pair</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>verbose</td>
|
|
|
|
|
<td>(<q>true|false</q>) verbose output when signing</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>dname</td>
|
|
|
|
|
<td>The distinguished name for entity</td>
|
|
|
|
|
<td>Yes unless <code><dname></code> element is specified</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
2018-07-16 15:42:34 -07:00
|
|
|
<tr>
|
2018-07-17 15:29:41 +05:30
|
|
|
<td>saname</td>
|
|
|
|
|
<td>The subject alternative name for entity. Requires
|
2018-07-16 15:42:34 -07:00
|
|
|
Java 7 or higher.</td>
|
2018-07-17 15:29:41 +05:30
|
|
|
<td>No</td>
|
2018-07-16 15:42:34 -07:00
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>validity</td>
|
|
|
|
|
<td>(integer) indicates how many days certificate is valid</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>keysize</td>
|
|
|
|
|
<td>(integer) indicates the size of key generated</td>
|
|
|
|
|
<td>No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Alternatively you can specify the distinguished name by creating a <code><dname></code>
|
|
|
|
|
sub-element and populating it with <code><param></code> elements that have a <var>name</var>
|
|
|
|
|
and a <var>value</var>. When using the subelement, it is automatically encoded properly and commas
|
|
|
|
|
(<q>,</q>) are replaced with <q>\,</q>.</p>
|
2003-03-19 09:11:57 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Examples</h3>
|
2018-05-15 09:51:58 +02:00
|
|
|
<p>The following two examples are identical:</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2018-01-22 23:52:21 +01:00
|
|
|
<genkey alias="apache-group" storepass="secret"
|
2018-02-28 07:58:59 +01:00
|
|
|
dname="CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US"/></pre>
|
2001-02-13 12:32:01 +00:00
|
|
|
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<genkey alias="apache-group" storepass="secret">
|
2001-02-13 12:32:01 +00:00
|
|
|
<dname>
|
|
|
|
|
<param name="CN" value="Ant Group"/>
|
|
|
|
|
<param name="OU" value="Jakarta Division"/>
|
|
|
|
|
<param name="O" value="Apache.Org"/>
|
|
|
|
|
<param name="C" value="US"/>
|
|
|
|
|
</dname>
|
2005-03-10 13:01:55 +00:00
|
|
|
</genkey></pre>
|
2006-09-11 04:33:25 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
