.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
.\}
.\" ========================================================================
.\"
.IX Title "Lemonldap::NG::Common::Conf::SOAP 3pm"
.TH Lemonldap::NG::Common::Conf::SOAP 3pm "2018-10-07" "perl v5.26.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::Conf::SOAP \- Perl extension written to access to
Lemonldap::NG Web\-SSO configuration via SOAP.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "Client side"
.IX Subsection "Client side"
\fIArea protection (Apache handler)\fR
.IX Subsection "Area protection (Apache handler)"
.PP
.Vb 1
\& package My::Package;
\&
\& use base Lemonldap::NG::Handler::SharedConf;
\&
\& _\|_PACKAGE_\|_\->init ( {
\& localStorage => "Cache::FileCache",
\& localStorageOptions => {
\& \*(Aqnamespace\*(Aq => \*(Aqlemonldap\-ng\*(Aq,
\& \*(Aqdefault_expires_in\*(Aq => 600,
\& },
\& configStorage => {
\& type => \*(AqSOAP\*(Aq,
\& proxy => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\& # If soapserver is protected by HTTP Basic:
\& User => \*(Aqhttp\-user\*(Aq,
\& Password => \*(Aqpass\*(Aq,
\& },
\& https => 0,
\& } );
.Ve
.PP
\fIAuthentication portal\fR
.IX Subsection "Authentication portal"
.PP
.Vb 1
\& use Lemonldap::NG::Portal::SharedConf;
\&
\& my $portal = Lemonldap::NG::Portal::SharedConf\->new ( {
\& configStorage => {
\& type => \*(AqSOAP\*(Aq,
\& proxy => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\& # If soapserver is protected by HTTP Basic:
\& User => \*(Aqhttp\-user\*(Aq,
\& Password => \*(Aqpass\*(Aq,
\& }
\& });
\& # Next as usual... See Lemonldap::NG::Portal(3)
\& if($portal\->process()) {
\& ...
.Ve
.PP
\fIManager\fR
.IX Subsection "Manager"
.PP
.Vb 1
\& use Lemonldap::NG::Manager;
\&
\& my $m=new Lemonldap::NG::Manager(
\& {
\& configStorage=>{
\& type => \*(AqSOAP\*(Aq,
\& proxy => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\& # If soapserver is protected by HTTP Basic:
\& User => \*(Aqhttp\-user\*(Aq,
\& Password => \*(Aqpass\*(Aq,
\& },
\& dhtmlXTreeImageLocation=> "/imgs/",
\& }
\& ) or die "Unable to start manager";
\&
\& $m\->doall();
.Ve
.SS "Server side"
.IX Subsection "Server side"
You just have to set \*(L"Soap => 1\*(R" in your portal. See \s-1HTML\s0 documentation for
more.
.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::Conf::SOAP provides the \*(L"\s-1SOAP\*(R"\s0 target used to access
configuration via \s-1SOAP.\s0
.SS "\s-1SECURITY\s0"
.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 \s-1HTTP\s0 basic authentication.
.PP
Examples :
.IP "\(bu" 4
\&\s-1HTTP\s0 Basic authentication
.Sp
.Vb 1
\& package My::Package;
\&
\& use base Lemonldap::NG::Handler::SharedConf;
\&
\& _\|_PACKAGE_\|_\->init ( {
\& localStorage => "Cache::FileCache",
\& localStorageOptions => {
\& \*(Aqnamespace\*(Aq => \*(Aqlemonldap\-ng\*(Aq,
\& \*(Aqdefault_expires_in\*(Aq => 600,
\& },
\& configStorage => {
\& type => \*(AqSOAP\*(Aq,
\& proxy => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\& User => \*(Aqhttp\-user\*(Aq,
\& Password => \*(Aqpass\*(Aq,
\& },
\& https => 1,
\& } );
.Ve
.IP "\(bu" 4
\&\s-1SSL\s0 Authentication
.Sp
SOAP::transport provides a simple way to use \s-1SSL\s0 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 ( {
\& localStorage => "Cache::FileCache",
\& localStorageOptions => {
\& \*(Aqnamespace\*(Aq => \*(Aqlemonldap\-ng\*(Aq,
\& \*(Aqdefault_expires_in\*(Aq => 600,
\& },
\& configStorage => {
\& type => \*(AqSOAP\*(Aq,
\& proxy => \*(Aqhttp://auth.example.com/index.pl/config\*(Aq,
\& },
\& https => 1,
\& } );
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Lemonldap::NG::Common::Conf::SOAP,
Lemonldap::NG::Handler, Lemonldap::NG::Portal,
.SH "AUTHOR"
.IX Header "AUTHOR"
.IP "Clement Oudot, " 4
.IX Item "Clement Oudot, "
.PD 0
.IP "François\-Xavier Deltombe, " 4
.IX Item "François-Xavier Deltombe, "
.IP "Xavier Guimard, " 4
.IX Item "Xavier Guimard, "
.PD
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use \s-1OW2\s0 system to report bug or ask for features:
.SH "DOWNLOAD"
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.IP "Copyright (C) 2008\-2016 by Xavier Guimard, " 4
.IX Item "Copyright (C) 2008-2016 by Xavier Guimard, "
.PD 0
.IP "Copyright (C) 2012\-2014 by François\-Xavier Deltombe, " 4
.IX Item "Copyright (C) 2012-2014 by François-Xavier Deltombe, "
.IP "Copyright (C) 2010\-2012 by Clement Oudot, " 4
.IX Item "Copyright (C) 2010-2012 by Clement Oudot, "
.PD
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 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 \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program. If not, see .