Net::SSL(3)

🎀 NAME 🎀

Hey bestie!! 💖 Welcome to Net::SSL(3) — the manual page for Net::SSL, brought to you by the User Contributed Perl Documentation zone. It's giving support for Secure Sockets Layer, and that's the whole name vibe. ✨

✨ METHODS ✨

Okay so here's the full method roster — every single one, no skipping, no cap. 🫶

• new — creates a new Net::SSL object.
• configure — configures a Net::SSL socket for operation.
• configure_certs — sets up a certificate file to use for communicating with on the socket.
• connect — no extra description here; it's just listed, bestie.
• die_with_error — no extra description here; just the name.
• get_cipher — no extra description here; just the name.
• get_lwp_object — walks up the caller stack and looks for something blessed into the LWP::UserAgent namespace and returns it. Vaguely deprecated. 👀
• get_peer_certificate — gets the peer certificate from the underlying Crypt::SSLeay::Conn object.
• get_peer_verify — no extra description here; just the name.
• get_shared_ciphers — no extra description here; just the name.
• getchunk — attempts to read up to 32KiB of data from the socket. Returns undef if nothing was read, otherwise returns the data as a scalar. 📦
• pending — provides access to OpenSSL's pending attribute on the SSL connection object.
• getline — reads one character at a time until a newline is encountered, and returns the line, including the newline. Grossly inefficient. 😭
• print — concatenates the input parameters and writes them to the socket. Does not honour $, nor $/. Returns the number of bytes written.
• printf — performs a sprintf of the input parameters (thus, the first parameter must be the format), and writes the result to the socket. Returns the number of bytes written.
• proxy — returns the hostname of an https proxy server, as specified by the HTTPS_PROXY environment variable.
• proxy_connect_helper — helps set up a connection through a proxy.
• read — performs a read on the socket and returns the result.
• ssl_context — no extra description here; just the name.
• sysread — is an alias of read.
• timeout — returns the timeout value of the socket as defined by the implementing class or 60 seconds by default. ⏰
• blocking — returns a boolean indicating whether the underlying socket is in blocking mode. By default, Net::SSL sockets are in blocking mode.

Set it like this:

$sock->blocking(0); # set to non-blocking mode

This method simply calls the underlying blocking method of the IO::Socket object. 💅

• write — writes the parameters passed in (thus, a list) to the socket. Returns the number of bytes written.
• syswrite — is an alias of write.
• accept — Not yet implemented. Will die if called. 💀
• getc — Not yet implemented. Will die if called. 💀
• getlines — Not yet implemented. Will die if called. 💀
• ungetc — Not yet implemented. Will die if called. 💀
• send_useragent_to_proxy — by default (as of version 2.80 of Net::SSL in the 0.54 distribution of Crypt::SSLeay), the user agent string is no longer sent to the proxy (but will continue to be sent to the remote host). The previous behaviour was of marginal benefit, and could cause fatal errors in certain scenarios (see CPAN bug #4759) and so no longer happens by default. To reinstate the old behaviour, call Net::SSL::send_useragent_to_proxy with a true value (usually 1). 🕵️

💅 DIAGNOSTICS 💅

Here are the diagnostic messages, bestie, so you know what's up when things get dramatic. 😭

• "no port given for proxy server <proxy>" — a proxy was specified for configuring a socket, but no port number was given. Ensure that the proxy is specified as a host:port pair, such as proxy.example.com:8086.
• "configure certs failed: <contents of $@>; <contents of $!>"
• "proxy connect failed: <contents of $@>; <contents of $!>"
• "Connect failed: <contents of $@>; <contents of $!>"

During connect(). 🫠

🌈 SEE ALSO 🌈

• IO::Socket::INET — Net::SSL is implemented by subclassing IO::Socket::INET, hence methods not specifically overridden are defined by that package. 👑
• Net::SSLeay — a package that provides a Perl-level interface to the openssl secure sockets layer library. 🌸

---

That's the whole manual, bestie! 💖 This iconic page comes from perl v5.42.0, dated 2024-03-04, and it's Net::SSL(3) — catch you in the group chat! 🦋✨