344 lines
9.0 KiB
Perl
344 lines
9.0 KiB
Perl
|
|
##@class
|
|
# SAML Metadata object for Lemonldap::NG
|
|
package Lemonldap::NG::Common::Conf::SAML::Metadata;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use Data::Dumper;
|
|
use HTML::Template;
|
|
use XML::Simple;
|
|
use Safe;
|
|
|
|
our $VERSION = '0.1';
|
|
our $DEBUG = 0;
|
|
|
|
## @cmethod Lemonldap::NG::Common::Conf::SAML::Metadata new(hashRef args)
|
|
# Class constructor.
|
|
# @param args hash reference
|
|
# @return Lemonldap::NG::Common::Conf::SAML::Metadata object
|
|
sub new {
|
|
my $class = shift;
|
|
my $self = bless {}, $class;
|
|
if ( ref( $_[0] ) ) {
|
|
%$self = %{ $_[0] };
|
|
}
|
|
elsif ( defined @_ && $#_ % 2 == 1 ) {
|
|
%$self = @_;
|
|
}
|
|
return $self;
|
|
}
|
|
|
|
## @method void setDebug(boolean debug)
|
|
# Set debug flag
|
|
# @param boolean debug value
|
|
# @return nothing
|
|
sub setDebug {
|
|
my $self = shift;
|
|
my $debug = shift || 1;
|
|
|
|
$DEBUG = $debug;
|
|
|
|
return;
|
|
}
|
|
|
|
## @method public boolean initiliazeFromConf(string s)
|
|
# Initialize this object from configuration string.
|
|
# @param $s Configuration string.
|
|
# @return boolean
|
|
sub initializeFromConf {
|
|
my $self = shift;
|
|
my $string = shift;
|
|
|
|
$string =~ s/'/'/g;
|
|
my $data = eval $string;
|
|
|
|
return $self->initializeFromConfHash($data);
|
|
}
|
|
|
|
## @method public boolean initiliazeFromConfHash(hash h)
|
|
# Initialize this object from configuration hash element.
|
|
# @param $h Configuration hash element.
|
|
# @return boolean
|
|
sub initializeFromConfHash {
|
|
my $self = shift;
|
|
my $hash = shift;
|
|
|
|
return 0 unless $hash;
|
|
|
|
while ( my ( $k, $v ) = each(%$hash) ) {
|
|
$self->{$k} = $v;
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
## @method public boolean initializeFromFile(string file)
|
|
# Initialize this object from XML file.
|
|
# @param $file Filename
|
|
# @return boolean
|
|
sub initializeFromFile {
|
|
my $self = shift;
|
|
my $file = shift;
|
|
my $xml = $self->_loadFile($file);
|
|
if ( !$xml ) {
|
|
return 0;
|
|
}
|
|
return $self->initializeFromXML($xml);
|
|
}
|
|
|
|
## @method public boolean initializeFromXML(string string)
|
|
# Initialize this object from configuration XML string.
|
|
# @param $string Configuration XML string.
|
|
# @return boolean
|
|
sub initializeFromXML {
|
|
my $self = shift;
|
|
my $string = shift;
|
|
|
|
# Remove spaces
|
|
$string =~ s/[\n\r\s]+/ /g;
|
|
$string =~ s/> </></g;
|
|
|
|
# New XML::Simple object
|
|
my $xs = XML::Simple->new( ForceContent => 1, ForceArray => 1 );
|
|
my $data = $xs->XMLin($string);
|
|
|
|
# Store data in Metadata object
|
|
if ($data) {
|
|
while ( my ( $k, $v ) = each( %{$data} ) ) {
|
|
$self->{$k} = $v;
|
|
}
|
|
return 1;
|
|
}
|
|
return 0;
|
|
|
|
}
|
|
|
|
## @method public string serviceToXML
|
|
# Return all SAML parameters in well formated XML format, corresponding to
|
|
# SAML 2 description.
|
|
# @return string
|
|
sub serviceToXML {
|
|
my $self = shift;
|
|
my $file = shift;
|
|
my ($conf) = @_;
|
|
my $template = HTML::Template->new(
|
|
filename => "$file",
|
|
die_on_bad_params => 0,
|
|
cache => 0,
|
|
);
|
|
|
|
# Automatic parameters
|
|
my @param_auto = qw(
|
|
samlEntityID
|
|
samlOrganizationName
|
|
samlOrganizationDisplayName
|
|
samlOrganizationURL
|
|
samlSPSSODescriptorAuthnRequestsSigned
|
|
samlSPSSODescriptorProtocolSupportEnumeration
|
|
samlSPSSODescriptorKeyDescriptorSigning
|
|
samlSPSSODescriptorNameIDFormatX509SubjectName
|
|
samlSPSSODescriptorNameIDFormatPersistent
|
|
samlSPSSODescriptorNameIDFormatTransient
|
|
samlIDPSSODescriptorWantAuthnRequestsSigned
|
|
samlIDPSSODescriptorProtocolSupportEnumeration
|
|
samlIDPSSODescriptorKeyDescriptorSigning
|
|
samlIDPSSODescriptorNameIDFormatX509SubjectName
|
|
samlIDPSSODescriptorNameIDFormatPersistent
|
|
samlIDPSSODescriptorNameIDFormatTransient
|
|
);
|
|
|
|
foreach (@param_auto) {
|
|
$template->param( $_, $conf->{$_} );
|
|
}
|
|
|
|
# Rebuilded parameters for SAML services
|
|
# A samlService value is formated like the following:
|
|
# "binding;location;responseLocation"
|
|
# The last value, responseLocation, is optional.
|
|
my @param_service = qw(
|
|
samlSPSSODescriptorSingleLogoutServiceHTTP
|
|
samlSPSSODescriptorSingleLogoutServiceSOAP
|
|
samlIDPSSODescriptorSingleSignOnServiceHTTP
|
|
samlIDPSSODescriptorSingleSignOnServiceSOAP
|
|
samlIDPSSODescriptorSingleLogoutServiceHTTP
|
|
samlIDPSSODescriptorSingleLogoutServiceSOAP
|
|
samlIDPSSODescriptorManageNameIDServiceHTTP
|
|
samlIDPSSODescriptorManageNameIDServiceSOAP
|
|
);
|
|
|
|
foreach (@param_service) {
|
|
my @_tab = split( /;/, $conf->{$_} );
|
|
$template->param( $_ . 'Binding', $_tab[0] );
|
|
$template->param( $_ . 'Location', $_tab[1] );
|
|
$template->param( $_ . 'ResponseLocation', $_tab[2] );
|
|
}
|
|
|
|
# Rebuilded parameters for SAML assertions
|
|
# A samlAssertion value is formated like the following:
|
|
# "default;index;binding;location"
|
|
my @param_assertion = qw(
|
|
samlSPSSODescriptorAssertionConsumerServiceHTTPArtifact
|
|
samlSPSSODescriptorAssertionConsumerServiceHTTPPost
|
|
samlSPSSODescriptorAssertionConsumerServiceHTTPRedirect
|
|
samlIDPSSODescriptorArtifactResolutionServiceArtifact
|
|
);
|
|
foreach (@param_assertion) {
|
|
my @_tab = split( /;/, $conf->{$_} );
|
|
$template->param( $_ . 'Default', $_tab[0] ? 'true' : 'false' );
|
|
$template->param( $_ . 'Index', $_tab[1] );
|
|
$template->param( $_ . 'Binding', $_tab[2] );
|
|
$template->param( $_ . 'Location', $_tab[3] );
|
|
}
|
|
|
|
# Return the XML metadata.
|
|
return $template->output;
|
|
}
|
|
|
|
## @method public string toXML
|
|
# Return this object in XML format.
|
|
# @return string
|
|
sub toXML {
|
|
my $self = shift;
|
|
|
|
# Use XML::Simple to Dump Perl Hash in XML format
|
|
my $xs = XML::Simple->new( RootName => "md:EntityDescriptor" );
|
|
|
|
# Force xmlns:md key
|
|
$self->{"xmlns:md"} = "urn:oasis:names:tc:SAML:2.0:metadata"
|
|
unless defined $self->{"xmlns:md"};
|
|
|
|
# Serialize XML
|
|
my $xml = $xs->XMLout($self);
|
|
|
|
return $xml;
|
|
}
|
|
|
|
## @method public string toConf ()
|
|
# Return this object in configuration string format.
|
|
# @return string
|
|
sub toConf {
|
|
my $self = shift;
|
|
my $fields = $self->toHash();
|
|
local $Data::Dumper::Indent = 0;
|
|
local $Data::Dumper::Varname = "data";
|
|
my $data = Dumper($fields);
|
|
$data =~ s/^\s*(.*?)\s*$/$1/;
|
|
$data =~ s/'/'/g;
|
|
$data =~ s/^\$data[0-9]*\s*=\s*({?\s*.+\s*}?)/$1/g;
|
|
return $data;
|
|
}
|
|
|
|
## @method public string toHash ()
|
|
# Return this object in configuration hash format.
|
|
# @return hashref
|
|
sub toHash {
|
|
my $self = shift;
|
|
my $fields = ();
|
|
foreach ( keys %$self ) {
|
|
$fields->{$_} = $self->{$_};
|
|
}
|
|
return $fields;
|
|
}
|
|
|
|
## @method public hashref toStruct ()
|
|
# Return this object to be display into the Manager.
|
|
# NOT USED FOR THE MOMENT.
|
|
# @return hashref
|
|
sub toStruct {
|
|
my $self = shift;
|
|
my $struct = ();
|
|
foreach ( keys %$self ) {
|
|
$struct->{$_} = $self->{$_};
|
|
}
|
|
return $self->_toStruct( '', $struct );
|
|
}
|
|
|
|
## @method private hashref _toStruct (Hashref node)
|
|
# Return a preformated structure to be stored into Manager structure.
|
|
# NOT USED FOR THE MOMENT.
|
|
# @param $path The path of the node.
|
|
# @param $node The current node into the hashref tree.
|
|
# @return Hashref A structure to be inserted into Manager structure.
|
|
sub _toStruct {
|
|
my $self = shift;
|
|
my $path = shift;
|
|
my $node = shift;
|
|
if ( ref $node ) {
|
|
my $struct = {
|
|
_nodes => [],
|
|
_help => 'default'
|
|
};
|
|
my @nodes = ();
|
|
my $tmpnode;
|
|
if ( ref $node eq 'ARRAY' ) {
|
|
|
|
# More than one value for the same key
|
|
# Build a hash with indices
|
|
my $i = 0;
|
|
foreach (@$node) {
|
|
$tmpnode->{$i} = $node->[$i];
|
|
}
|
|
}
|
|
else {
|
|
$tmpnode = $node;
|
|
}
|
|
foreach ( keys %$tmpnode ) {
|
|
|
|
if ( $_ =~ /^xmlns/ ) {
|
|
next;
|
|
}
|
|
my $key = $path . ' ' . $_;
|
|
$key =~ s/^ +//g;
|
|
my $data;
|
|
|
|
$data = $self->_toStruct( $key, $tmpnode->{$_} );
|
|
if ($data) {
|
|
$struct->{$key} = $data;
|
|
push @nodes, 'n:' . $key;
|
|
}
|
|
else {
|
|
$struct->{$key} = 'text:/' . $_;
|
|
push @nodes, $key;
|
|
}
|
|
}
|
|
$struct->{_nodes} = \@nodes;
|
|
return $struct;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
## @method public static boolean load(Array files)
|
|
# Return an array of Metadata object.
|
|
# @param $files Array of filenames
|
|
# @return Array of Metadata objects
|
|
sub load {
|
|
my @files = splice @_;
|
|
my @metadatas = ();
|
|
foreach (@files) {
|
|
my $metadata = new Lemonldap::NG::Common::Conf::SAML::Metadata();
|
|
if ( $metadata->initializeFromFile($_) ) {
|
|
push @metadatas, $metadata;
|
|
}
|
|
}
|
|
return @metadatas;
|
|
}
|
|
|
|
## @method private hashref _loadFile(string file)
|
|
# Load XML file as a XML string.
|
|
# @param $file Filename
|
|
# @return string
|
|
sub _loadFile {
|
|
my $self = shift;
|
|
my $file = shift;
|
|
local $/ = undef;
|
|
open FILE, $file
|
|
or die "Couldn't open file: $!";
|
|
my $string = <FILE>;
|
|
close FILE;
|
|
return $string;
|
|
}
|
|
|
|
1;
|
|
|