2 // RSACryptoServiceProvider.cs: Handles an RSA implementation.
5 // Sebastien Pouliot <sebastien@ximian.com>
6 // Ben Maurer (bmaurer@users.sf.net)
8 // (C) 2002, 2003 Motus Technologies Inc. (http://www.motus.com)
9 // Portions (C) 2003 Ben Maurer
10 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
12 // Permission is hereby granted, free of charge, to any person obtaining
13 // a copy of this software and associated documentation files (the
14 // "Software"), to deal in the Software without restriction, including
15 // without limitation the rights to use, copy, modify, merge, publish,
16 // distribute, sublicense, and/or sell copies of the Software, and to
17 // permit persons to whom the Software is furnished to do so, subject to
18 // the following conditions:
20 // The above copyright notice and this permission notice shall be
21 // included in all copies or substantial portions of the Software.
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35 using System.Runtime.InteropServices;
37 using Mono.Security.Cryptography;
39 namespace System.Security.Cryptography {
42 public sealed class RSACryptoServiceProvider : RSA, ICspAsymmetricAlgorithm {
43 private const int PROV_RSA_FULL = 1; // from WinCrypt.h
44 private const int AT_KEYEXCHANGE = 1;
45 private const int AT_SIGNATURE = 2;
47 private KeyPairPersistence store;
48 private bool persistKey;
49 private bool persisted;
51 private bool privateKeyExportable = true;
52 private bool m_disposed;
54 private RSAManaged rsa;
56 public RSACryptoServiceProvider ()
58 // Here it's not clear if we need to generate a keypair
59 // (note: MS implementation generates a keypair in this case).
61 // (a) often use this constructor to import an existing keypair.
62 // (b) take a LOT of time to generate the RSA keypair
63 // So we'll generate the keypair only when (and if) it's being
64 // used (or exported). This should save us a lot of time (at
65 // least in the unit tests).
69 public RSACryptoServiceProvider (CspParameters parameters)
71 Common (1024, parameters);
72 // no keypair generation done at this stage
75 public RSACryptoServiceProvider (int dwKeySize)
77 // Here it's clear that we need to generate a new keypair
78 Common (dwKeySize, null);
79 // no keypair generation done at this stage
82 public RSACryptoServiceProvider (int dwKeySize, CspParameters parameters)
84 Common (dwKeySize, parameters);
85 // no keypair generation done at this stage
88 private void Common (int dwKeySize, CspParameters p)
90 // Microsoft RSA CSP can do between 384 and 16384 bits keypair
91 LegalKeySizesValue = new KeySizes [1];
92 LegalKeySizesValue [0] = new KeySizes (384, 16384, 8);
93 base.KeySize = dwKeySize;
95 rsa = new RSAManaged (KeySize);
96 rsa.KeyGenerated += new RSAManaged.KeyGeneratedEventHandler (OnKeyGenerated);
98 persistKey = (p != null);
100 p = new CspParameters (PROV_RSA_FULL);
102 if (useMachineKeyStore)
103 p.Flags |= CspProviderFlags.UseMachineKeyStore;
105 store = new KeyPairPersistence (p);
106 // no need to load - it cannot exists
109 store = new KeyPairPersistence (p);
110 bool exists = store.Load ();
111 bool required = (p.Flags & CspProviderFlags.UseExistingKey) != 0;
113 if (required && !exists)
114 throw new CryptographicException ("Keyset does not exist");
116 if (store.KeyValue != null) {
118 this.FromXmlString (store.KeyValue);
124 private static bool useMachineKeyStore = false;
126 public static bool UseMachineKeyStore {
127 get { return useMachineKeyStore; }
128 set { useMachineKeyStore = value; }
132 ~RSACryptoServiceProvider ()
134 // Zeroize private key
138 public override string KeyExchangeAlgorithm {
139 get { return "RSA-PKCS1-KeyEx"; }
142 public override int KeySize {
151 public bool PersistKeyInCsp {
152 get { return persistKey; }
156 OnKeyGenerated (rsa, null);
161 public bool PublicOnly {
162 get { return rsa.PublicOnly; }
165 public override string SignatureAlgorithm {
166 get { return "http://www.w3.org/2000/09/xmldsig#rsa-sha1"; }
169 public byte[] Decrypt (byte[] rgb, bool fOAEP)
173 throw new ObjectDisposedException ("rsa");
175 // choose between OAEP or PKCS#1 v.1.5 padding
176 AsymmetricKeyExchangeDeformatter def = null;
178 def = new RSAOAEPKeyExchangeDeformatter (rsa);
180 def = new RSAPKCS1KeyExchangeDeformatter (rsa);
182 return def.DecryptKeyExchange (rgb);
185 // NOTE: Unlike MS we need this method
186 // LAMESPEC: Not available from MS .NET framework but MS don't tell
187 // why! DON'T USE IT UNLESS YOU KNOW WHAT YOU ARE DOING!!! You should
188 // only encrypt/decrypt session (secret) key using asymmetric keys.
189 // Using this method to decrypt data IS dangerous (and very slow).
190 public override byte[] DecryptValue (byte[] rgb)
192 if (!rsa.IsCrtPossible)
193 throw new CryptographicException ("Incomplete private key - missing CRT.");
195 return rsa.DecryptValue (rgb);
198 public byte[] Encrypt (byte[] rgb, bool fOAEP)
200 // choose between OAEP or PKCS#1 v.1.5 padding
201 AsymmetricKeyExchangeFormatter fmt = null;
203 fmt = new RSAOAEPKeyExchangeFormatter (rsa);
205 fmt = new RSAPKCS1KeyExchangeFormatter (rsa);
207 return fmt.CreateKeyExchange (rgb);
210 // NOTE: Unlike MS we need this method
211 // LAMESPEC: Not available from MS .NET framework but MS don't tell
212 // why! DON'T USE IT UNLESS YOU KNOW WHAT YOU ARE DOING!!! You should
213 // only encrypt/decrypt session (secret) key using asymmetric keys.
214 // Using this method to encrypt data IS dangerous (and very slow).
215 public override byte[] EncryptValue (byte[] rgb)
217 return rsa.EncryptValue (rgb);
220 public override RSAParameters ExportParameters (bool includePrivateParameters)
222 if ((includePrivateParameters) && (!privateKeyExportable))
223 throw new CryptographicException ("cannot export private key");
225 return rsa.ExportParameters (includePrivateParameters);
228 public override void ImportParameters (RSAParameters parameters)
230 rsa.ImportParameters (parameters);
233 private HashAlgorithm GetHash (object halg)
236 throw new ArgumentNullException ("halg");
238 HashAlgorithm hash = null;
240 hash = HashAlgorithm.Create ((String)halg);
241 else if (halg is HashAlgorithm)
242 hash = (HashAlgorithm) halg;
243 else if (halg is Type)
244 hash = (HashAlgorithm) Activator.CreateInstance ((Type)halg);
246 throw new ArgumentException ("halg");
251 // NOTE: this method can work with ANY configured (OID in machine.config)
252 // HashAlgorithm descendant
253 public byte[] SignData (byte[] buffer, object halg)
257 throw new ArgumentNullException ("buffer");
259 return SignData (buffer, 0, buffer.Length, halg);
262 // NOTE: this method can work with ANY configured (OID in machine.config)
263 // HashAlgorithm descendant
264 public byte[] SignData (Stream inputStream, object halg)
266 HashAlgorithm hash = GetHash (halg);
267 byte[] toBeSigned = hash.ComputeHash (inputStream);
268 return PKCS1.Sign_v15 (this, hash, toBeSigned);
271 // NOTE: this method can work with ANY configured (OID in machine.config)
272 // HashAlgorithm descendant
273 public byte[] SignData (byte[] buffer, int offset, int count, object halg)
275 HashAlgorithm hash = GetHash (halg);
276 byte[] toBeSigned = hash.ComputeHash (buffer, offset, count);
277 return PKCS1.Sign_v15 (this, hash, toBeSigned);
280 private string GetHashNameFromOID (string oid)
283 case "1.3.14.3.2.26":
285 case "1.2.840.113549.2.5":
287 case "2.16.840.1.101.3.4.2.1":
289 case "2.16.840.1.101.3.4.2.2":
291 case "2.16.840.1.101.3.4.2.3":
294 throw new CryptographicException (oid + " is an unsupported hash algorithm for RSA signing");
298 public byte[] SignHash (byte[] rgbHash, string str)
301 throw new ArgumentNullException ("rgbHash");
302 // Fx 2.0 defaults to the SHA-1
303 string hashName = (str == null) ? "SHA1" : GetHashNameFromOID (str);
304 HashAlgorithm hash = HashAlgorithm.Create (hashName);
305 return PKCS1.Sign_v15 (this, hash, rgbHash);
308 // NOTE: this method can work with ANY configured (OID in machine.config)
309 // HashAlgorithm descendant
310 public bool VerifyData (byte[] buffer, object halg, byte[] signature)
313 throw new ArgumentNullException ("buffer");
314 if (signature == null)
315 throw new ArgumentNullException ("signature");
317 HashAlgorithm hash = GetHash (halg);
318 byte[] toBeVerified = hash.ComputeHash (buffer);
319 return PKCS1.Verify_v15 (this, hash, toBeVerified, signature);
322 public bool VerifyHash (byte[] rgbHash, string str, byte[] rgbSignature)
325 throw new ArgumentNullException ("rgbHash");
326 if (rgbSignature == null)
327 throw new ArgumentNullException ("rgbSignature");
328 // Fx 2.0 defaults to the SHA-1
329 string hashName = (str == null) ? "SHA1" : GetHashNameFromOID (str);
330 HashAlgorithm hash = HashAlgorithm.Create (hashName);
331 return PKCS1.Verify_v15 (this, hash, rgbHash, rgbSignature);
334 protected override void Dispose (bool disposing)
337 // the key is persisted and we do not want it persisted
338 if ((persisted) && (!persistKey)) {
339 store.Remove (); // delete the container
344 // no need as they all are abstract before us
351 private void OnKeyGenerated (object sender, EventArgs e)
353 // the key isn't persisted and we want it persisted
354 if ((persistKey) && (!persisted)) {
355 // save the current keypair
356 store.KeyValue = this.ToXmlString (!rsa.PublicOnly);
361 // ICspAsymmetricAlgorithm
364 public CspKeyContainerInfo CspKeyContainerInfo {
366 return new CspKeyContainerInfo(store.Parameters);
371 public byte[] ExportCspBlob (bool includePrivateParameters)
374 if (includePrivateParameters)
375 blob = CryptoConvert.ToCapiPrivateKeyBlob (this);
377 blob = CryptoConvert.ToCapiPublicKeyBlob (this);
379 // ALGID (bytes 4-7) - default is KEYX
380 // 00 24 00 00 (for CALG_RSA_SIGN)
381 // 00 A4 00 00 (for CALG_RSA_KEYX)
382 blob [5] = (byte) (((store != null) && (store.Parameters.KeyNumber == AT_SIGNATURE)) ? 0x24 : 0xA4);
387 public void ImportCspBlob (byte[] keyBlob)
390 throw new ArgumentNullException ("keyBlob");
392 RSA rsa = CryptoConvert.FromCapiKeyBlob (keyBlob);
393 if (rsa is RSACryptoServiceProvider) {
394 // default (if no change are present in machine.config)
395 RSAParameters rsap = rsa.ExportParameters (!(rsa as RSACryptoServiceProvider).PublicOnly);
396 ImportParameters (rsap);
398 // we can't know from RSA if the private key is available
401 RSAParameters rsap = rsa.ExportParameters (true);
402 ImportParameters (rsap);
406 RSAParameters rsap = rsa.ExportParameters (false);
407 ImportParameters (rsap);
411 var p = new CspParameters (PROV_RSA_FULL);
412 p.KeyNumber = keyBlob [5] == 0x24 ? AT_SIGNATURE : AT_KEYEXCHANGE;
414 if (useMachineKeyStore)
415 p.Flags |= CspProviderFlags.UseMachineKeyStore;
417 store = new KeyPairPersistence (p);