keycloak/keycloak

Client credentials hashing (encryption / decryption)

Open

#15,567 opened on Nov 18, 2022

View on GitHubContributor guide
 (2 comments) (2 reactions) (0 assignees)Java (8,346 forks)batch import
area/weaknesshelp wantedkind/featureteam/core-clients

Repository metrics

Stars
 (34,398 stars)
PR merge metrics
 (Avg merge 6d 19h) (384 merged PRs in 30d)

Description

Description

Client credentials are currently stored as clear text. To improve Keycloak security, client credentials/secrets should be optionally be stored as hashes. A new pluggable SPI would be a great way to achieve this.

References:

Discussion

No response

Motivation

My Company, Transatel, is providing client credentials to our customers in order to use some of our APIs. These APIs give access to personal data, so, in order to respect the GDPR regulations, we must store these secrets in a secure way so that the secrets cannot be retrieved.

Details

No response

Contributor guide

Research direction
Study the referenced design document for secure credentials store and examine existing SPI implementations in Keycloak to design a new pluggable SPI for client credential hashing.
Tech stack
java
Domain
security
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaKeycloak SPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45