esiur-dotnet/Esiur/Net/Packets/WebSocket/WebsocketPacket.cs

/*
 
Copyright (c) 2017 Ahmed Kh. Zamil

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

*/

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Esiur.Misc;
using Esiur.Data;

namespace Esiur.Net.Packets.WebSocket;
public class WebsocketPacket : Packet
{
    public enum WSOpcode : byte
    {
        ContinuationFrame = 0x0, //  %x0 denotes a continuation frame

        TextFrame = 0x1, // %x1 denotes a text frame

        BinaryFrame = 0x2,            // %x2 denotes a binary frame

        // %x3-7 are reserved for further non-control frames

        ConnectionClose = 0x8,    // %x8 denotes a connection close

        Ping = 0x9, // %x9 denotes a ping

        Pong = 0xA,            // %xA denotes a pong

        //*  %xB-F are reserved for further control frames
    }


    public bool FIN;
    public bool RSV1;
    public bool RSV2;
    public bool RSV3;
    public WSOpcode Opcode;
    public bool Mask;
    public long PayloadLength;
    //        public UInt32 MaskKey;
    public byte[] MaskKey;

    public byte[] Message;

    public override string ToString()
    {
        return "WebsocketPacket"
            + "\n\tFIN: " + FIN
            + "\n\tOpcode: " + Opcode
            + "\n\tPayload: " + PayloadLength
            + "\n\tMaskKey: " + MaskKey
            + "\n\tMessage: " + (Message != null ? Message.Length.ToString() : "NULL");
    }

    public override bool Compose()
    {
        var pkt = new List<byte>();
        pkt.Add((byte)((FIN ? 0x80 : 0x0) |
            (RSV1 ? 0x40 : 0x0) |
            (RSV2 ? 0x20 : 0x0) |
            (RSV3 ? 0x10 : 0x0) |
            (byte)Opcode));

        // calculate length
        if (Message.Length > ushort.MaxValue)
        // 4 bytes
        {
            pkt.Add((byte)((Mask ? 0x80 : 0x0) | 127));
            pkt.AddRange(((ulong)Message.LongCount()).ToBytes(Endian.Big));
        }
        else if (Message.Length > 125)
        // 2 bytes
        {
            pkt.Add((byte)((Mask ? 0x80 : 0x0) | 126));
            pkt.AddRange(((ushort)Message.Length).ToBytes(Endian.Big));
        }
        else
        {
            pkt.Add((byte)((Mask ? 0x80 : 0x0) | Message.Length));
        }

        if (Mask)
        {
            pkt.AddRange(MaskKey);
        }

        pkt.AddRange(Message);

        Data = pkt.ToArray();

        return true;
    }

    public override long Parse(byte[] data, uint offset, uint ends)
    {
        try
        {
            long needed = 2;
            var length = ends - offset;
            if (length < needed)
            {
                //Console.WriteLine("stage 1 " + needed);
                return length - needed;
            }

            uint oOffset = offset;
            FIN = (data[offset] & 0x80) == 0x80;
            RSV1 = (data[offset] & 0x40) == 0x40;
            RSV2 = (data[offset] & 0x20) == 0x20;
            RSV3 = (data[offset] & 0x10) == 0x10;
            Opcode = (WSOpcode)(data[offset++] & 0xF);
            Mask = (data[offset] & 0x80) == 0x80;
            PayloadLength = data[offset++] & 0x7F;

            if (Mask)
                needed += 4;

            if (PayloadLength == 126)
            {
                needed += 2;
                if (length < needed)
                {
                    //Console.WriteLine("stage 2 " + needed);
                    return length - needed;
                }
                PayloadLength = data.GetUInt16(offset, Endian.Big);
                offset += 2;
            }
            else if (PayloadLength == 127)
            {
                needed += 8;
                if (length < needed)
                {
                    //Console.WriteLine("stage 3 " + needed);
                    return length - needed;
                }

                PayloadLength = data.GetInt64(offset, Endian.Big);
                offset += 8;
            }

            /*
            if (Mask)
            {
                                MaskKey = new byte[4];
                MaskKey[0] = data[offset++];
                MaskKey[1] = data[offset++];
                MaskKey[2] = data[offset++];
                MaskKey[3] = data[offset++];

                //MaskKey = DC.GetUInt32(data, offset);
                //offset += 4;
            }
            */

            needed += PayloadLength;
            if (length < needed)
            {
                //Console.WriteLine("stage 4");
                return length - needed;
            }
            else
            {

                if (Mask)
                {
                    MaskKey = new byte[4];
                    MaskKey[0] = data[offset++];
                    MaskKey[1] = data[offset++];
                    MaskKey[2] = data[offset++];
                    MaskKey[3] = data[offset++];

                    Message = data.Clip(offset, (uint)PayloadLength);

                    //var aMask = BitConverter.GetBytes(MaskKey);
                    for (int i = 0; i < Message.Length; i++)
                        Message[i] = (byte)(Message[i] ^ MaskKey[i % 4]);
                }
                else
                    Message = data.Clip(offset, (uint)PayloadLength);


                return offset - oOffset + (int)PayloadLength;
            }
        }
        catch (Exception ex)
        {
            Global.Log(ex);
            Global.Log("WebsocketPacket", Core.LogType.Debug, offset + "::" + data.ToHex());
            throw ex;
        }
    }
}