Source for gnu.javax.crypto.key.GnuSecretKey

   1: /* GnuSecretKey.java --
   2:    Copyright (C) 2003, 2006 Free Software Foundation, Inc.
   3: 
   4: This file is a 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 of the License, or (at
   9: your option) 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; if not, write to the Free Software
  18: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19: 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: 
  39: package gnu.javax.crypto.key;
  40: 
  41: import gnu.java.security.util.Util;
  42: import java.security.Key;
  43: 
  44: /**
  45:  * A secret key composed of a sequence of raw, unformatted octets. This class is
  46:  * analogous to the {@link javax.crypto.spec.SecretKeySpec} class, but is
  47:  * provided for platforms that do not or cannot contain that class.
  48:  */
  49: public class GnuSecretKey
  50:     implements Key
  51: {
  52:   private final byte[] key;
  53:   private final String algorithm;
  54: 
  55:   /**
  56:    * Creates a new secret key. The supplied byte array is copied by this
  57:    * constructor.
  58:    *
  59:    * @param key The raw, secret key.
  60:    * @param algorithm The algorithm name, which can be null or empty.
  61:    */
  62:   public GnuSecretKey(byte[] key, String algorithm)
  63:   {
  64:     this(key, 0, key.length, algorithm);
  65:   }
  66: 
  67:   /**
  68:    * Creates a new secret key from a portion of a byte array.
  69:    *
  70:    * @param key The raw, secret key.
  71:    * @param offset The offset at which the key begins.
  72:    * @param length The number of bytes that comprise the key.
  73:    * @param algorithm The algorithm name, which can be null or empty.
  74:    */
  75:   public GnuSecretKey(byte[] key, int offset, int length, String algorithm)
  76:   {
  77:     this.key = new byte[length];
  78:     System.arraycopy(key, offset, this.key, 0, length);
  79:     this.algorithm = algorithm;
  80:   }
  81: 
  82:   /**
  83:    * Returns the algorithm name, if any.
  84:    *
  85:    * @return The algorithm name.
  86:    */
  87:   public String getAlgorithm()
  88:   {
  89:     return null;
  90:   }
  91: 
  92:   /**
  93:    * Returns the encoded key, which is merely the byte array this class was
  94:    * created with. A reference to the internal byte array is returned, so the
  95:    * caller can delete this key from memory by modifying the returned array.
  96:    *
  97:    * @return The raw key.
  98:    */
  99:   public byte[] getEncoded()
 100:   {
 101:     return key;
 102:   }
 103: 
 104:   /**
 105:    * Returns the string "RAW".
 106:    *
 107:    * @return The string "RAW".
 108:    */
 109:   public String getFormat()
 110:   {
 111:     return "RAW";
 112:   }
 113: 
 114:   public boolean equals(Object o)
 115:   {
 116:     if (! (o instanceof GnuSecretKey))
 117:       return false;
 118:     if (key.length != ((GnuSecretKey) o).key.length)
 119:       return false;
 120:     byte[] key2 = ((GnuSecretKey) o).key;
 121:     for (int i = 0; i < key.length; i++)
 122:       if (key[i] != key2[i])
 123:         return false;
 124:     return true;
 125:   }
 126: 
 127:   public String toString()
 128:   {
 129:     return "GnuSecretKey [ " + algorithm + " " + Util.toString(key) + " ]";
 130:   }
 131: }