Browse Source

New signjar task.

For consistency across ant tasks, I changed the method by which the boolean
attributes are set to use the Project.toBoolean method.

Submitted by:	Peter Donald <donaldp@mad.scientist.com>


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@267746 13f79535-47bb-0310-9956-ffa450edef68
master
Conor MacNeill 25 years ago
parent
commit
2907030ab0
3 changed files with 295 additions and 0 deletions
  1. +78
    -0
      docs/index.html
  2. +216
    -0
      src/main/org/apache/tools/ant/taskdefs/SignJar.java
  3. +1
    -0
      src/main/org/apache/tools/ant/taskdefs/defaults.properties

+ 78
- 0
docs/index.html View File

@@ -524,6 +524,7 @@ If you do not want these default excludes applied, you may disable them with the
<li><a href="#rename">Rename</a></li> <li><a href="#rename">Rename</a></li>
<li><a href="#replace">Replace</a></li> <li><a href="#replace">Replace</a></li>
<li><a href="#rmic">Rmic</a></li> <li><a href="#rmic">Rmic</a></li>
<li><a href="#signjar">SignJar</a></li>
<li><a href="#tar">Tar</a></li> <li><a href="#tar">Tar</a></li>
<li><a href="#taskdef">Taskdef</a></li> <li><a href="#taskdef">Taskdef</a></li>
<li><a href="#touch">Touch</a></li> <li><a href="#touch">Touch</a></li>
@@ -2597,6 +2598,83 @@ compiled files will be stored in the directory <code>${build}/classes</code>.</p
files below <code>${build}/classes</code> whose classname starts with files below <code>${build}/classes</code> whose classname starts with
<i>Remote</i>. The compiled files will be stored in the directory <i>Remote</i>. The compiled files will be stored in the directory
<code>${build}/classes</code>.</p> <code>${build}/classes</code>.</p>

<hr>
<h2><a name="signjar">SignJar</a></h2>
<h3>Description</h3>
<p>Signs a jar or zip file with the javasign command line tool.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">jar</td>
<td valign="top">the jar file to sign</td>
<td valign="top" align="center">Yes.</td>
</tr>
<tr>
<td valign="top">alias</td>
<td valign="top">the alias to sign under</td>
<td valign="top" align="center">Yes.</td>
</tr>
<tr>
<td valign="top">storepass</td>
<td valign="top">password for keystore integrity.</td>
<td valign="top" align="center">Yes.</td>
</tr>
<tr>
<td valign="top">keystore</td>
<td valign="top">keystore location</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">storetype</td>
<td valign="top">keystore type</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">keypass</td>
<td valign="top">password for private key (if different)</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">sigfile</td>
<td valign="top">name of .SF/.DSA file</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">signedjar</td>
<td valign="top">name of signed JAR file</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">(true | false) verbose output when signing</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">internalsf</td>
<td valign="top">(true | false) include the .SF file inside the signature
block</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">sectionsonly</td>
<td valign="top">(true | false) don't compute hash of entire manifest</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<p><code>&lt;signjar jar=&quot;${dist}/lib/ant.jar&quot;
alias=&quot;apache-group&quot; storepass=&quot;secret&quot; /&gt;</code></p>
</blockquote>
<p>signs the ant.jar with alias &quot;apache-group&quot; accessing the
keystore and private key via &quot;secret&quot; password.</p>
<hr> <hr>
<h2><a name="tar">Tar</a></h2> <h2><a name="tar">Tar</a></h2>
<h3>Description</h3> <h3>Description</h3>


+ 216
- 0
src/main/org/apache/tools/ant/taskdefs/SignJar.java View File

@@ -0,0 +1,216 @@
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.tools.ant.taskdefs;

import org.apache.tools.ant.*;
import java.io.File;

/**
* Sign a archive.
*
* @author Peter Donald <a href="mailto:donaldp@mad.scientist.com">donaldp@mad.scientist.com</a>
*/
public class SignJar extends Task {

/**
* The name of the jar file.
*/
protected String jar;

/**
* The alias of signer.
*/
protected String alias;

/**
* The name of keystore file.
*/
protected String keystore;
protected String storepass;
protected String storetype;
protected String keypass;
protected String sigfile;
protected String signedjar;
protected boolean verbose;
protected boolean internalsf;
protected boolean sectionsonly;

public void setJar(final String jar) {
this.jar = jar;
}

public void setAlias(final String alias) {
this.alias = alias;
}

public void setKeystore(final String keystore) {
this.keystore = keystore;
}

public void setStorepass(final String storepass) {
this.storepass = storepass;
}

public void setStoretype(final String storetype) {
this.storetype = storetype;
}

public void setKeypass(final String keypass) {
this.keypass = keypass;
}

public void setSigfile(final String sigfile) {
this.sigfile = sigfile;
}

public void setSignedjar(final String signedjar) {
this.signedjar = signedjar;
}

public void setVerbose(final String verbose) {
this.verbose = project.toBoolean(verbose);
}

public void setInternalsf(final String internalsf) {
this.internalsf = project.toBoolean(internalsf);
}

public void setSectionsonly(final String sectionsonly) {
this.sectionsonly = project.toBoolean(sectionsonly);
}

public void execute() throws BuildException {
if (project.getJavaVersion().equals(Project.JAVA_1_1)) {
throw new BuildException("The signjar task is only available on JDK versions 1.2 or greater");
}

if (null == jar) {
throw new BuildException("jar attribute must be set");
}

if (null == alias) {
throw new BuildException("alias attribute must be set");
}

if (null == storepass) {
throw new BuildException("storepass attribute must be set");
}

final StringBuffer sb = new StringBuffer();

sb.append("jarsigner ");

if (null != keystore) {
sb.append("-keystore \"");
sb.append(keystore);
sb.append("\" ");
}

if (null != storepass) {
sb.append("-storepass \"");
sb.append(storepass);
sb.append("\" ");
}

if (null != storetype) {
sb.append("-storetype \"");
sb.append(storetype);
sb.append("\" ");
}

if (null != keypass) {
sb.append("-keypass \"");
sb.append(keypass);
sb.append("\" ");
}

if (null != sigfile) {
sb.append("-sigfile \"");
sb.append(sigfile);
sb.append("\" ");
}

if (null != signedjar) {
sb.append("-signedjar \"");
sb.append(signedjar);
sb.append("\" ");
}

if (verbose) {
sb.append("-verbose ");
}

if (internalsf) {
sb.append("-internalsf ");
}

if (sectionsonly) {
sb.append("-sectionsonly ");
}

sb.append('\"');
sb.append(jar);
sb.append("\" ");
sb.append('\"');
sb.append(alias);
sb.append("\" ");

log("Signing Jar : " + (new File(jar)).getAbsolutePath());
final Exec cmd = (Exec) project.createTask("exec");
cmd.setCommand(sb.toString());
cmd.execute();
}
}


+ 1
- 0
src/main/org/apache/tools/ant/taskdefs/defaults.properties View File

@@ -33,6 +33,7 @@ patch=org.apache.tools.ant.taskdefs.Patch
compileTask=org.apache.tools.ant.taskdefs.CompileTask compileTask=org.apache.tools.ant.taskdefs.CompileTask
style=org.apache.tools.ant.taskdefs.XSLTProcess style=org.apache.tools.ant.taskdefs.XSLTProcess
touch=org.apache.tools.ant.taskdefs.Touch touch=org.apache.tools.ant.taskdefs.Touch
signjar=org.apache.tools.ant.taskdefs.SignJar


# optional tasks # optional tasks
script=org.apache.tools.ant.taskdefs.optional.Script script=org.apache.tools.ant.taskdefs.optional.Script


Loading…
Cancel
Save