Skip to content

Enforce custom compliance salt in OpenSearch 4.0 #6124

@cwperks

Description

@cwperks

Description

In #6022 we added salt generation to the demo security configuration and introduced Salt.validateSaltSettings() which throws an OpenSearchException if the default compliance salt is used outside of demo/test environments. However, this validation is currently commented out to avoid breaking existing deployments:

// TODO: Uncomment for 4.0 - enforce that the default compliance salt is not used outside of demo configuration
// Salt.validateSaltSettings(settings);

In OpenSearch 4.0, we should uncomment this line in OpenSearchSecurityPlugin.java to enforce that cluster administrators configure a custom salt for field masking unless plugins.security.allow_unsafe_democertificates is set to true. Perhaps it would also make sense to rename that setting to allow_demo_configuration?

Tasks

  • Uncomment Salt.validateSaltSettings(settings) in OpenSearchSecurityPlugin.java
  • Add a migration/upgrade note documenting that clusters must configure plugins.security.compliance.salt before upgrading to 4.0
  • Update documentation to reflect the new requirement

Metadata

Metadata

Assignees

No one assigned

    Labels

    4.0enhancementNew feature or requestuntriagedRequire the attention of the repository maintainers and may need to be prioritized

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions