Merge branch 'release-2.1.0'

Author: athinab

CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [v2.1.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.0.0...v2.1.0) - 2018-10-18
+
+### Added
+- Add banner and an extra view for cookies options
+- Add corner ribbon that displays customisable text
+- Add this changelog file
+- Module discopower: Add style rules and logos for the buttons of the IdPs:
+  - eduTEAMS
+  - EGI
+  - Aria
+
+### Changed
+  - Change vanilla logo and favicon
+  - Move wording and links from the templates of several modules to the related
+    definition file
+  - Render header logo link url customisable
+
+## [v2.0.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v1.0.0...v2.0.0) - 2018-04-17
+
+### Added
+- Module discopower:
+  - Add style rules and logos for the IdPs:
+    - B2ACCESS
+    - DARIAH
+    - Elixir
+    - IGTF
+  - Support customisable order of IdPs' groups based on the existing mechanism of
+  discopower.
+
+### Changed
+- Module discopower: Support only 2 tags for the grouping of IdPs.
+- Module userid: Add content in the error template.
+
+### Fixed
+- Use the translated name to display an IdP.
+
+
+## [v1.0.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v0.1.0...v1.0.0) - 2018-01-19
+
+### Added
+- Use SASS for the added style rules.
+- Use Bootstrap v3.3.7.
+- Add support for error pages that are produced from several modules.
+- Add detailed instructions for the installation procedures.
+- Document configuration options.
+- Module discopower: Add enhanced style for the following  IdPs' buttons:
+  - Facebook
+  - Google
+  - LinkedIn
+  - ORCID
+
+### Changed
+- Change the look n feel of several SimpleSAMLphp modules:
+  - authX509
+  - authorize
+  - consent
+  - core
+  - default
+  - discopower
+  - userid
+- Module discopower: Replace the section that includes the edugain IdPs with a section that lists all IdPs.
+- Improve responsiveness of the layout.
+- Enhance the customization of the theme.
+
+
+
+## [v0.1.0](https://github.com/rciam/simplesamlphp-module-themevanilla/commits/v0.1.0) - 2018-01-12
+
+### Added
+Create a new theme for SimpleSAMLphp. The goal is to improve the experience for
+people that login to services through multiple identity providers.

README.md

@@ -98,6 +98,14 @@ directories (`js.zip` and `css.zip`) from the [release page](https://github.com/
 extract them under `modules/themevanilla/www/resources`.  If you want to produce
 them, you may read the customisation instructions below.
 
+### Cookie Policy
+
+In order to use Cookie Policy page you must copy the configuration file
+from the `config-example` folder to core config directory.
+```
+cp <path-to-module>/config-example/module_themevanilla.php <path-to-simplesamlphp>/config
+```
+
 
 ## Configuration
 
@@ -143,8 +151,11 @@ To set style rules for the each button, the configured css_classname value must
 be defined in the `idps_buttons.scss` file. See more information bellow.
 
 At the moment there are style rules for the IdPs:
+* ARIA
 * B2ACCESS
+* Check-in
 * DARIAH
+* eduTEAMS
 * Elixir
 * Facebook
 * Google
@@ -162,17 +173,28 @@ You can find definitions and dictionaries in the `dictionaries` directory.
 ### Images
 
 Place your logo and favicon in the directory:
-`themevanilla/www/resources/images` If you name them `logo.png` and
+`themevanilla/www/resources/images` If you name them `logo.jpg` and
 `favicon.ico` they will be loaded without any other modification.  If you name
 them differently you need to modify the template `header.php` that is placed in:
 `themevanilla/themes/ssp/default/includes/`.
 
 By default, the logo has height 60px. See below how you can modify it.
 
+### Header logo link
+
+You can customise the url of the link of the logo in the header by changing
+the `logo_link_url` definition in `dictionaries/default.definition.json` file.
+
 ### Footer
 If you want to make any changes in the footer you need to modify the template
 `footer.php` that is placed in: `themevanilla/themes/ssp/default/includes/`.
 
+### Header ribbon
+
+The text in the header ribbon can be altered by changing the `ribbon_text`
+definition in `dictionaries/default.definition.json` file.
+If you want to hide the ribbon, set `ribbon_text` to `""`.
+
 ### CSS
 
 To produce the css files for this theme follow these steps:
@@ -208,6 +230,13 @@ mentioned above.
 Please, check the help page of the cli tool sass if you want to use more
 compiling options.
 
+### Cookie Policy
+
+To modify the cookie banner and cookie policy page, you must edit the following files:
+`<path-to-module>/dictionaries/policy.definition.json`
+and to modify the table in cookie policy page:
+`<path-to-simplesamlphp>/config/module_themevanilla.php`
+
 
 ## About SimpleSAMLphp themes
 

config-example/module_themevanilla.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * This is example configuration of SimpleSAMLphp themevanila.
+ * Copy this file to default config directory and edit the properties.
+ *
+ * copy command (from SimpleSAML base dir)
+ * cp modules/themevanilla/module_themevanilla.php config/
+ */
+$config = array(
+    'cookiePolicy' => array(
+        array('type' => 'Session State', 'provider' => 'aai.rciam.eu', 'name' => 'rciam_proxy_authtoken, rciam_google_proxy_authtoken, rciam_google_proxy_authtoken, rciam_facebook_proxy_authtoken, rciam_linkedin_proxy_authtoken, rciam_orcid_proxy_authtoken', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve user authentication token to prevent session fixation attacks'),
+        array('type' => 'Session State', 'provider' => 'aai.rciam.eu', 'name' => 'rciam_proxy_sid, rciam_google_proxy_sid, rciam_google_proxy_sid, rciam_facebook_proxy_sid, rciam_linkedin_proxy_sid, rciam_orcid_proxy_sid', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve user session ID to retrieve session information'),
+        array('type' => 'Preferences', 'provider' => 'aai.rciam.eu', 'name' => 'rciam_poweridpdisco_lastidp', 'thirdParty' => false, 'category' => 'Persistent', 'purpose' => 'Preserve preferred IdP selection for SimpleSAMLphp IdP discovery service'),
+        array('type' => 'Preferences', 'provider' => 'aai.rciam.eu', 'name' => 'rciam_poweridpdisco_remember', 'thirdParty' => false, 'category' => 'Persistent', 'purpose' => 'Preserve preference whether to remember IdP selection for SimpleSAMLphp IdP discovery service'),
+        array('type' => 'Session State', 'provider' => 'aai.rciam.eu', 'name' => 'rciam_co_registry_sid', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve user session ID to retrieve session information'),
+        array('type' => 'Preferences', 'provider' => 'aai.rciam.eu', 'name' => 'rciam_co_registry_tz', 'thirdParty' => false, 'category' => 'Persistent', 'purpose' => 'Preserve preferred timezone selection for COmanage RCIAM Account Registry'),
+        array('type' => 'Preferences', 'provider' => 'aai.rciam.eu', 'name' => 'i18next', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve preferred language for RCIAM AAI OpenID Connect Provider'),
+        array('type' => 'Session State', 'provider' => 'aai.rciam.eu', 'name' => 'JSESSIONID', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve user session ID to retrieve session information')
+    )
+);
+
+?>

dictionaries/default.definition.json

@@ -1,8 +1,17 @@
 {
+  "browser_tab_title": {
+    "en": "SimpleSAMLphp"
+  },
   "header_title": {
     "en": "Identity Access Management for Research Communities"
   },
   "header_subtitle": {
     "en": "Use the same credentials for all our services"
+  },
+  "logo_link_url": {
+    "en": "https://www.example.com"
+  },
+  "ribbon_text": {
+    "en": "Demo"
   }
 }

dictionaries/discopower.definition.json

@@ -10,5 +10,20 @@
   },
   "favourite_dialog_button_close": {
     "en": "Choose another account"
+  },
+  "copyright_year_start": {
+    "en": "2016"
+  },
+  "cookies_link_text": {
+    "en": "updated privacy policy and cookie policy."
+  },
+  "cookies_text": {
+    "en": "We use cookies to identify you, thereby enabling us to grant you access to the services and resources provided by the Infrastructure, and also to improve your experience on our site. To find out more, read our "
+  },
+  "cookies_accept_btn_text": {
+    "en": "OK"
+  },
+  "cookies_link_url": {
+    "en": "../themevanilla/policy.php"
   }
 }

dictionaries/policy.definition.json

@@ -0,0 +1,50 @@
+{
+	"page_title": {
+		"en": "Cookie Policy"
+	},
+	"purpose_head": {
+		"en": "<strong>Purpose of this cookie policy<\/strong>"
+	},
+	"purpose_body": {
+		"en": "<p>This Website uses technologies such as \"cookies\" and \"pixel tags\". By browsing the webpage, the User agrees to the creation and use of cookies. If User does not wish to consent to the use of cookies, User may either disable them or discontinue browsing this webpage.<\/p><p>For the purpose of this Policy, the following terms shall have the following meaning:<\/p><p>\"<strong><em>Cookie\" or \"Cookies<\/em><\/strong>\": Cookies are small text or message files sent from the server of an organization and stored on your computer. Cookies do not have access to data stored on your computer's hard disk or to Cookies placed by other websites, and they may not harm or damage your system.</p><ul><li>\"<em>Persistence cookies<\/em>\" remain during multiple website visits and get stored on your hard disk.<\/li><li>\"<em>Session Cookies<\/em>\" are temporary cookies that disappear automatically after you leave a website; or<\/li><li>\"<em>Third Party Cookies<\/em>\" these are cookies used by the websites of our partners, as integrated in our own Website or used by websites, we link to.<\/li><\/ul>"
+	},
+	"cookie_list_head": {
+		"en": "<strong> Which cookies are placed on your device when using our Website?<\/strong>"
+	},
+	"cookie_list_body": {
+		"en": "<p>When you access and\/or use the Website, we place one or more Cookies on your device for the purposes described herein.<\/p><p>The following table and relevant information set out the cookies used for the Website. It also provides details of third parties setting cookies:<\/p>"
+	},
+	"endurance_head": {
+		"en": "<strong> How long are cookies stored on your device?<\/strong>"
+	},
+	"endurance_body": {
+		"en": "<p>The duration for which a cookie will be stored on your browsing device depends on whether it is a \"persistence\" or a \"session\" cookie. Session cookies will be stored on a device until you turn off your web browser. \"Persistence cookies\" shall remain on your device after you have finished browsing until they expire or until they are deleted by you<\/p>"
+	},
+	"disable_cookie_head": {
+		"en": "<strong> How can you disable cookies that have been placed on your device?<\/strong>"
+	},
+	"disable_cookie_body": {
+		"en": "<p>You can usually use your web browser to enable, disable, or delete cookies. To do so, follow the instructions provided for by your web browser (usually located in the \"Help\", \"Tools\" or \"Edit\" settings). You can also set your web browser to reject all cookies or to indicate when a cookie is being sent.<\/p>"
+	},
+	"note": {
+		"en": "<p><em>Cookies are important for identifying you, thereby enabling us to grant you access to the RCIAM service and other Infrastructure services and for optimizing your browsing experience. <\/em><\/p>"
+	},
+	"table_type": {
+		"en": "Cookie Type"
+	},
+	"table_provider": {
+		"en": "Cookie Provider"
+	},
+	"table_name": {
+		"en": "Cookie Name"
+	},
+	"table_third_party": {
+		"en": "Third party Cookie"
+	},
+	"table_category": {
+		"en": "Persistent or session Cookie"
+	},
+	"table_purpose": {
+		"en": "Purpose of Cookie"
+	}
+}