Commit 0e3639a3 authored by haemmer's avatar haemmer

Fixed shall and should

parent ddf0df74
......@@ -120,11 +120,11 @@ XCache is less than 1% because the TLS hand-shake is what consumes most CPU time
-------------------------------------------------------------------------------
SAML2 Metadata support:
In case the WAYF/DS shall display the list of IdPs by parsing them from a
In case the WAYF/DS should display the list of IdPs by parsing them from a
SAML2 Medatadata file that is used by Shibboleth:
- Set $useSAML2Metadata in config.php to true
- Specify the path to the metadata file that shall be read in $metadataFile
- Specify the path to the metadata file that should be read in $metadataFile
and make sure this file is updated regularely by Shibboleth or a cron job
- Make sure the files specified in $metadataIDPFile and $metadataSPFile can be
written by the userthat executes the PHP script (the web server user,
......@@ -137,7 +137,7 @@ general. However, for large numbers of entities an opcode cacher might speed up
execution time considerably (see chapter "Optimization" above) thanks to
this format.
If an entry shall be changed, removed or extended in this automatically
If an entry should changed, removed or extended in this automatically
generated file, one can extend the IDP definitions by modifying them in
the $IDPConfigFile. To overwrite IDP values with entries in the $IDPConfigFile,
make sure the entry $SAML2MetaOverLocalConf is set to 'false';
......@@ -205,7 +205,7 @@ wayf_use_disco_feed might not be used.
-------------------------------------------------------------------------------
Kerberos support:
If this features shall be used the web server needs to support Negotiate/SPNEGO
If this features is used, the web server needs to support Negotiate/SPNEGO
Kerberos protocol. For example by using mod_auth_kerb.
- Make a symlink of the file 'WAYF' and name it like configured in the variable
$kerberosRedirectURL
......@@ -255,7 +255,7 @@ the entry stands for an Identity Provider. For entries of Type category, the
['Type']: Optional Type that is used for the embedded wayf to hide
or show certain categories. Default type will
be 'unknown' if not specified.
An entry for another WAYF/DS that the user shall be
An entry for another WAYF/DS that the user should be
redirected to should have ['Type'] ='wayf
The Type values 'category' and 'wayf' are reserved
words that are not allowed to be assigned to
......
......@@ -12,7 +12,7 @@ $defaultLanguage = 'en';
// 2. Cookie settings
//*******************
// Domain within the WAYF cookei shall be readable. Must start with a .
// Domain within the WAYF cookie should be readable. Must start with a .
$commonDomain = '.switch.ch';
// Optionnal cookie name prefix in case you run several
......@@ -43,7 +43,7 @@ $SPCookieName = $cookieNamePrefix.'_saml_sp';
// cookies
$cookieSecurity = false;
// Number of days longterm cookies shall be valid
// Number of days longterm cookies should be valid
$cookieValidity = 100;
// 3. Features and extensions
......@@ -59,7 +59,7 @@ $useImprovedDropDownList = true;
// metadata file defined below in $metadataFile
$useSAML2Metadata = false;
// If true parsed metadata shall have precedence if there are entries defined
// If true parsed metadata should have precedence if there are entries defined
// in metadata as well as the local IDProviders configuration file.
// Requires $useSAML2Metadata to be true
$SAML2MetaOverLocalConf = false;
......@@ -98,7 +98,7 @@ $useKerberos = false;
$useReverseDNSLookup = false;
// Whether the JavaScript required for embedding the WAYF
// on a remote site shall be generated or not
// on a remote site should be generated or not
// Lowers security against phising!
// If this value is set to true, any web page in the world can
// (with some efforts) find out with a high probability from which
......@@ -155,10 +155,10 @@ $cssURL = 'https://'.$_SERVER['SERVER_NAME'].dirname($_SERVER['SCRIPT_NAME']).'/
// Absolute URL to point to javascript directory
$javascriptURL = 'https://'.$_SERVER['SERVER_NAME'].dirname($_SERVER['SCRIPT_NAME']).'/js';
// Absolute URL to the logo that shall be displayed in the Embedded WAYF
// Absolute URL to the logo that should be displayed in the Embedded WAYF
$logoURL = $imageURL.'/switch-aai-transparent.png';
// Absolute URL to the small logo that shall be displayed in the
// Absolute URL to the small logo that should be displayed in the
// embedded WAYF if dimensions must be small
$smallLogoURL = $imageURL.'/switch-aai-transparent-small.png';
......
......@@ -17,7 +17,7 @@
<input type="checkbox" <?php echo $rememberSelectionChecked ?> name="session" id="rememberForSession" value="true">
<label for="rememberForSession"><?php echo getLocalString('remember_selection') ?></label><br>
<?php if ($showPermanentSetting) : ?>
<!-- Value permanent must be a number which is equivalent to the days the cookie shall be valid -->
<!-- Value permanent must be a number which is equivalent to the days the cookie should be valid -->
<input type="checkbox" name="permanent" id="rememberPermanent" value="100">
<label for="rememberPermanent" /><?php echo getLocalString('permanently_remember_selection') ?></label>
<?php endif ?>
......
......@@ -27,7 +27,7 @@ var wayf_sp_entityID = "https://my-app.switch.ch/shibboleth";
// [Mandatory, if wayf_use_discovery_service = false]
var wayf_sp_handlerURL = "https://my-app.switch.ch/Shibboleth.sso";
// URL on this resource that the user shall be returned to after authentication
// URL on this resource that the user should be returned to after authentication
// Examples: "https://econf.switch.ch/aai/home", "https://olat.uzh.ch/my/courses"
// [Mandatory]
var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome";
......@@ -67,7 +67,7 @@ var wayf_show_remember_checkbox = true;
var wayf_force_remember_for_session = false;
// Logo size
// Choose whether the small or large logo shall be used
// Choose whether the small or large logo should be used
// [Optional, default: true]
var wayf_use_small_logo = true;
......@@ -110,14 +110,14 @@ var wayf_show_categories = true;
// [Optional, commented out by default]
// var wayf_most_used_idps = new Array("https://aai-logon.unibas.ch/idp/shibboleth", "https://aai.unil.ch/idp/shibboleth");
// Categories of Identity Provider that shall not be shown
// Categories of Identity Provider that should not be shown
// Possible values are: <?php echo $types ?>, "all"
// Example of how to hide categories
// var wayf_hide_categories = new Array("other", "library");
// [Optional, commented out by default]
// var wayf_hide_categories = new Array();
// EntityIDs of Identity Provider whose category is hidden but that shall be shown anyway
// EntityIDs of Identity Provider whose category is hidden but that should be shown anyway
// If this array is not empty, wayf_show_categories will be disabled because
// otherwise, unhidden IdPs may be displayed in the wrong category
// Example of how to unhide certain Identity Providers
......@@ -125,7 +125,7 @@ var wayf_show_categories = true;
// [Optional, commented out by default]
// var wayf_unhide_idps = new Array();
// EntityIDs of Identity Provider that shall not be shown at all
// EntityIDs of Identity Provider that should not be shown at all
// Example of how to hide certain Identity Provider
// var wayf_hide_idps = new Array("https://idp.unige.ch/idp/shibboleth", "https://lewotolo.switch.ch/idp/shibboleth");
// [Optional, commented out by default]
......@@ -206,7 +206,7 @@ var wayf_show_categories = true;
// }
// EntityIDs, Names and SSO URLs of Identity Providers from other federations
// that shall be added to the drop-down list
// that should be added to the drop-down list
// The IdPs will be displayed in the sequence they are defined
// [Optional, commented out by default]
// var wayf_additional_idps = [ ];
......
......@@ -12,7 +12,7 @@
</select>
<input type="submit" name="Select" accesskey="s" value="<?php echo getLocalString('save_button') ?>" >
</div>
<!-- Value permanent must be a number which is equivalent to the days the cookie shall be valid -->
<!-- Value permanent must be a number which is equivalent to the days the cookie should be valid -->
<input name="permanent" type="hidden" value="100">
</div>
</form>
......
......@@ -969,13 +969,13 @@ function getGETArgumentSeparator(url){
writeHTML('<div id="wayf_div" style="background:' + wayf_background_color + ';border-style: solid;border-color: ' + wayf_border_color + ';border-width: 1px;padding: 10px; height: ' + wayf_height + ';width: ' + wayf_width + ';text-align: left;overflow: hidden;">');
}
// Shall we display the logo
// Should we display the logo
if (wayf_hide_logo != true){
// Write header of logo div
writeHTML('<div id="wayf_logo_div" style="float: right;"><a href="$federationURL" target="_blank" style="border:0px">');
// Which size of the logo shall we display
// Which size of the logo should we display
if (wayf_use_small_logo){
writeHTML('<img id="wayf_logo" src="{$smallLogoURL}" alt="Federation Logo" style="border:0px">')
} else {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment