libjava/classpath/gnu/javax/crypto/jce/mac/MacAdapter.java

   1 /* MacAdapter.java --
   2    Copyright (C) 2002, 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.jce.mac;
  40
  41 import gnu.javax.crypto.mac.IMac;
  42 import gnu.javax.crypto.mac.MacFactory;
  43
  44 import java.security.InvalidAlgorithmParameterException;
  45 import java.security.InvalidKeyException;
  46 import java.security.Key;
  47 import java.security.spec.AlgorithmParameterSpec;
  48 import java.util.HashMap;
  49 import java.util.Map;
  50 import javax.crypto.MacSpi;
  51
  52 /**
  53  * <p>The implementation of a generic {@link javax.crypto.Mac} adapter class
  54  * to wrap GNU Crypto MAC instances.</p>
  55  *
  56  * <p>This class defines the <i>Service Provider Interface</i> (<b>SPI</b>) for
  57  * the {@link javax.crypto.Mac} class, which provides the functionality of a
  58  * message authentication code algorithm, such as the <i>Hashed Message
  59  * Authentication Code</i> (<b>HMAC</b>) algorithms.</p>
  60  */
  61 class MacAdapter extends MacSpi implements Cloneable
  62 {
  63
  64   // Constants and variables
  65   // -----------------------------------------------------------------------
  66
  67   /** Our MAC instance. */
  68   protected IMac mac;
  69
  70   /** Our MAC attributes. */
  71   protected Map attributes;
  72
  73   // Constructor(s)
  74   // -----------------------------------------------------------------------
  75
  76   /**
  77    * <p>Creates a new Mac instance for the given name.</p>
  78    *
  79    * @param name The name of the mac to create.
  80    */
  81   protected MacAdapter(String name)
  82   {
  83     mac = MacFactory.getInstance(name);
  84     attributes = new HashMap();
  85   }
  86
  87   /**
  88    * Private constructor for cloning purposes.
  89    *
  90    * @param mac a clone of the internal {@link IMac} instance.
  91    * @param attributes a clone of the current {@link Map} of attributes.
  92    */
  93   private MacAdapter(IMac mac, Map attributes)
  94   {
  95     super();
  96
  97     this.mac = mac;
  98     this.attributes = attributes;
  99   }
 100
 101   // Class methods
 102   // -----------------------------------------------------------------------
 103
 104   // Instance methods
 105   // -----------------------------------------------------------------------
 106
 107   // Cloneable interface implementation ------------------------------------
 108
 109   public Object clone() throws CloneNotSupportedException
 110   {
 111     return new MacAdapter((IMac) mac.clone(), new HashMap(attributes));
 112   }
 113
 114   // Instance methods implementing javax.crypto.MacSpi ---------------------
 115
 116   protected byte[] engineDoFinal()
 117   {
 118     byte[] result = mac.digest();
 119     engineReset();
 120     return result;
 121   }
 122
 123   protected int engineGetMacLength()
 124   {
 125     return mac.macSize();
 126   }
 127
 128   protected void engineInit(Key key, AlgorithmParameterSpec params)
 129       throws InvalidKeyException, InvalidAlgorithmParameterException
 130   {
 131     if (!key.getFormat().equalsIgnoreCase("RAW"))
 132       {
 133         throw new InvalidKeyException("unknown key format " + key.getFormat());
 134       }
 135     attributes.put(IMac.MAC_KEY_MATERIAL, key.getEncoded());
 136     mac.reset();
 137     mac.init(attributes);
 138   }
 139
 140   protected void engineReset()
 141   {
 142     mac.reset();
 143   }
 144
 145   protected void engineUpdate(byte b)
 146   {
 147     mac.update(b);
 148   }
 149
 150   protected void engineUpdate(byte[] in, int off, int len)
 151   {
 152     mac.update(in, off, len);
 153   }
 154 }