| 1 | <!--
|
|---|
| 2 | Licensed to the Apache Software Foundation (ASF) under one or more
|
|---|
| 3 | contributor license agreements. See the NOTICE file distributed with
|
|---|
| 4 | this work for additional information regarding copyright ownership.
|
|---|
| 5 | The ASF licenses this file to You under the Apache License, Version 2.0
|
|---|
| 6 | (the "License"); you may not use this file except in compliance with
|
|---|
| 7 | the License. You may obtain a copy of the License at
|
|---|
| 8 |
|
|---|
| 9 | http://www.apache.org/licenses/LICENSE-2.0
|
|---|
| 10 |
|
|---|
| 11 | Unless required by applicable law or agreed to in writing, software
|
|---|
| 12 | distributed under the License is distributed on an "AS IS" BASIS,
|
|---|
| 13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|---|
| 14 | See the License for the specific language governing permissions and
|
|---|
| 15 | limitations under the License.
|
|---|
| 16 | -->
|
|---|
| 17 | <html>
|
|---|
| 18 |
|
|---|
| 19 | <head>
|
|---|
| 20 | <meta http-equiv="Content-Language" content="en-us">
|
|---|
| 21 | <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
|---|
| 22 | <title>GenKey Task</title>
|
|---|
| 23 | </head>
|
|---|
| 24 |
|
|---|
| 25 | <body>
|
|---|
| 26 |
|
|---|
| 27 | <h2><a name="genkey">GenKey</a></h2>
|
|---|
| 28 | <h3>Description</h3>
|
|---|
| 29 | <p>Generates a key in a keystore. </p>
|
|---|
| 30 |
|
|---|
| 31 | <h3>Parameters</h3>
|
|---|
| 32 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 33 | <tr>
|
|---|
| 34 | <td valign="top"><b>Attribute</b></td>
|
|---|
| 35 | <td valign="top"><b>Description</b></td>
|
|---|
| 36 | <td align="center" valign="top"><b>Required</b></td>
|
|---|
| 37 | </tr>
|
|---|
| 38 | <tr>
|
|---|
| 39 | <td valign="top">alias</td>
|
|---|
| 40 | <td valign="top">the alias to add under</td>
|
|---|
| 41 | <td valign="top" align="center">Yes.</td>
|
|---|
| 42 | </tr>
|
|---|
| 43 | <tr>
|
|---|
| 44 | <td valign="top">storepass</td>
|
|---|
| 45 | <td valign="top">password for keystore integrity. Must
|
|---|
| 46 | be at least 6 characters long</td>
|
|---|
| 47 | <td valign="top" align="center">Yes.</td>
|
|---|
| 48 | </tr>
|
|---|
| 49 | <tr>
|
|---|
| 50 | <td valign="top">keystore</td>
|
|---|
| 51 | <td valign="top">keystore location</td>
|
|---|
| 52 | <td valign="top" align="center">No</td>
|
|---|
| 53 | </tr>
|
|---|
| 54 | <tr>
|
|---|
| 55 | <td valign="top">storetype</td>
|
|---|
| 56 | <td valign="top">keystore type</td>
|
|---|
| 57 | <td valign="top" align="center">No</td>
|
|---|
| 58 | </tr>
|
|---|
| 59 | <tr>
|
|---|
| 60 | <td valign="top">keypass</td>
|
|---|
| 61 | <td valign="top">password for private key (if different)</td>
|
|---|
| 62 | <td valign="top" align="center">No</td>
|
|---|
| 63 | </tr>
|
|---|
| 64 | <tr>
|
|---|
| 65 | <td valign="top">sigalg</td>
|
|---|
| 66 | <td valign="top">the algorithm to use in signing</td>
|
|---|
| 67 | <td valign="top" align="center">No</td>
|
|---|
| 68 | </tr>
|
|---|
| 69 | <tr>
|
|---|
| 70 | <td valign="top">keyalg</td>
|
|---|
| 71 | <td valign="top">the method to use when generating name-value pair</td>
|
|---|
| 72 | <td valign="top" align="center">No</td>
|
|---|
| 73 | </tr>
|
|---|
| 74 | <tr>
|
|---|
| 75 | <td valign="top">verbose</td>
|
|---|
| 76 | <td valign="top">(true | false) verbose output when signing</td>
|
|---|
| 77 | <td valign="top" align="center">No</td>
|
|---|
| 78 | </tr>
|
|---|
| 79 | <tr>
|
|---|
| 80 | <td valign="top">dname</td>
|
|---|
| 81 | <td valign="top">The distinguished name for entity</td>
|
|---|
| 82 | <td valign="top" align="center">Yes if dname element unspecified</td>
|
|---|
| 83 | </tr>
|
|---|
| 84 | <tr>
|
|---|
| 85 | <td valign="top">validity</td>
|
|---|
| 86 | <td valign="top">(integer) indicates how many days certificate is valid</td>
|
|---|
| 87 | <td valign="top" align="center">No</td>
|
|---|
| 88 | </tr>
|
|---|
| 89 | <tr>
|
|---|
| 90 | <td valign="top">keysize</td>
|
|---|
| 91 | <td valign="top">(integer) indicates the size of key generated</td>
|
|---|
| 92 | <td valign="top" align="center">No</td>
|
|---|
| 93 | </tr>
|
|---|
| 94 | </table>
|
|---|
| 95 |
|
|---|
| 96 | <p>Alternatively you can specify the distinguished name by creating a
|
|---|
| 97 | sub-element named dname and populating it with param elements that
|
|---|
| 98 | have a name and a value. When using the subelement it is automatically
|
|---|
| 99 | encoded properly and commas ("<code>,</code>") are replaced
|
|---|
| 100 | with "<code>\,</code>".</p>
|
|---|
| 101 |
|
|---|
| 102 | <p>The following two examples are identical: </p>
|
|---|
| 103 |
|
|---|
| 104 | <h3>Examples</h3>
|
|---|
| 105 | <blockquote><pre>
|
|---|
| 106 | <genkey alias="apache-group" storepass="secret"
|
|---|
| 107 | dname="CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US"/>
|
|---|
| 108 | </pre></blockquote>
|
|---|
| 109 |
|
|---|
| 110 | <blockquote>
|
|---|
| 111 | <pre>
|
|---|
| 112 | <genkey alias="apache-group" storepass="secret" >
|
|---|
| 113 | <dname>
|
|---|
| 114 | <param name="CN" value="Ant Group"/>
|
|---|
| 115 | <param name="OU" value="Jakarta Division"/>
|
|---|
| 116 | <param name="O" value="Apache.Org"/>
|
|---|
| 117 | <param name="C" value="US"/>
|
|---|
| 118 | </dname>
|
|---|
| 119 | </genkey></pre>
|
|---|
| 120 | </blockquote>
|
|---|
| 121 |
|
|---|
| 122 |
|
|---|
| 123 | </body>
|
|---|
| 124 | </html>
|
|---|
| 125 |
|
|---|
