CPP style NDR formatting (#21)

* initial support for cpp style NDR formatting
* simple types are now adjusted to standard c++ types names by the formatter

Author: irsl

NtApiDotNet/Ndr/NdrArrayTypes.cs

@@ -64,7 +64,7 @@ public override int GetSize()
             return ElementCount * ElementSize;
         }
 
-        internal override string FormatType(NdrFormatter context)
+        internal override string FormatType(INdrFormatterInternal context)
         {
             return string.Format("{0}[{1}]", ElementType.FormatType(context), ElementCount == 0 ? string.Empty : ElementCount.ToString());
         }
@@ -149,7 +149,7 @@ protected override int GetElementCount()
             return 0;
         }
 
-        internal override string FormatType(NdrFormatter context)
+        internal override string FormatType(INdrFormatterInternal context)
         {
             StringBuilder builder = new StringBuilder();
             if (ConformanceDescriptor.IsValid)
@@ -205,7 +205,7 @@ protected override int GetElementCount()
             return 0;
         }
 
-        internal override string FormatType(NdrFormatter context)
+        internal override string FormatType(INdrFormatterInternal context)
         {
             StringBuilder builder = new StringBuilder();
             if (ConformanceDescriptor != null && ConformanceDescriptor.IsValid)
@@ -274,7 +274,7 @@ protected override int GetElementCount()
             return 0;
         }
 
-        internal override string FormatType(NdrFormatter context)
+        internal override string FormatType(INdrFormatterInternal context)
         {
             StringBuilder builder = new StringBuilder();
             if (VarianceDescriptor != null && VarianceDescriptor.IsValid)

NtApiDotNet/Ndr/NdrComProxyDefinition.cs

@@ -73,7 +73,7 @@ public static NdrComProxyDefinition FromProcedures(string name, Guid iid, Guid b
             return new NdrComProxyDefinition(name, iid, base_iid, dispatch_count, procedures.ToList().AsReadOnly());
         }
 
-        internal string Format(NdrFormatter context)
+        internal string Format(INdrFormatterInternal context)
         {
             NdrStringBuilder builder = new NdrStringBuilder();
             builder.AppendLine("[Guid(\"{0}\")]", Iid);

NtApiDotNet/Ndr/NdrFormatter.cs

@@ -14,6 +14,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace NtApiDotNet.Ndr
 {
@@ -51,23 +52,39 @@ public interface INdrFormatter
         string FormatRpcServerInterface(NdrRpcServerInterface rpc_server);
     }
 
+    internal interface INdrFormatterInternal : INdrFormatter
+    {
+        string SimpleTypeToName(NdrFormatCharacter format);
+        string FormatComment(string comment);
+        string FormatComment(string comment, params object[] args);
+        string FormatPointer(string base_type);
+        string IidToName(Guid iid);
+        string DemangleComName(string name);
+        bool ShowProcedureParameterAttributes { get; }
+    }
+
     /// <summary>
     /// An base class which describes a text formatter for NDR data.
     /// </summary>
-    internal class NdrFormatter : INdrFormatter
+    internal class NdrFormatter : INdrFormatterInternal
     {
         private readonly IDictionary<Guid, string> _iids_to_name;
         private readonly Func<string, string> _demangle_com_name;
         private DefaultNdrFormatterFlags _flags;
 
+        bool INdrFormatterInternal.ShowProcedureParameterAttributes { get { return true; } }
+
         internal NdrFormatter(IDictionary<Guid, string> iids_to_names, Func<string, string> demangle_com_name, DefaultNdrFormatterFlags flags)
         {
             _iids_to_name = iids_to_names;
-            _demangle_com_name = demangle_com_name;
+            _demangle_com_name = demangle_com_name ?? (s => s);
             _flags = flags;
         }
-
-        internal string IidToName(Guid iid)
+        string INdrFormatterInternal.IidToName(Guid iid)
+        {
+            return IidToName(iid);
+        }
+        protected string IidToName(Guid iid)
         {
             if (_iids_to_name.ContainsKey(iid))
             {
@@ -76,12 +93,12 @@ internal string IidToName(Guid iid)
             return null;
         }
 
-        internal string DemangleComName(string name)
+        string INdrFormatterInternal.DemangleComName(string name)
         {
             return _demangle_com_name(name);
         }
 
-        internal string SimpleTypeToName(NdrFormatCharacter format)
+        string INdrFormatterInternal.SimpleTypeToName(NdrFormatCharacter format)
         {
             switch (format)
             {
@@ -136,12 +153,21 @@ internal string SimpleTypeToName(NdrFormatCharacter format)
             return string.Format("{0}", format);
         }
 
-        internal string FormatPointer(string base_type)
+        string INdrFormatterInternal.FormatPointer(string base_type)
         {
             return $"{base_type}*";
         }
 
-        internal string FormatComment(string comment)
+        string INdrFormatterInternal.FormatComment(string comment)
+        {
+            return FormatComment(comment);
+        }
+        string INdrFormatterInternal.FormatComment(string comment, params object[] args)
+        {
+            return FormatComment(string.Format(comment, args));
+        }
+
+        private string FormatComment(string comment)
         {
             if ((_flags & DefaultNdrFormatterFlags.RemoveComments) == DefaultNdrFormatterFlags.RemoveComments)
             {
@@ -150,11 +176,6 @@ internal string FormatComment(string comment)
             return $"/* {comment} */";
         }
 
-        internal string FormatComment(string comment, params object[] args)
-        {
-            return FormatComment(string.Format(comment, args));
-        }
-
         string INdrFormatter.FormatComplexType(NdrComplexTypeReference complex_type)
         {
             return complex_type.FormatComplexType(this);
@@ -176,6 +197,139 @@ string INdrFormatter.FormatRpcServerInterface(NdrRpcServerInterface rpc_server)
         }
     }
 
+
+    /**
+     * This formatter generates data that the CPP compiler can (hopefully) understand,
+     * at least it will serve as a good skeleton to support spinning up new projects easily.
+     * */
+    internal class CppNdrFormatterInternal : NdrFormatter, INdrFormatterInternal
+    {
+        internal CppNdrFormatterInternal(IDictionary<Guid, string> iids_to_names, Func<string, string> demangle_com_name, DefaultNdrFormatterFlags flags)
+            : base(iids_to_names, demangle_com_name, flags)
+        {
+
+        }
+
+        bool INdrFormatterInternal.ShowProcedureParameterAttributes { get { return false; } }
+
+        string INdrFormatterInternal.SimpleTypeToName(NdrFormatCharacter format)
+        {
+            switch (format)
+            {
+                case NdrFormatCharacter.FC_BYTE:
+                case NdrFormatCharacter.FC_USMALL:
+                    return "uint8_t";
+                case NdrFormatCharacter.FC_SMALL:
+                case NdrFormatCharacter.FC_CHAR:
+                    return "int8_t";
+                case NdrFormatCharacter.FC_WCHAR:
+                    return "wchar_t";
+                case NdrFormatCharacter.FC_SHORT:
+                    return "int16_t";
+                case NdrFormatCharacter.FC_USHORT:
+                    return "uint16_t";
+                case NdrFormatCharacter.FC_LONG:
+                    return "int64_t";
+                case NdrFormatCharacter.FC_ULONG:
+                    return "uint64_t";
+                case NdrFormatCharacter.FC_FLOAT:
+                    return "float";
+                case NdrFormatCharacter.FC_HYPER:
+                    return "int64_t";
+                case NdrFormatCharacter.FC_DOUBLE:
+                    return "double";
+                case NdrFormatCharacter.FC_INT3264:
+                    return "intptr_t";
+                case NdrFormatCharacter.FC_UINT3264:
+                    return "uintptr_t";
+                case NdrFormatCharacter.FC_C_WSTRING:
+                case NdrFormatCharacter.FC_WSTRING:
+                    return "wchar_t";
+                case NdrFormatCharacter.FC_C_CSTRING:
+                case NdrFormatCharacter.FC_CSTRING:
+                    return "char";
+                case NdrFormatCharacter.FC_ENUM16:
+                    return "/* ENUM16 */ uint16_t";
+                case NdrFormatCharacter.FC_ENUM32:
+                    return "/* ENUM32 */ uint32_t";
+                case NdrFormatCharacter.FC_SYSTEM_HANDLE:
+                    return "HANDLE";
+                case NdrFormatCharacter.FC_AUTO_HANDLE:
+                case NdrFormatCharacter.FC_CALLBACK_HANDLE:
+                case NdrFormatCharacter.FC_BIND_CONTEXT:
+                case NdrFormatCharacter.FC_BIND_PRIMITIVE:
+                case NdrFormatCharacter.FC_BIND_GENERIC:
+                    return "handle_t";
+                case NdrFormatCharacter.FC_ERROR_STATUS_T:
+                    return "uint";
+            }
+
+            return string.Format("{0}", format);
+        }
+
+        string INdrFormatter.FormatProcedure(NdrProcedureDefinition procedure)
+        {
+            return FormatProcedure(procedure);
+        }
+        private string FormatProcedure(NdrProcedureDefinition procedure)
+        {
+            string return_value;
+
+            if (procedure.ReturnValue == null)
+            {
+                return_value = "void";
+            }
+            else if (procedure.ReturnValue.Type.Format == NdrFormatCharacter.FC_LONG)
+            {
+                return_value = "HRESULT";
+            }
+            else
+            {
+                return_value = procedure.ReturnValue.Type.FormatType(this);
+            }
+
+            string procedureParameters = string.Join(", ", procedure.Params.Select(
+                (p, i) => string.Format(
+                    "{0} {1} {2}", 
+                    (this as INdrFormatterInternal).FormatComment("Stack Offset: {0}", p.Offset), 
+                    p.Format(this), 
+                    p.FormatName(i)
+                )
+            ));
+            return string.Format("virtual {0} __stdcall {1}({2});", return_value,
+                procedure.Name, procedureParameters);
+        }
+
+        string INdrFormatter.FormatComProxy(NdrComProxyDefinition com_proxy)
+        {
+            NdrStringBuilder builder = new NdrStringBuilder();
+
+            string base_name = this.IidToName(com_proxy.BaseIid);
+            if (base_name == null)
+            {
+                string unknown_iid = $"Unknown IID {com_proxy.BaseIid}";
+                string comment = (this as INdrFormatterInternal).FormatComment(unknown_iid);
+                base_name = $"{comment} IUnknown";
+            }
+
+            builder.AppendLine(
+                "class __declspec(uuid(\"{0}\")) {1} : public {2} {{\npublic:",
+                com_proxy.Iid,
+                (this as INdrFormatterInternal).DemangleComName(com_proxy.Name),
+                base_name
+            );
+
+            builder.PushIndent(' ', 4);
+            foreach (NdrProcedureDefinition proc in com_proxy.Procedures)
+            {
+                builder.AppendLine(this.FormatProcedure(proc));
+            }
+            builder.PopIndent();
+            builder.AppendLine("}").AppendLine();
+            return builder.ToString();
+        }
+    }
+
     /// <summary>
     /// Flags for the NDR formatter.
     /// </summary>
@@ -228,7 +382,7 @@ public static INdrFormatter Create(IDictionary<Guid, string> iids_to_names, Func
         /// <returns>The default formatter.</returns>
         public static INdrFormatter Create(IDictionary<Guid, string> iids_to_names, DefaultNdrFormatterFlags flags)
         {
-            return Create(iids_to_names, s => s, flags);
+            return Create(iids_to_names, null, flags);
         }
 
         /// <summary>
@@ -238,7 +392,7 @@ public static INdrFormatter Create(IDictionary<Guid, string> iids_to_names, Defa
         /// <returns>The default formatter.</returns>
         public static INdrFormatter Create(IDictionary<Guid, string> iids_to_names)
         {
-            return Create(iids_to_names, s => s);
+            return Create(iids_to_names, null);
         }
 
         /// <summary>
@@ -260,4 +414,74 @@ public static INdrFormatter Create()
             return Create(new Dictionary<Guid, string>());
         }
     }
+
+
+    /// <summary>
+    /// NDR formatter constructor for CPP style output.
+    /// </summary>
+    public static class CppNdrFormatter
+    {
+        /// <summary>
+        /// Create the CPP formatter.
+        /// </summary>
+        /// <param name="iids_to_names">Specify a dictionary of IIDs to names.</param>
+        /// <param name="demangle_com_name">Function to demangle COM interface names during formatting.</param>
+        /// <param name="flags">Formatter flags.</param>
+        /// <returns>The CPP formatter.</returns>
+        public static INdrFormatter Create(IDictionary<Guid, string> iids_to_names, Func<string, string> demangle_com_name, DefaultNdrFormatterFlags flags)
+        {
+            return new CppNdrFormatterInternal(iids_to_names, demangle_com_name, flags);
+        }
+
+        /// <summary>
+        /// Create the CPP formatter.
+        /// </summary>
+        /// <param name="iids_to_names">Specify a dictionary of IIDs to names.</param>
+        /// <param name="demangle_com_name">Function to demangle COM interface names during formatting.</param>
+        /// <returns>The CPPformatter.</returns>
+        public static INdrFormatter Create(IDictionary<Guid, string> iids_to_names, Func<string, string> demangle_com_name)
+        {
+            return Create(iids_to_names, demangle_com_name, DefaultNdrFormatterFlags.None);
+        }
+
+        /// <summary>
+        /// Create the CPP formatter.
+        /// </summary>
+        /// <param name="iids_to_names">Specify a dictionary of IIDs to names.</param>
+        /// <param name="flags">Formatter flags.</param>
+        /// <returns>The CPP formatter.</returns>
+        public static INdrFormatter Create(IDictionary<Guid, string> iids_to_names, DefaultNdrFormatterFlags flags)
+        {
+            return Create(iids_to_names, null, flags);
+        }
+
+        /// <summary>
+        /// Create the CPP formatter.
+        /// </summary>
+        /// <param name="iids_to_names">Specify a dictionary of IIDs to names.</param>
+        /// <returns>The CPP formatter.</returns>
+        public static INdrFormatter Create(IDictionary<Guid, string> iids_to_names)
+        {
+            return Create(iids_to_names, null);
+        }
+
+        /// <summary>
+        /// Create the default formatter.
+        /// </summary>
+        /// <param name="flags">Formatter flags.</param>
+        /// <returns>The CPP formatter.</returns>
+        public static INdrFormatter Create(DefaultNdrFormatterFlags flags)
+        {
+            return Create(new Dictionary<Guid, string>(), flags);
+        }
+
+        /// <summary>
+        /// Create the default formatter.
+        /// </summary>
+        /// <returns>The CPP formatter.</returns>
+        public static INdrFormatter Create()
+        {
+            return Create(new Dictionary<Guid, string>());
+        }
+    }
 }

NtApiDotNet/Ndr/NdrHandleTypes.cs

@@ -56,7 +56,7 @@ internal NdrSystemHandleTypeReference(BinaryReader reader)
             AccessMask = reader.ReadUInt32();
         }
 
-        internal override string FormatType(NdrFormatter context)
+        internal override string FormatType(INdrFormatterInternal context)
         {
             if (AccessMask != 0)
             {
@@ -118,7 +118,7 @@ internal NdrHandleTypeReference(NdrFormatCharacter format)
         {
         }
 
-        internal override string FormatType(NdrFormatter context)
+        internal override string FormatType(INdrFormatterInternal context)
         {
             return $"{context.FormatComment(Format.ToString())} {context.SimpleTypeToName(Format)}";
         }