modulepackage
0.0.8-beta
Repository: https://github.com/qsocket/qsocket-go.git
Documentation: pkg.go.dev
# README
QSocket Go
Go library for qsocket...
Documentation
[!WARNING]
This library is in its early alpha development stage, featuring experimental functionality that may lack backwards compatibility, and users are advised to exercise caution and not use it in production environments.
Example
Usage is really simple, qsocket.New()
function simply creates a new quantum socket with given secret, it includes all the functions of standard net
sockets and also implements io Read/Write
. After creating a socket you need to dial the QSRN network by calling Dial*
functions. Simple example below...
// Create a new QSocket client...
qsock := qsocket.New(qsocket.Client, "my-secret");
// Create a new QSocket server...
qsock := qsocket.New(qsocket.Server, "my-secret");
qsock.Dial(true) // Dial using TLS...
// OR
qsock.Dial(false) // Dial using TCP...
// Dial using a socks5 proxy over TLS
qsock.SetProxy("127.0.0.1:9050")
qsock.Dial(true)
After dialing the QSRN, socket is ready for read/write operations. Check here and qs-netcat for more usage examples.
# Functions
BindSockets is used for creating a full duplex channel between `con1` and `con2` sockets, effectively binding two sockets.
CalcChecksum calculates the modulus based checksum of the given data, modulus base is given in the base variable.
chanFromConn creates a channel from a Conn object, and sends everything it
Read()s from the socket to the channel.
No description provided by the author
No description provided by the author
NewSocket creates a new QSocket structure with the given secret.
No description provided by the author
# Constants
CHECKSUM_BASE is the constant base value for calculating knock sequence URI checksums.
Tag ID for representing client mode connections.
Some global constants for These values can be changed for obfuscating the knock protocol.
QSRN_GATE is the static gate address for the QSocket network.
QSRN_GATE_PORT Default TCP port for the QSocket gate.
QSRN_GATE_TLS_PORT Default TLS port for the QSocket gate.
QSRN_TOR_GATE is the static ONION address for the QSocket network.
00000000 => Server.
No description provided by the author
Some global constants for These values can be changed for obfuscating the knock protocol.
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
.
No description provided by the author
No description provided by the author
# Structs
A QSocket structure contains required values for performing a knock sequence with the QSRN gate.
# Type aliases
No description provided by the author