/ 
MKDoc-Auth-0.3
/ MKDoc::Auth::Handler::Authenticate

NAME

MKDoc::Auth::Handler::Authenticate - MKDoc::Auth apache authentication handler

OVERVIEW

This handler password-protects / authenticates a portion of your site MKDoc::Auth user database. It is useful if for example you wish some portion of your site to be accessible to "members only".

<Location /private/>
  PerlAuthenHandler MKDoc::Handler::Authenticate
  AuthName "MKDoc/Auth"
  AuthType Basic
  require valid-user
</Location>

This module is here for completeness, it is not actually set up by MKDoc::Setup::Auth. However it is here just in case you might need it.

API

get_login();

If the browser has sent credentials, returns the login which has been sent.

Returns undef otherwise.

get_password();

If the browser has sent the credentials, returns the password which has been sent.

Returns undef otherwise.

handler()

If the browser has sent the credentials and the credentials match an existing MKDoc::Auth::User, sets $::MKD_USER to this object and returns OK.

Otherwise, return AUTH_REQUIRED.