mTLS auth as an alternative to API Key auth
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 232
- PR merge metrics
- No merged PRs in 30d
Description
Is your proposal related to a problem?
We should support mTLS as an auth mechanism for API calls.
Additional context
mTLS ensures that the parties at each end of a network connection are who they claim to be by verifying that they both have the correct private key. The information within their respective TLS certificates provides additional verification.
Further details
We currently use API keys to authenticate protected requests. We need to offer mTLS as an alternative auth mechanism, this will allow our customers to set up internal communication between their services and Jackson.
If possible both auth mechanisms should work (shouldn't be a choice between mTLS or API Keys).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing API key authentication and protected API request handling. Determine how mTLS certificates would be configured and verified alongside API keys, then define completion as successful authentication through either mechanism without removing API key support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nodejs, typescript
- Domain
- api, authentication, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100