524 lines
16 KiB
Perl
524 lines
16 KiB
Perl
package Lemonldap::NG::Manager;
|
||
|
||
use strict;
|
||
|
||
use XML::Simple;
|
||
|
||
#use AutoLoader qw(AUTOLOAD);
|
||
use Lemonldap::NG::Manager::Base;
|
||
use Lemonldap::NG::Manager::Conf;
|
||
use Lemonldap::NG::Manager::_HTML;
|
||
|
||
our @ISA = qw(Lemonldap::NG::Manager::Base);
|
||
|
||
our $VERSION = '0.1';
|
||
|
||
sub new {
|
||
my ( $class, $args ) = @_;
|
||
my $self = $class->SUPER::new();
|
||
unless ($args) {
|
||
print STDERR "parameters are required, I can't start so\n";
|
||
return 0;
|
||
}
|
||
%$self = ( %$self, %$args );
|
||
foreach (qw(configStorage dhtmlXTreeImageLocation)) {
|
||
unless ( $self->{$_} ) {
|
||
print STDERR qq/The "$_" parameter is required\n/;
|
||
return 0;
|
||
}
|
||
}
|
||
$self->{jsFile} ||= $self->_dir . "lemonldap-ng-manager.js";
|
||
unless ( -r $self->{jsFile} ) {
|
||
print STDERR qq#Unable to read $self->{jsFile}. You have to set "jsFile" parameter to /path/to/lemonldap-ng-manager.js\n#;
|
||
}
|
||
if ( $self->param('lmQuery') ) {
|
||
my $tmp = "print_" . $self->param('lmQuery');
|
||
$self->$tmp;
|
||
}
|
||
else {
|
||
my $datas;
|
||
if ( $datas = $self->param('POSTDATA') ) {
|
||
$self->print_upload( \$datas );
|
||
}
|
||
else {
|
||
return $self;
|
||
}
|
||
}
|
||
exit;
|
||
}
|
||
|
||
# Subroutines to make all the work
|
||
sub doall {
|
||
my $self = shift;
|
||
print $self->header_public;
|
||
print $self->start_html;
|
||
print $self->main;
|
||
print $self->end_html;
|
||
}
|
||
|
||
# CSS and Javascript export
|
||
sub print_css {
|
||
my $self = shift;
|
||
print $self->header_public( $ENV{SCRIPT_FILENAME}, -type => 'text/css' );
|
||
$self->css;
|
||
}
|
||
|
||
sub print_libjs {
|
||
my $self = shift;
|
||
print $self->header_public( $self->{jsFile},
|
||
-type => 'application/x-javascript' );
|
||
open F, $self->{jsFile};
|
||
while (<F>) {
|
||
print;
|
||
}
|
||
close F;
|
||
}
|
||
|
||
sub print_lmjs {
|
||
my $self = shift;
|
||
print $self->header_public( $ENV{SCRIPT_FILENAME},
|
||
-type => 'text/javascript' );
|
||
$self->javascript;
|
||
}
|
||
|
||
# HELP subroutines
|
||
|
||
sub print_help {
|
||
my $self = shift;
|
||
print $self->header_public;
|
||
print "TODO: help";
|
||
}
|
||
|
||
# Configuration download subroutines
|
||
sub print_conf {
|
||
my $self = shift;
|
||
print $self->header( -type => "text/xml", '-Cache-Control' => 'private' );
|
||
$self->printXmlConf;
|
||
exit;
|
||
}
|
||
|
||
sub default {
|
||
return {
|
||
cfgNum => 0,
|
||
ldapBase => "dc=example,dc=com",
|
||
};
|
||
}
|
||
|
||
sub printXmlConf {
|
||
my $self = shift;
|
||
my $config = $self->config->getConf();
|
||
$config = $self->default unless ($config);
|
||
my $tree = {
|
||
id => '0',
|
||
item => {
|
||
id => 'root',
|
||
open => 1,
|
||
text => "configuration $config->{cfgNum}",
|
||
item => {
|
||
generalParameters => {
|
||
text => 'Param<61>tres g<>n<EFBFBD>raux',
|
||
item => {
|
||
exportedVars => {
|
||
text => "Attributs LDAP <20> mapper",
|
||
item => {},
|
||
},
|
||
ldapParameters => {
|
||
text => 'Param<61>tres LDAP',
|
||
item => {},
|
||
},
|
||
sessionStorage => {
|
||
text => 'Stockage des sessions',
|
||
item => {
|
||
globalStorageOptions => {
|
||
text =>
|
||
'Param<61>tres du module Apache::Session',
|
||
}
|
||
},
|
||
},
|
||
authParams => {
|
||
text => "Param<61>tres d'authentification",
|
||
item => {},
|
||
},
|
||
},
|
||
},
|
||
groups => { text => "Groupes d'utilisateurs", },
|
||
virtualHosts => {
|
||
text => "H<>tes virtuels",
|
||
open => 1,
|
||
},
|
||
},
|
||
},
|
||
};
|
||
my $generalParameters = $tree->{item}->{item}->{generalParameters}->{item};
|
||
my $exportedVars = $tree->{item}->{item}->{generalParameters}->{item}->{exportedVars}->{item};
|
||
my $ldapParameters = $tree->{item}->{item}->{generalParameters}->{item}->{ldapParameters}->{item};
|
||
my $sessionStorage = $tree->{item}->{item}->{generalParameters}->{item}->{sessionStorage}->{item};
|
||
my $globalStorageOptions = $tree->{item}->{item}->{generalParameters}->{item}->{sessionStorage}->{item}->{globalStorageOptions}->{item};
|
||
my $authParams = $tree->{item}->{item}->{generalParameters}->{item}->{authParams}->{item};
|
||
$authParams->{authentication} = $self->xmlField(
|
||
"value",
|
||
$config->{authentication} || 'ldap',
|
||
"Type d'authentification"
|
||
);
|
||
$authParams->{portal} =
|
||
$self->xmlField(
|
||
"value",
|
||
$config->{portal} || 'http://portal/',
|
||
"Portail" );
|
||
$authParams->{securedCookie} = $self->xmlField(
|
||
"value",
|
||
$config->{securedCookie} || 0,
|
||
"Cookie s<>curis<69> (SSL)"
|
||
);
|
||
|
||
$generalParameters->{domain} =
|
||
$self->xmlField(
|
||
"value",
|
||
$config->{domain} || 'example.com',
|
||
'Domaine'
|
||
);
|
||
$generalParameters->{cookieName} = $self->xmlField(
|
||
"value",
|
||
$config->{cookieName} || 'lemonldap',
|
||
'Nom du cookie'
|
||
);
|
||
|
||
$sessionStorage->{globalStorage} = $self->xmlField(
|
||
"value",
|
||
$config->{globalStorage} || 'Apache::Session::File',
|
||
'Module Apache::Session'
|
||
);
|
||
|
||
$ldapParameters->{ldapServer} = $self->xmlField(
|
||
"value",
|
||
$config->{ldapServer} || 'localhost',
|
||
'Serveur LDAP' );
|
||
$ldapParameters->{ldapPort} = $self->xmlField(
|
||
"value",
|
||
$config->{ldapPort} || 389,
|
||
'Port du serveur LDAP'
|
||
);
|
||
$ldapParameters->{ldapBase} = $self->xmlField(
|
||
"value",
|
||
$config->{ldapBase} || ' ',
|
||
'Base de recherche LDAP'
|
||
);
|
||
$ldapParameters->{managerDn} = $self->xmlField(
|
||
"value",
|
||
$config->{managerDn} || ' ',
|
||
'Compte de connexion LDAP'
|
||
);
|
||
$ldapParameters->{managerPassword} = $self->xmlField(
|
||
"value",
|
||
$config->{managerPassword} || ' ',
|
||
'Mot de passe LDAP'
|
||
);
|
||
|
||
if ( $config->{exportedVars} ) {
|
||
while ( my ( $n, $att ) = each( %{ $config->{exportedVars} } ) ) {
|
||
$exportedVars->{$n} = $self->xmlField( "both", $att, $n );
|
||
}
|
||
}
|
||
else {
|
||
foreach (qw(mail uid cn)) {
|
||
$exportedVars->{$_} = $self->xmlField( 'both', $_, $_ );
|
||
}
|
||
}
|
||
|
||
if ( $config->{globalStorageOptions} ) {
|
||
$tree->{item}->{item}->{generalParameters}->{item}->{sessionStorage}->{item}->{globalStorageOptions}->{item} = {};
|
||
$globalStorageOptions =
|
||
$tree->{item}->{item}->{generalParameters}->{item}->{sessionStorage}->{item}->{globalStorageOptions}->{item};
|
||
while ( my ( $n, $opt ) = each( %{ $config->{globalStorageOptions} } ) ) {
|
||
$globalStorageOptions->{$n} = $self->xmlField( "both", $opt, $n );
|
||
}
|
||
}
|
||
else {
|
||
}
|
||
|
||
my $indice = 1;
|
||
if ( $config->{locationRules} ) {
|
||
$tree->{item}->{item}->{virtualHosts}->{item} = {};
|
||
my $virtualHost = $tree->{item}->{item}->{virtualHosts}->{item};
|
||
while ( my ( $host, $rules ) = each( %{ $config->{locationRules} } ) ) {
|
||
$virtualHost->{$host} = $self->xmlField( "text", 'i', $host );
|
||
my ( $ih, $ir ) = ( "exportedHeaders_$indice", "locationRules_$indice" );
|
||
$virtualHost->{$host}->{item} = {
|
||
"$ih" => { text => "Headers", },
|
||
"$ir" => { text => "R<>gles", },
|
||
};
|
||
while ( my ( $reg, $expr ) = each(%$rules) ) {
|
||
my $type = ( $reg eq 'default' ) ? 'value' : 'both';
|
||
$virtualHost->{$host}->{item}->{$ir}->{item}->{"r_$indice"} =
|
||
$self->xmlField( $type, $expr, $reg );
|
||
$indice++;
|
||
}
|
||
my $headers = $config->{exportedHeaders}->{$host};
|
||
while ( my ( $h, $expr ) = each(%$headers) ) {
|
||
$virtualHost->{$host}->{item}->{$ih}->{item}->{"h_$indice"} =
|
||
$self->xmlField( "both", $expr, $h );
|
||
$indice++;
|
||
}
|
||
}
|
||
}
|
||
if ( $config->{groups} ) {
|
||
$tree->{item}->{item}->{groups}->{item} = {};
|
||
my $groups = $tree->{item}->{item}->{groups}->{item};
|
||
while ( my ( $group, $expr ) = each( %{ $config->{groups} } ) ) {
|
||
$groups->{$group} = $self->xmlField( 'both', $expr, $group );
|
||
}
|
||
}
|
||
|
||
print XMLout(
|
||
$tree,
|
||
XMLDecl => "<?xml version='1.0' encoding='iso-8859-1'?>",
|
||
RootName => 'tree',
|
||
KeyAttr => { item => 'id', username => 'name' },
|
||
NoIndent => 1
|
||
);
|
||
}
|
||
|
||
sub xmlField {
|
||
my ( $self, $type, $value, $text ) = @_;
|
||
$value =~ s/"/\"/g;
|
||
$text =~ s/"/\"/g;
|
||
return {
|
||
text => $text,
|
||
aCol => "#000000",
|
||
sCol => "#0000FF",
|
||
userdata => [
|
||
{ name => 'value', content => $value },
|
||
{ name => 'modif', content => $type },
|
||
],
|
||
};
|
||
}
|
||
|
||
# Upload subroutines
|
||
sub print_upload {
|
||
my $self = shift;
|
||
my $datas = shift;
|
||
print $self->header( -type => "text/html" );
|
||
my $tmp = $self->upload($datas);
|
||
if ($tmp) {
|
||
print $tmp;
|
||
}
|
||
else {
|
||
print 0;
|
||
}
|
||
}
|
||
|
||
sub upload {
|
||
my ( $self, $tree ) = @_;
|
||
$tree = XMLin($$tree);
|
||
my $config = {};
|
||
while ( my ( $g, $h ) = each( %{ $tree->{groups} } ) ) {
|
||
next unless ( ref($h) );
|
||
$config->{groups}->{ $h->{text} } = $h->{value};
|
||
}
|
||
while ( my ( $vh, $h ) = each( %{ $tree->{virtualHosts} } ) ) {
|
||
next unless ( ref($h) );
|
||
my $lr;
|
||
my $eh;
|
||
foreach ( keys(%$h) ) {
|
||
$lr = $h->{$_} if ( $_ =~ /locationRules/ );
|
||
$eh = $h->{$_} if ( $_ =~ /exportedHeaders/ );
|
||
}
|
||
LR: foreach my $r ( values(%$lr) ) {
|
||
next LR unless ( ref($r) );
|
||
$config->{locationRules}->{$vh}->{ $r->{text} } = $r->{value};
|
||
}
|
||
EH: foreach my $h ( values(%$eh) ) {
|
||
next EH unless ( ref($h) );
|
||
$config->{exportedHeaders}->{$vh}->{ $h->{text} } = $h->{value};
|
||
}
|
||
}
|
||
$config->{cookieName} = $tree->{generalParameters}->{cookieName}->{value};
|
||
$config->{domain} = $tree->{generalParameters}->{domain}->{value};
|
||
$config->{globalStorage} = $tree->{generalParameters}->{sessionStorage}->{globalStorage}->{value};
|
||
while (
|
||
my ( $v, $h ) = each(
|
||
%{
|
||
$tree->{generalParameters}->{sessionStorage}->{globalStorageOptions}
|
||
}
|
||
)
|
||
)
|
||
{
|
||
next unless ( ref($h) );
|
||
$config->{globalStorageOptions}->{ $h->{text} } = $h->{value};
|
||
}
|
||
foreach (qw(ldapBase ldapPort ldapServer managerDn managerPassword)) {
|
||
$config->{$_} =
|
||
$tree->{generalParameters}->{ldapParameters}->{$_}->{value};
|
||
$config->{$_} = '' if ( ref( $config->{$_} ) );
|
||
$config->{$_} =~ s/^\s*(.*?)\s*/$1/;
|
||
}
|
||
foreach (qw(authentication portal securedCookie)) {
|
||
$config->{$_} = $tree->{generalParameters}->{authParams}->{$_}->{value};
|
||
$config->{$_} = '' if ( ref( $config->{$_} ) );
|
||
$config->{$_} =~ s/^\s*(.*?)\s*/$1/;
|
||
}
|
||
while ( my ( $v, $h ) =
|
||
each( %{ $tree->{generalParameters}->{exportedVars} } ) )
|
||
{
|
||
next unless ( ref($h) );
|
||
$config->{exportedVars}->{$v} = $h->{value};
|
||
}
|
||
return $self->config->saveConf($config);
|
||
}
|
||
|
||
# Internal subroutines
|
||
sub _dir {
|
||
my $d = $ENV{SCRIPT_FILENAME};
|
||
$d =~ s#[^/]*$##;
|
||
return $d;
|
||
}
|
||
|
||
sub config {
|
||
my $self = shift;
|
||
return $self->{_config} if $self->{_config};
|
||
$self->{_config} =
|
||
Lemonldap::NG::Manager::Conf->new( $self->{configStorage} );
|
||
unless ( $self->{_config} ) {
|
||
die "Configuration not loaded\n";
|
||
}
|
||
return $self->{_config};
|
||
}
|
||
|
||
*css = *Lemonldap::NG::Manager::_HTML::css;
|
||
*javascript = *Lemonldap::NG::Manager::_HTML::javascript;
|
||
*main = *Lemonldap::NG::Manager::_HTML::main;
|
||
*start_html = *Lemonldap::NG::Manager::_HTML::start_html;
|
||
|
||
__END__
|
||
=head1 NAME
|
||
|
||
Lemonldap::NG::Manager - Perl extension for managing Lemonldap::NG Web-SSO
|
||
system.
|
||
|
||
=head1 SYNOPSIS
|
||
|
||
use Lemonldap::NG::Manager;
|
||
my $h=new Lemonldap::NG::Manager(
|
||
{
|
||
configStorage=>{
|
||
type=>'File',
|
||
dirName=>"/tmp/",
|
||
},
|
||
dhtmlXTreeImageLocation=> "/devel/img/",
|
||
# uncomment this only if lemonldap-ng-manager.js is not in the same
|
||
# directory than your script.
|
||
# jsFile => /path/to/lemonldap-ng-manager.js,
|
||
}
|
||
) or die "Unable to start, see Apache logs";
|
||
# Simple
|
||
$h->doall();
|
||
|
||
You can also peersonalize the HTML code instead of using C<doall()>:
|
||
|
||
print $self->header_public;
|
||
print $self->start_html ( # See CGI(3) for more about start_html
|
||
-style => "/location/to/my.css",
|
||
-title => "Example.com SSO configuration",
|
||
);
|
||
# optional HTML code for the top of the page
|
||
print "<img src=...";
|
||
print $self->main;
|
||
# optional HTML code for the footer of the page
|
||
print "<img src=...";
|
||
|
||
print $self->end_html;
|
||
|
||
=head1 DESCRIPTION
|
||
|
||
Lemonldap::NG::Manager provides a web interface to manage Lemonldap::NG Web-SSO
|
||
system.
|
||
|
||
=head2 SUBROUTINES
|
||
|
||
=over
|
||
|
||
=item * B<new> (constructor): new instanciates the manager object. It takes the
|
||
following arguments:
|
||
|
||
=over
|
||
|
||
=item * B<configStorage> (required): a hash reference to the description of the
|
||
configuration database system. the key 'type' must be set. Example:
|
||
|
||
configStorage => {
|
||
type => "DBI",
|
||
dbiChain => "DBI:mysql:database=session;host=1.2.3.4",
|
||
dbiUser => "lemonldap-ng",
|
||
dbiPassword => "pass",
|
||
}
|
||
|
||
See L<Lemonldap::Manager::NG::Manager::Conf::File> or
|
||
L<Lemonldap::Manager::NG::Manager::Conf::DBI> to know which keys are required.
|
||
|
||
=item * B<dhtmlXTreeImageLocation> (required): the location of the directory
|
||
containing dhtmlXTree images (provided in example/imgs). If this parameter
|
||
isn't correct, the tree will not appear and you will have sone error in Apache
|
||
error logs.
|
||
|
||
=item * B<jsFile> (optional): the path to the file C<lemonldap-ng-manager.js>.
|
||
It is required only if this file is not in the same directory than your script.
|
||
|
||
=back
|
||
|
||
=item * B<doall>: subroutine that provide headers and the full html code. Il
|
||
simply calls C<header_public>, C<start_html>, C<main> and C<end_html> in this
|
||
order.
|
||
|
||
=item * B<header>: print HTTP headers. See L<CGI> for more.
|
||
|
||
=item * B<header_public>: print HTTP headers and manage the
|
||
C<If-Modified-Since> HTTP header. If it match to the age of the file passed
|
||
in first argument, it returns C<HTTP 304 Not Modified> end exit. Else, it
|
||
calls C<header> with the other arguments. By default, all elements of the
|
||
manager use this mecanism except the configuration itself.
|
||
|
||
=item * B<start_html>: subroutine that print the HTML headers. you can add
|
||
parameters to it; example;
|
||
|
||
print start_html(-title => 'My SSO configuration',
|
||
-author => 'fred@capricorn.org',
|
||
-target => '_blank',
|
||
-meta => {'keywords'=>'pharaoh secret mummy',
|
||
'copyright' => 'copyright 1996 King Tut'},
|
||
-style => {'src'=>'/styles/style1.css'},
|
||
-BGCOLOR => 'blue');
|
||
|
||
See start_html description in L<CGI> for more. Bee carefull with C<-style>
|
||
argument. You have to call it like the example above or simply like this:
|
||
-style=> '/styles/style1.css',
|
||
All other forms will not work.
|
||
|
||
=item * B<main>: il produce the main HTML code needed to build the
|
||
configuration interface.
|
||
|
||
=item * B<end_html>: close the HTML code by writing C<'E<lt>/bodyE<gt>E<lt>/htmlE<gt>'>
|
||
|
||
=back
|
||
|
||
Other subroutines manage the produce of CSS, Javascripts and of course the
|
||
configuration tree (called with AJAX).
|
||
|
||
=head1 SEE ALSO
|
||
|
||
L<Lemonldap::NG::Handler>, L<Lemonldap::NG::Portal>, L<CGI>
|
||
|
||
=head1 AUTHOR
|
||
|
||
Xavier Guimard, E<lt>x.guimard@free.frE<gt>
|
||
|
||
=head1 COPYRIGHT AND LICENSE
|
||
|
||
Copyright (C) 2006 by Xavier Guimard
|
||
|
||
This library is free software; you can redistribute it and/or modify
|
||
it under the same terms as Perl itself, either Perl version 5.8.8 or,
|
||
at your option, any later version of Perl 5 you may have available.
|
||
|
||
=cut
|
||
|