metarefresh.php File Reference

Go to the source code of this file.

Functions
	printHelp ()
	This function prints the help output. More...

Variables
	$baseDir = dirname(dirname(dirname(dirname(__FILE__))))
if(!SimpleSAML\Module::isModuleEnabled('metarefresh'))	$configdir = SimpleSAML\Utils\Config::getConfigDir()
	$outputDir = $baseDir . '/metadata-generated'
	$toStdOut = FALSE
	$certificates = NULL
	$validateFingerprint = NULL
	$files = array()
	$progName = array_shift($argv)
foreach( $argv as $a) if(count($files)===0)	$metaloader = new sspmod_metarefresh_MetaLoader()
foreach( $files as $f) if($toStdOut)	else

Function Documentation

printHelp()

printHelp

(

)

This function prints the help output.

Definition at line 149 of file metarefresh.php.

                     {
        global $progName;
 
        /*   '======================================================================' */
        echo('Usage: ' . $progName . ' [options] [files]' . "\n");
        echo("\n");
        echo('This program parses a SAML metadata files and output pieces that can' . "\n");
        echo('be added to the metadata files in metadata/.' . "\n");
        echo("\n");
        echo('Options:' . "\n");
        echo(' --certificate=<FILE>         The certificate which should be used' . "\n");
        echo('                              to check the signature of the metadata.' . "\n");
        echo('                              The file are stored in the cert dir.' . "\n");
        echo('                              It is possibility to add multiple' . "\n");
        echo('                              --certificate options to handle' . "\n");
        echo('                              key rollover.' . "\n");
        echo(' --validate-fingerprint=<FINGERPRINT>' . "\n");
        echo('                              Check the signature of the metadata,' . "\n");
        echo('                              and check the fingerprint of the' . "\n");
        echo('                              certificate against <FINGERPRINT>.' . "\n");
        echo(' -h, --help                   Print this help.' . "\n");
        echo(' -o=<DIR>, --out-dir=<DIR>    Write the output to this directory. The' . "\n");
        echo('                              default directory is metadata-generated/.' . "\n");
        echo('                              Path will be relative to the SimpleSAMLphp' . "\n");
        echo('                              base directory.' . "\n");
        echo(' -s, --stdout                 Write the output to stdout instead of' . "\n");
        echo('                              seperate files in the output directory.' . "\n");
        echo("\n");
}

References $progName.

Variable Documentation

$baseDir

$baseDir = dirname(dirname(dirname(dirname(__FILE__))))

Definition at line 11 of file metarefresh.php.

$certificates

$certificates = NULL

Definition at line 39 of file metarefresh.php.

Referenced by sspmod_saml_Message\checkSign(), sspmod_saml_Message\findCertificate(), SAML2\Assertion\getCertificates(), SAML2\Message\getCertificates(), SAML2\SignedElementHelper\getCertificates(), SAML2\Utils\insertSignature(), SAML2\Assertion\setCertificates(), SAML2\Message\setCertificates(), SAML2\SignedElementHelper\setCertificates(), and SimpleSAML_Metadata_SAMLParser\validateSignature().

$configdir

if (!SimpleSAML\Module::isModuleEnabled( 'metarefresh')) $configdir = SimpleSAML\Utils\Config::getConfigDir()

Definition at line 24 of file metarefresh.php.

$files

$files = array()

Definition at line 49 of file metarefresh.php.

$metaloader

foreach($argv as $a) if (count( $files)===0) $metaloader = new sspmod_metarefresh_MetaLoader()

Definition at line 131 of file metarefresh.php.

Referenced by metarefresh_hook_cron().

$outputDir

$outputDir = $baseDir . '/metadata-generated'

Definition at line 28 of file metarefresh.php.

Referenced by metarefresh_hook_cron(), and sspmod_metarefresh_MetaLoader\writeMetadataFiles().

$progName

$progName = array_shift($argv)

Definition at line 53 of file metarefresh.php.

Referenced by printHelp().

$toStdOut

$toStdOut = FALSE

Definition at line 34 of file metarefresh.php.

$validateFingerprint

$validateFingerprint = NULL

Definition at line 45 of file metarefresh.php.

else

foreach($files as $f) if ( $toStdOut) else

Initial value:

{
        $metaloader->writeMetadataFiles($outputDir)

Definition at line 142 of file metarefresh.php.