Difference between revisions of "API:EPrints/Apache/Auth"
| Line 6: | Line 6: | ||
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | ||
==NAME== | ==NAME== | ||
| − | '''EPrints::Apache::Auth''' - Password authentication & authorisation checking | + | '''EPrints::Apache::Auth''' - Password authentication & authorisation checking for EPrints. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 39: | Line 39: | ||
$rc = EPrints::Apache::Auth::authen( $r, [ $realm ] ) | $rc = EPrints::Apache::Auth::authen( $r, [ $realm ] ) | ||
| − | Perform authentication on request $r. If using auth_basic then include $realm as well. | + | Perform authentication on request <tt>$r</tt>. If using <tt>auth_basic</tt> then include <tt>$realm</tt> as well. |
| − | Returns | + | Returns a HTTP response code. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 54: | Line 54: | ||
$rc = EPrints::Apache::Auth::authen_doc( $r, [ $realm ] ) | $rc = EPrints::Apache::Auth::authen_doc( $r, [ $realm ] ) | ||
| − | Perform authentication on request $r for a document. If using auth_basic then include $realm as well. | + | Perform authentication on request <tt>$r</tt> for a document. If using <tt>auth_basic</tt> then include <tt>$realm</tt> as well. |
| − | Returns | + | Returns a HTTP response code. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 69: | Line 69: | ||
$rc = EPrints::Apache::Auth::auth_cookie( $r, $repository ) | $rc = EPrints::Apache::Auth::auth_cookie( $r, $repository ) | ||
| − | Perform authentication by cookie on request $r for repository $repository. | + | Perform authentication by cookie on request S!$r! for repository <tt>$repository</tt>. Redirect as appropriate. |
| − | Returns | + | Returns a HTTP response code. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 83: | Line 83: | ||
===auth_basic=== | ===auth_basic=== | ||
| − | $rc = EPrints::Apache::Auth::auth_basic( $r, $repository, $realm ) | + | $rc = EPrints::Apache::Auth::auth_basic( $r, $repository, [ $realm ] ) |
| − | Perform authentication by basic authentication on request $r for repository $repository. | + | Perform authentication by basic authentication on request <tt>$r</tt> for repository <tt>$repository</tt>. If using <tt>auth_basic</tt> then include <tt>$realm</tt> as well. |
| − | Returns | + | Returns a HTTP response code. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 99: | Line 99: | ||
$rc = EPrints::Apache::Auth::authz( $r ) | $rc = EPrints::Apache::Auth::authz( $r ) | ||
| − | Perform authorization of request $r. | + | Perform authorization of request <tt>$r</tt>. |
| − | Returns | + | Returns a HTTP response code (always <tt>200 OK</tt>). |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 114: | Line 114: | ||
$rc = EPrints::Apache::Auth::authz( $r ) | $rc = EPrints::Apache::Auth::authz( $r ) | ||
| − | Perform authorization of request $r for a document. | + | Perform authorization of request <tt>$r</tt> for a document. |
| − | Returns | + | Returns a HTTP response code |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
Latest revision as of 12:42, 15 March 2023
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
EPrints::Apache::Auth - Password authentication & authorisation checking for EPrints.
DESCRIPTION
This module handles the authentication and authorisation of users viewing private sections of an EPrints website.
METHODS
authen
$rc = EPrints::Apache::Auth::authen( $r, [ $realm ] )
Perform authentication on request $r. If using auth_basic then include $realm as well.
Returns a HTTP response code.
authen_doc
$rc = EPrints::Apache::Auth::authen_doc( $r, [ $realm ] )
Perform authentication on request $r for a document. If using auth_basic then include $realm as well.
Returns a HTTP response code.
auth_cookie
$rc = EPrints::Apache::Auth::auth_cookie( $r, $repository )
Perform authentication by cookie on request S!$r! for repository $repository. Redirect as appropriate.
Returns a HTTP response code.
auth_basic
$rc = EPrints::Apache::Auth::auth_basic( $r, $repository, [ $realm ] )
Perform authentication by basic authentication on request $r for repository $repository. If using auth_basic then include $realm as well.
Returns a HTTP response code.
authz
$rc = EPrints::Apache::Auth::authz( $r )
Perform authorization of request $r.
Returns a HTTP response code (always 200 OK).
authz
$rc = EPrints::Apache::Auth::authz( $r )
Perform authorization of request $r for a document.
Returns a HTTP response code
COPYRIGHT
© Copyright 2023 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE
This file is part of EPrints 3.4 http://www.eprints.org/.
EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.
EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.
