From b961c37937302efedbd410f7895e22c7a1acdf61 Mon Sep 17 00:00:00 2001
From: Alex Stuart <Alex.Stuart@ed.ac.uk>
Date: Wed, 15 Jan 2014 12:53:25 +0000
Subject: [PATCH] Added metadata query tool. Outputs simple information about
 entities, and can discriminate on the registrationAuthority.

---
 build/query-entities.pl | 165 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 165 insertions(+)
 create mode 100755 build/query-entities.pl

diff --git a/build/query-entities.pl b/build/query-entities.pl
new file mode 100755
index 00000000..36278552
--- /dev/null
+++ b/build/query-entities.pl
@@ -0,0 +1,165 @@
+#!/usr/bin/perl -w
+#
+# Query tool for showing information about entities in a SAML metadata aggregate.
+# Useful when there are multiple registration authorities.
+#
+use strict;
+use Getopt::Long;
+use XML::Twig;
+$| = 1;
+
+my $DEBUG;
+$DEBUG = 0;
+
+sub help {
+	print<<'EOF';
+
+usage: entities.pl [--help] [--idp] [--sp] [--reg <registrationAuthority>] [--notreg <registrationAuthority>] <file>
+
+Outputs the entityID and display name(s) of a entities in the supplied file.
+
+--help			- prints this help and exits
+
+--idp 			- only outputs IdPs
+--sp			- only outputs SPs
+	(By default the script outputs all IdP and SP entities)
+
+--reg <registrationAuthority>		- outputs entities registered by registrationAuthority
+--notreg <registrationAuthority>	- outputs those entities NOT registered by registrationAuthority
+	(By default the script outputs all entities; can only have one of -reg or -notreg)
+
+EOF
+}
+
+my $idp;
+my $sp;
+my $reg;
+my $notreg;
+my $help;
+
+my $result = GetOptions(
+		"idp" => \$idp,
+		"sp" => \$sp,	
+		"reg=s" => \$reg,
+		"notreg=s" => \$notreg,
+		"help=s" => \$help,
+		);
+
+if ($help) {
+	help();
+	exit 0;
+}
+
+#
+# Input checking
+#
+
+if (!$ARGV[0]) {
+	print "\nError: you must define an input file\n";
+	help();
+	exit 1;
+}
+
+if ( ! -r $ARGV[0] ) {
+	print "\nError: input file $ARGV[0] must be readable\n";
+	help();
+	exit 2;
+}
+
+my $infile = $ARGV[0];
+
+# If no IdP/SP descriminator set, 
+if ( ! $idp && ! $sp ) { $idp = 1; $sp = 1; }
+
+# Can only have one of -reg and -notreg set
+if ( $reg && $notreg ) {
+	print "\nError: can only have one of --reg and --notreg set at the same time\n";
+	help();
+	exit 3;
+}
+
+#
+# Debug printing of input flags
+#
+if ($DEBUG) {
+	if ($idp) { print "idp: $idp\n"; }
+	if ($sp) { print "sp: $sp\n"; }
+	if ($reg) { print "reg: $reg\n"; }
+	if ($notreg) { print "notreg: $notreg\n"; }
+}
+
+#
+# Get contents of file
+#
+my $xml;
+$DEBUG && print "input file: $infile\n";
+open(FILE, $infile) || die "Error: could not open $infile";
+while (<FILE>) { $xml .= $_; }
+close FILE;
+if (!length $xml) {
+	print "Error: length of file $infile is zero\n";
+	exit 4;
+}
+
+my $twig = XML::Twig->new(
+		pretty_print => "indented",
+		twig_handlers =>
+		{
+			'EntityDescriptor' => \&is_entity
+		},
+	);
+$twig->parse($xml);
+
+sub is_entity () {
+	my ($t, $section)= @_;
+	my ($entityID, $ODN, $MDUI, $URL, $registrationAuthority, $type, $temp);
+
+	$entityID = "No entityID found";
+	$entityID = $section->{'att'}->{'entityID'};
+
+	$ODN = "No OrganizationDisplayName found";
+	$URL = "No URL found";	
+	# Turns out the Organization element is optional
+	if ( $section->first_child('Organization') ) {
+		if ( $section->first_child('Organization')->first_child('OrganizationDisplayName[@xml:lang="en"]') ) {
+			if ( $temp = $section->first_child('Organization')->first_child('OrganizationDisplayName[@xml:lang="en"]')->text) {
+				$ODN = $temp;
+			}
+		}
+		if ( $section->first_child('Organization')->first_child('OrganizationURL') ) {
+			if ( $temp = $section->first_child('Organization')->first_child('OrganizationURL')->text) {
+				$URL = $temp;
+			}
+		}	
+	}
+	
+	$MDUI = "No MDUI display name found";
+	
+	$registrationAuthority = "No registrationAuthority found";
+	if ( $temp = $section->first_child('Extensions')->first_child('mdrpi:RegistrationInfo')->{'att'}->{'registrationAuthority'} ) {
+		$registrationAuthority = $temp;
+	}
+	
+	if ( $notreg && $notreg eq $registrationAuthority ) { return; }
+	if ( $reg && $reg ne $registrationAuthority ) { return; }
+
+	$type = "Unknown";
+	if ( $section->first_child('IDPSSODescriptor') ) { $type = "IdP"; }
+	if ( $section->first_child('SPSSODescriptor') ) { $type = "SP"; }	
+
+	if ( ($sp && $type eq "SP") || ($idp && $type eq "IdP") ) {
+
+# This is crying out for object-orientation and/or a MVC framework
+#	print "---------------------------------\n";
+#	print "entityID: $entityID\n";
+#	print "OrganzationDisplayName: $ODN\n";
+##	print "MDUI display name: $MDUI\n";
+#	print "OrganizationURL: $URL\n";
+#	print "registrationAuthority: $registrationAuthority\n";
+#	print "type: $type\n";
+	
+	# ... however CSV is the file format of the future :)
+	print "$type, $entityID, $registrationAuthority, \"$ODN\", $URL\n"
+	
+	}
+}