BlockSignatureVerifier.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.signature;

import java.io.IOException;
import java.security.GeneralSecurityException;

import org.xwiki.component.annotation.Role;
import org.xwiki.crypto.pkix.CertificateProvider;
import org.xwiki.crypto.signer.param.CMSSignedDataVerified;
import org.xwiki.rendering.block.Block;

/**
 * Verify signature of a {@link org.xwiki.rendering.block.Block}.
 *
 * @version $Id: d7afeda9e4636298bd07d7f57684e7e0239fb293 $
 * @since 6.1M2
 */
@Role
public interface BlockSignatureVerifier
{
    /**
     * Verify a signature.
     *
     * The signature of the certificate is verified as well, but not the certificate chain.
     *
     * @param signature a signature produced by this signer.
     * @param block a rendering block to sign.
     * @param certificateProvider provider of certificates.
     * @return the certified public key that have signed the given block or null if the signature is invalid.
     * @throws GeneralSecurityException on signature verification operation error.
     * @throws IOException on encoding/decoding operation error.
     */
    CMSSignedDataVerified verify(byte[] signature, Block block, CertificateProvider certificateProvider)
        throws GeneralSecurityException, IOException;

    /**
     * Check if the given block can be supported by this signer.
     *
     * @param block the block to check.
     * @return true if this block can be signed/verified by this signer.
     */
    boolean isSupported(Block block);
}