jdk/src/jdk.dev/share/classes/com/sun/jarsigner/ContentSignerParameters.java
changeset 29455 e451c01a5747
parent 29454 e5e9478e2ddb
parent 29433 c97e2d1bad97
child 29478 6637277d28cc
equal deleted inserted replaced
29454:e5e9478e2ddb 29455:e451c01a5747
     1 /*
       
     2  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
       
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       
     4  *
       
     5  * This code is free software; you can redistribute it and/or modify it
       
     6  * under the terms of the GNU General Public License version 2 only, as
       
     7  * published by the Free Software Foundation.  Oracle designates this
       
     8  * particular file as subject to the "Classpath" exception as provided
       
     9  * by Oracle in the LICENSE file that accompanied this code.
       
    10  *
       
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
       
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
       
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
       
    14  * version 2 for more details (a copy is included in the LICENSE file that
       
    15  * accompanied this code).
       
    16  *
       
    17  * You should have received a copy of the GNU General Public License version
       
    18  * 2 along with this work; if not, write to the Free Software Foundation,
       
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
       
    20  *
       
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
       
    22  * or visit www.oracle.com if you need additional information or have any
       
    23  * questions.
       
    24  */
       
    25 
       
    26 package com.sun.jarsigner;
       
    27 
       
    28 import java.net.URI;
       
    29 import java.security.cert.X509Certificate;
       
    30 import java.util.zip.ZipFile;
       
    31 
       
    32 /**
       
    33  * This interface encapsulates the parameters for a ContentSigner object.
       
    34  *
       
    35  * @since 1.5
       
    36  * @author Vincent Ryan
       
    37  */
       
    38 @jdk.Exported
       
    39 public interface ContentSignerParameters {
       
    40 
       
    41     /**
       
    42      * Retrieves the command-line arguments passed to the jarsigner tool.
       
    43      *
       
    44      * @return The command-line arguments. May be null.
       
    45      */
       
    46     public String[] getCommandLine();
       
    47 
       
    48     /**
       
    49      * Retrieves the identifier for a Timestamping Authority (TSA).
       
    50      *
       
    51      * @return The TSA identifier. May be null.
       
    52      */
       
    53     public URI getTimestampingAuthority();
       
    54 
       
    55     /**
       
    56      * Retrieves the certificate for a Timestamping Authority (TSA).
       
    57      *
       
    58      * @return The TSA certificate. May be null.
       
    59      */
       
    60     public X509Certificate getTimestampingAuthorityCertificate();
       
    61 
       
    62     /**
       
    63      * Retrieves the TSAPolicyID for a Timestamping Authority (TSA).
       
    64      *
       
    65      * @return The TSAPolicyID. May be null.
       
    66      */
       
    67     public default String getTSAPolicyID() {
       
    68         return null;
       
    69     }
       
    70 
       
    71     /**
       
    72      * Retreives the message digest algorithm that is used to generate
       
    73      * the message imprint to be sent to the TSA server.
       
    74      *
       
    75      * @since 1.9
       
    76      * @return The non-null string of the message digest algorithm name.
       
    77      */
       
    78     public default String getTSADigestAlg() {
       
    79         return "SHA-256";
       
    80     }
       
    81 
       
    82     /**
       
    83      * Retrieves the JAR file's signature.
       
    84      *
       
    85      * @return The non-null array of signature bytes.
       
    86      */
       
    87     public byte[] getSignature();
       
    88 
       
    89     /**
       
    90      * Retrieves the name of the signature algorithm.
       
    91      *
       
    92      * @return The non-null string name of the signature algorithm.
       
    93      */
       
    94     public String getSignatureAlgorithm();
       
    95 
       
    96     /**
       
    97      * Retrieves the signer's X.509 certificate chain.
       
    98      *
       
    99      * @return The non-null array of X.509 public-key certificates.
       
   100      */
       
   101     public X509Certificate[] getSignerCertificateChain();
       
   102 
       
   103     /**
       
   104      * Retrieves the content that was signed.
       
   105      * The content is the JAR file's signature file.
       
   106      *
       
   107      * @return The content bytes. May be null.
       
   108      */
       
   109     public byte[] getContent();
       
   110 
       
   111     /**
       
   112      * Retrieves the original source ZIP file before it was signed.
       
   113      *
       
   114      * @return The original ZIP file. May be null.
       
   115      */
       
   116     public ZipFile getSource();
       
   117 }