Skip to content

Commit 18d9668

Browse files
committed
Merge branch 'release-2.1.0'
2 parents 52b63b3 + ef1e66d commit 18d9668

31 files changed

+1685
-23
lines changed

CHANGELOG.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
8+
## [v2.1.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.0.0...v2.1.0) - 2018-10-18
9+
10+
### Added
11+
- Add banner and an extra view for cookies options
12+
- Add corner ribbon that displays customisable text
13+
- Add this changelog file
14+
- Module discopower: Add style rules and logos for the buttons of the IdPs:
15+
- eduTEAMS
16+
- EGI
17+
- Aria
18+
19+
### Changed
20+
- Change vanilla logo and favicon
21+
- Move wording and links from the templates of several modules to the related
22+
definition file
23+
- Render header logo link url customisable
24+
25+
## [v2.0.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v1.0.0...v2.0.0) - 2018-04-17
26+
27+
### Added
28+
- Module discopower:
29+
- Add style rules and logos for the IdPs:
30+
- B2ACCESS
31+
- DARIAH
32+
- Elixir
33+
- IGTF
34+
- Support customisable order of IdPs' groups based on the existing mechanism of
35+
discopower.
36+
37+
### Changed
38+
- Module discopower: Support only 2 tags for the grouping of IdPs.
39+
- Module userid: Add content in the error template.
40+
41+
### Fixed
42+
- Use the translated name to display an IdP.
43+
44+
45+
## [v1.0.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v0.1.0...v1.0.0) - 2018-01-19
46+
47+
### Added
48+
- Use SASS for the added style rules.
49+
- Use Bootstrap v3.3.7.
50+
- Add support for error pages that are produced from several modules.
51+
- Add detailed instructions for the installation procedures.
52+
- Document configuration options.
53+
- Module discopower: Add enhanced style for the following IdPs' buttons:
54+
- Facebook
55+
- Google
56+
- LinkedIn
57+
- ORCID
58+
59+
### Changed
60+
- Change the look n feel of several SimpleSAMLphp modules:
61+
- authX509
62+
- authorize
63+
- consent
64+
- core
65+
- default
66+
- discopower
67+
- userid
68+
- Module discopower: Replace the section that includes the edugain IdPs with a section that lists all IdPs.
69+
- Improve responsiveness of the layout.
70+
- Enhance the customization of the theme.
71+
72+
73+
74+
## [v0.1.0](https://github.com/rciam/simplesamlphp-module-themevanilla/commits/v0.1.0) - 2018-01-12
75+
76+
### Added
77+
Create a new theme for SimpleSAMLphp. The goal is to improve the experience for
78+
people that login to services through multiple identity providers.

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,14 @@ directories (`js.zip` and `css.zip`) from the [release page](https://github.com/
9898
extract them under `modules/themevanilla/www/resources`. If you want to produce
9999
them, you may read the customisation instructions below.
100100

101+
### Cookie Policy
102+
103+
In order to use Cookie Policy page you must copy the configuration file
104+
from the `config-example` folder to core config directory.
105+
```
106+
cp <path-to-module>/config-example/module_themevanilla.php <path-to-simplesamlphp>/config
107+
```
108+
101109

102110
## Configuration
103111

@@ -143,8 +151,11 @@ To set style rules for the each button, the configured css_classname value must
143151
be defined in the `idps_buttons.scss` file. See more information bellow.
144152

145153
At the moment there are style rules for the IdPs:
154+
* ARIA
146155
* B2ACCESS
156+
* Check-in
147157
* DARIAH
158+
* eduTEAMS
148159
* Elixir
149160
* Facebook
150161
* Google
@@ -162,17 +173,28 @@ You can find definitions and dictionaries in the `dictionaries` directory.
162173
### Images
163174

164175
Place your logo and favicon in the directory:
165-
`themevanilla/www/resources/images` If you name them `logo.png` and
176+
`themevanilla/www/resources/images` If you name them `logo.jpg` and
166177
`favicon.ico` they will be loaded without any other modification. If you name
167178
them differently you need to modify the template `header.php` that is placed in:
168179
`themevanilla/themes/ssp/default/includes/`.
169180

170181
By default, the logo has height 60px. See below how you can modify it.
171182

183+
### Header logo link
184+
185+
You can customise the url of the link of the logo in the header by changing
186+
the `logo_link_url` definition in `dictionaries/default.definition.json` file.
187+
172188
### Footer
173189
If you want to make any changes in the footer you need to modify the template
174190
`footer.php` that is placed in: `themevanilla/themes/ssp/default/includes/`.
175191

192+
### Header ribbon
193+
194+
The text in the header ribbon can be altered by changing the `ribbon_text`
195+
definition in `dictionaries/default.definition.json` file.
196+
If you want to hide the ribbon, set `ribbon_text` to `""`.
197+
176198
### CSS
177199

178200
To produce the css files for this theme follow these steps:
@@ -208,6 +230,13 @@ mentioned above.
208230
Please, check the help page of the cli tool sass if you want to use more
209231
compiling options.
210232

233+
### Cookie Policy
234+
235+
To modify the cookie banner and cookie policy page, you must edit the following files:
236+
`<path-to-module>/dictionaries/policy.definition.json`
237+
and to modify the table in cookie policy page:
238+
`<path-to-simplesamlphp>/config/module_themevanilla.php`
239+
211240

212241
## About SimpleSAMLphp themes
213242

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
/**
3+
* This is example configuration of SimpleSAMLphp themevanila.
4+
* Copy this file to default config directory and edit the properties.
5+
*
6+
* copy command (from SimpleSAML base dir)
7+
* cp modules/themevanilla/module_themevanilla.php config/
8+
*/
9+
$config = array(
10+
'cookiePolicy' => array(
11+
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'),
12+
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'),
13+
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'),
14+
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'),
15+
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'),
16+
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'),
17+
array('type' => 'Preferences', 'provider' => 'aai.rciam.eu', 'name' => 'i18next', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve preferred language for RCIAM AAI OpenID Connect Provider'),
18+
array('type' => 'Session State', 'provider' => 'aai.rciam.eu', 'name' => 'JSESSIONID', 'thirdParty' => false, 'category' => 'Session', 'purpose' => 'Preserve user session ID to retrieve session information')
19+
)
20+
);
21+
22+
?>
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
{
2+
"browser_tab_title": {
3+
"en": "SimpleSAMLphp"
4+
},
25
"header_title": {
36
"en": "Identity Access Management for Research Communities"
47
},
58
"header_subtitle": {
69
"en": "Use the same credentials for all our services"
10+
},
11+
"logo_link_url": {
12+
"en": "https://www.example.com"
13+
},
14+
"ribbon_text": {
15+
"en": "Demo"
716
}
817
}

dictionaries/discopower.definition.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,20 @@
1010
},
1111
"favourite_dialog_button_close": {
1212
"en": "Choose another account"
13+
},
14+
"copyright_year_start": {
15+
"en": "2016"
16+
},
17+
"cookies_link_text": {
18+
"en": "updated privacy policy and cookie policy."
19+
},
20+
"cookies_text": {
21+
"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 "
22+
},
23+
"cookies_accept_btn_text": {
24+
"en": "OK"
25+
},
26+
"cookies_link_url": {
27+
"en": "../themevanilla/policy.php"
1328
}
1429
}
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"page_title": {
3+
"en": "Cookie Policy"
4+
},
5+
"purpose_head": {
6+
"en": "<strong>Purpose of this cookie policy<\/strong>"
7+
},
8+
"purpose_body": {
9+
"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>"
10+
},
11+
"cookie_list_head": {
12+
"en": "<strong> Which cookies are placed on your device when using our Website?<\/strong>"
13+
},
14+
"cookie_list_body": {
15+
"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>"
16+
},
17+
"endurance_head": {
18+
"en": "<strong> How long are cookies stored on your device?<\/strong>"
19+
},
20+
"endurance_body": {
21+
"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>"
22+
},
23+
"disable_cookie_head": {
24+
"en": "<strong> How can you disable cookies that have been placed on your device?<\/strong>"
25+
},
26+
"disable_cookie_body": {
27+
"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>"
28+
},
29+
"note": {
30+
"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>"
31+
},
32+
"table_type": {
33+
"en": "Cookie Type"
34+
},
35+
"table_provider": {
36+
"en": "Cookie Provider"
37+
},
38+
"table_name": {
39+
"en": "Cookie Name"
40+
},
41+
"table_third_party": {
42+
"en": "Third party Cookie"
43+
},
44+
"table_category": {
45+
"en": "Persistent or session Cookie"
46+
},
47+
"table_purpose": {
48+
"en": "Purpose of Cookie"
49+
}
50+
}
-128 KB
Loading
8.93 KB
Loading

screenshots/consent_overall.png

-121 KB
Loading
-98.1 KB
Loading

0 commit comments

Comments
 (0)