From bfb1f0db659c1cb0f01492121423e35133a2e6bb Mon Sep 17 00:00:00 2001 From: trscavo Date: Thu, 13 Oct 2016 18:21:01 -0400 Subject: [PATCH 1/4] Create README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..717362c --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Metadata Transforms + +XSLT transformations of SAML metadata + +## Installation + +Download the source, change directory to the source directory, and install the source into ``/tmp`` as follows: + +```Shell +$ export BIN_DIR=/tmp/bin +$ export LIB_DIR=/tmp/lib +$ ./install.sh $BIN_DIR $LIB_DIR +``` + +or install into your home directory: + +```Shell +$ export BIN_DIR=$HOME/bin +$ export LIB_DIR=$HOME/lib +$ ./install.sh $BIN_DIR $LIB_DIR +``` + +An installation directory will be created if it doesn't already exist. + +## Compatibility + +These scripts are compatible with GNU/Linux and Mac OS. + +## Dependencies + +None From 2418cd183662cea3a945596dcdfa69ea3fe5eaf2 Mon Sep 17 00:00:00 2001 From: trscavo Date: Thu, 13 Oct 2016 19:27:59 -0400 Subject: [PATCH 2/4] Add contents section to README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 717362c..ba1c1d1 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ XSLT transformations of SAML metadata +## Contents + +Executables: + +* http_xsltproc.sh + +Library files: + +* list_all_IdP_DisplayNames_csv.xsl +* list_all_IdPs_csv.xsl +* list_all_RandS_IdPs_csv.xsl +* list_all_RandS_SPs_csv.xsl +* list_all_SPs_csv.xsl + ## Installation Download the source, change directory to the source directory, and install the source into ``/tmp`` as follows: From b5b16269faa10e0409121e2a463cfed5aabd3a9d Mon Sep 17 00:00:00 2001 From: trscavo Date: Thu, 13 Oct 2016 19:48:20 -0400 Subject: [PATCH 3/4] Added overview section to README.md --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ba1c1d1..9fdf3f0 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,35 @@ $ ./install.sh $BIN_DIR $LIB_DIR An installation directory will be created if it doesn't already exist. +## Overview + +Bash script ``http_xsltproc.sh`` is a wrapper around the ``xsltproc`` command-line tool. Unlike ``xsltproc``, this script fetches the target XML document from an HTTP server. See the inline help file for details: + +```Shell +$ http_xsltproc.sh -h +``` + +Here's an example: + +```Shell +$ MD_LOCATION=http://md.incommon.org/InCommon/InCommon-metadata.xml +$ $BIN_DIR/http_xsltproc.sh $LIB_DIR/list_all_IdP_DisplayNames_csv.xsl $MD_LOCATION | head +IdP Display Name,IdP Entity ID,IdP Discovery,Registrar ID +"Ohio State University",urn:mace:incommon:osu.edu,show,https://incommon.org +"Cornell University",https://shibidp.cit.cornell.edu/idp/shibboleth,show,https://incommon.org +"University of California - Office of the President",urn:mace:incommon:ucop.edu,show,https://incommon.org +"University of California-Irvine",urn:mace:incommon:uci.edu,show,https://incommon.org +"University of Washington",urn:mace:incommon:washington.edu,show,https://incommon.org +"Internet2",urn:mace:incommon:internet2.edu,show,https://incommon.org +"University of California-San Diego",urn:mace:incommon:ucsd.edu,show,https://incommon.org +"Georgetown University",https://shibb-idp.georgetown.edu/idp/shibboleth,show,https://incommon.org +"Case Western Reserve University",urn:mace:incommon:case.edu,show,https://incommon.org +``` + ## Compatibility -These scripts are compatible with GNU/Linux and Mac OS. +The executable scripts are compatible with GNU/Linux and Mac OS. The library files are written XSLT 1.0. ## Dependencies -None +* [Bash Library](https://github.internet2.edu/InCommon/bash-library) From 0859943e85f62f1d0f6f940e265abed092513d27 Mon Sep 17 00:00:00 2001 From: Tom Scavo Date: Fri, 14 Oct 2016 12:17:27 -0400 Subject: [PATCH 4/4] Minor edits to README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9fdf3f0..39641a5 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,10 @@ An installation directory will be created if it doesn't already exist. Bash script ``http_xsltproc.sh`` is a wrapper around the ``xsltproc`` command-line tool. Unlike ``xsltproc``, this script fetches the target XML document from an HTTP server. See the inline help file for details: ```Shell -$ http_xsltproc.sh -h +$ $BIN_DIR/http_xsltproc.sh -h ``` -Here's an example: +Here's an example of script usage: ```Shell $ MD_LOCATION=http://md.incommon.org/InCommon/InCommon-metadata.xml @@ -63,7 +63,7 @@ IdP Display Name,IdP Entity ID,IdP Discovery,Registrar ID ## Compatibility -The executable scripts are compatible with GNU/Linux and Mac OS. The library files are written XSLT 1.0. +The executable scripts are compatible with GNU/Linux and Mac OS. The library files are written in XSLT 1.0. ## Dependencies