| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.fulcrum.crypto;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3"></a> |
| <span class="sourceLineNo">004</span><a id="line.4">/*</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> *</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> *</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> * under the License.</a> |
| <span class="sourceLineNo">021</span><a id="line.21"> */</a> |
| <span class="sourceLineNo">022</span><a id="line.22"></a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">/**</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * This interface describes the various Crypto Algorithms that are</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * handed out by the Crypto Service.</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> *</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a></a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * @version $Id$</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> */</a> |
| <span class="sourceLineNo">031</span><a id="line.31">public interface CryptoAlgorithm</a> |
| <span class="sourceLineNo">032</span><a id="line.32">{</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> /**</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * Allows the user to set a salt value whenever the</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * algorithm is used. Setting a new salt should invalidate</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * all internal state of this object.</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * <p></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * Algorithms that do not use a salt are allowed to ignore</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * this parameter.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * <p></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * Algorithms must be able to deal with the null value as salt.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * They should treat it as "use a random salt".</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> *</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @param salt The salt value</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> *</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> */</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> void setSeed(String salt);</a> |
| <span class="sourceLineNo">049</span><a id="line.49"></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> /**</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * Performs the actual encryption.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> *</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * @param value The value to be encrypted</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> *</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @return The encrypted value</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> *</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * @throws Exception various errors from the underlying ciphers.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * The caller should catch them and report accordingly.</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> *</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> */</a> |
| <span class="sourceLineNo">061</span><a id="line.61"></a> |
| <span class="sourceLineNo">062</span><a id="line.62"> String encrypt(String value)</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> throws Exception;</a> |
| <span class="sourceLineNo">064</span><a id="line.64"></a> |
| <span class="sourceLineNo">065</span><a id="line.65"> /**</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * Algorithms that perform multiple ciphers get told</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * with setCipher, which cipher to use. This should be</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * called before any other method call.</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> *</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * If called after any call to encrypt or setSeed, the</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * CryptoAlgorithm may choose to ignore this or to reset</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * and use the new cipher.</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> *</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * If any other call is used before this, the algorithm</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * should use a default cipher and not throw an error.</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> *</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * @param cipher The cipher to use.</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> *</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> */</a> |
| <span class="sourceLineNo">080</span><a id="line.80"></a> |
| <span class="sourceLineNo">081</span><a id="line.81"> void setCipher(String cipher);</a> |
| <span class="sourceLineNo">082</span><a id="line.82"></a> |
| <span class="sourceLineNo">083</span><a id="line.83">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
