Summit
/
BrowzOS
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
BrowzOS/help_offline/jarsigner.html

777 lines
40 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>jarsigner - JAR Signing and Verification Tool</title>
<style type="text/css">
body {
background-color: #FFFFFF;
color: #000000;
}
</style>
</head>
<body>
<h1>jarsigner - JAR Signing and Verification Tool</h1>
<blockquote>
<p>Generates signatures for Java ARchive (JAR) files, and verifies the
signatures of signed JAR files. </p>
</blockquote>
<h2>SYNOPSIS</h2>
<blockquote>
<pre><strong>jarsigner</strong> [ <a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jarsigner.html#Options">options</a> ] jar-file alias
<strong>jarsigner</strong> -verify [ <a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jarsigner.html#Options">options</a> ] jar-file
</pre>
</blockquote>
<h2>DESCRIPTION</h2>
<blockquote>
<p>The <b>jarsigner</b> tool is used for two purposes: </p>
<ol>
<li>to sign Java ARchive (JAR) files, and<p>&nbsp;</li>
<li>to verify the signatures and integrity of signed JAR files. </li>
</ol>
<p>The JAR feature enables the packaging of class files, images, sounds, and
other digital data in a single file for faster and easier distribution. A tool
named
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jar.html">
<b>jar</b></a> enables developers to produce JAR files. (Technically, any zip
file can also be considered a JAR file, although when created by <b>jar</b> or
processed by <b>jarsigner</b>, JAR files also contain a META-INF/MANIFEST.MF
file.) </p>
<p>A <i>digital signature</i> is a string of bits that is computed from some
data (the data being &quot;signed&quot;) and the private key of an entity (a person,
company, etc.). Like a handwritten signature, a digital signature has many
useful characteristics:</p>
<p>&nbsp;</p>
<ul>
<li>Its authenticity can be verified, via a computation that uses the public
key corresponding to the private key used to generate the signature.<p>&nbsp;</li>
<li>It cannot be forged, assuming the private key is kept secret.<p>&nbsp;</li>
<li>It is a function of the data signed and thus can't be claimed to be the
signature for other data as well.<p>&nbsp;</li>
<li>The signed data cannot be changed; if it is, the signature will no
longer verify as being authentic.<p>&nbsp;</li>
</ul>
<p>In order for an entity's signature to be generated for a file, the entity
must first have a public/private key pair associated with it, and also one or
more certificates authenticating its public key. A <i>certificate</i> is a
digitally signed statement from one entity, saying that the public key of some
other entity has a particular value. </p>
<p><b>jarsigner</b> uses key and certificate information from a <i>keystore</i>
to generate digital signatures for JAR files. A keystore is a database of
private keys and their associated X.509 certificate chains authenticating the
corresponding public keys. The
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/keytool.html">
<b>keytool</b></a> utility is used to create and administer keystores. </p>
<p><b>jarsigner</b> uses an entity's private key to generate a signature. The
signed JAR file contains, among other things, a copy of the certificate from
the keystore for the public key corresponding to the private key used to sign
the file. <b>jarsigner</b> can verify the digital signature of the signed JAR
file using the certificate inside it (in its signature block file). </p>
<p>At this time, <b>jarsigner</b> can only sign JAR files created by the JDK
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jar.html">
<b>jar</b></a> tool or zip files. (JAR files are the same as zip files, except
they also have a META-INF/MANIFEST.MF file. Such a file will automatically be
created when <b>jarsigner</b> signs a zip file.) </p>
<p>The default <b>jarsigner</b> behavior is to <i>sign</i> a JAR (or zip)
file. Use the <code>-verify</code> option to instead have it <i>verify</i> a
signed JAR file. </p>
<h3>Compatibility with JDK 1.1</h3>
<blockquote>
<p>The <b>keytool</b> and <b>jarsigner</b> tools completely replace the <b>
javakey</b> tool provided in JDK 1.1. These new tools provide more features
than <b>javakey</b>, including the ability to protect the keystore and
private keys with passwords, and the ability to verify signatures in
addition to generating them. </p>
<p>The new keystore architecture replaces the identity database that <b>
javakey</b> created and managed. There is no backwards compatibility between
the keystore format and the database format used by <b>javakey</b> in 1.1.
However, </p>
<ul>
<li>It is possible to import the information from an identity database
into a keystore, via the <b>keytool</b> <code>-identitydb</code> command.<p>&nbsp;</li>
<li><b>jarsigner</b> can sign JAR files also previously signed using <b>
javakey</b>.<p>&nbsp;</li>
<li><b>jarsigner</b> can verify JAR files signed using <b>javakey</b>.
Thus, it recognizes and can work with signer aliases that are from a JDK
1.1 identity database rather than a Java 2 SDK keystore. </li>
</ul>
<p>The following table explains how JAR files that were signed in JDK 1.1.x
are treated in the Java 2 SDK. </p>
<p>&nbsp;</p>
<table border="1">
<tr>
<th>JAR File Type</th>
<th>Identity in 1.1 database</th>
<th>Trusted Identity imported into Java 2 Platform keystore from 1.1
database (4)</th>
<th>Policy File grants privileges to Identity/Alias</th>
<th>Privileges Granted</th>
</tr>
<tr>
<td>Signed JAR</td>
<td>NO</td>
<td>NO</td>
<td>NO</td>
<td>Default privileges granted to all code.</td>
</tr>
<tr>
<td>Unsigned JAR</td>
<td>NO</td>
<td>NO</td>
<td>NO</td>
<td>Default privileges granted to all code.</td>
</tr>
<tr>
<td>Signed JAR</td>
<td>NO</td>
<td>YES</td>
<td>NO</td>
<td>Default privileges granted to all code.</td>
</tr>
<tr>
<td>Signed JAR</td>
<td>YES/Untrusted</td>
<td>NO</td>
<td>NO</td>
<td>Default privileges granted to all code. (3)</td>
</tr>
<tr>
<td>Signed JAR</td>
<td>YES/Untrusted</td>
<td>NO</td>
<td>YES</td>
<td>Default privileges granted to all code. (1,3)</td>
</tr>
<tr>
<td>Signed JAR</td>
<td>NO</td>
<td>YES</td>
<td>YES</td>
<td>Default privileges granted to all code plus privileges granted in
policy file.</td>
</tr>
<tr>
<td>Signed JAR</td>
<td>YES/Trusted</td>
<td>YES</td>
<td>YES</td>
<td>Default privileges granted to all code plus privileges granted in
policy file. (2)</td>
</tr>
<tr>
<td>Signed JAR</td>
<td>YES/Trusted</td>
<td>NO</td>
<td>NO</td>
<td>All privileges</td>
</tr>
<tr>
<td>Signed JAR</td>
<td>YES/Trusted</td>
<td>YES</td>
<td>NO</td>
<td>All privileges (1)</td>
</tr>
<tr>
<td>Signed JAR</td>
<td>YES/Trusted</td>
<td>NO</td>
<td>YES</td>
<td>All privileges (1)</td>
</tr>
</table>
<p>&nbsp;</p>
<p>Notes:</p>
<ol>
<li>If an identity/alias is mentioned in the policy file, it must be
imported into the keystore for the policy file to have any effect on
privileges granted.<p>&nbsp;</li>
<li>The policy file/keystore combination has precedence over a trusted
identity in the identity database.<p>&nbsp;</li>
<li>Untrusted identities are ignored in the Java 2 SDK.<p>&nbsp;</li>
<li>Only trusted identities can be imported into Java 2 SDK keystores.<p>&nbsp;</li>
</ol>
</blockquote>
<h3>Keystore Aliases</h3>
<blockquote>
<p>All keystore entities are accessed via unique <i>aliases</i>. </p>
<p>When using <b>jarsigner</b> to sign a JAR file, you must specify the
alias for the keystore entry containing the private key needed to generate
the signature. For example, the following will sign the JAR file named &quot;MyJarFile.jar&quot;,
using the private key associated with the alias &quot;duke&quot; in the keystore named
&quot;mystore&quot; in the &quot;working&quot; directory on the C drive. Since no output file is
specified, it overwrites MyJarFile.jar with the signed JAR file. </p>
<pre> jarsigner -keystore C:\working\mystore -storepass myspass
-keypass dukekeypasswd MyJarFile.jar duke
</pre>
<p>Keystores are protected with a password, so the store password (in this
case &quot;myspass&quot;) must be specified. You will be prompted for it if you don't
specify it on the command line. Similarly, private keys are protected in a
keystore with a password, so the private key's password (in this case &quot;dukekeypasswd&quot;)
must be specified, and you will be prompted for it if you don't specify it
on the command line and it isn't the same as the store password. </p>
</blockquote>
<h3><a name="KeystoreLoc">Keystore Location</a></h3>
<blockquote>
<p><b>jarsigner</b> has a <code>-keystore</code> option for specifying the
URL of the keystore to be used. The keystore is by default stored in a file
named <i>.keystore</i> in the user's home directory, as determined by the &quot;user.home&quot;
system property. Given user name <i>uName</i>, the &quot;user.home&quot; property
value defaults to </p>
<pre>C:\Winnt\Profiles\uName on multi-user Windows NT systems
C:\Windows\Profiles\uName on multi-user Windows 95 systems
C:\Windows on single-user Windows 95 systems
</pre>
<p>Thus, if the user name is &quot;cathy&quot;, &quot;user.home&quot; defaults to </p>
<pre>C:\Winnt\Profiles\cathy on multi-user Windows NT systems
C:\Windows\Profiles\cathy on multi-user Windows 95 systems
</pre>
</blockquote>
<h3><a name="KeystoreImplementation">Keystore Implementation</a></h3>
<blockquote>
<p>The <code>KeyStore</code> class provided in the <code>java.security</code>
package supplies well-defined interfaces to access and modify the
information in a keystore. It is possible for there to be multiple different
concrete implementations, where each implementation is that for a particular
<i>type</i> of keystore. </p>
<p>Currently, there are two command-line tools that make use of keystore
implementations (<b>keytool</b> and <b>jarsigner</b>), and also a GUI-based
tool named <b>Policy Tool</b>. Since <code>KeyStore</code> is publicly
available, JDK users can write additional security applications that use it.
</p>
<p>There is a built-in default implementation, provided by Sun Microsystems.
It implements the keystore as a file, utilizing a proprietary keystore type
(format) named &quot;JKS&quot;. It protects each private key with its individual
password, and also protects the integrity of the entire keystore with a
(possibly different) password. </p>
<p>Keystore implementations are provider-based. More specifically, the
application interfaces supplied by <code>KeyStore</code> are implemented in
terms of a &quot;Service Provider Interface&quot; (SPI). That is, there is a
corresponding abstract <code>KeystoreSpi</code> class, also in the <code>
java.security</code> package, which defines the Service Provider Interface
methods that &quot;providers&quot; must implement. (The term &quot;provider&quot; refers to a
package or a set of packages that supply a concrete implementation of a
subset of services that can be accessed by the Java Security API.) Thus, to
provide a keystore implementation, clients must implement a provider and
supply a KeystoreSpi subclass implementation, as described in
<a href="http://download.oracle.com/javase/1.3/docs/guide/security/HowToImplAProvider.html">
How to Implement a Provider for the Java Cryptography Architecture</a>. </p>
<p>Applications can choose different <i>types</i> of keystore
implementations from different providers, using the &quot;getInstance&quot; factory
method supplied in the <code>KeyStore</code> class. A keystore type defines
the storage and data format of the keystore information, and the algorithms
used to protect private keys in the keystore and the integrity of the
keystore itself. Keystore implementations of different types are not
compatible. </p>
<p><b>keytool</b> works on any file-based keystore implementation. (It
treats the keytore location that is passed to it at the command line as a
filename and converts it to a FileInputStream, from which it loads the
keystore information.) The <b>jarsigner</b> and <b>policytool</b> tools, on
the other hand, can read a keystore from any location that can be specified
using a URL. </p>
<p>For <b>jarsigner</b> and <b>keytool</b>, you can specify a keystore type
at the command line, via the <i>-storetype</i> option. For <b>Policy Tool</b>,
you can specify a keystore type via the &quot;Change Keystore&quot; command in the
Edit menu. </p>
<p>If you don't explicitly specify a keystore type, the tools choose a
keystore implementation based simply on the value of the <code>keystore.type</code>
property specified in the security properties file. The security properties
file is called <tt>java.security</tt>, and it resides in the JDK security
properties directory, <code><i>java.home</i>\lib\security</code>, where <i>
java.home</i> is the runtime environment's directory (the <tt>jre</tt>
directory in the SDK or the top-level directory of the Java 2 Runtime
Environment). </p>
<p>Each tool gets the <code>keystore.type</code> value and then examines all
the currently-installed providers until it finds one that implements
keystores of that type. It then uses the keystore implementation from that
provider. </p>
<p>The <code>KeyStore</code> class defines a static method named <code>
getDefaultType</code> that lets applications and applets retrieve the value
of the <code>keystore.type</code> property. The following line of code
creates an instance of the default keystore type (as specified in the <code>
keystore.type</code> property): </p>
<pre> KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
</pre>
<p>The default keystore type is &quot;jks&quot; (the proprietary type of the keystore
implementation provided by Sun). This is specified by the following line in
the security properties file: </p>
<pre> keystore.type=jks
</pre>
<p>To have the tools utilize a keystore implementation other than the
default, change that line to specify a different keystore type. </p>
<p>For example, if you have a provider package that supplies a keystore
implementation for a keystore type called &quot;pkcs12&quot;, change the line to </p>
<pre> keystore.type=pkcs12
</pre>
<p>Note: case doesn't matter in keystore type designations. For example, &quot;JKS&quot;
would be considered the same as &quot;jks&quot;. </p>
</blockquote>
<h3><a name="DefaultAlgs">Supported Algorithms</a></h3>
<blockquote>
<p>At this time, <b>jarsigner</b> can sign a JAR file using either </p>
<ul>
<li>DSA (Digital Signature Algorithm) with the SHA-1 digest algorithm, or<p>&nbsp;</li>
<li>the RSA algorithm with the MD5 digest algorithm. </li>
</ul>
<p>That is, if the signer's public and private keys are DSA keys, <b>
jarsigner</b> will sign the JAR file using the &quot;SHA1withDSA&quot; algorithm. If
the signer's keys are RSA keys, <b>jarsigner</b> will attempt to sign the
JAR file using the &quot;MD5withRSA&quot; algorithm. This is only possible if there is
a statically installed
<a href="http://download.oracle.com/javase/1.3/docs/guide/security/CryptoSpec.html#Provider">
provider</a> supplying an implementation for the &quot;MD5withRSA&quot; algorithm.
(There is always a &quot;SHA1withDSA&quot; algorithm available, from the default &quot;SUN&quot;
provider.) </p>
</blockquote>
<h3><a name="DefaultAlgs">The Signed JAR File</a></h3>
<blockquote>
<p>When <b>jarsigner</b> is used to sign a JAR file, the output signed JAR
file is exactly the same as the input JAR file, except that it has two
additional files placed in the META-INF directory: </p>
<ul>
<li>a signature file, with a .SF extension, and<p>&nbsp;</li>
<li>a signature block file, with a .DSA extension. </li>
</ul>
<p>The base file names for these two files come from the value of the <code>
-sigFile</code> option. For example, if the option appears as </p>
<pre> -sigFile MKSIGN
</pre>
<p>the files are named &quot;MKSIGN.SF&quot; and &quot;MKSIGN.DSA&quot;. </p>
<p>If no <code>-sigfile</code> option appears on the command line, the base
file name for the .SF and .DSA files will be the first 8 characters of the
alias name specified on the command line, all converted to upper case. If
the alias name has fewer than 8 characters, the full alias name is used. If
the alias name contains any characters that are not allowed in a signature
file name, each such character is converted to an underscore (&quot;_&quot;) character
in forming the file name. Legal characters include letters, digits,
underscores, and hyphens. </p>
<h4><a name="SFFile">The Signature (.SF) File</a></h4>
<blockquote>
<p>A signature file (the .SF file) looks similar to the manifest file that
is always included in a JAR file when <b>jarsigner</b> is used to sign the
file. That is, for each source file included in the JAR file, the .SF file
has three lines, just as in the manifest file, listing the following: </p>
<ul>
<li>the file name,<p>&nbsp;</li>
<li>the name of the digest algorithm used (SHA), and
<p>&nbsp;</li>
<li>a SHA digest value. </li>
</ul>
<p>In the manifest file, the SHA digest value for each source file is the
digest (hash) of the binary data in the source file. In the .SF file, on
the other hand, the digest value for a given source file is the hash of
the three lines in the manifest file for the source file. </p>
<p>The signature file also, by default, includes a header containing a
hash of the whole manifest file. The presence of the header enables
verification optimization, as described in
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jarsigner.html#Verifying">
JAR File Verification</a>. </p>
</blockquote>
<h4>The Signature Block (.DSA) File</h4>
<blockquote>
<p>The .SF file is signed and the signature is placed in the .DSA file.
The .DSA file also contains, encoded inside it, the certificate or
certificate chain from the keystore which authenticates the public key
corresponding to the private key used for signing. </p>
</blockquote>
</blockquote>
<h3><a name="Verifying">JAR File Verification</a></h3>
<blockquote>
<p>A successful JAR file verification occurs if the signature(s) are valid,
and none of the files that were in the JAR file when the signatures were
generated have been changed since then. JAR file verification involves the
following steps: </p>
<ol>
<li>Verify the signature of the .SF file itself.
<p>That is, the verification ensures that the signature stored in each
signature block (.DSA) file was in fact generated using the private key
corresponding to the public key whose certificate (or certificate chain)
also appears in the .DSA file. It also ensures that the signature is a
valid signature of the corresponding signature (.SF) file, and thus the
.SF file has not been tampered with.</p>
<p>&nbsp;</li>
<li>Verify the digest listed in each entry in the .SF file with each
corresponding section in the manifest.
<p>The .SF file by default includes a header containing a hash of the
entire manifest file. When the header is present, then the verification
can check to see whether or not the hash in the header indeed matches the
hash of the manifest file. If that is the case, verification proceeds to
the next step. </p>
<p>If that is not the case, a less optimized verification is required to
ensure that the hash in each source file information section in the .SF
file equals the hash of its corresponding section in the manifest file
(see
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jarsigner.html#SFFile">
The Signature (.SF) File</a>). </p>
<p>One reason the hash of the manifest file that is stored in the .SF file
header may not equal the hash of the current manifest file would be
because one or more files were added to the JAR file (using the <code>jar</code>
tool) after the signature (and thus the .SF file) was generated. When the
<code>jar</code> tool is used to add files, the manifest file is changed
(sections are added to it for the new files), but the .SF file is not. A
verification is still considered successful if none of the files that were
in the JAR file when the signature was generated have been changed since
then, which is the case if the hashes in the non-header sections of the
.SF file equal the hashes of the corresponding sections in the manifest
file.</p>
<p>&nbsp;</li>
<li>Read each file in the JAR file that has an entry in the .SF file.
While reading, compute the file's digest, and then compare the result with
the digest for this file in the manifest section. The digests should be
the same, or verification fails. </li>
</ol>
<p>If any serious verification failures occur during the verification
process, the process is stopped and a security exception is thrown. It is
caught and displayed by <b>jarsigner</b>. </p>
</blockquote>
<h3>Multiple Signatures for a JAR File</h3>
<blockquote>
<p>A JAR file can be signed by multiple people simply by running the <b>
jarsigner</b> tool on the file multiple times, specifying the alias for a
different person each time, as in: </p>
<pre> jarsigner myBundle.jar susan
jarsigner myBundle.jar kevin
</pre>
<p>When a JAR file is signed multiple times, there are multiple .SF and .DSA
files in the resulting JAR file, one pair for each signature. Thus, in the
example above, the output JAR file includes files with the following names:
</p>
<pre> SUSAN.SF
SUSAN.DSA
KEVIN.SF
KEVIN.DSA
</pre>
<p>Note: It is also possible for a JAR file to have mixed signatures, some
generated by the JDK 1.1 <b>javakey</b> tool and others by <b>jarsigner</b>.
That is, <b>jarsigner</b> can be used to sign JAR files already previously
signed using <b>javakey</b>. </p>
</blockquote>
</blockquote>
<h2><a name="Options">OPTIONS</a></h2>
<blockquote>
<p>The various <b>jarsigner</b> options are listed and described below. Note:
</p>
<ul>
<li>All option names are preceded by a minus sign (-).<p>&nbsp;</li>
<li>The options may be provided in any order.<p>&nbsp;</li>
<li>Items in italics (option values) represent the actual values that must
be supplied.<p>&nbsp;</li>
<li>The <code>-keystore</code>, <code>-storepass</code>, <code>-keypass</code>,
<code>-sigfile</code> , and <code>-signedjar</code> options are only
relevant when signing a JAR file, not when verifying a signed JAR file.
Similarly, an alias is only specified on the command line when signing a JAR
file. </li>
</ul>
<p>&nbsp;</p>
<dl>
<dt><b><code>-keystore </code></b><i>url</i> </dt>
<dd>Specifies the URL that tells the keystore location. This defaults to the
file <i>.keystore</i> in the user's home directory, as determined by the &quot;user.home&quot;
system property.
<p>A keystore is required when signing, so you must explicitly specify one
if the default keystore does not exist (or you want to use one other than
the default). </p>
<p>A keystore is <i>not</i> required when verifying, but if one is
specified, or the default exists, and the <code>-verbose</code> option was
also specified, additional information is output regarding whether or not
any of the certificates used to verify the JAR file are contained in that
keystore. </p>
<p>Note: the <code>-keystore</code> argument can actually be a file name
(and path) specification rather than a URL, in which case it will be treated
the same as a &quot;file:&quot; URL. That is, </p>
<pre> -keystore <i>filePathAndName</i>
</pre>
<p>is treated as equivalent to </p>
<pre> -keystore file:<i>filePathAndName</i>
</pre>
<p>&nbsp;</dd>
<dt><b><code>-storetype </code></b><i>storetype</i> </dt>
<dd>Specifies the type of keystore to be instantiated. The default keystore
type is the one that is specified as the value of the &quot;keystore.type&quot;
property in the security properties file, which is returned by the static
<code>getDefaultType</code> method in <code>java.security.KeyStore</code>.
<p>&nbsp;</dd>
<dt><b><code>-storepass </code></b><i>password</i> </dt>
<dd>Specifies the password which is required to access the keystore. This is
only needed when signing (not verifying) a JAR file. In that case, if a
<code>-storepass</code> option is not provided at the command line, the user
is prompted for the password.
<p>Note: The password shouldn't be specified on the command line or in a
script unless it is for testing purposes, or you are on a secure system.
Also, when typing in a password at the password prompt, the password is
echoed (displayed exactly as typed), so be careful not to type it in front
of anyone. </p>
<p>&nbsp;</dd>
<dt><b><code>-keypass </code></b><i>password</i> </dt>
<dd>Specifies the password used to protect the private key of the keystore
entry addressed by the alias specified on the command line. The password is
required when using <b>jarsigner</b> to sign a JAR file. If no password is
provided on the command line, and the required password is different from
the store password, the user is prompted for it.
<p>Note: The password shouldn't be specified on the command line or in a
script unless it is for testing purposes, or you are on a secure system.
Also, when typing in a password at the password prompt, the password is
echoed (displayed exactly as typed), so be careful not to type it in front
of anyone. </p>
<p>&nbsp;</dd>
<dt><b><code>-sigfile </code></b><i>file</i> </dt>
<dd>Specifies the base file name to be used for the generated .SF and .DSA
files. For example, if <i>file</i> is &quot;DUKESIGN&quot;, the generated .SF and .DSA
files will be named &quot;DUKESIGN.SF&quot; and &quot;DUKESIGN.DSA&quot;, and will be placed in
the &quot;META-INF&quot; directory of the signed JAR file.
<p>The characters in <i>file</i> must come from the set &quot;a-zA-Z0-9_-&quot;. That
is, only letters, numbers, underscore, and hyphen characters are allowed.
Note: All lowercase characters will be converted to uppercase for the .SF
and .DSA file names. </p>
<p>If no <code>-sigfile</code> option appears on the command line, the base
file name for the .SF and .DSA files will be the first 8 characters of the
alias name specified on the command line, all converted to upper case. If
the alias name has fewer than 8 characters, the full alias name is used. If
the alias name contains any characters that are not legal in a signature
file name, each such character is converted to an underscore (&quot;_&quot;) character
in forming the file name. </p>
<p>&nbsp;</dd>
<dt><b><code>-signedjar </code></b><i>file</i> </dt>
<dd>Specifies the name to be used for the signed JAR file.
<p>If no name is specified on the command line, the name used is the same as
the input JAR file name (the name of the JAR file to be signed); in other
words, that file is overwritten with the signed JAR file. </p>
<p>&nbsp;</dd>
<dt><b><code>-verify </code></b></dt>
<dd>If this appears on the command line, the specified JAR file will be
verified, not signed. If the verification is successful, &quot;jar verified&quot; will
be displayed. If you try to verify an unsigned JAR file, or a JAR file
signed with an unsupported algorithm (e.g., RSA when you don't have an RSA
provider installed), the following is displayed: &quot;jar is unsigned.
(signatures missing or not parsable)&quot;
<p>It is possible to verify JAR files signed using either <b>jarsigner</b>
or the JDK 1.1 <b>javakey</b> tool, or both. </p>
<p>For further information on verification, see
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jarsigner.html#Verifying">
JAR File Verification</a>. </p>
<p>&nbsp;</dd>
<dt><b><code>-certs </code></b></dt>
<dd>If this appears on the command line, along with the <code>-verify</code>
and <code>-verbose</code> options, the output includes certificate
information for each signer of the JAR file. This information includes<p>&nbsp;<ul>
<li>the name of the type of certificate (stored in the .DSA file) that
certifies the signer's public key<p>&nbsp;</li>
<li>if the certificate is an X.509 certificate (more specifically, an
instance of <code>java.security.cert.X509Certificate</code>): the
distinguished name of the signer </li>
</ul>
<p>The keystore is also examined. If no keystore value is specified on the
command line, the default keystore file (if any) will be checked. If the
public key certificate for a signer matches an entry in the keystore, then
the following information will also be displayed:</p>
<p>&nbsp;<ul>
<li>in parentheses, the alias name for the keystore entry for that signer.
If the signer actually comes from a JDK 1.1 identity database instead of
from a keystore, the alias name will appear in brackets instead of
parentheses. </li>
</ul>
<p>&nbsp;</dd>
<dt><b><code>-verbose </code></b></dt>
<dd>If this appears on the command line, it indicates &quot;verbose&quot; mode, which
causes <b>jarsigner</b> to output extra information as to the progress of
the JAR signing or verification.
<p>&nbsp;</dd>
<dt><b><code>-internalsf </code></b></dt>
<dd>In the past, the .DSA (signature block) file generated when a JAR file
was signed used to include a complete encoded copy of the .SF file
(signature file) also generated. This behavior has been changed. To reduce
the overall size of the output JAR file, the .DSA file by default doesn't
contain a copy of the .SF file anymore. But if <code>-internalsf</code>
appears on the command line, the old behavior is utilized. <b>This option is
mainly useful for testing; in practice, it should not be used, since doing
so eliminates a useful optimization.</b>
<p>&nbsp;</dd>
<dt><b><code>-sectionsonly</code></b> </dt>
<dd>If this appears on the command line, the .SF file (signature file)
generated when a JAR file is signed does <i>not</i> include a header
containing a hash of the whole manifest file. It just contains information
and hashes related to each individual source file included in the JAR file,
as described in
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jarsigner.html#SFFile">
The Signature (.SF) File</a> .
<p>By default, this header is added, as an optimization. When the header is
present, then whenever the JAR file is verified, the verification can first
check to see whether or not the hash in the header indeed matches the hash
of the whole manifest file. If so, verification proceeds to the next step.
If not, it is necessary to do a less optimized verification that the hash in
each source file information section in the .SF file equals the hash of its
corresponding section in the manifest file. </p>
<p>For further information, see
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jarsigner.html#Verifying">
JAR File Verification</a>. </p>
<p><b>This option is mainly useful for testing; in practice, it should not
be used, since doing so eliminates a useful optimization.</b></p>
<p>&nbsp;</dd>
<dt><b><code>-provider</code></b> <i>provider-class-name</i> </dt>
<dd>Used to specify the name of cryptographic service provider's master
class file when the service provider is not listed in the security
properties file.<p>&nbsp;</dd>
<dt><b><code>-J</code></b><i>javaoption</i> </dt>
<dd>Passes through the specified <i>javaoption</i> string directly to the
Java interpreter. (<b>jarsigner</b> is actually a &quot;wrapper&quot; around the
interpreter.) This option should not contain any spaces. It is useful for
adjusting the execution environment or memory usage. For a list of possible
interpreter options, type <code>java -h</code> or <code>java -X</code> at
the command line.<p>&nbsp;</dd>
</dl>
</blockquote>
<h2>EXAMPLES</h2>
<blockquote>
<h3>Signing a JAR File</h3>
<blockquote>
<p>Suppose you have a JAR file named &quot;bundle.jar&quot; and you'd like to sign it
using the private key of the user whose keystore alias is &quot;jane&quot; in the
keystore named &quot;mystore&quot; in the &quot;working&quot; directory on the C drive. Suppose
the keystore password is &quot;myspass&quot; and the password for <i>jane</i>'s
private key is &quot;j638klm&quot;. You can use the following to sign the JAR file and
name the signed JAR file &quot;sbundle.jar&quot;: </p>
<pre> jarsigner -keystore C:\working\mystore -storepass myspass
-keypass j638klm -signedjar sbundle.jar bundle.jar jane
</pre>
<p>Note that there is no <code>-sigfile</code> specified in the command
above, so the generated .SF and .DSA files to be placed in the signed JAR
file will have default names based on the alias name. That is, they will be
named <code>JANE.SF</code> and <code>JANE.DSA</code>. </p>
<p>If you want to be prompted for the store password and the private key
password, you could shorten the above command to </p>
<pre> jarsigner -keystore C:\working\mystore
-signedjar sbundle.jar bundle.jar jane
</pre>
<p>If the keystore to be used is the default keystore (the one named &quot;.keystore&quot;
in your home directory), you don't need to specify a keystore, as in: </p>
<pre> jarsigner -signedjar sbundle.jar bundle.jar jane
</pre>
<p>Finally, if you want the signed JAR file to simply overwrite the input
JAR file (<code>bundle.jar</code>), you don't need to specify a <code>-signedjar</code>
option: </p>
<pre> jarsigner bundle.jar jane
</pre>
</blockquote>
<h3>Verifying a Signed JAR File</h3>
<blockquote>
<p>To verify a signed JAR file, that is, to verify that the signature is
valid and the JAR file has not been tampered with, use a command such as the
following: </p>
<pre> jarsigner -verify sbundle.jar
</pre>
<p>If the verification is successful, </p>
<pre> jar verified.
</pre>
<p>is displayed. Otherwise, an error message appears. </p>
<p>You can get more information if you use the <code>-verbose</code> option.
A sample use of <b>jarsigner</b> with the <code>-verbose</code> option is
shown below, along with sample output: </p>
<pre> jarsigner -verify -verbose sbundle.jar
198 Fri Sep 26 16:14:06 PDT 1997 META-INF/MANIFEST.MF
199 Fri Sep 26 16:22:10 PDT 1997 META-INF/JANE.SF
1013 Fri Sep 26 16:22:10 PDT 1997 META-INF/JANE.DSA
smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx.class
smk 849 Fri Sep 26 16:12:46 PDT 1997 test.class
s = signature was verified
m = entry is listed in manifest
k = at least one certificate was found in keystore
jar verified.
</pre>
<h3>Verification with Certificate Information</h3>
<p>If you specify the <code>-certs</code> option when verifying, along with
the <code>-verify</code> and <code>-verbose</code> options, the output
includes certificate information for each signer of the JAR file, including
the certificate type, the signer distinguished name information (iff it's an
X.509 certificate), and, in parentheses, the keystore alias for the signer
if the public key certificate in the JAR file matches that in a keystore
entry. For example, </p>
<pre> jarsigner -keystore /working/mystore -verify -verbose -certs myTest.jar
198 Fri Sep 26 16:14:06 PDT 1997 META-INF/MANIFEST.MF
199 Fri Sep 26 16:22:10 PDT 1997 META-INF/JANE.SF
1013 Fri Sep 26 16:22:10 PDT 1997 META-INF/JANE.DSA
208 Fri Sep 26 16:23:30 PDT 1997 META-INF/JAVATEST.SF
1087 Fri Sep 26 16:23:30 PDT 1997 META-INF/JAVATEST.DSA
smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst.class
X.509, CN=Test Group, OU= , O=Sun Microsystems, L=CUP, S=CA, C=US (javatest)
X.509, CN=Jane Smith, OU= , O=Sun, L=cup, S=ca, C=us (jane)
s = signature was verified
m = entry is listed in manifest
k = at least one certificate was found in keystore
jar verified.
</pre>
<p>If the certificate for a signer is not an X.509 certificate, there is no
distinguished name information. In that case, just the certificate type and
the alias are shown. For example, if the certificate is a PGP certificate,
and the alias is &quot;bob&quot;, you'd get </p>
<pre> PGP, (bob)
</pre>
<h3>Verification of a JAR File that Includes Identity Database Signers</h3>
<p>If a JAR file has been signed using the JDK 1.1 <b>javakey</b> tool, and
thus the signer is an alias in an identity database, the verification output
includes an &quot;i&quot; symbol. If the JAR file has been signed by both an alias in
an identity database and an alias in a keystore, both &quot;k&quot; and &quot;i&quot; appear.
</p>
<p>When the <code>-certs</code> option is used, any identity database
aliases are shown in square brackets rather than the parentheses used for
keystore aliases. For example: </p>
<pre> jarsigner -keystore /working/mystore -verify -verbose -certs writeFile.jar
198 Fri Sep 26 16:14:06 PDT 1997 META-INF/MANIFEST.MF
199 Fri Sep 26 16:22:10 PDT 1997 META-INF/JANE.SF
1013 Fri Sep 26 16:22:10 PDT 1997 META-INF/JANE.DSA
199 Fri Sep 27 12:22:30 PDT 1997 META-INF/DUKE.SF
1013 Fri Sep 27 12:22:30 PDT 1997 META-INF/DUKE.DSA
smki 2752 Fri Sep 26 16:12:30 PDT 1997 writeFile.html
X.509, CN=Jane Smith, OU= , O=Sun, L=cup, S=ca, C=us (jane)
X.509, CN=Duke, OU= , O=Sun, L=cup, S=ca, C=us [duke]
s = signature was verified
m = entry is listed in manifest
k = at least one certificate was found in keystore
i = at least one certificate was found in identity scope
jar verified.
</pre>
<p>Note that the alias &quot;duke&quot; is in brackets to denote that it is an
identity database alias, not a keystore alias. </p>
</blockquote>
</blockquote>
<h2>SEE ALSO</h2>
<blockquote>
<ul>
<li>
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/jar.html">
jar</a> tool documentation</li>
<li>
<a href="http://download.oracle.com/javase/1.3/docs/tooldocs/win32/keytool.html">
keytool</a> tool documentation</li>
<li>the
<a href="http://java.sun.com/docs/books/tutorial/security1.2/index.html"><b>
Security</b></a> trail of the
<a href="http://java.sun.com/docs/books/tutorial/trailmap.html"><b>Java
Tutorial</b></a> for examples of the use of the <b>jarsigner</b> tool </li>
</ul>
</blockquote>
<hr noshade="noshade" size="3">
<table border="0" width="100%">
<tr valign="top">
<td><font size="-2">
<a href="http://download.oracle.com/javase/1.3/docs/relnotes/SMICopyright.html">
Copyright <20></a> 1995, 2010 <a href="http://www.oracle.com">Oracle and/or its
affiliates.</a> All rights reserved.</font></td>
<td align="right">
<img src="sunlogo64x30.gif" alt="Sun" border="0" width="100" height="29">
<br>
&nbsp;</td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink