diff --git a/README.md b/README.md new file mode 100644 index 0000000..39641a5 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# Metadata Transforms + +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: + +```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. + +## 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 +$ $BIN_DIR/http_xsltproc.sh -h +``` + +Here's an example of script usage: + +```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 + +The executable scripts are compatible with GNU/Linux and Mac OS. The library files are written in XSLT 1.0. + +## Dependencies + +* [Bash Library](https://github.internet2.edu/InCommon/bash-library)