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    import java.io.OutputStream;
023    
024    /**
025     * Interface for signing data with OpenPGP.
026     *
027     * @author <a href="mailto:brett@apache.org">Brett Porter</a>
028     * @todo perhaps should have different interface methods for the default key
029     * @todo should the exception be a signature exception instead of a common one?
030     */
031    public interface OpenPgpSigner
032    {
033        String ROLE = OpenPgpSigner.class.getName();
034    
035        /**
036         * Sign a piece of data with the given key.
037         *
038         * @param data         the data to sign
039         * @param signedOutput the signed output data
040         * @param keyId        the key ID of the key used to sign it
041         * @param keyRing      the keyring containing the key above
042         * @param asciiArmor   whether to ascii armor the output
043         */
044        void sign( InputStream data, OutputStream signedOutput, String keyId, KeyRing keyRing, boolean asciiArmor )
045            throws OpenPgpException;
046    
047        /**
048         * Sign a piece of data with the given key, storing the signature in a detached output.
049         *
050         * @param data       the data to sign
051         * @param signature  the detached signature
052         * @param keyId      the key ID of the key used to sign it
053         * @param keyRing    the keyring containing the key above
054         * @param asciiArmor whether to ascii armor the output
055         */
056        void detachedSign( InputStream data, OutputStream signature, String keyId, KeyRing keyRing, boolean asciiArmor )
057            throws OpenPgpException, IOException;
058    }