001    package org.apache.commons.openpgp;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one or more
005     * contributor license agreements.  See the NOTICE file distributed with
006     * this work for additional information regarding copyright ownership.
007     * The ASF licenses this file to You under the Apache License, Version 2.0
008     * (the "License"); you may not use this file except in compliance with
009     * the License.  You may obtain a copy of the License at
010     *
011     *      http://www.apache.org/licenses/LICENSE-2.0
012     *
013     * Unless required by applicable law or agreed to in writing, software
014     * distributed under the License is distributed on an "AS IS" BASIS,
015     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016     * See the License for the specific language governing permissions and
017     * limitations under the License.
018     */
019    
020    import java.io.IOException;
021    import java.io.InputStream;
022    
023    /**
024     * Interface for verifying data signed with OpenPGP.
025     *
026     * @author <a href="mailto:brett@apache.org">Brett Porter</a>
027     * @todo perhaps should have different interface methods for the default key
028     * @todo should the exception be a verification exception instead of a common one?
029     */
030    public interface OpenPgpSignatureVerifier
031    {
032        String ROLE = OpenPgpSignatureVerifier.class.getName();
033    
034        /**
035         * Verify a piece of data that was signed with OpenPGP.
036         *
037         * @param data    the data that was signed
038         * @param keyRing the keyring containing the key used to sign the data
039         */
040        SignatureStatus verifySignature( InputStream data, KeyRing keyRing )
041            throws OpenPgpException, UnknownKeyException;
042    
043        /**
044         * Verify a piece of data against a detached signature.
045         *
046         * @param data         the data to that was signed
047         * @param signature    the detached signature to verify against the data
048         * @param keyRing      the keyring containing the key used to sign the data
049         */
050        SignatureStatus verifyDetachedSignature( InputStream data, InputStream signature, KeyRing keyRing )
051            throws OpenPgpException, UnknownKeyException, IOException;
052    }