1. Manuals
  2. Tumbleweed
  3. perl-Mojolicious
  4. Mojo::IOLoop::TLS(3pm)

Scroll to navigation

Mojo::IOLoop::TLS(3) User Contributed Perl Documentation Mojo::IOLoop::TLS(3)

NAME

Mojo::IOLoop::TLS - Non-blocking TLS handshake

SYNOPSIS

  use Mojo::IOLoop::TLS;
  # Negotiate TLS
  my $tls = Mojo::IOLoop::TLS->new($old_handle);
  $tls->on(upgrade => sub ($tls, $new_handle) {...});
  $tls->on(error => sub ($tls, $err) {...});
  $tls->negotiate(server => 1, tls_version => 'TLSv1_2');
  # Start reactor if necessary
  $tls->reactor->start unless $tls->reactor->is_running;

DESCRIPTION

Mojo::IOLoop::TLS negotiates TLS for Mojo::IOLoop.

EVENTS

Mojo::IOLoop::TLS inherits all events from Mojo::EventEmitter and can emit the following new ones.

upgrade

  $tls->on(upgrade => sub ($tls, $handle) {...});

Emitted once TLS has been negotiated.

error

  $tls->on(error => sub ($tls, $err) {...});

Emitted if an error occurs during negotiation, fatal if unhandled.

ATTRIBUTES

Mojo::IOLoop::TLS implements the following attributes.

reactor

  my $reactor = $tls->reactor;
  $tls        = $tls->reactor(Mojo::Reactor::Poll->new);

Low-level event reactor, defaults to the "reactor" attribute value of the global Mojo::IOLoop singleton. Note that this attribute is weakened.

METHODS

Mojo::IOLoop::TLS inherits all methods from Mojo::EventEmitter and implements the following new ones.

can_tls

  my $bool = Mojo::IOLoop::TLS->can_tls;

True if IO::Socket::SSL 2.009+ is installed and TLS support enabled.

negotiate

  $tls->negotiate(server => 1, tls_version => 'TLSv1_2');
  $tls->negotiate({server => 1, tls_version => 'TLSv1_2'});

Negotiate TLS.

These options are currently available:

  server => 1

Negotiate TLS from the server-side, defaults to the client-side.

  tls_ca => '/etc/tls/ca.crt'

Path to TLS certificate authority file.

  tls_cert => '/etc/tls/server.crt'
  tls_cert => {'mojolicious.org' => '/etc/tls/mojo.crt'}

Path to the TLS cert file, defaults to a built-in test certificate on the server-side.

  tls_key => '/etc/tls/server.key'
  tls_key => {'mojolicious.org' => '/etc/tls/mojo.key'}

Path to the TLS key file, defaults to a built-in test key on the server-side.

  tls_options => {SSL_alpn_protocols => ['foo', 'bar'], SSL_verify_mode => 0x00, SSL_version => 'TLSv1_2'}

Additional options for IO::Socket::SSL.

new

  my $tls = Mojo::IOLoop::TLS->new($handle);

Construct a new Mojo::IOLoop::Stream object.

SEE ALSO

Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.

2024-03-22 perl v5.38.2