Munin::Common::TLS(3)

💖 NAME 💖

okay bestie, the manual name up top is Munin::Common::TLS(3) — User Contributed Perl Documentation energy ✨ — but the NAME line itself says Munin::Node::TLS: the abstract base class implementing the STARTTLS protocol. Yes, those are both literally in there, and yes, we're keeping both. 💅

---

✨ SYNOPSIS ✨

Do not call this directly, bestie — no cap. Go look at the synopsis for Munin::Common::TLSServer and Munin::Common::TLSClient instead. 🫶

---

🎀 METHODS 🎀

🌸 new 🌸

my $tls = Munin::Common::TLSFoo->new({ # Substitute Foo with Client or Server
    # Mandatory attributes:
    logger      => \&a_logger_func,
    read_fd     => fileno($socket),
    read_func   => \&a_socket_read_func,
    write_fd    => fileno($socket),
    write_func  => \&a_socket_read_func,

    # Optional attributes                          DEFAULTS
    DEBUG              => 0,                       # 0
    tls_ca_cert        => "path/to/ca/cert.pem",   # ''
    tls_cert           => "path/to/cert.pem",      # ''
    tls_paranoia       => 1,                       # 0
    tls_priv           => "path/to/priv_key.pem",  # ''
    tls_vdepth         => 5,                       # 0
    tls_verify         => 1,                       # 0
});

This is the constructor, and it should not be called directly. What it does document is the attributes that are in common for Munin::Common::TLSServer and Munin::Common::TLSClient. The mandatory ones are logger, read_fd, read_func, write_fd, and write_func; the optional ones and their defaults are right there in the code block, iykyk. 👑

---

🦋 read 🦋

my $msg = $tls->read();

Encrypted read. That's it. That's the whole vibe. 🔥

---

🌈 write 🌈

$tls->write($msg);

Encrypted write. Slay. 💜

---

⭐ session_started ⭐

my $bool = $tls->session_started();

Returns true if the TLS object is ready to read/write encrypted data. Basically the vibe check for "are we encrypted and ready or not." 🎀

---

mwah 💋 this page is literally perl v5.42.3, dated 1980-01-01, and the footer manual name is Munin::Common::TLS(3) — bye bestie 🫶✨