Upgrade to new Gitlab Version 13.9 on Saturday 19th April 20:00. Expect an interruption of about 30 to 60 minutes

default-embedded-wayf.php 11.9 KB
Newer Older
haemmer's avatar
haemmer committed
1
<?php // Copyright (c) 2012, SWITCH - Serving Swiss Universities ?>
haemmer's avatar
haemmer committed
2

haemmer's avatar
haemmer committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<!-- EMBEDDED-WAYF-START -->
<script type="text/javascript"><!--
// To use this JavaScript, please access:
// https://<?php echo $host ?><?php echo $path ?>/embedded-wayf.js/snippet.html
// and copy/paste the resulting HTML snippet to an unprotected web page that 
// you want the embedded WAYF to be displayed


//////////////////// ESSENTIAL SETTINGS ////////////////////

// URL of the WAYF to use
// Examples: "https://wayf.switch.ch/SWITCHaai/WAYF", "https://wayf-test.switch.ch/aaitest/WAYF";
// [Mandatory]
var wayf_URL = "https://<?php echo $host ?><?php echo $path ?>";

// EntityID of the Service Provider that protects this Resource
haemmer's avatar
haemmer committed
19 20
// Value will be overwritten automatically if the page where the Embedded WAYF
// is displayed is called with a GET argument 'entityID' as automatically set by Shibboleth
haemmer's avatar
haemmer committed
21 22 23 24
// Examples: "https://econf.switch.ch/shibboleth", "https://dokeos.unige.ch/shibboleth"
// [Mandatory]
var wayf_sp_entityID = "https://my-app.switch.ch/shibboleth";

25 26
// Shibboleth Service Provider handler URL
// Examples: "https://point.switch.ch/Shibboleth.sso", "https://rr.aai.switch.ch/aaitest/Shibboleth.sso"
haemmer's avatar
haemmer committed
27 28 29
// [Mandatory, if wayf_use_discovery_service = false]
var wayf_sp_handlerURL = "https://my-app.switch.ch/Shibboleth.sso";

haemmer's avatar
haemmer committed
30
// URL on this resource that the user should be returned to after authentication
haemmer's avatar
haemmer committed
31 32 33 34 35 36 37 38
// 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";


//////////////////// RECOMMENDED SETTINGS ////////////////////

// Width of the embedded WAYF in pixels or "auto"
39 40 41
// This is the width of the content only (without padding and border). 
// Add 2 x (10px + 1px) = 22px for padding and border to get the actual 
// width of everything that is drawn.
haemmer's avatar
haemmer committed
42
// [Optional, default: "auto"]
43 44
// Example for fixed size: 
// var wayf_width  = 250;
haemmer's avatar
haemmer committed
45
var wayf_width = "auto";
haemmer's avatar
haemmer committed
46 47

// Height of the embedded WAYF in pixels or "auto"
48 49 50
// This is the height of the content only (without padding and border). 
// Add 2 x (10px + 1px) = 22px for padding and border to get the actual 
// height of everything that is drawn.
haemmer's avatar
haemmer committed
51
// [Optional, default: "auto"]
52 53
// Example for fixed size: 
// var wayf_height = 150;
haemmer's avatar
haemmer committed
54 55 56 57 58 59
var wayf_height = "auto";

// Whether to show the checkbox to remember settings for this session
// [Optional, default: true]
var wayf_show_remember_checkbox = true;

haemmer's avatar
haemmer committed
60 61 62 63 64 65 66
// Force the user's Home Organisation selection to be remembered for the
// current browser session. If wayf_show_remember_checkbox is true
// the checkbox will be shown but will be read only.
// WARNING: Only use this feature if you know exactly what you are doing
//          This option will cause problems that are difficult to find 
//          in case they accidentially select a wrong Home Organisation
// [Optional, false]
67
var wayf_force_remember_for_session = false;
haemmer's avatar
haemmer committed
68

haemmer's avatar
haemmer committed
69
// Logo size
haemmer's avatar
haemmer committed
70
// Choose whether the small or large logo should be used
haemmer's avatar
haemmer committed
71 72 73 74 75 76 77 78 79 80 81 82
// [Optional, default: true]
var wayf_use_small_logo = true;

// Font size
// [Optional, default: 12]
var wayf_font_size = 12;

// Font color
// [Optional, default: #000000]
var wayf_font_color = '#000000';

// Border color
83 84
// [Optional, default: #848484]
var wayf_border_color = '#848484';
haemmer's avatar
haemmer committed
85 86

// Background color
87 88
// [Optional, default: #F0F0F0]
var wayf_background_color = '#F0F0F0';
haemmer's avatar
haemmer committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

// Whether to automatically log in user if he has a session/permanent redirect
// cookie set at central wayf
// [Optional, default: true]
var wayf_auto_login = true;

// Whether to hide the WAYF after the user was logged in
// This requires that the _shib_session_* cookie is set when a user 
// could be authenticated, which is the default case when Shibboleth is used.
// For other Service Provider implementations have a look at the setting
// wayf_check_login_state_function that allows you to customize this
// [Optional, default: true]
var wayf_hide_after_login = true;

// Whether or not to show the categories in the drop-down list
// Possible values are: true or false
// [Optional, default: true]
var wayf_show_categories =  true;

108
// Most used Identity Providers will be shown as top category in the drop down
haemmer's avatar
haemmer committed
109 110
// list if this feature is used.
// [Optional, commented out by default]
111
// var wayf_most_used_idps =  new Array("https://aai-logon.unibas.ch/idp/shibboleth", "https://aai.unil.ch/idp/shibboleth");
haemmer's avatar
haemmer committed
112

haemmer's avatar
haemmer committed
113
// Categories of Identity Provider that should not be shown
haemmer's avatar
haemmer committed
114
// Possible values are: <?php echo $types ?>, "all"
115 116
// Example of how to hide categories
// var wayf_hide_categories =  new Array("other", "library");
haemmer's avatar
haemmer committed
117 118 119
// [Optional, commented out by default]
// var wayf_hide_categories =  new Array();

haemmer's avatar
haemmer committed
120
// EntityIDs of Identity Provider whose category is hidden but that should be shown anyway
haemmer's avatar
haemmer committed
121 122 123
// 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
124
// var wayf_unhide_idps = new Array("https://aai-login.uzh.ch/idp/shibboleth");
haemmer's avatar
haemmer committed
125 126 127
// [Optional, commented out by default]
// var wayf_unhide_idps = new Array();

haemmer's avatar
haemmer committed
128
// EntityIDs of Identity Provider that should not be shown at all
haemmer's avatar
haemmer committed
129
// Example of how to hide certain Identity Provider
130
// var wayf_hide_idps = new Array("https://idp.unige.ch/idp/shibboleth", "https://lewotolo.switch.ch/idp/shibboleth");
haemmer's avatar
haemmer committed
131 132 133 134 135
// [Optional, commented out by default]
// var wayf_hide_idps = new Array();

//////////////////// ADVANCED SETTINGS ////////////////////

136 137 138 139 140 141 142
// Use the SAML2/Shibboleth 2 Discovery Service protocol where
// the user is sent back to the Service Provider after selection
// of his Home Organisation.
// This is true by default and it should only be uncommented and set to false
// if there is a good reason why to use the old and deprecated Shibboleth WAYF
// protocol instead.
// [Optional, default: commented out]
143
// var wayf_use_discovery_service = false;
haemmer's avatar
haemmer committed
144 145

// Session Initiator URL of the Service Provider
146 147
// Examples: "https://econf.switch.ch/Shibboleth.sso/Login", "https://dokeos.unige.ch/Shibboleth.sso/DS"
// This will implicitely be set to wayf_sp_samlDSURL = wayf_sp_handlerURL + "/Login";
haemmer's avatar
haemmer committed
148 149
// or will be set automatically if the page where the Embedded WAYF is placed is called
// with a 'return' and an 'entityID' GET Arguments
haemmer's avatar
haemmer committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
// [Optional, if wayf_use_discovery_service = true 
//  or if wayf_additional_idps is not empty, default: commented out]
// var wayf_sp_samlDSURL = wayf_sp_handlerURL + "/Login";

// Default IdP to preselect when central WAYF couldn't guess IdP either
// This is usually the case the first time ever a user accesses a resource
// [Optional, default: commented out]
// var wayf_default_idp = "https://aai.switch.ch/idp/shibboleth";

// Set a custom Assertion Consumer URL instead of
// the default wayf_sp_handlerURL + '/SAML/POST'
// Only relevant if wayf_use_discovery_service is false
// Examples: "https://olat.uzh.ch/shib/samlaa", 
// This will implicitely be set to wayf_sp_samlACURL = wayf_sp_handlerURL + "/SAML/POST";
// "https://foodle.feide.no/simplesaml/shib13/sp/AssertionConsumerService.php"
// [Optional, commented out by default]
// var wayf_sp_samlACURL = "https://maclh.switch.ch/foo/bar";

// Overwites the text of the checkbox if
// wayf_show_remember_checkbox is set to true
// [Optional, commented out by default]
// var wayf_overwrite_checkbox_label_text = 'Save setting for today';

// Overwrites the text of the submit button
// [Optional, commented out by default]
// var wayf_overwrite_submit_button_text = 'Go';

// Overwrites the intro text above the drop-down list
// [Optional, commented out by default]
// var wayf_overwrite_intro_text = 'Select your Home Organisation to log in';

181 182 183 184 185
// Overwrites the category name of the most used IdP category in the drop-down list
// [Optional, commented out by default]
// var wayf_overwrite_most_used_idps_text = 'Most popular';


haemmer's avatar
haemmer committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
// Whether to hide the WAYF after the user was logged in
// This requires that the _shib_session_* cookie is set when a user 
// could be authenticated
// If you want to hide the embedded WAYF completely, uncomment
// the property and set it to "". This then won't draw anything
// [Optional, default commented out: You are already logged in]
// var wayf_logged_in_messsage = "";

// Provide the name of a JavaScript function that checks whether the user
// already is logged in. The function should return true if the user is logged
// in or false otherwise. If the user is logged in, the Embedded WAYF will
// hide itself or draw a custom message depending on the 
// setting wayf_logged_in_messsage
// The function you specify has of course to be implemented by yourself!
// [Optional, commented out by default]
// var wayf_check_login_state_function = function() { 
// if (# specify user-is-logged-in condition#)
//   return true;
// else 
//   return false;
// }

// EntityIDs, Names and SSO URLs of Identity Providers from other federations 
haemmer's avatar
haemmer committed
209
// that should be added to the drop-down list
haemmer's avatar
haemmer committed
210 211 212 213 214 215 216 217
// The IdPs will be displayed in the sequence they are defined
// [Optional, commented out by default]
// var wayf_additional_idps = [ ];

// Example of how to add Identity Provider from other federations
// var wayf_additional_idps = [ 
//        
//        {name:"International University X",
218
//        entityID:"urn:mace:switch.ch:SWITCHaai:example.university.org",
haemmer's avatar
haemmer committed
219 220 221 222 223 224 225 226
//        SAML1SSOurl:"https://int.univ.org/shibboleth-idp/SSO"},
//
//        {name:"Some Other University",
//        entityID:"https://other.univ.edu/idp/shibboleth",
//        SAML1SSOurl:"https://other.univ.edu/shibboleth-idp/SSO"},
// ];


haemmer's avatar
haemmer committed
227
// Whether to load Identity Providers from the Discovery Feed provided by
228 229 230 231 232 233 234 235
// the Service Provider. 
// IdPs that are not listed in the Discovery Feed and that the SP therefore is 
// not  are able to accept assertions from, are hidden by the Embedded WAYF
// IdPs that are in the Discovery Feed but are unknown to the SWITCHwayf
// are added to the wayf_additional_idps. 
// The list wayf_additional_idps will be sorted alphabetically
// The SP must have configured the discovery feed handler that generates a 
// JSON object. Otherwise it won't generate the JSON data containing the IdPs.
haemmer's avatar
haemmer committed
236
// [Optional, commented out by default]
237
// var wayf_use_disco_feed = true;
haemmer's avatar
haemmer committed
238 239 240

// URL where to load the Discovery Feed from in case wayf_use_disco_feed is true
// [Optional, commented out by default]
241
// var wayf_discofeed_url = "/Shibboleth.sso/DiscoFeed";
haemmer's avatar
haemmer committed
242 243


haemmer's avatar
haemmer committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
//////////////////// ADDITIONAL CSS CUSTOMIZATIONS ////////////////////

// To further customize the appearance of the Embedded WAYF you could
// define CSS rules for the following CSS IDs that are used within the 
// Embedded WAYF:
// #wayf_div                     - Container for complete Embedded WAYF
// #wayf_logo_div                - Container for logo
// #wayf_logo                    - Image for logo
// #wayf_intro_div               - Container of drop-down list intro label
// #wayf_intro_label             - Label of intro text
// #IdPList                      - The form element
// #user_idp                     - Select element for drop-down list
// #wayf_remember_checkbox_div   - Container of checkbox and its label
// #wayf_remember_checkbox       - Checkbox for remembering settings for session
// #wayf_remember_checkbox_label - Text of checkbox
// #wayf_submit_button           - Submit button
//
// Use these CSS IDs carefully and at own risk because future updates could
// interfere with the rules you created and the IDs may change without notice!


//-->
</script>

<script type="text/javascript" src="https://<?php echo $host ?><?php echo $path ?>/embedded-wayf.js"></script>

<noscript>
  <!-- 
haemmer's avatar
haemmer committed
272 273
  Fallback to Shibboleth DS Session Initiator for non-JavaScript users 
  Value of the target GET parameter should be set to an URL-encoded 
haemmer's avatar
haemmer committed
274 275 276 277
  absolute URL that points to a Shibboleth protected web page where the user 
  is logged in into your application.
  -->
  <p>
haemmer's avatar
haemmer committed
278
    <strong>Login:</strong> Javascript is not enabled for your web browser. Please use the <a href="/Shibboleth.sso/Login?target=">non-Javascript Login</a>.
haemmer's avatar
haemmer committed
279 280 281 282
  </p>
</noscript>

<!-- EMBEDDED-WAYF-END -->