001: package org.apache.turbine.services.crypto.provider;
002:
003: /*
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: import java.security.MessageDigest;
023:
024: import org.apache.commons.codec.binary.Base64;
025:
026: import org.apache.turbine.services.crypto.CryptoAlgorithm;
027:
028: /**
029: * Implements the normal java.security.MessageDigest stream cipers.
030: * Base64 strings returned by this provider are correctly padded to
031: * multiples of four bytes. If you run into interoperability problems
032: * with other languages, especially perl and the Digest::MD5 module,
033: * note that the md5_base64 function from this package incorrectly drops
034: * the pad bytes. Use the MIME::Base64 package instead.
035: *
036: * If you upgrade from Turbine 2.1 and suddently your old stored passwords
037: * no longer work, please take a look at the OldJavaCrypt provider for
038: * bug-to-bug compatibility.
039: *
040: * This provider can be used as the default crypto algorithm provider.
041: *
042: * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
043: * @version $Id: JavaCrypt.java 534527 2007-05-02 16:10:59Z tv $
044: */
045: public class JavaCrypt implements CryptoAlgorithm {
046:
047: /** The default cipher */
048: public static final String DEFAULT_CIPHER = "SHA";
049:
050: /** The cipher to use for encryption */
051: private String cipher = null;
052:
053: /**
054: * C'tor
055: */
056: public JavaCrypt() {
057: this .cipher = DEFAULT_CIPHER;
058: }
059:
060: /**
061: * Setting the actual cipher requested. If not
062: * called, then the default cipher (SHA) is used.
063: *
064: * This will never throw an error even if there is no
065: * provider for this cipher. The error will be thrown
066: * by encrypt() (Fixme?)
067: *
068: * @param cipher The cipher to use.
069: */
070: public void setCipher(String cipher) {
071: this .cipher = cipher;
072: }
073:
074: /**
075: * This class never uses a seed, so this is
076: * just a dummy.
077: *
078: * @param seed Seed (ignored)
079: */
080: public void setSeed(String seed) {
081: /* dummy */
082: }
083:
084: /**
085: * encrypt the supplied string with the requested cipher
086: *
087: * @param value The value to be encrypted
088: * @return The encrypted value
089: * @throws Exception An Exception of the underlying implementation.
090: */
091: public String encrypt(String value) throws Exception {
092: MessageDigest md = MessageDigest.getInstance(cipher);
093:
094: // We need to use unicode here, to be independent of platform's
095: // default encoding. Thanks to SGawin for spotting this.
096: byte[] digest = md.digest(value.getBytes("UTF-8"));
097:
098: // Base64-encode the digest.
099: byte[] encodedDigest = Base64.encodeBase64(digest);
100: return (encodedDigest == null ? null
101: : new String(encodedDigest));
102: }
103:
104: }
|