01: package org.apache.turbine.services.crypto;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "License"); you may not use this file except in compliance
10: * with the License. You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing,
15: * software distributed under the License is distributed on an
16: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17: * KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations
19: * under the License.
20: */
21:
22: /**
23: * This interface describes the various Crypto Algorithms that are
24: * handed out by the Crypto Service.
25: *
26: * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
27: * @version $Id: CryptoAlgorithm.java 534527 2007-05-02 16:10:59Z tv $
28: */
29: public interface CryptoAlgorithm {
30: /**
31: * Allows the user to set a salt value whenever the
32: * algorithm is used. Setting a new salt should invalidate
33: * all internal state of this object.
34: * <p>
35: * Algorithms that do not use a salt are allowed to ignore
36: * this parameter.
37: * <p>
38: * Algorithms must be able to deal with the null value as salt.
39: * They should treat it as "use a random salt".
40: *
41: * @param salt The salt value
42: */
43: void setSeed(String salt);
44:
45: /**
46: * Performs the actual encryption.
47: *
48: * @param value The value to be encrypted
49: * @return The encrypted value
50: * @throws Exception various errors from the underlying ciphers.
51: * The caller should catch them and report accordingly.
52: */
53: String encrypt(String value) throws Exception;
54:
55: /**
56: * Algorithms that perform multiple ciphers get told
57: * with setCipher, which cipher to use. This should be
58: * called before any other method call.
59: *
60: * If called after any call to encrypt or setSeed, the
61: * CryptoAlgorithm may choose to ignore this or to reset
62: * and use the new cipher.
63: *
64: * If any other call is used before this, the algorithm
65: * should use a default cipher and not throw an error.
66: *
67: * @param cipher The cipher to use.
68: */
69: void setCipher(String cipher);
70:
71: }
|