001    /* Signer.java --- Signer Class
002       Copyright (C) 1999, 2003, Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    package java.security;
039    
040    /**
041     * <code>Signer</code> is a subclass of {@link Identity}. It is used to store a
042     * digital signature key with an <i>Identity</i>.
043     *
044     * @author Mark Benvenuto (ivymccough@worldnet.att.net)
045     * @deprecated Replaced by <code>java.security.KeyStore</code>, the
046     * <code>java.security.cert</code> package, and <code>java.security.Principal</code>.
047     */
048    public abstract class Signer extends Identity
049    {
050      private static final long serialVersionUID = -1763464102261361480L;
051      private PrivateKey privateKey = null;
052    
053      /** Trivial constructor for serialization purposes. */
054      protected Signer()
055      {
056      }
057    
058      /**
059       * Constructs a new instance of <code>Signer</code> with the specified
060       * identity name.
061       * 
062       * @param name
063       *          the name of the identity to use.
064       */
065      public Signer(String name)
066      {
067        super(name);
068      }
069    
070      /**
071       * Constructs a new instance of <code>Signer</code> with the specified
072       * identity name and {@link IdentityScope}.
073       * 
074       * @param name
075       *          the name of the the identity to use.
076       * @param scope
077       *          the {@link IdentityScope} to use.
078       * @throws KeyManagementException
079       *           if a duplicate identity <code>name</code> exists within
080       *           <code>scope</code>.
081       */
082      public Signer(String name, IdentityScope scope) throws KeyManagementException
083      {
084        super(name, scope);
085      }
086    
087      /**
088       * Returns the private key of this <code>Signer</code>.
089       * 
090       * @returns the private key of this <code>Signer</code>.
091       * @throws SecurityException
092       *           if a {@link SecurityManager} is installed which disallows this
093       *           operation.
094       */
095      public PrivateKey getPrivateKey()
096      {
097        SecurityManager sm = System.getSecurityManager();
098        if (sm != null)
099          sm.checkSecurityAccess("getSignerPrivateKey");
100    
101        return privateKey;
102      }
103    
104      /**
105       * Specifies the {@link KeyPair} associated with this <code>Signer</code>.
106       * 
107       * @param pair
108       *          the {@link KeyPair} to use.
109       * @throws InvalidParameterException
110       *           if the key-pair is invalid.
111       * @throws KeyException
112       *           if any another key-related error occurs.
113       * @throws SecurityException
114       *           if a {@link SecurityManager} is installed which disallows this
115       *           operation.
116       */
117      public final void setKeyPair(KeyPair pair)
118        throws InvalidParameterException, KeyException
119      {
120        SecurityManager sm = System.getSecurityManager();
121        if (sm != null)
122          sm.checkSecurityAccess("setSignerKeyPair");
123    
124        try
125          {
126            if (pair.getPublic() != null)
127              setPublicKey(pair.getPublic());
128            else
129              throw new InvalidParameterException();
130    
131          }
132        catch (KeyManagementException kme)
133          {
134            throw new KeyException();
135          }
136    
137        if (pair.getPrivate() != null)
138            privateKey = pair.getPrivate();
139        else
140          throw new InvalidParameterException();
141      }
142    
143      /** @returns a string representing this <code>Signer</code>. */
144      public String toString()
145      {
146        return (getName() + ": " + privateKey);
147      }
148    }