Skip to content

Commit 3e3e250

Browse files
Update UPGRADING.md
1 parent 6e027b7 commit 3e3e250

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

UPGRADING.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,12 @@ settings.idp_slo_service_binding = :redirect
7777

7878
For clarity, the default value of both parameters is `:redirect` if they are not set.
7979

80-
### Addition of Settings sp_uuid_prefix and removal of Utils::UUID_PREFIX
80+
### Change to message UUID prefix customization
8181

82-
By default, the `uuid` (aliased to `request_id` / `response_id`) method in `RubySaml::Authrequest`,
83-
`RubySaml::Logoutrequest`, and `RubySaml::Logoutresponse` uses the `_` character as a default prefix,
84-
for example `_a1b3c5d7-9f1e-3d5c-7b1a-9f1e3d5c7b1a`. In RubySaml, versions prior to `2.0.0`, it was
85-
possible to change this default prefix by either calling `RubySaml::Utils.set_prefix` or by mutating
82+
On SP-originated messages (`Authrequest`, `Logoutrequest`, `Logoutresponse`), RubySaml generates the
83+
`uuid` (aliased to `request_id` / `response_id`) using the `_` character as a default prefix,
84+
for example `_a1b3c5d7-9f1e-3d5c-7b1a-9f1e3d5c7b1a`. In RubySaml versions prior to `2.0.0`, it was
85+
possible to change this default prefix by either `RubySaml::Utils.set_prefix` or by mutating
8686
the `RubySaml::Utils::UUID_PREFIX` constant (which was what `.set_prefix` did.) In RubySaml `2.0.0`,
8787
this prefix is now set using `settings.sp_uuid_prefix`:
8888

@@ -91,10 +91,9 @@ this prefix is now set using `settings.sp_uuid_prefix`:
9191
settings.sp_uuid_prefix = 'my_id_'
9292
```
9393

94-
A side-effect of this change is that the `uuid` (aliased to `request_id` / `response_id`) method in
95-
`RubySaml::Authrequest`, `RubySaml::Logoutrequest`, and `RubySaml::Logoutresponse` now is `nil` until
96-
the `#create` method is called. Previously, it was generated automatically during object instantiation.
97-
After calling `#create` for the first time the UUID will not change, even if a `Settings` object with
94+
A side-effect of this change is that the `uuid` of the `Authrequest`, `Logoutrequest`, and `Logoutresponse`
95+
classes now is `nil` until the `#create` method is called (previously, it was generated during object instantiation.)
96+
After calling `#create` for the first time the `uuid` will not change, even if a `Settings` object with
9897
a different `sp_uuid_prefix` is passed-in on subsequent calls.
9998

10099
### Deprecation of compression settings

0 commit comments

Comments
 (0)