.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Lemonldap::NG::Common::Apache::Session::SOAP 3pm"
.TH Lemonldap::NG::Common::Apache::Session::SOAP 3pm 2024-02-07 "perl v5.38.2" "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
Lemonldap::NG::Common::Apache::Session::SOAP \- Perl extension written to
access to Lemonldap::NG Web\-SSO sessions via SOAP.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.IP \(bu 4
With Lemonldap::NG::Handler
.Sp
.Vb 2
\&  package My::Package;
\&  use Lemonldap::NG::Handler::SharedConf;
\&
\&  our @ISA = qw(Lemonldap::NG::Handler::Simple);
\&
\&  _\|_PACKAGE_\|_\->init ({
\&         globalStorage => \*(AqLemonldap::NG::Common::Apache::Session::SOAP\*(Aq,
\&         globalStorageOptions => {
\&                 proxy => \*(Aqhttp://auth.example.com/sessions\*(Aq,
\&                 proxyOptions => {
\&                     timeout => 5,
\&                 },
\&                 # If soapserver is protected by HTTP Basic:
\&                 User     => \*(Aqhttp\-user\*(Aq,
\&                 Password => \*(Aqpass\*(Aq,
\&                 # To have a local session cache
\&                 localStorage        => "Cache::FileCache",
\&                 localStorageOptions => {
\&                     \*(Aqnamespace\*(Aq          => \*(Aqlemonldap\-ng\*(Aq,
\&                     \*(Aqdefault_expires_in\*(Aq => 600,
\&                 },
\&         },
\&         configStorage       => {
\&             ... # See Lemonldap::NG::Handler
.Ve
.IP \(bu 4
With Lemonldap::NG::Portal
.Sp
.Vb 10
\&  use Lemonldap::NG::Portal::SharedConf;
\&  my $portal = new Lemonldap::NG::Portal::SharedConf (
\&         globalStorage => \*(AqLemonldap::NG::Common::Apache::Session::SOAP\*(Aq,
\&         globalStorageOptions => {
\&                 proxy => \*(Aqhttp://auth.example.com/sessions\*(Aq,
\&                 proxyOptions => {
\&                     timeout => 5,
\&                 },
\&                 # If soapserver is protected by HTTP Basic:
\&                 User     => \*(Aqhttp\-user\*(Aq,
\&                 Password => \*(Aqpass\*(Aq,
\&                 # To have a local session cache
\&                 localStorage        => "Cache::FileCache",
\&                 localStorageOptions => {
\&                     \*(Aqnamespace\*(Aq          => \*(Aqlemonldap\-ng\*(Aq,
\&                     \*(Aqdefault_expires_in\*(Aq => 600,
\&                 },
\&         },
\&         configStorage => {
\&             ... # See Lemonldap::NG::Portal
.Ve
.Sp
You can also set parameters corresponding to "Apache::Session module" in the
manager.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Lemonldap::NG::Common::Conf provides a simple interface to access to
Lemonldap::NG Web-SSO configuration. It is used by Lemonldap::NG::Handler,
Lemonldap::NG::Portal and Lemonldap::NG::Manager.
.PP
Lemonldap::NG::Common::Apache::Session::SOAP used with
Lemonldap::NG::Portal provides the ability to access to
Lemonldap::NG sessions via SOAP: the portal act as a proxy to access to the
real Apache::Session module (see HTML documentation for more)
.SS SECURITY
.IX Subsection "SECURITY"
As Lemonldap::NG::Common::Conf::SOAP use SOAP::Lite, you have to see
SOAP::Transport to know arguments that can be passed to \f(CW\*(C`proxyOptions\*(C'\fR.
Lemonldap::NG provides a system for HTTP basic authentication.
.PP
Examples :
.IP \(bu 4
HTTP Basic authentication
.Sp
SOAP::transport can use basic authentication by rewriting
\&\f(CW\*(C`\*(C'\fRSOAP::Transport::HTTP::Client::get_basic_credentials>:
.Sp
.Vb 1
\&  package My::Package;
\&  
\&  use base Lemonldap::NG::Handler::SharedConf;
\&  
\&  _\|_PACKAGE_\|_\->init ( {
\&      globalStorage => \*(AqLemonldap::NG::Common::Apache::Session::SOAP\*(Aq,
\&      globalStorageOptions => {
\&                proxy => \*(Aqhttp://auth.example.com/sessions\*(Aq,
\&                User     => \*(Aqhttp\-user\*(Aq,
\&                Password => \*(Aqpass\*(Aq,
\&      },
\&  } );
.Ve
.IP \(bu 4
SSL Authentication
.Sp
SOAP::transport provides a simple way to use SSL certificate: you've just to
set environment variables.
.Sp
.Vb 1
\&  package My::Package;
\&  
\&  use base Lemonldap::NG::Handler::SharedConf;
\&  
\&  # AUTHENTICATION
\&  $ENV{HTTPS_CERT_FILE} = \*(Aqclient\-cert.pem\*(Aq;
\&  $ENV{HTTPS_KEY_FILE}  = \*(Aqclient\-key.pem\*(Aq;
\&  
\&  _\|_PACKAGE_\|_\->init ( {
\&      globalStorage => \*(AqLemonldap::NG::Common::Apache::Session::SOAP\*(Aq,
\&      globalStorageOptions => {
\&                proxy => \*(Aqhttps://auth.example.com/sessions\*(Aq,
\&      },
\&  } );
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Lemonldap::NG::Manager, Lemonldap::NG::Common::Conf::SOAP,
Lemonldap::NG::Handler, Lemonldap::NG::Portal,
<http://lemonldap\-ng.org/>
.SH AUTHORS
.IX Header "AUTHORS"
.IP "LemonLDAP::NG team <http://lemonldap\-ng.org/team>" 4
.IX Item "LemonLDAP::NG team <http://lemonldap-ng.org/team>"
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use OW2 system to report bug or ask for features:
<https://gitlab.ow2.org/lemonldap\-ng/lemonldap\-ng/issues>
.SH DOWNLOAD
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
<https://lemonldap\-ng.org/download>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
See COPYING file for details.
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
.PP
This program 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 General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.