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