Skip to content

Commit 020e575

Browse files
authored
Session prefix (#2859)
* Added mention about session renaming * Renamed session examples * Fixed name
1 parent 65e8c85 commit 020e575

File tree

4 files changed

+20
-13
lines changed

4 files changed

+20
-13
lines changed

docs/api/rest_api/rest_api_authentication.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,14 @@ To create a session, execute the following REST request:
7070
```
7171
HTTP/1.1 201 Created
7272
Location: /user/sessions/go327ij2cirpo59pb6rrv2a4el2
73-
Set-Cookie: eZSESSID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2; domain=.example.net; path=/; expires=Wed, 13-Jan-2021 22:23:01 GMT; HttpOnly
73+
Set-Cookie: IBX_SESSION_ID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2; domain=.example.net; path=/; expires=Wed, 13-Jan-2021 22:23:01 GMT; HttpOnly
7474
Content-Type: application/vnd.ibexa.api.Session+xml
7575
```
7676

7777
```xml
7878
<?xml version="1.0" encoding="UTF-8"?>
7979
<Session href="/user/sessions/sessionID" media-type="application/vnd.ibexa.api.Session+xml">
80-
<name>eZSESSID98defd6ee70dfb1dea416</name>
80+
<name>IBX_SESSION_ID98defd6ee70dfb1dea416</name>
8181
<identifier>go327ij2cirpo59pb6rrv2a4el2</identifier>
8282
<csrfToken>23lk.neri34ijajedfw39orj-3j93</csrfToken>
8383
<User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/>
@@ -105,7 +105,7 @@ To create a session, execute the following REST request:
105105
```
106106
HTTP/1.1 201 Created
107107
Location: /user/sessions/go327ij2cirpo59pb6rrv2a4el2
108-
Set-Cookie: eZSESSID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2; domain=.example.net; path=/; expires=Wed, 13-Jan-2021 22:23:01 GMT; HttpOnly
108+
Set-Cookie: IBX_SESSION_ID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2; domain=.example.net; path=/; expires=Wed, 13-Jan-2021 22:23:01 GMT; HttpOnly
109109
Content-Type: application/vnd.ibexa.api.Session+xml
110110
```
111111

@@ -114,7 +114,7 @@ To create a session, execute the following REST request:
114114
"Session": {
115115
"_media-type": "application\/vnd.ibexa.api.Session+json",
116116
"_href": "\/api\/ibexa\/v2\/user\/sessions\/jg1nhinvepsb9ivd10hbjbdp4l",
117-
"name": "eZSESSID98defd6ee70dfb1dea416",
117+
"name": "IBX_SESSION_ID98defd6ee70dfb1dea416",
118118
"identifier": "go327ij2cirpo59pb6rrv2a4el2",
119119
"csrfToken": "23lk.neri34ijajedfw39orj-3j93",
120120
"User": {
@@ -136,7 +136,7 @@ Logging in is similar to session creation, with one important detail: the CSRF t
136136
Host: www.example.net
137137
Accept: application/vnd.ibexa.api.Session+xml
138138
Content-Type: application/vnd.ibexa.api.SessionInput+xml
139-
Cookie: eZSESSID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
139+
Cookie: IBX_SESSION_ID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
140140
X-CSRF-Token: 23lk.neri34ijajedfw39orj-3j93
141141
```
142142

@@ -156,7 +156,7 @@ Logging in is similar to session creation, with one important detail: the CSRF t
156156
```xml
157157
<?xml version="1.0" encoding="UTF-8"?>
158158
<Session href="user/sessions/go327ij2cirpo59pb6rrv2a4el2/refresh" media-type="application/vnd.ibexa.api.Session+xml">
159-
<name>eZSESSID98defd6ee70dfb1dea416</name>
159+
<name>IBX_SESSION_ID98defd6ee70dfb1dea416</name>
160160
<identifier>go327ij2cirpo59pb6rrv2a4el2</identifier>
161161
<csrfToken>23lk.neri34ijajedfw39orj-3j93</csrfToken>
162162
<User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/>
@@ -170,7 +170,7 @@ Logging in is similar to session creation, with one important detail: the CSRF t
170170
Host: www.example.net
171171
Accept: application/vnd.ibexa.api.Session+json
172172
Content-Type: application/vnd.ibexa.api.SessionInput+json
173-
Cookie: eZSESSID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
173+
Cookie: IBX_SESSION_ID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
174174
X-CSRF-Token: 23lk.neri34ijajedfw39orj-3j93
175175
```
176176

@@ -193,7 +193,7 @@ Logging in is similar to session creation, with one important detail: the CSRF t
193193
"Session": {
194194
"_media-type": "application\/vnd.ibexa.api.Session+json",
195195
"_href": "\/api\/ibexa\/v2\/user\/sessions\/jg1nhinvepsb9ivd10hbjbdp4l",
196-
"name": "eZSESSID98defd6ee70dfb1dea416",
196+
"name": "IBX_SESSION_ID98defd6ee70dfb1dea416",
197197
"identifier": "go327ij2cirpo59pb6rrv2a4el2",
198198
"csrfToken": "23lk.neri34ijajedfw39orj-3j93",
199199
"User": {
@@ -214,7 +214,7 @@ You can now add the previously set cookie to requests to be executed with the lo
214214
GET /content/locations/1/5 HTTP/1.1
215215
Host: www.example.net
216216
Accept: Accept: application/vnd.ibexa.api.Location+xml
217-
Cookie: eZSESSID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
217+
Cookie: IBX_SESSION_ID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
218218
```
219219

220220
##### CSRF token
@@ -227,7 +227,7 @@ Only three built-in routes can accept unsafe methods without CSRF, the sessions
227227
```
228228
DELETE /content/types/32 HTTP/1.1
229229
Host: www.example.net
230-
Cookie: eZSESSID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
230+
Cookie: IBX_SESSION_ID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
231231
X-CSRF-Token: 23lk.neri34ijajedfw39orj-3j93
232232
```
233233

@@ -262,7 +262,7 @@ To log out is to `DELETE` the session using its ID (like in the cookie). As this
262262
```
263263
DELETE /user/sessions/go327ij2cirpo59pb6rrv2a4el2 HTTP/1.1
264264
Host: www.example.net
265-
Cookie: eZSESSID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
265+
Cookie: IBX_SESSION_ID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2
266266
X-CSRF-Token: 23lk.neri34ijajedfw39orj-3j93
267267
```
268268

docs/infrastructure_and_maintenance/cache/http_cache/context_aware_cache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ It also varies on `Authorization` to cover any possible basic authorization head
7575
enabled: true
7676
hash_cache_ttl: 600
7777
# NOTE: These are also defined/used in AppCache, in Varnish VCL, and Fastly VCL
78-
session_name_prefix: eZSESSID
78+
session_name_prefix: IBX_SESSION_ID
7979
```
8080

8181
## Personalize responses

docs/infrastructure_and_maintenance/sessions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ ibexa:
3333
system:
3434
my_siteaccess:
3535
session:
36-
# Default session name is eZSESSID{siteaccess_hash}
36+
# Default session name is IBX_SESSION_ID{siteaccess_hash}
3737
# (unique session name per SiteAccess)
3838
name: my_session_name
3939
# These are optional. 

docs/release_notes/ibexa_dxp_v5.0_deprecations.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -651,6 +651,13 @@ The following service definitions have been removed:
651651
| `ibexa.site_access.config.default.user_registration.group_id` | `ibexa.site_access.config.default.user_registration.group_remote_id` |
652652
| `ezpublish_http_basic` | Use `http_basic` in `security.yml` directly. |
653653

654+
## Session prefix
655+
656+
The default prefix used for [SiteAccess sessions](sessions.md) has been renamed.
657+
658+
| Old prefix | New prefix |
659+
|:----|:----|
660+
| `eZSESSID` | `IBX_SESSION_ID` |
654661

655662
## CSS settings
656663

0 commit comments

Comments
 (0)