dnsjit.output.tlscli(3)

πŸ“¦
version 1.5.1 Β· 5 versions
, in epel 10, epel 9, fedora 43, fedora 44, ubuntu resolute, ubuntu stonking

πŸ’… dnsjit.output.tlscli β€” the manual page, but make it cute

okay bestie, welcome to dnsjit.output.tlscli(3) from the dnsjit library, section 3 of the manual. it's literally a Simple TLS client and i'm obsessed. let's get into it πŸŽ€


✨ NAME ✨

dnsjit.output.tlscli β€” a Simple TLS client, no cap πŸ’–


🌸 SYNOPSIS 🌸

local output = require("dnsjit.output.tlscli").new("127.0.0.1", "853")

look at her. two strings in, an output object out. iconic behavior. πŸ‘‘


πŸ¦‹ DESCRIPTION πŸ¦‹

so basically: it's a Simple TLS client that attempts to do a TLS handshake β€” and bestie, listen β€” without certificate verification. i'm just the messenger, that's what the page says. πŸ™ˆ

it behaves the same way as tcpcli, except all the data is sent over the encrypted channel. same energy, but make it secure-ish. πŸ”₯

⭐ Attributes

  • timeout β€” a core.timespec that gets used when producing objects. that's it, that's the whole attribute. she's simple, she's effective. πŸ’…

πŸ’œ Functions

  • Tlscli.new() β€” create a new Tlscli output. fresh out the box, brand new, main character energy. ✨
  • Tlscli:timeout(seconds, nanoseconds) β€” set the timeout for when objects are being produced. give her seconds and nanoseconds, she'll handle the rest. ⏰
  • Tlscli:connect(host, port) β€” connect to the host and port, perform a TLS handshake, and return 0 if it worked. that 0 is the little "slay, we're in" signal. 🫢
  • Tlscli:receive() β€” return the C functions and context for receiving objects. and these objects? they get sent. πŸ“€
  • Tlscli:produce() β€” return the C functions and context for producing objects. these objects are received. the producer will wait for data, and if it times out (see timeout, bestie, she's back) it will return a payload object with length zero.
and now the important part: if a timeout happens during the first stage β€” getting the length β€” it will fail and return nil. 😭 additional calls will continue retrieving the payload. and the producer returns nil on error too. so if you see nil, something said no. fr fr.
  • Tlscli:packets() β€” return the number of "packets" sent. and yes, the quotes around "packets" are doing a lot of work here, because it's actually the number of completely sent payloads. πŸŽ€
  • Tlscli:received() β€” return the number of "packets" received, which is actually the number of completely received DNS messages. see what i mean? quotes carrying the whole team. 😌
  • Tlscli:errors() β€” return the number of errors when sending. hopefully 0, but she's keeping count either way. πŸ’€

πŸ‘‘ AUTHORS and CONTRIBUTORS πŸ‘‘

the legends behind this:

  • Jerry LundstrΓΆm (DNS-OARC)
  • TomΓ‘Ε‘ KΕ™Γ­ΕΎek (CZ.NIC)
  • Petr Ε paček (ISC)

Maintained by DNS-OARC

https://www.dns-oarc.net/

the way they maintain it… periodt. 🌈


πŸ“ BUGS πŸ“

found a bug? need a feature? bestie, please use:

https://codeberg.org/DNS-OARC/dnsjit/issues

got a question, or just need a hand? use:

admin@dns-oarc.net

they're nice, i promise. go say hi. πŸ’–


okay that's the whole page, no skips, no shortcuts, every flag and every function accounted for. 🧚

this was dnsjit version 1.5.1, and the page you just read is dnsjit.output.tlscli(3). mwah, take care of her πŸ’…βœ¨