opensearch-project / opensearch-project/opensearch-plugin-template-java

[PROPOSAL] Add plugin-security.policy

Open
#45 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
33
Forks
32
Avg merge
2h 19m
Merged PRs (30d)
3

Description

What/Why

What are you proposing?

Some plugins need plugin-security.policy config file. The plugin template does not have any example or it explain how to add it.

What users have asked for this feature?

n/a

What problems are you trying to solve?

When the plugin needs this file there is no example provided in the template. And there is also no explanation about when/why this file is required.

What is the developer experience going to be?

A new file src/main/plugin-metadata/plugin-security.policy will be added.

Are there any security considerations?

Possibly? If users just carry over this file into their plugins without any modifications.

Are there any breaking changes to the API

No breaking changes. The documentation should make it clear for users to understand if they need this config file or not. If this file is not needed in their case they should be given instructions about how to remove this file (or how to keep it "empty", ie. without any permissions, if that is an option too).

What is the user experience going to be?

The README currently explains how to customize the plugin code. The customization will include a new part about the plugin-security.policy file.

Are there breaking changes to the User Experience?

I do not think there are any.

Why should it be built? Any reason not to?

See above.

What will it take to execute?
  • A simple example of plugin-security.policy shall be introduced along with some code changes that really require listed permissions (meaning users will face a real issues if they remove the policy file).
  • It should be documented and explained.
Any remaining open questions?

n/a

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the plugin customization section in README and inspecting the template under src/main/plugin-metadata/. Define an example plugin-security.policy, document when permissions are required, and explain how to remove or empty the file when they are not. Done means the template includes the example and the README explains its use and security implications.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
developer-experience, documentation, security
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.