| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| OpenPgpSignatureVerifier |
|
| 1.0;1 |
| 1 | package org.apache.commons.openpgp; | |
| 2 | ||
| 3 | /* | |
| 4 | * Licensed to the Apache Software Foundation (ASF) under one or more | |
| 5 | * contributor license agreements. See the NOTICE file distributed with | |
| 6 | * this work for additional information regarding copyright ownership. | |
| 7 | * The ASF licenses this file to You under the Apache License, Version 2.0 | |
| 8 | * (the "License"); you may not use this file except in compliance with | |
| 9 | * the License. You may obtain a copy of the License at | |
| 10 | * | |
| 11 | * http://www.apache.org/licenses/LICENSE-2.0 | |
| 12 | * | |
| 13 | * Unless required by applicable law or agreed to in writing, software | |
| 14 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 16 | * See the License for the specific language governing permissions and | |
| 17 | * limitations under the License. | |
| 18 | */ | |
| 19 | ||
| 20 | import java.io.IOException; | |
| 21 | import java.io.InputStream; | |
| 22 | ||
| 23 | /** | |
| 24 | * Interface for verifying data signed with OpenPGP. | |
| 25 | * | |
| 26 | * @author <a href="mailto:brett@apache.org">Brett Porter</a> | |
| 27 | * @todo perhaps should have different interface methods for the default key | |
| 28 | * @todo should the exception be a verification exception instead of a common one? | |
| 29 | */ | |
| 30 | public interface OpenPgpSignatureVerifier | |
| 31 | { | |
| 32 | String ROLE = OpenPgpSignatureVerifier.class.getName(); | |
| 33 | ||
| 34 | /** | |
| 35 | * Verify a piece of data that was signed with OpenPGP. | |
| 36 | * | |
| 37 | * @param data the data that was signed | |
| 38 | * @param keyRing the keyring containing the key used to sign the data | |
| 39 | */ | |
| 40 | SignatureStatus verifySignature( InputStream data, KeyRing keyRing ) | |
| 41 | throws OpenPgpException, UnknownKeyException; | |
| 42 | ||
| 43 | /** | |
| 44 | * Verify a piece of data against a detached signature. | |
| 45 | * | |
| 46 | * @param data the data to that was signed | |
| 47 | * @param signature the detached signature to verify against the data | |
| 48 | * @param keyRing the keyring containing the key used to sign the data | |
| 49 | */ | |
| 50 | SignatureStatus verifyDetachedSignature( InputStream data, InputStream signature, KeyRing keyRing ) | |
| 51 | throws OpenPgpException, UnknownKeyException, IOException; | |
| 52 | } |