.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTTP::Server::Simple::Authen 3pm"
.TH HTTP::Server::Simple::Authen 3pm "2022-12-12" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTTP::Server::Simple::Authen \- Authentication plugin for HTTP::Server::Simple
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package MyServer;
\&  use base qw( HTTP::Server::Simple::Authen HTTP::Server::Simple::CGI);
\&
\&  use Authen::Simple::Passwd;
\&  sub authen_handler {
\&      Authen::Simple::Passwd\->new(passwd => \*(Aq/etc/passwd\*(Aq);
\&  }
\&
\&  sub handle_request {
\&      my($self, $cgi) = @_;
\&      my $user = $self\->authenticate or return;
\&      ...
\&  }
\&
\&  MyServer\->new\->run();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
HTTP::Server::Simple::Authen is an HTTP::Server::Simple plugin to
allow \s-1HTTP\s0 authentication. Authentication scheme is pluggable and you
can use whatever Authentication protocol that Authen::Simple supports.
.PP
You can use \f(CW\*(C`authenticate\*(C'\fR method whatever you want to authenticate
the request. The method returns \f(CW$username\fR taken from the request if
the authentication is successful, and \f(CW\*(C`undef\*(C'\fR otherwise. The code in
\&\*(L"\s-1SYNOPSIS\*(R"\s0 requires authentication for all the requests and behaves
just the same as Apache's \f(CW\*(C`Require valid\-user\*(C'\fR.
.PP
The following code will explain more about conditioning.
.PP
.Vb 8
\&  sub handle_request {
\&      my($self, $cgi) = @_;
\&      if ($cgi\->path_info =~ m!/foo/!) {
\&          my $user = $self\->authenticate;
\&          return unless defined($user) && length($user) == 8;
\&      }
\&      ...
\&  }
.Ve
.PP
This means all the requests to \s-1URL\s0 \f(CW\*(C`/foo/\*(C'\fR require to be
authenticated, and usernames with 8 chars long are authorized.
.SH "METHODS"
.IX Header "METHODS"
Your subclass has to override following methods to implement \s-1HTTP\s0
authentication.
.IP "authen_handler" 4
.IX Item "authen_handler"
Should return a valid Authen::Simple instance to authenticate \s-1HTTP\s0
request (Required).
.IP "authen_realm" 4
.IX Item "authen_realm"
Returns a string for Authentication realm to be shown in the browser's
dialog box. Defaults to 'Authorized area'.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tatsuhiko Miyagawa <miyagawa@bulknews.net>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTTP::Server::Simple, Authen::Simple