org.eclipse.osgi.signedcontent.SignedContent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation
Tools from the AspectJ project
There is a newer version: 1.9.3.RC1
/*******************************************************************************
 * Copyright (c) 2007, 2012 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.osgi.signedcontent;

import java.security.cert.CertificateExpiredException;
import java.security.cert.CertificateNotYetValidException;
import java.util.Date;

/**
 * A SignedContent object represents content which may be signed. A
 * {@link SignedContentFactory} is used to create signed content objects.
 * 
 * A SignedContent object is intended to provide information about
 * the signers of the content, and cannot be used to access the actual data of
 * the content.
 * 
 * 
 * This interface is not intended to be implemented by clients.
 * 
 * 
 * @since 3.4
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface SignedContent {

	/**
	 * Returns all entries of the content. The returned entries can be used to
	 * verify the entry content using {@link SignedContentEntry#verify()} and get
	 * signer info for each entry in this content using
	 * {@link SignedContentEntry#getSignerInfos()}. Note that this operation may be
	 * expensive because it requires an exhaustive search for entries over the
	 * entire content.
	 * 
	 * Unsigned entries are included in the result. Entries for which signer info
	 * exists but no content is found are also returned. For example, when an entry
	 * is removed from a signed jar but the jar is not resigned, the signer thinks
	 * the entry should exist but the content got removed. This would be considered
	 * an invalid entry which would fail verification.
	 * 
	 * 
	 * @return all entries of the content
	 */
	public SignedContentEntry[] getSignedEntries();

	/**
	 * Returns the signed entry for the specified name.
	 * 
	 * @param name the name of the entry
	 * @return the entry or null if the entry could not be found
	 */
	public SignedContentEntry getSignedEntry(String name);

	/**
	 * Returns all the signer infos for this SignedContent. If the
	 * content is not signed then an empty array is returned.
	 * 
	 * @return all the signer infos for this SignedContent
	 */
	public SignerInfo[] getSignerInfos();

	/**
	 * Returns true if the content is signed; false otherwise. This is a convenience
	 * method equivalent to calling
	 * {@link #getSignerInfos()}.length > 0
	 * 
	 * @return true if the content is signed
	 */
	public boolean isSigned();

	/**
	 * Returns the signing time for the signer info. If no TSA signers exist then
	 * null is returned
	 * 
	 * @param signerInfo the signer info to get the signing time for
	 * @return the signing time
	 */
	public Date getSigningTime(SignerInfo signerInfo);

	/**
	 * Returns the TSA signer info used to authenticate the signer time of a signer
	 * info.
	 * 
	 * @param signerInfo the signer info to get the TSA signer for
	 * @return the TSA signer info
	 */
	public SignerInfo getTSASignerInfo(SignerInfo signerInfo);

	/**
	 * Checks if the certificates are valid for the specified signer. If the signer
	 * has a singing time returned by {@link #getSigningTime(SignerInfo)} then that
	 * time is used to check the validity of the certificates; otherwise the current
	 * time is used.
	 * 
	 * @param signerInfo the signer info to check validity for.
	 * @throws CertificateExpiredException     if one of the certificates of this
	 *                                         signer is expired
	 * @throws CertificateNotYetValidException if one of the certificates of this
	 *                                         signer is not yet valid
	 */
	public void checkValidity(SignerInfo signerInfo)
			throws CertificateExpiredException, CertificateNotYetValidException;
}