opensearch-project / opensearch-project/data-prepper

All TLS/SSL certificate provider should accommodate encrypted key

Open
#362 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog enhancement
Dominant language
Java
Stars
374
Forks
354
Avg merge
3d 18h
Merged PRs (30d)
8

Description

Is your feature request related to a problem? Please describe.
Currently we have the following certificate providers on source plugin (server) and peer forwarder (client)

  • local file
  • s3
  • ACM
    where only ACM supports encrypted key file with passphrase.

Describe the solution you'd like
We should support encrypted key with passphrase for all certificate provider since key file encryption standard is generic.

Approach:
Since Armeria server provides the API to configure TLS with encrypted key and passphrase, we only need to modify the Certificate model to accommodate encrypted key and passphrase.

Describe alternatives you've considered (Optional)
Alternatively, we could refactor the decrypt method existing in ACM provider into a common SSL utility method for reusage. This will work with servers that happen not to support encrypted private key. We do not have such use case so far.

Additional context
Add any other context or screenshots about the feature request here.

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 with the Certificate model and the provider implementations for local files, S3, and ACM, then read the decrypt method in ACMCertificateProvider.java. Trace how certificates are passed to the source plugin and peer forwarder, and verify that encrypted private keys and passphrases work for every provider.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
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.