Lemonldap::NG::Common::Conf::SOAP(3pm)

NAME
Lemonldap::NG::Common::Conf::SOAP - Perl extension written to access to Lemonldap::NG Web-SSO configuration via SOAP.

SYNOPSIS

  Client side
Area protection (Apache handler)

  package My::Package;

  use base Lemonldap::NG::Handler::SharedConf;

  __PACKAGE__->init ( {
      localStorage        => "Cache::FileCache",
      localStorageOptions => {
                'namespace'          => 'lemonldap-ng',
                'default_expires_in' => 600,
      },
      configStorage       => {
                type     => 'SOAP',
                proxy    => 'http://auth.example.com/index.pl/config',
                # If soapserver is protected by HTTP Basic:
                User     => 'http-user',
                Password => 'pass',
      },
      https               => 0,
  } );

Authentication portal

  use Lemonldap::NG::Portal::SharedConf;

  my $portal = Lemonldap::NG::Portal::SharedConf->new ( {
          configStorage => {
                  type    => 'SOAP',
                  proxy    => 'http://auth.example.com/index.pl/config',
                  # If soapserver is protected by HTTP Basic:
                  User     => 'http-user',
                  Password => 'pass',
          }
  });
  # Next as usual... See Lemonldap::NG::Portal(3)
  if($portal->process()) {
    ...

Manager

  use Lemonldap::NG::Manager;

  my $m=new Lemonldap::NG::Manager(
       {
           configStorage=>{
                  type  => 'SOAP',
                  proxy    => 'http://auth.example.com/index.pl/config',
                  # If soapserver is protected by HTTP Basic:
                  User     => 'http-user',
                  Password => 'pass',
           },
            dhtmlXTreeImageLocation=> "/imgs/",
        }
  ) or die "Unable to start manager";

  $m->doall();

  Server side
You just have to set "Soap => 1" in your portal. See HTML documentation for more.

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.

Lemonldap::NG::Common::Conf::SOAP provides the "SOAP" target used to access configuration via SOAP.

  SECURITY
As Lemonldap::NG::Common::Conf::SOAP use SOAP::Lite, you have to see SOAP::Transport to know arguments that can be passed to "proxyOptions". Lemonldap::NG provides a system for HTTP basic authentication.

Examples :

•   HTTP Basic authentication

      package My::Package;

      use base Lemonldap::NG::Handler::SharedConf;

      __PACKAGE__->init ( {
          localStorage        => "Cache::FileCache",
          localStorageOptions => {
                    'namespace'          => 'lemonldap-ng',
                    'default_expires_in' => 600,
          },
          configStorage       => {
                    type  => 'SOAP',
                    proxy => 'http://auth.example.com/index.pl/config',
                    User     => 'http-user',
                    Password => 'pass',
          },
          https               => 1,
      } );

•   SSL Authentication

    SOAP::transport provides a simple way to use SSL certificate: you've just to set environment variables.

      package My::Package;

      use base Lemonldap::NG::Handler::SharedConf;

      # AUTHENTICATION
      $ENV{HTTPS_CERT_FILE} = 'client-cert.pem';
      $ENV{HTTPS_KEY_FILE}  = 'client-key.pem';

      __PACKAGE__->init ( {
          localStorage        => "Cache::FileCache",
          localStorageOptions => {
                    'namespace'          => 'lemonldap-ng',
                    'default_expires_in' => 600,
          },
          configStorage       => {
                    type  => 'SOAP',
                    proxy => 'http://auth.example.com/index.pl/config',
          },
          https               => 1,
      } );

SEE ALSO
Lemonldap::NG::Common::Conf::SOAP, Lemonldap::NG::Handler, Lemonldap::NG::Portal, <http://lemonldap-ng.org/>

AUTHOR

Clement Oudot, <clem.oudot@gmail.com>
François-Xavier Deltombe, <fxdeltombe@gmail.com.>
Xavier Guimard, <x.guimard@free.fr>

BUG REPORT
Use OW2 system to report bug or ask for features: <http://jira.ow2.org>

DOWNLOAD
Lemonldap::NG is available at <http://forge.objectweb.org/project/showfiles.php?group_id=274>

COPYRIGHT AND LICENSE

Copyright (C) 2008, 2009, 2010 by Xavier Guimard, <x.guimard@free.fr>
Copyright (C) 2012 by François-Xavier Deltombe, <fxdeltombe@gmail.com.>
Copyright (C) 2010, 2011, 2012 by Clement Oudot, <clem.oudot@gmail.com>

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.

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.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.