Skip to content
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.

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

Future: Move settings.security Hash parameters to be regular parameters. #694

Closed
johnnyshields opened this issue Jul 9, 2024 · 2 comments

Comments

@johnnyshields
Copy link
Collaborator

Currently a RubySaml::Settings object has some parameters which are normal settings, while there is a security method that returns a hash.

# Normal setting
settings.idp_slo_service_url = "http://example.com?field=value"

# security Hash
settings.security[:logout_requests_signed] = true

We should get rid of the security Hash entirely, and migrate them to just be normal settings. One reason is that it's hard to control deprecation warnings for a hash.

This could be done in a backward compatible fashion. settings.security could be made into a new "SettingsHash" object that extends Hash, but also sets the proper settings value. settings.security= could coerce any Hash you set to the special SettingsHash object.

@johnnyshields johnnyshields changed the title Move settings.security Hash parameters to be regular parameters. v2.0: Move settings.security Hash parameters to be regular parameters. Jul 9, 2024
@pitbulk
Copy link
Collaborator

pitbulk commented Jul 9, 2024

I want to avoid more non-real necessary changes on 2.0

We can consider this in the future 2.1, but at the moment, I don't see it as a blocker. Also, I don't think we're going to deprecate more parameters from the security hash in the near future.

@johnnyshields johnnyshields changed the title v2.0: Move settings.security Hash parameters to be regular parameters. Future: Move settings.security Hash parameters to be regular parameters. Jul 9, 2024
@johnnyshields
Copy link
Collaborator Author

Agreed lets not do it for 2.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants