Source for java.security.Signer

   1: /* Signer.java --- Signer Class
   2:    Copyright (C) 1999, 2003, Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.security;
  39: 
  40: /**
  41:  * <code>Signer</code> is a subclass of {@link Identity}. It is used to store a
  42:  * digital signature key with an <i>Identity</i>.
  43:  *
  44:  * @author Mark Benvenuto (ivymccough@worldnet.att.net)
  45:  * @deprecated Replaced by <code>java.security.KeyStore</code>, the
  46:  * <code>java.security.cert</code> package, and <code>java.security.Principal</code>.
  47:  */
  48: public abstract class Signer extends Identity
  49: {
  50:   private static final long serialVersionUID = -1763464102261361480L;
  51:   private PrivateKey privateKey = null;
  52: 
  53:   /** Trivial constructor for serialization purposes. */
  54:   protected Signer()
  55:   {
  56:   }
  57: 
  58:   /**
  59:    * Constructs a new instance of <code>Signer</code> with the specified
  60:    * identity name.
  61:    * 
  62:    * @param name
  63:    *          the name of the identity to use.
  64:    */
  65:   public Signer(String name)
  66:   {
  67:     super(name);
  68:   }
  69: 
  70:   /**
  71:    * Constructs a new instance of <code>Signer</code> with the specified
  72:    * identity name and {@link IdentityScope}.
  73:    * 
  74:    * @param name
  75:    *          the name of the the identity to use.
  76:    * @param scope
  77:    *          the {@link IdentityScope} to use.
  78:    * @throws KeyManagementException
  79:    *           if a duplicate identity <code>name</code> exists within
  80:    *           <code>scope</code>.
  81:    */
  82:   public Signer(String name, IdentityScope scope) throws KeyManagementException
  83:   {
  84:     super(name, scope);
  85:   }
  86: 
  87:   /**
  88:    * Returns the private key of this <code>Signer</code>.
  89:    * 
  90:    * @returns the private key of this <code>Signer</code>.
  91:    * @throws SecurityException
  92:    *           if a {@link SecurityManager} is installed which disallows this
  93:    *           operation.
  94:    */
  95:   public PrivateKey getPrivateKey()
  96:   {
  97:     SecurityManager sm = System.getSecurityManager();
  98:     if (sm != null)
  99:       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: }