001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.server.kerberos.shared.crypto.checksum;
021    
022    
023    import org.apache.directory.server.kerberos.shared.crypto.encryption.KeyUsage;
024    
025    
026    /**
027     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028     * @version $Rev: 541572 $, $Date: 2007-05-25 10:16:04 +0300 (Fri, 25 May 2007) $
029     */
030    public interface ChecksumEngine
031    {
032        /**
033         * Returns the checksum type of this checksum engine.
034         *
035         * @return The checksum type.
036         */
037        public ChecksumType checksumType();
038    
039    
040        /**
041         * Calculate a checksum given raw bytes and an (optional) key.
042         *
043         * @param data
044         * @param key
045         * @param usage 
046         * @return The checksum value.
047         */
048        public byte[] calculateChecksum( byte[] data, byte[] key, KeyUsage usage );
049    }