Skip to content

Session prefix #2859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 31, 2025
Merged

Session prefix #2859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8a96fb
Added mention about session renaming
mnocon Jul 31, 2025
7c21752
Renamed session examples
mnocon Jul 31, 2025
ebd9813
Fixed name
mnocon Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/api/rest_api/rest_api_authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,14 @@ To create a session, execute the following REST request:
```
HTTP/1.1 201 Created
Location: /user/sessions/go327ij2cirpo59pb6rrv2a4el2
Set-Cookie: eZSESSID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2; domain=.example.net; path=/; expires=Wed, 13-Jan-2021 22:23:01 GMT; HttpOnly
Set-Cookie: IBX_SESSION_ID98defd6ee70dfb1dea416=go327ij2cirpo59pb6rrv2a4el2; domain=.example.net; path=/; expires=Wed, 13-Jan-2021 22:23:01 GMT; HttpOnly
Content-Type: application/vnd.ibexa.api.Session+xml
```

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

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

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

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/infrastructure_and_maintenance/cache/http_cache/context_aware_cache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ It also varies on `Authorization` to cover any possible basic authorization head
enabled: true
hash_cache_ttl: 600
# NOTE: These are also defined/used in AppCache, in Varnish VCL, and Fastly VCL
session_name_prefix: eZSESSID
session_name_prefix: IBX_SESSION_ID
```

## Personalize responses
Expand Down
2 changes: 1 addition & 1 deletion docs/infrastructure_and_maintenance/sessions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ ibexa:
system:
my_siteaccess:
session:
# Default session name is eZSESSID{siteaccess_hash}
# Default session name is IBX_SESSION_ID{siteaccess_hash}
# (unique session name per SiteAccess)
name: my_session_name
# These are optional. 
Expand Down
7 changes: 7 additions & 0 deletions docs/release_notes/ibexa_dxp_v5.0_deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,13 @@ The following service definitions have been removed:
| `ibexa.site_access.config.default.user_registration.group_id` | `ibexa.site_access.config.default.user_registration.group_remote_id` |
| `ezpublish_http_basic` | Use `http_basic` in `security.yml` directly. |

## Session prefix

The default prefix used for [SiteAccess sessions](sessions.md) has been renamed.

| Old prefix | New prefix |
|:----|:----|
| `eZSESSID` | `IBX_SESSION_ID` |

## CSS settings

Expand Down
Loading