blob: ba171a3bb12ae0b3f8b55f3e20fc85e2625796bf [file] [log] [blame]
<?xml version="1.0"?>
<!--
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.
-->
<document>
<properties>
<title>Fulcrum PBE Service</title>
<author email="siegfried.goeschl@it20one.at">Siegfried Goeschl</author>
</properties>
<body>
<section name="Configuration">
<subsection name="Role Configuration">
<source><![CDATA[
<role
name="org.apache.fulcrum.pbe.PBEService"
shorthand="PBEService"
default-class="org.apache.fulcrum.pbe.PBEServiceImpl"
description="Provides Password Based Encyrption using JCA/JCE"
/>
]]></source>
</subsection>
<subsection name="Component Configuration">
<p>
The configuration parameters are basically used to make
the service compatible with existing applications using
password based encryption.
</p>
<table>
<tr>
<th>Item</th>
<th>Datatype</th>
<th>Optional</th>
<th>Description</th>
</tr>
<tr>
<td>cryptoSalt</td>
<td>String</td>
<td>Y</td>
<td>
Contains the hex-encoded salt for PBE
</td>
</tr>
<tr>
<td>cyrptoCount</td>
<td>int</td>
<td>Y</td>
<td>
Defines the count for PBEParameterSpec
</td>
</tr>
<tr>
<td>passwordCount</td>
<td>int</td>
<td>Y</td>
<td>
Defines the number of SHA-1 invocations to
create the password. Changing this value creates
completely different passwords.
</td>
</tr>
</table>
</subsection>
<subsection name="Component Configuration Example">
<source><![CDATA[
<PBEService>
<cryptoSalt>4463657541544141</cryptoSalt>
<cyrptoCount>20</cyrptoCount>
<cryptoProvider></cryptoProvider>
<passwordCount>40</passwordCount>
</PBEService>
]]></source>
</subsection>
</section>
</body>
</document>