Shegotwet/Assets/GUPS/AntiCheat/Source/Protected/Primitive/ProtectedUInt16.cs

// System
using System;

// Unity
using UnityEngine;

// GUPS - AntiCheat - Core
using GUPS.AntiCheat.Core.Protected;

// GUPS - AntiCheat
using GUPS.AntiCheat.Detector;
using GUPS.AntiCheat.Settings;

namespace GUPS.AntiCheat.Protected
{
    /// <summary>
    /// Represents a protected UInt16, designed to enhance integrity and security by obfuscating its value and incorporating anti-cheat measures.
    /// In most cases, this protected UInt16 can be used as a drop-in replacement for the default UInt16 type.
    /// </summary>
    [Serializable]
    public struct ProtectedUInt16 : IProtected, IDisposable, ISerializationCallbackReceiver
    {
        /// <summary>
        /// A struct does not have a default constructor that is called when the structure is created. Therefore, the protected primitive must return 
        /// a default value if it does not have an assigned value.
        /// </summary>
        private bool isInitialized;

        /// <summary>
        /// Gets a value indicating whether the protected value has integrity, i.e., whether it has maintained its original state.
        /// </summary>
        private bool hasIntegrity;

        /// <summary>
        /// Gets a value indicating whether the protected value has integrity, i.e., whether it has maintained its original state.
        /// </summary>
        public bool HasIntegrity { get => hasIntegrity || !isInitialized; private set => hasIntegrity = value; }

        /// <summary>
        /// The encrypted true value.
        /// </summary>
        private UInt16 obfuscatedValue;

        /// <summary>
        /// A secret key the true value gets encrypted with.
        /// </summary>
        private UInt16 secret;

        /// <summary>
        /// A honeypot pretending to be the original value. If some user tries to change this value via a cheat/hack engine, you will get notified.
        /// The protected value will keep its true value.
        /// </summary>
        [SerializeField]
        private UInt16 fakeValue;

        /// <summary>
        /// Unity serialization hook. Ensures the correct values will be serialized.
        /// </summary>
        public void OnBeforeSerialize()
        {
            this.fakeValue = Value;
        }

        /// <summary>
        /// Unity deserialization hook. Ensures the correct values will be deserialized.
        /// </summary>
        public void OnAfterDeserialize()
        {
            this = this.fakeValue;
        }

        /// <summary>
        /// Creates a new protected UInt16 with the specified initial value.
        /// </summary>
        /// <param name="_Value">The initial value of the protected UInt16.</param>
        public ProtectedUInt16(UInt16 _Value = 0)
        {
            // Initialization
            this.isInitialized = true;
            this.obfuscatedValue = 0;
            this.secret = (UInt16)GlobalSettings.RandomProvider.RandomInt32(1, UInt16.MaxValue);
            this.fakeValue = 0;
            this.hasIntegrity = true;

            // Obfuscate the value.
            this.Obfuscate(_Value);
        }

        /// <summary>
        /// Gets and sets the true unencrypted field value.
        /// </summary>
        public UInt16 Value
        {
            get
            {
                if (!this.isInitialized)
                {
                    return 0;
                }

                if (!this.CheckIntegrity())
                {
                    AntiCheatMonitor.Instance.GetDetector<PrimitiveCheatingDetector>()?.OnNext(this);
                }

                return this.UnObfuscate();
            }
            set { this.Obfuscate(value); }
        }

        /// <summary>
        /// Gets the true unencrypted field value.
        /// </summary>
        object IProtected.Value => this.Value;

        /// <summary>
        /// Obfuscates the specified value, encrypting it with the secret key.
        /// </summary>
        private void Obfuscate(UInt16 _Value)
        {
            // Obfuscate the value.
            this.obfuscatedValue = (UInt16)(_Value ^ this.secret);

            // Assign the fake value.
            this.fakeValue = _Value;
        }

        /// <summary>
        /// Unobfuscates the secured value and returns the true unencrypted value.
        /// </summary>
        /// <returns>The true unencrypted value.</returns>
        private UInt16 UnObfuscate()
        {
            // Get the unobfuscated value.
            return (UInt16)(this.obfuscatedValue ^ this.secret);
        }

        /// <summary>
        /// Obfuscates the current value, generating a new random secret key.
        /// </summary>
        public void Obfuscate()
        {
            // Unobfuscate the secured value.
            UInt16 var_UnobfuscatedValue = this.UnObfuscate();

            // Create a new random secret.
            this.secret = (UInt16)GlobalSettings.RandomProvider.RandomInt32(1, UInt16.MaxValue);

            // Obfuscate the value.
            this.Obfuscate(var_UnobfuscatedValue);
        }

        /// <summary>
        /// Checks the integrity of the protected value, detecting if an attacher changed the honeypot fake value.
        /// </summary>
        /// <returns>True if the protected value has integrity; otherwise, false.</returns>
        public bool CheckIntegrity()
        {
            // Unobfuscate the secured value.
            UInt16 var_UnobfuscatedValue = this.UnObfuscate();

            // Check if an attacher changed the honeypot fake value.
            if (this.fakeValue != var_UnobfuscatedValue)
            {
                this.HasIntegrity = false;
            }

            // Return the integrity status.
            return this.HasIntegrity;
        }

        /// <summary>
        /// Disposes of the secured and secret values.
        /// </summary>
        public void Dispose()
        {
            this.obfuscatedValue = 0;
            this.secret = 0;
        }

        /// <summary>
        /// Converts the protected UInt16 to its string representation.
        /// </summary>
        /// <returns>The string representation of the true value.</returns>
        public override string ToString()
        {
            return this.Value.ToString();
        }

        /// <summary>
        /// Gets the hash code of the protected UInt16's true value.
        /// </summary>
        /// <returns>The hash code of the true value.</returns>
        public override int GetHashCode()
        {
            return (int)this.Value;
        }

        #region Implicit operator

        /// <summary>
        /// Implicitly converts an UInt16 value to a protected UInt16.
        /// </summary>
        /// <param name="_Value">The UInt16 value to convert.</param>
        /// <returns>The corresponding protected UInt16.</returns>
        public static implicit operator ProtectedUInt16(UInt16 _Value)
        {
            return new ProtectedUInt16(_Value);
        }

        /// <summary>
        /// Implicitly converts a protected UInt16 to its UInt16 value.
        /// </summary>
        /// <param name="_Value">The protected UInt16 to convert.</param>
        /// <returns>The UInt16 value of the protected UInt16.</returns>
        public static implicit operator UInt16(ProtectedUInt16 _Value)
        {
            return _Value.Value;
        }

        #endregion

        #region Calculation operator

        /// <summary>
        /// Adds two protected UInt16 values.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>The result of the addition.</returns>
        public static ProtectedUInt16 operator +(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return new ProtectedUInt16((UInt16)(v1.Value + v2.Value));
        }

        /// <summary>
        /// Subtracts the second protected UInt16 from the first.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>The result of the subtraction.</returns>
        public static ProtectedUInt16 operator -(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return new ProtectedUInt16((UInt16)(v1.Value - v2.Value));
        }

        /// <summary>
        /// Multiplies two protected UInt16 values.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>The result of the multiplication.</returns>
        public static ProtectedUInt16 operator *(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return new ProtectedUInt16((UInt16)(v1.Value * v2.Value));
        }

        /// <summary>
        /// Divides the first protected UInt16 by the second.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>The result of the division.</returns>
        public static ProtectedUInt16 operator /(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return new ProtectedUInt16((UInt16)(v1.Value / v2.Value));
        }

        #endregion

        #region Equality operator

        /// <summary>
        /// Checks if two protected UInt16 values are equal based on their true values.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>True if the true values are equal; otherwise, false.</returns>
        public static bool operator ==(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return v1.Value == v2.Value;
        }

        /// <summary>
        /// Checks if two protected UInt16 values are not equal based on their true values.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>True if the true values are not equal; otherwise, false.</returns>
        public static bool operator !=(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return v1.Value != v2.Value;
        }

        /// <summary>
        /// Checks if the protected UInt16 is equal to another object based on their true values.
        /// </summary>
        /// <param name="obj">The object to compare with the protected UInt16.</param>
        /// <returns>True if the true values are equal; otherwise, false.</returns>
        public override bool Equals(object obj)
        {
            if (obj is ProtectedUInt16)
            {
                return this.Value == ((ProtectedUInt16)obj).Value;
            }
            return this.Value.Equals(obj);
        }

        /// <summary>
        /// Compares two protected UInt16 values.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>True if the first value is less than the second; otherwise, false.</returns>
        public static bool operator <(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return v1.Value < v2.Value;
        }

        /// <summary>
        /// Checks if the first protected UInt16 is less than or equal to the second.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>True if the first value is less than or equal to the second; otherwise, false.</returns>
        public static bool operator <=(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return v1.Value <= v2.Value;
        }

        /// <summary>
        /// Checks if the first protected UInt16 is greater than the second.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>True if the first value is greater than the second; otherwise, false.</returns>
        public static bool operator >(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return v1.Value > v2.Value;
        }

        /// <summary>
        /// Checks if the first protected UInt16 is greater than or equal to the second.
        /// </summary>
        /// <param name="v1">The first protected UInt16.</param>
        /// <param name="v2">The second protected UInt16.</param>
        /// <returns>True if the first value is greater than or equal to the second; otherwise, false.</returns>
        public static bool operator >=(ProtectedUInt16 v1, ProtectedUInt16 v2)
        {
            return v1.Value >= v2.Value;
        }

        #endregion
    }
}