org.apache.maven.plugins.jarsigner.JarsignerVerifyMojo Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of maven-jarsigner-plugin Show documentation
Signs or verifies a project artifact and attachments using jarsigner.
The newest version!
package org.apache.maven.plugins.jarsigner;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.shared.jarsigner.JarSignerRequest;
import org.apache.maven.shared.jarsigner.JarSignerUtil;
import org.apache.maven.shared.jarsigner.JarSignerVerifyRequest;

import java.io.File;
import java.io.IOException;

/**
 * Checks the signatures of a project artifact and attachments using jarsigner.
 *
 * @author Christian Schulte
 * @version $Id$
 * @since 1.0
 */
@Mojo( name = "verify", defaultPhase = LifecyclePhase.VERIFY )
public class JarsignerVerifyMojo
    extends AbstractJarsignerMojo
{

    /**
     * See options.
     */
    @Parameter( property = "jarsigner.certs", defaultValue = "false" )
    private boolean certs;

    /**
     * When true this will make the execute() operation fail,
     * throwing an exception, when verifying a non signed jar.
     * Primarily to keep backwards compatibility with existing code, and allow reusing the
     * bean in unattended operations when set to false.
     *
     * @since 1.3
     **/
    @Parameter( property = "jarsigner.errorWhenNotSigned", defaultValue = "false" )
    private boolean errorWhenNotSigned;

    /**
     * {@inheritDoc}
     */
    protected JarSignerRequest createRequest( File archive )
    {
        JarSignerVerifyRequest request = new JarSignerVerifyRequest();
        request.setCerts( certs );
        return request;
    }

    @Override
    protected void preProcessArchive( File archive )
        throws MojoExecutionException
    {
        super.preProcessArchive( archive );

        if ( errorWhenNotSigned )
        {

            // check archive if signed
            boolean archiveSigned;
            try
            {
                archiveSigned = JarSignerUtil.isArchiveSigned( archive );
            }
            catch ( IOException e )
            {
                throw new MojoExecutionException( "Failed to check if archive " + archive + " is signed: "
                    + e.getMessage(), e );
            }

            if ( !archiveSigned )
            {

                // fails, archive must be signed
                throw new MojoExecutionException( getMessage( "archiveNotSigned", archive ) );
            }
        }
    }
}