NAME
    Mojolicious::Plugin::Ident - Mojolicious plugin to interact with a
    remote ident service

VERSION
    version 0.21

SYNOPSIS
     use Mojolicious::Lite;
     plugin 'ident';
 
     # get the username of the remote using ident protocol
     get '/' => sub {
       my $self = shift;
       $self->render_text("hello " . $self->ident->username);
     };
 
     # only allow access to the user on localhost which 
     # started the mojolicious lite app
     under sub { shift->ident_same_user };
 
     get '/private' => sub {
       shift->render_text("secret place");
     };

DESCRIPTION
    This plugin provides an interface for querying an ident service on a
    remote system. The ident protocol helps identify the user of a
    particular TCP connection. If the remote client connecting to your
    Mojolicious application is running the ident service you can identify
    the remote users' name. This can be useful for determining the source of
    abusive or malicious behavior. Although ident can be used to
    authenticate users, it is not recommended for untrusted networks and
    systems (see CAVEATS below).

    Under the covers this plugin uses Net::Ident.

OPTIONS
  timeout
     plugin 'ident' => { timeout => 60 };

    Default number of seconds to wait before timing out when contacting the
    remote ident server. The default is 2.

HELPERS
  ident [ $tx, [ $timeout ] ]
     get '/' => sub {
       my $self = shift;
       my $ident = $self->ident;
       $self->render_text(
         "username: " . $ident->username .
         "os:       " . $ident->os
       );
     };

    Returns an instance of Mojolicious::Plugin::Ident::Response, which
    provides two fields, username and os for the remote connection. This
    helper optionally takes two arguments, a transaction ($tx) and a timeout
    ($timeout). If not specified, the current transaction and the configured
    default timeout will be used.

    The ident helper will throw an exception if

    *   it cannot connect to the remote's ident server

    *   the connection to the remote's ident server times out

    *   the remote ident server returns an error

     under sub { eval { shift->ident->same_user } };
     get '/private' => 'private_route';

    The ident response class also has a same_user method which can be used
    to determine if the user which started the Mojolicious application and
    the remote user are the same. The user is considered the same if the
    remote connection came over the loopback address (127.0.0.1) and the
    username matches either the server's username or real UID. Although this
    can be used as a simple authentication method, keep in mind that it may
    not be secure (see CAVEATS below).

  ident_same_user [ $tx, [ $timeout ] ]
     under sub { shift->ident_same_user };
     get '/private' => 'private_route';

    This helper returns true if the remote user is the same as the user
    which started the Mojolicious application. This uses the same_user
    method on the ident response class described above. If it is able to
    connect to the ident service on the remote system it will cache the
    result so that the remote ident service does not have to be contacted on
    every HTTP request. If the user does not match, or if it is unable to
    contact the remote ident service, or if the connection times out it will
    return false. Unlike the ident helper, this one will not throw an
    exception. This helper optionally takes two arguments, a transaction
    ($tx) and a timeout ($timeout). If not specified, the current
    transaction and the configured default timeout will be used.

CAVEATS
    In Windows and possibly other operating systems, an unprivileged user
    can listen to port 113 and on any untrusted network, a remote ident
    server is not a secure authentication mechanism. Most modern operating
    systems do not enable the ident service by default, so unless you have
    control both the client and the server and can configure the ident
    service securely on both, its usefulness is reduced.

AUTHOR
    Graham Ollis <plicease@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2012 by Graham Ollis.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.

