2005-06-10 Sebastien Pouliot <sebastien@ximian.com>
[mono.git] / mcs / class / corlib / System.Security.Cryptography / KeyedHashAlgorithm.cs
1 //
2 // KeyedHashAlgorithm.cs: Handles keyed hash and MAC classes.
3 //
4 // Author:
5 //      Sebastien Pouliot (sebastien@ximian.com)
6 //
7 // (C) 2002 Motus Technologies Inc. (http://www.motus.com)
8 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
9 //
10 // Permission is hereby granted, free of charge, to any person obtaining
11 // a copy of this software and associated documentation files (the
12 // "Software"), to deal in the Software without restriction, including
13 // without limitation the rights to use, copy, modify, merge, publish,
14 // distribute, sublicense, and/or sell copies of the Software, and to
15 // permit persons to whom the Software is furnished to do so, subject to
16 // the following conditions:
17 // 
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
20 // 
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 //
29
30 using System.Globalization;
31 using System.Runtime.InteropServices;
32
33 namespace System.Security.Cryptography {
34
35 #if NET_2_0
36 [ComVisible (true)]
37 #endif
38 public abstract class KeyedHashAlgorithm : HashAlgorithm {
39         
40         protected byte[] KeyValue;
41
42         protected KeyedHashAlgorithm () : base () 
43         {
44                 // create a random 64 bits key
45         }
46
47         ~KeyedHashAlgorithm () 
48         {
49                 Dispose (false);
50         }
51
52         public virtual byte[] Key {
53                 get { 
54                         return (byte[]) KeyValue.Clone (); 
55                 }
56                 set { 
57                         // can't change the key during a hashing ops
58                         if (State != 0) {
59                                 throw new CryptographicException (
60                                         Locale.GetText ("Key can't be changed at this state."));
61                         }
62                         // zeroize current key material for security
63                         ZeroizeKey ();
64                         // copy new key
65                         KeyValue = (byte[]) value.Clone (); 
66                 }
67         }
68
69         protected override void Dispose (bool disposing)
70         {
71                 // zeroize key material for security
72                 ZeroizeKey();
73                 // dispose managed resources
74                 // none so far
75                 // dispose unmanaged resources 
76                 // none so far
77                 // calling base class HashAlgorithm
78                 base.Dispose (disposing);
79         }
80
81         private void ZeroizeKey() 
82         {
83                 if (KeyValue != null)
84                         Array.Clear (KeyValue, 0, KeyValue.Length);
85         }
86
87         public static new KeyedHashAlgorithm Create ()
88         {
89                 return Create ("System.Security.Cryptography.KeyedHashAlgorithm");
90         }
91
92         public static new KeyedHashAlgorithm Create (string algName)
93         {
94                 return (KeyedHashAlgorithm) CryptoConfig.CreateFromName (algName);
95         }
96 }
97
98 }