Add InvokePermission attribute when RequireOwnership is defined

Author: EmandM

com.unity.netcode.gameobjects/Editor/CodeGen/NetworkBehaviourILPP.cs

@@ -470,6 +470,7 @@ private void CreateNetworkVariableTypeInitializers(AssemblyDefinition assembly,
         private FieldReference m_UniversalRpcParams_Receive_SenderClientId_FieldRef;
         private TypeReference m_UniversalRpcParams_TypeRef;
         private TypeReference m_ClientRpcParams_TypeRef;
+        private TypeReference m_RpcInvokePermissions_TypeRef;
         private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedByMemcpy_MethodRef;
         private MethodReference m_NetworkVariableSerializationTypes_InitializeSerializer_UnmanagedByMemcpyArray_MethodRef;
 #if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
@@ -656,6 +657,7 @@ private bool ImportReferences(ModuleDefinition moduleDefinition, string[] assemb
             TypeDefinition serverRpcParamsTypeDef = null;
             TypeDefinition clientRpcParamsTypeDef = null;
             TypeDefinition universalRpcParamsTypeDef = null;
+            TypeDefinition rpcInvokePermissionTypeDef = null;
             TypeDefinition fastBufferWriterTypeDef = null;
             TypeDefinition fastBufferReaderTypeDef = null;
             TypeDefinition networkVariableSerializationTypesTypeDef = null;
@@ -717,6 +719,12 @@ private bool ImportReferences(ModuleDefinition moduleDefinition, string[] assemb
                     continue;
                 }
 
+                if (rpcInvokePermissionTypeDef == null && netcodeTypeDef.Name == nameof(RpcInvokePermission))
+                {
+                    rpcInvokePermissionTypeDef = netcodeTypeDef;
+                    continue;
+                }
+
                 if (fastBufferWriterTypeDef == null && netcodeTypeDef.Name == nameof(FastBufferWriter))
                 {
                     fastBufferWriterTypeDef = netcodeTypeDef;
@@ -942,6 +950,7 @@ private bool ImportReferences(ModuleDefinition moduleDefinition, string[] assemb
             }
 
             m_ClientRpcParams_TypeRef = moduleDefinition.ImportReference(clientRpcParamsTypeDef);
+            m_RpcInvokePermissions_TypeRef = moduleDefinition.ImportReference(rpcInvokePermissionTypeDef);
             m_FastBufferWriter_TypeRef = moduleDefinition.ImportReference(fastBufferWriterTypeDef);
             m_FastBufferReader_TypeRef = moduleDefinition.ImportReference(fastBufferReaderTypeDef);
 
@@ -1638,27 +1647,37 @@ private CustomAttribute CheckAndGetRpcAttribute(MethodDefinition methodDefinitio
                 return null;
             }
 
-            bool hasRequireOwnership = false, hasInvokePermission = false;
+            var typeSystem = methodDefinition.Module.TypeSystem;
+            var hasInvokePermission = false;
 
-            foreach (var argument in rpcAttribute.Fields)
+            CustomAttributeNamedArgument? invokePermissionAttribute = null;
+            foreach(var argument in rpcAttribute.Fields)
             {
                 switch (argument.Name)
                 {
                     case k_ServerRpcAttribute_RequireOwnership:
-                        hasRequireOwnership = true;
+                        var requireOwnership = argument.Argument.Type == typeSystem.Boolean && (bool)argument.Argument.Value;
+                        var invokePermissionArg = new CustomAttributeArgument(m_RpcInvokePermissions_TypeRef, requireOwnership ? RpcInvokePermission.Owner : RpcInvokePermission.Everyone);
+                        invokePermissionAttribute = new CustomAttributeNamedArgument( k_RpcAttribute_InvokePermission,  invokePermissionArg);
                         break;
                     case k_RpcAttribute_InvokePermission:
                         hasInvokePermission = true;
                         break;
                 }
             }
 
-            if (hasRequireOwnership && hasInvokePermission)
+            if (invokePermissionAttribute != null)
             {
-                m_Diagnostics.AddError("Rpc attribute cannot declare both RequireOwnership and InvokePermission!");
-                return null;
+                if (hasInvokePermission)
+                {
+                    m_Diagnostics.AddError($"{methodDefinition.Name} cannot declare both RequireOwnership and InvokePermission!");
+                    return null;
+                }
+
+                rpcAttribute.Fields.Add(invokePermissionAttribute.Value);
             }
 
+
             // Checks for IsSerializable are moved to later as the check is now done by dynamically seeing if any valid
             // serializer OR extension method exists for it.
             return rpcAttribute;
@@ -2922,8 +2941,6 @@ private MethodDefinition GenerateStaticHandler(MethodDefinition methodDefinition
             var processor = rpcHandler.Body.GetILProcessor();
 
             var isServerRpc = rpcAttribute.AttributeType.FullName == CodeGenHelpers.ServerRpcAttribute_FullName;
-            var isClientRpc = rpcAttribute.AttributeType.FullName == CodeGenHelpers.ClientRpcAttribute_FullName;
-            var isGenericRpc = rpcAttribute.AttributeType.FullName == CodeGenHelpers.RpcAttribute_FullName;
             var requireOwnership = true; // default value MUST be == `ServerRpcAttribute.RequireOwnership`
             foreach (var attrField in rpcAttribute.Fields)
             {

com.unity.netcode.gameobjects/Runtime/Core/NetworkBehaviour.cs

@@ -335,7 +335,7 @@ internal FastBufferWriter __beginSendRpc(uint rpcMethodId, RpcParams rpcParams,
                 throw new RpcException("This RPC can only be sent by the server.");
             }
 
-            if ((attributeParams.RequireOwnership || attributeParams.InvokePermission == RpcInvokePermission.Owner) && !IsOwner)
+            if (attributeParams.InvokePermission == RpcInvokePermission.Owner && !IsOwner)
             {
                 throw new RpcException("This RPC can only be sent by its owner.");
             }

com.unity.netcode.gameobjects/Tests/Runtime/Rpc/RpcInvocationTests.cs

@@ -22,6 +22,9 @@ public RpcInvocationTests(NetworkTopologyTypes topologyType) : base(topologyType
 
         private Dictionary<NetworkManager, InvokePermissionBehaviour> m_InvokeInstances = new();
 
+        // TODO: [CmbServiceTests] Enable once the CMB service fixes the client spoofing issue.
+        protected override bool UseCMBService() => false;
+
         protected override void OnServerAndClientsCreated()
         {
             m_Prefab = CreateNetworkObjectPrefab("RpcInvokePermissionTest");
@@ -188,42 +191,38 @@ public IEnumerator RpcInvokePermissionReceivingTests()
             yield return WaitForConditionOrTimeOut(AllExpectedCallsReceived);
             AssertOnTimeout("[InvokePermissions.Everyone] Incorrect Rpc calls received");
 
-            // DANGO-TODO: Fix the client spoofing issue
-            if (!m_UseCmbService)
-            {
-                var firstClientInstance = m_InvokeInstances[firstClient];
-                var secondClient = GetNonAuthorityNetworkManager(1);
-                var thirdClient = GetNonAuthorityNetworkManager(2);
+            var firstClientInstance = m_InvokeInstances[firstClient];
+            var secondClient = GetNonAuthorityNetworkManager(1);
+            var thirdClient = GetNonAuthorityNetworkManager(2);
 
-                firstClientInstance.ExpectedCallCounts[nameof(InvokePermissionBehaviour.TrackSenderIdRpc)] = 1;
+            firstClientInstance.ExpectedCallCounts[nameof(InvokePermissionBehaviour.TrackSenderIdRpc)] = 1;
 
-                // Manually set the senderId to an incorrect value
-                var secondClientInstance = m_InvokeInstances[secondClient];
-                var bufferWriter = new FastBufferWriter(1024, Allocator.Temp);
-                using (bufferWriter)
+            // Manually set the senderId to an incorrect value
+            var secondClientInstance = m_InvokeInstances[secondClient];
+            var bufferWriter = new FastBufferWriter(1024, Allocator.Temp);
+            using (bufferWriter)
+            {
+                var rpcMessage = new RpcMessage
                 {
-                    var rpcMessage = new RpcMessage
+                    Metadata = new RpcMetadata
                     {
-                        Metadata = new RpcMetadata
-                        {
-                            NetworkObjectId = secondClientInstance.NetworkObjectId,
-                            NetworkBehaviourId = secondClientInstance.NetworkBehaviourId,
-                            NetworkRpcMethodId = GetMethodIdFromMethodName(nameof(InvokePermissionBehaviour.TrackSenderIdRpc)),
-                        },
-                        // Set the sender to the third client
-                        SenderClientId = thirdClient.LocalClientId,
-                        WriteBuffer = bufferWriter
-                    };
-
-                    // Send the message on the second client
-                    secondClientInstance.RpcTarget.Owner.Send(secondClientInstance, ref rpcMessage, NetworkDelivery.Reliable, new RpcParams());
-                }
+                        NetworkObjectId = secondClientInstance.NetworkObjectId,
+                        NetworkBehaviourId = secondClientInstance.NetworkBehaviourId,
+                        NetworkRpcMethodId = GetMethodIdFromMethodName(nameof(InvokePermissionBehaviour.TrackSenderIdRpc)),
+                    },
+                    // Set the sender to the third client
+                    SenderClientId = thirdClient.LocalClientId,
+                    WriteBuffer = bufferWriter
+                };
+
+                // Send the message on the second client
+                secondClientInstance.RpcTarget.Owner.Send(secondClientInstance, ref rpcMessage, NetworkDelivery.Reliable, new RpcParams());
+            }
 
-                yield return WaitForConditionOrTimeOut(AllExpectedCallsReceived);
-                AssertOnTimeout("[SpoofedSenderId] Incorrect Rpc calls received");
+            yield return WaitForConditionOrTimeOut(AllExpectedCallsReceived);
+            AssertOnTimeout("[SpoofedSenderId] Incorrect Rpc calls received");
 
-                Assert.That(firstClientInstance.SenderIdReceived, Is.EqualTo(secondClient.LocalClientId), "Received spoofed sender id!");
-            }
+            Assert.That(firstClientInstance.SenderIdReceived, Is.EqualTo(secondClient.LocalClientId), "Received spoofed sender id!");
         }
 
         private void SendUncheckedMessage(NetworkManager manager, InvokePermissionBehaviour invokePermissionsObject, string rpcMethodName)