Public Member Functions
	Request (byte[] data, Socket socket, Configuration config, bool isTLS=false)

Session	GetSession ()
	Return the session associated with the request.

Tuple< string, string >?	GetBasicAuthInformation ()

OAuth1_0Information?	GetOAuth1_0Information ()

bool	IsJSON ()
	Test if a request contains a JSON document in the body.

bool	IsWebSocket ()
	Returns true if the request is a websocket request.

bool	IsFileUpload ()
	Returns true if the request is a file upload.

bool	IsFormUpload ()
	Returns true if the request is a form upload.

MultiPartFormData?	GetMultiPartFormData ()
	Returns the form data if the request is a multipart formdata upload, else null.

Form?	GetFormData ()
	Returns the form data if the request is a form upload, else null.

Socket	GetSocket ()

void	DumpRequest (string path="./request.txt")

void	DumpBody (string path="./body.txt")

void	FullPrint ()

override string	ToString ()

Public Attributes
bool	validRequest = false

readonly bool	IsTLS = false

bool	IsValidRequest = true

Properties
HTTP_METHOD	METHOD `[get]`
	Return the method of the request.

HTTP_PROTOCOL	PROTOCOL `[get]`
	Return the protocol of the request.

string	URL `[get]`
	Return the url of the request.

string	ClientIP `[get]`
	Return the ip of the client (request source ip)

int	ClientPort `[get]`
	Return the port of the client (request source port)

AddressFamily	ClientIPVersion `[get]`
	Return the ip version of the client (request source ip version (v4 or v6))

byte[]	RawBody `[get]`
	Return the raw body of the request.

string	Body `[get]`
	Return the body of the request parsed as string.

Dictionary< string, string >	Headers `[get]`
	Return the headers.

List< string >	RawHeaders `[get]`
	Return the unparsed headers.

Dictionary< string, string >	Parameters `[get]`
	Return the parameters.

bool	IsAjaxRequest `[get]`
	Returns if the request is an ajax request.

string	GetRawRequestText `[get]`

Detailed Description

Definition at line 10 of file Request.cs.

Constructor & Destructor Documentation

◆ Request()

HSB.Request.Request	(	byte[]	data,
		Socket	socket,
		Configuration	config,
		bool	isTLS = `false`
	)

Definition at line 45 of file Request.cs.

    {
        connectionSocket = socket;
        rawData = data;
        rawBody = [];
        this.config = config;
        requestContent = [];
        IsTLS = isTLS;
 
        if (data == null || data.Length == 0)
        {
            return;
        }
        var rEP = socket.RemoteEndPoint;
        //extract ipv4 or ipv6 from the remote endpoint
        if (rEP != null)
        {
            var rIEP = (IPEndPoint)rEP;
            clientIP = rIEP.Address.ToString();
            clientPort = rIEP.Port;
            clientIPVersion = rIEP.AddressFamily;
        }
 
        switch (Utils.GetEncoding(data))
        {
            case UTF8Encoding:
                reqText = Encoding.UTF8.GetString(data);
                break;
            case UTF32Encoding:
                reqText = Encoding.UTF32.GetString(data);
                break;
            case ASCIIEncoding:
                reqText = Encoding.ASCII.GetString(data);
                break;
        }
 
        if (reqText.Replace("\0", "") == "")
        {
            //note:
            //it can happen in programs like postman that a request to localhost produces two requests
            //one for IPv6 and one for IPv4
            //i don't know why but the second request is invalid
            validRequest = false;
            config.Debug.INFO("Got an invalid request, ignoring...");
            requestContent.Add(" ");
            return;
        }
        // reqText = Encoding.UTF8.GetString(data);
        requestContent = [.. reqText.Split("\r\n")];
        ParseRequest();
 
 
    }

Member Function Documentation

◆ DumpBody()

void HSB.Request.DumpBody ( string path = "./body.txt" )

Definition at line 354 of file Request.cs.

    {
        File.WriteAllText(path, body);
    }

◆ DumpRequest()

void HSB.Request.DumpRequest ( string path = "./request.txt" )

Definition at line 350 of file Request.cs.

    {
        File.WriteAllBytes(path, rawData);
    }

◆ FullPrint()

void HSB.Request.FullPrint ( )

Definition at line 362 of file Request.cs.

    {
        Terminal.DEBUG("PRINTING RAW REQUEST\n====================");
        Terminal.INFO(reqText);
        Terminal.DEBUG("\n====================");
        Terminal.INFO($"Has basic auth? {basicAuth != null}");
        if (basicAuth != null)
            Terminal.INFO(basicAuth);
        Terminal.INFO($"Has oauth1.0? {oAuth1_0Information != null}");
        if (oAuth1_0Information != null)
            Terminal.INFO(oAuth1_0Information);
 
        Terminal.INFO($"Has oAuth2.0? {oAuth2_0Token != ""} {oAuth2_0Token}");
 
    }

◆ GetFormData()

Form? HSB.Request.GetFormData ( )

Returns the form data if the request is a form upload, else null.

Returns

◆ GetMultiPartFormData()

MultiPartFormData? HSB.Request.GetMultiPartFormData ( )

Returns the form data if the request is a multipart formdata upload, else null.

Returns

◆ GetSession()

Session HSB.Request.GetSession ( )

Return the session associated with the request.

Returns

◆ IsFileUpload()

bool HSB.Request.IsFileUpload ( )

Returns true if the request is a file upload.

Returns

◆ IsFormUpload()

bool HSB.Request.IsFormUpload ( )

Returns true if the request is a form upload.

Returns

◆ IsJSON()

bool HSB.Request.IsJSON ( )

Test if a request contains a JSON document in the body.

Returns

◆ IsWebSocket()

bool HSB.Request.IsWebSocket ( )

Returns true if the request is a websocket request.

Returns

Definition at line 318 of file Request.cs.

    {
        return
        headers.ContainsKey("Connection") && headers["Connection"].Equals("upgrade", StringComparison.CurrentCultureIgnoreCase) &&
        headers.ContainsKey("Upgrade") && headers["Upgrade"].Equals("websocket", StringComparison.CurrentCultureIgnoreCase);
    }

◆ ToString()

override string HSB.Request.ToString ( )

Definition at line 385 of file Request.cs.

    {
        string str = _method.ToString() + " - " + _url + " - " + _protocol.ToString();
        return str;
    }

Member Data Documentation

◆ IsTLS

readonly bool HSB.Request.IsTLS = false

Definition at line 34 of file Request.cs.

◆ IsValidRequest

bool HSB.Request.IsValidRequest = true

Definition at line 44 of file Request.cs.

◆ validRequest

bool HSB.Request.validRequest = false

Definition at line 22 of file Request.cs.

Property Documentation

◆ Body

string HSB.Request.Body

get

Return the body of the request parsed as string.

Definition at line 283 of file Request.cs.

◆ ClientIP

string HSB.Request.ClientIP

get

Return the ip of the client (request source ip)

Definition at line 267 of file Request.cs.

◆ ClientIPVersion

AddressFamily HSB.Request.ClientIPVersion

get

Return the ip version of the client (request source ip version (v4 or v6))

Definition at line 275 of file Request.cs.

◆ ClientPort

int HSB.Request.ClientPort

get

Return the port of the client (request source port)

Definition at line 271 of file Request.cs.

◆ GetRawRequestText

string HSB.Request.GetRawRequestText

get

Definition at line 349 of file Request.cs.

◆ Headers

Dictionary<string, string> HSB.Request.Headers

get

Return the headers.

Definition at line 287 of file Request.cs.

◆ IsAjaxRequest

bool HSB.Request.IsAjaxRequest

get

Returns if the request is an ajax request.

Definition at line 313 of file Request.cs.

◆ METHOD

HTTP_METHOD HSB.Request.METHOD

get

Return the method of the request.

Definition at line 255 of file Request.cs.

◆ Parameters

Dictionary<string, string> HSB.Request.Parameters

get

Return the parameters.

Definition at line 295 of file Request.cs.

◆ PROTOCOL

HTTP_PROTOCOL HSB.Request.PROTOCOL

get

Return the protocol of the request.

Definition at line 259 of file Request.cs.

◆ RawBody

byte [] HSB.Request.RawBody

get

Return the raw body of the request.

Definition at line 279 of file Request.cs.

◆ RawHeaders

List<string> HSB.Request.RawHeaders

get

Return the unparsed headers.

Definition at line 291 of file Request.cs.

◆ URL

string HSB.Request.URL

get

Return the url of the request.

Definition at line 263 of file Request.cs.

The documentation for this class was generated from the following file:

HSB/Components/Request.cs

Public Member Functions

Public Attributes

Properties