Transcribe docker reference parsing and introduce dockerFile detector (#114)

Transcribe docker reference parsing and introduce dockerFile detectors/submission

Co-authored-by: Jamie Magee <jamagee@microsoft.com>

Author: FernandoRojo

Directory.Packages.props

@@ -42,5 +42,6 @@
         <PackageVersion Include="System.Threading.Tasks.Dataflow" Version="4.9.0"/>
         <PackageVersion Include="yamldotnet" Version="11.2.1"/>
         <PackageVersion Include="Faker.net" Version="2.0.154"/>
+        <PackageVersion Include="Valleysoft.DockerfileModel" Version="1.0.0"/>
     </ItemGroup>
 </Project>

src/Microsoft.ComponentDetection.Common/DockerReference/DigestUtility.cs

@@ -0,0 +1,54 @@
+using System.Collections.Generic;
+
+namespace Microsoft.ComponentDetection.Common
+{
+    public class DigestUtility
+    {
+        private static readonly Dictionary<string, int> AlgorithmsSizes = new Dictionary<string, int>()
+        {
+            { "sha256", 32 },
+            { "sha384", 48 },
+            { "sha512", 64 },
+        };
+
+        public static bool CheckDigest(string digest, bool throwError = true)
+        {
+            var indexOfColon = digest.IndexOf(':');
+            if (indexOfColon < 0 ||
+                indexOfColon + 1 == digest.Length ||
+                !DockerRegex.AnchoredDigestRegexp.IsMatch(digest))
+            {
+                if (throwError)
+                {
+                    throw new InvalidDigestFormatError(digest);
+                }
+
+                return false;
+            }
+
+            string algorithm = digest.Substring(0, indexOfColon);
+
+            if (!AlgorithmsSizes.ContainsKey(algorithm))
+            {
+                if (throwError)
+                {
+                    throw new UnsupportedAlgorithmError(digest);
+                }
+
+                return false;
+            }
+
+            if (AlgorithmsSizes[algorithm] * 2 != (digest.Length - indexOfColon - 1))
+            {
+                if (throwError)
+                {
+                    throw new InvalidDigestLengthError(digest);
+                }
+
+                return false;
+            }
+
+            return true;
+        }
+    }
+}

src/Microsoft.ComponentDetection.Common/DockerReference/DockerReferenceException.cs

@@ -0,0 +1,120 @@
+using System;
+
+#pragma warning disable SA1402
+namespace Microsoft.ComponentDetection.Common
+{
+    public class DockerReferenceException : Exception
+    {
+        public DockerReferenceException(string reference, string exceptionErrorMessage)
+            : base($"Error while parsing docker reference {reference} : {exceptionErrorMessage}")
+        {
+        }
+    }
+
+    // ReferenceInvalidFormat represents an error while trying to parse a string as a reference.
+    public class ReferenceInvalidFormatException : DockerReferenceException
+    {
+        private const string ErrorMessage = "invalid reference format";
+
+        public ReferenceInvalidFormatException(string reference) 
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+
+    // TagInvalidFormat represents an error while trying to parse a string as a tag.
+    public class ReferenceTagInvalidFormatException : DockerReferenceException
+    {
+        private const string ErrorMessage = "invalid tag format";
+
+        public ReferenceTagInvalidFormatException(string reference)
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+
+    // DigestInvalidFormat represents an error while trying to parse a string as a tag.
+    public class ReferenceDigestInvalidFormatException : DockerReferenceException
+    {
+        private const string ErrorMessage = "invalid digest format";
+
+        public ReferenceDigestInvalidFormatException(string reference)
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+
+    // NameContainsUppercase is returned for invalid repository names that contain uppercase characters.
+    public class ReferenceNameContainsUppercaseException : DockerReferenceException
+    {
+        private const string ErrorMessage = "repository name must be lowercase";
+
+        public ReferenceNameContainsUppercaseException(string reference)
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+
+    // NameEmpty is returned for empty, invalid repository names.
+    public class ReferenceNameEmptyException : DockerReferenceException
+    {
+        private const string ErrorMessage = "repository name must have at least one component";
+
+        public ReferenceNameEmptyException(string reference)
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+
+    // ErrNameTooLong is returned when a repository name is longer than NameTotalLengthMax.
+    public class ReferenceNameTooLongException : DockerReferenceException
+    {
+        private const string ErrorMessage = "repository name must not be more than 255 characters";
+
+        public ReferenceNameTooLongException(string reference)
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+
+    // ErrNameNotCanonical is returned when a name is not canonical.
+    public class ReferenceNameNotCanonicalException : DockerReferenceException
+    {
+        private const string ErrorMessage = "repository name must be canonical";
+
+        public ReferenceNameNotCanonicalException(string reference)
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+
+    public class InvalidDigestFormatError : DockerReferenceException
+    {
+        private const string ErrorMessage = "invalid digest format";
+
+        public InvalidDigestFormatError(string reference)
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+
+    public class UnsupportedAlgorithmError : DockerReferenceException
+    {
+        private const string ErrorMessage = "unsupported digest algorithm";
+
+        public UnsupportedAlgorithmError(string reference)
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+
+    public class InvalidDigestLengthError : DockerReferenceException
+    {
+        private const string ErrorMessage = "invalid checksum digest length";
+
+        public InvalidDigestLengthError(string reference)
+            : base(reference, ErrorMessage)
+        {
+        }
+    }
+}