API:EPrints/Apache/Auth: Difference between revisions
m adding Category:Rubbish |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category: | <!-- Pod2Wiki=_preamble_ | ||
This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. | |||
-->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Auth.pm|package_name=EPrints::Apache::Auth}}[[Category:API|AUTH]][[Category:API:EPrints/Apache|AUTH]]<div><!-- Edit below this comment --> | |||
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | |||
==NAME== | |||
'''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%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=head_description --> | |||
==DESCRIPTION== | |||
This module handles the authentication and authorisation of users viewing private sections of an EPrints website. | |||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=head_methods --> | |||
==METHODS== | |||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=item_authen --> | |||
===authen=== | |||
$rc = EPrints::Apache::Auth::authen( $r, [ $realm ] ) | |||
Perform authentication on request <tt>$r</tt>. If using <tt>auth_basic</tt> then include <tt>$realm</tt> as well. | |||
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%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=item_authen_doc --> | |||
===authen_doc=== | |||
$rc = EPrints::Apache::Auth::authen_doc( $r, [ $realm ] ) | |||
Perform authentication on request <tt>$r</tt> for a document. If using <tt>auth_basic</tt> then include <tt>$realm</tt> as well. | |||
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%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=item_auth_cookie --> | |||
===auth_cookie=== | |||
$rc = EPrints::Apache::Auth::auth_cookie( $r, $repository ) | |||
Perform authentication by cookie on request S!$r! for repository <tt>$repository</tt>. Redirect as appropriate. | |||
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%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=item_auth_basic --> | |||
===auth_basic=== | |||
$rc = EPrints::Apache::Auth::auth_basic( $r, $repository, [ $realm ] ) | |||
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 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%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=item_authz --> | |||
===authz=== | |||
$rc = EPrints::Apache::Auth::authz( $r ) | |||
Perform authorization of request <tt>$r</tt>. | |||
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%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=item_authz --> | |||
===authz=== | |||
$rc = EPrints::Apache::Auth::authz( $r ) | |||
Perform authorization of request <tt>$r</tt> for a document. | |||
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%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=head_copyright --> | |||
==COPYRIGHT== | |||
{{API:Copyright}} | |||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | |||
<span style='display:none'>User Comments</span> | |||
<!-- Edit below this comment --> | |||
<!-- Pod2Wiki= --> | |||
</div> | |||
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment --> | |||
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
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 2000-2024 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/.