Scaled back Trace. Code cleanup.

Author: vplusplus

src/Org.Security.Cryptography.X509Extensions/MyTrace.cs

@@ -1,49 +1,16 @@
 
 using System;
 using System.Diagnostics;
-using System.Runtime.CompilerServices;
 using System.Text;
 
 namespace Org.Security.Cryptography
 {
     internal static class MyTrace
     {
-        // Trace switch name: Org.Security.Cryptography
-        static readonly string MyName = typeof(MyTrace).Namespace;
-
-        // Making TraceSwitch update-able, because of the .Net core MESS (I meant, one of the .Net core messes)
-        // .Net core applications WILL NOT honor TraceSwitch in config files.
-        // Use X509Extensions.TraceLevel property
-        internal static TraceSwitch MyTraceSwitch { get; set; } = new TraceSwitch(MyName, MyName, $"{TraceLevel.Warning}");
-
-        [Conditional("DEBUG")]
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal static void Entering([CallerMemberName] string memberName = "") => WriteIf(MyTraceSwitch.TraceVerbose, () => $"--> {memberName}()");
+        static readonly string ME = typeof(MyTrace).Namespace;
 
         [Conditional("DEBUG")]
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal static void Verbose(Func<string> fxMessage) => WriteIf(MyTraceSwitch.TraceVerbose, fxMessage);
-
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal static void Info(Func<string> fxMessage) => WriteIf(MyTraceSwitch.TraceInfo, fxMessage);
-
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal static void Warn(Func<string> fxMessage) => WriteIf(MyTraceSwitch.TraceWarning, fxMessage);
-
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal static void Error(Func<string> fxMessage) => Write(fxMessage);
-
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        static void WriteIf(bool condition, Func<string> fxMessage)
-        {
-            if (condition) Trace.WriteLine($"{MyName}: {fxMessage()}");
-        }
-
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        static void Write(Func<string> fxMessage)
-        {
-            Trace.WriteLine($"{MyName}: {fxMessage()}");
-        }
+        internal static void Info(Func<string> fxMessage) => Trace.WriteLine($"{ME}: {fxMessage()}");
 
         internal static void Error(Exception err)
         {
@@ -57,7 +24,7 @@ internal static void Error(Exception err)
                 var buffer = new StringBuilder();
 
                 // The exception chain...
-                buffer.AppendLine($"{MyName}: An error occured at {DateTime.UtcNow} UTC");
+                buffer.AppendLine($"ERROR: {ME} / {DateTime.UtcNow} UTC");
                 while (null != err)
                 {
                     buffer.AppendLine(err.Message);

src/Org.Security.Cryptography.X509Extensions/X509Extensions.cs

@@ -1,6 +1,5 @@
 
 using System;
-using System.Diagnostics;
 using System.IO;
 using System.Security.Cryptography;
 using System.Security.Cryptography.X509Certificates;
@@ -48,12 +47,10 @@ public static void EncryptUsingPublicKey(this X509Certificate2 x509WithPublicKey
             if (null == outputStream) throw new ArgumentNullException(nameof(outputStream));
             if (null == dataEncryptionAlgorithmName) throw new ArgumentNullException(nameof(dataEncryptionAlgorithmName));
 
-            MyTrace.Entering();
-
             try
             {
-                if (null == x509WithPublicKey.PublicKey) throw new ArgumentException("X509Certificate2.PublicKey was NULL.");
-                if (null == x509WithPublicKey.PublicKey.Key) throw new ArgumentException("X509Certificate2.PublicKey.Key was NULL.");
+                if (null == x509WithPublicKey.PublicKey) throw new Exception($"X509Certificate2.PublicKey was NULL. Cert: {x509WithPublicKey.Thumbprint}");
+                if (null == x509WithPublicKey.PublicKey.Key) throw new Exception($"X509Certificate2.PublicKey.Key was NULL. Cert: {x509WithPublicKey.Thumbprint}");
 
                 // IMP: We didn't create the Cert. DO NOT DISPOSE.
                 // IMP: Disposing the AsymmetricAlgorithm will render the X509Certificate2 useless for subsequent use.
@@ -63,26 +60,28 @@ public static void EncryptUsingPublicKey(this X509Certificate2 x509WithPublicKey
                 {
                     if (null == dataEncryptionAlgorithm) throw new Exception($"SymmetricAlgorithm.Create('{dataEncryptionAlgorithmName}') returned NULL.");
 
+                    // Set desired key and block size.
+                    // This may throw an excepion on invalid key/block sizes.
                     dataEncryptionAlgorithm.KeySize = keySize;
                     dataEncryptionAlgorithm.BlockSize = blockSize;
 
                     // The DataEncryptionKey and IV.
-                    byte[] dataEncryptionKey = dataEncryptionAlgorithm.Key;
-                    byte[] dataEncryptionIV = dataEncryptionAlgorithm.IV;
+                    byte[] dataEncryptionKey = dataEncryptionAlgorithm.Key ?? throw new Exception("dataEncryptionAlgorithm.Key was NULL.");
+                    byte[] dataEncryptionIV = dataEncryptionAlgorithm.IV ?? throw new Exception("dataEncryptionAlgorithm.IV was NULL.");
 
                     // Encrypt the DEK using the X509 public key (KEK).
                     var keyFormatter = new RSAPKCS1KeyExchangeFormatter(keyEncryptionAlgorithm);
                     byte[] encryptedDataEncryptionKey = keyFormatter.CreateKeyExchange(dataEncryptionKey);
 
-                    // Debug information (Set Trace to warning or above for PRD)
+                    // Essential debug information...
                     MyTrace.Info(() => $"KEK: {keyEncryptionAlgorithm.GetType().Name} / {keyEncryptionAlgorithm.KeySize} bits / {x509WithPublicKey.Thumbprint}");
                     MyTrace.Info(() => $"DEK: {dataEncryptionAlgorithm.GetType().Name} / {dataEncryptionAlgorithm.KeySize} bits. / BlockSize: {dataEncryptionAlgorithm.BlockSize} bits.");
 
-                    // Write the length & bytes of encrypted DEK and IV
+                    // Write the EncryptedDEK and the IV (length & bytes)
                     outputStream.WriteLengthAndBytes(encryptedDataEncryptionKey);
                     outputStream.WriteLengthAndBytes(dataEncryptionIV);
 
-                    // Write Data
+                    // Write encrypted data
                     using (var transform = dataEncryptionAlgorithm.CreateEncryptor())
                     using (var cryptoStream = new CryptoStream(outputStream, transform, CryptoStreamMode.Write))
                     {
@@ -110,16 +109,9 @@ public static void DecryptUsingPrivateKey(this X509Certificate2 x509WithPrivateK
             if (null == x509WithPrivateKey) throw new ArgumentNullException(nameof(x509WithPrivateKey));
             if (null == dataEncryptionAlgorithmName) throw new ArgumentNullException(nameof(dataEncryptionAlgorithmName));
 
-            MyTrace.Entering();
-
-            // Data Encryption key (DEK) is read from the stream.
-            // DEK itself comes encrypted using the Key encryption key (KEK)
-            // Use X509 cert private key to decrypt the DEK
-            // Use the DEK to decrypt the data
-
             try
             {
-                if (null == x509WithPrivateKey.PrivateKey) throw new ArgumentException("X509Certificate2.PrivateKey was NULL.");
+                if (null == x509WithPrivateKey.PrivateKey) throw new Exception($"X509Certificate2.PrivateKey was NULL. Cert: {x509WithPrivateKey.Thumbprint}");
 
                 // IMP: We didn't create the Cert. DO NOT DISPOSE.
                 // IMP: Disposing the AsymmetricAlgorithm will render the X509Certificate2 useless for subsequent use.
@@ -234,18 +226,6 @@ static Int32 ReadInt32(this Stream inputStream)
 
             return BitConverter.ToInt32(fourBytes, startIndex: 0);
         }
-
-        /// <summary>
-        /// Because, .Net core doesn't honor TraceSwitches from the config files.
-        /// Try TraceSwitch "Org.Security.Cryptography" in config files.
-        /// If it doesn't work, update me.
-        /// </summary>
-        public static TraceLevel TraceLevel
-        {
-            set {
-                MyTrace.MyTraceSwitch = new TraceSwitch("", "", value.ToString());
-            }
-        }
     }
 }
 

src/UnitTests/X509Tests.cs

@@ -20,12 +20,6 @@ public class X509Tests
 
         const string CertThumbPrint = "2E3257EE8FC8A72DB3778DFB3F9EDC7D0A9D66C7";
 
-        [TestInitialize]
-        public void TestInitialize()
-        {
-            X509Extensions.TraceLevel = TraceLevel.Info;
-        }
-
 
         [TestMethod]
         public void FindCertificateTest()