Skip to content

Create SPI and Provider for Verifiable Credentials Signing #25937 - #25947

Closed
wistefan wants to merge 121 commits into
keycloak:mainfrom
wistefan:25937-create-spi-and-provider-for-verifiable-credentials-signing
Closed

Create SPI and Provider for Verifiable Credentials Signing #25937#25947
wistefan wants to merge 121 commits into
keycloak:mainfrom
wistefan:25937-create-spi-and-provider-for-verifiable-credentials-signing

Conversation

@wistefan

@wistefan wistefan commented Jan 5, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

The PR adds implementations for SPI and Provider factories and interfaces to prepare the implementation of the #25936 feature.

Closes #25937

@wistefan
wistefan requested a review from a team as a code owner January 5, 2024 13:17
@wistefan
wistefan force-pushed the 25937-create-spi-and-provider-for-verifiable-credentials-signing branch 2 times, most recently from df6d696 to 656e317 Compare January 5, 2024 13:46
@mposolda mposolda self-assigned this Jan 17, 2024
mposolda
mposolda reviewed Jan 17, 2024
View reviewed changes

@mposolda mposolda left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Added 2 minor comments inline.

Additional comment: Is it possible to introduce EXPERIMENTAL feature OID4VC into the org.keycloak.common.Profile ? Then also make sure that your factories (jwtSigningServiceProviderFactory, LDSigningServiceProviderFactory, VCSigningServiceProviderFactory) all implement EnvironmentDependentFactory and are supported just when the feature is enabled?

I appreciate the factories are not yet enabled anyway, but I would appreciate them to be "hidden" behind the feature flag from day 1, so we don't forget at it later.

NOTE: This will require some minor changes in few tests like ProfileTest and some help* files used during quarkus distribution tests. For example see this commit for the inspiration 7da52a43 ,

Comment thread services/src/main/java/org/keycloak/protocol/oid4vc/issuance/VCIssuerException.java Outdated

@mposolda mposolda Jan 17, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: Is it possible to use same padding like other Keycloak classes? So 4 characters only in java classes?

@wistefan wistefan Jan 17, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed by #f74153f

Comment thread services/src/main/java/org/keycloak/protocol/oid4vc/issuance/signing/VCSigningServiceSpi.java Outdated

@mposolda mposolda Jan 17, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to make sure that the class referenced from here is an interface rather than abstract class? It currently works with an abstract class, but AFAIK it is not recommended pattern and it is possible this can cause issues in the future (if Keycloak later does some refactoring in providers initialization part etc).

Hopefully just something minor like having interface VCSigningServiceProviderFactory and rename current abstract class to AbstractVCSigningServiceProviderFactory will do the job?

@wistefan wistefan Jan 17, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed by #7d5dea4

@wistefan

wistefan commented Jan 17, 2024

Copy link
Copy Markdown
Contributor Author

Thanks! Added 2 minor comments inline.

Additional comment: Is it possible to introduce EXPERIMENTAL feature OID4VC into the org.keycloak.common.Profile ? Then also make sure that your factories (jwtSigningServiceProviderFactory, LDSigningServiceProviderFactory, VCSigningServiceProviderFactory) all implement EnvironmentDependentFactory and are supported just when the feature is enabled?

I appreciate the factories are not yet enabled anyway, but I would appreciate them to be "hidden" behind the feature flag from day 1, so we don't forget at it later.

Hi, yes I will add it. Was just not aware of it.

@mposolda

mposolda commented Jan 17, 2024

Copy link
Copy Markdown
Contributor

@tnorimat @thomasdarimont Anyone of you can also review this please?

@wistefan

wistefan commented Jan 17, 2024

Copy link
Copy Markdown
Contributor Author

Thanks! Added 2 minor comments inline.
Additional comment: Is it possible to introduce EXPERIMENTAL feature OID4VC into the org.keycloak.common.Profile ? Then also make sure that your factories (jwtSigningServiceProviderFactory, LDSigningServiceProviderFactory, VCSigningServiceProviderFactory) all implement EnvironmentDependentFactory and are supported just when the feature is enabled?
I appreciate the factories are not yet enabled anyway, but I would appreciate them to be "hidden" behind the feature flag from day 1, so we don't forget at it later.

Hi, yes I will add it. Was just not aware of it.

Fixed by #1e5d94d

wistefan and others added 20 commits January 17, 2024 10:48
@wistefan
add spi, provider and interfaces for oid4vc keycloak#25937
fdb4a73 
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@wistefan
update to java 17
de3da78 
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@atharvakshi @ahus1 @wistefan
Fix for empty realm name issue
5fb240b 
Throw ModelException if name is empty when creating/updating a realm

Closes keycloak#17449

Signed-off-by: atharva kshirsagar <atharva4894@gmail.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@jonkoops @wistefan
Make passing parameters to generateEncodedPath() type-safe (keycloa…
9e55511 
…k#25944)

Signed-off-by: Jon Koops <jonkoops@gmail.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@alice-wondered @wistefan
Add logging to the policy providers for general debugging purposes
ade5680 
Signed-off-by: Alice W <105500542+alice-wondered@users.noreply.github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@hmlnarik @wistefan
Do not switch to admin console too early (keycloak#25952)
91dd9dd 
Closes: keycloak#25951

Signed-off-by: Hynek Mlnarik <hmlnarik@redhat.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@pedroigor @wistefan
Using a valid URI when deleting cookies before/after running tests
4aa4353 
Closes keycloak#22691

Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@dependabot @wistefan
Bump vite from 5.0.10 to 5.0.11 in /js
e3b5bd2 
Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 5.0.10 to 5.0.11.
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/main/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v5.0.11/packages/vite)

---
updated-dependencies:
- dependency-name: vite
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@dependabot @wistefan
Bump @typescript-eslint/parser from 6.17.0 to 6.18.0 in /js
16403e3 
Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 6.17.0 to 6.18.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v6.18.0/packages/parser)

---
updated-dependencies:
- dependency-name: "@typescript-eslint/parser"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@dependabot @wistefan
Bump rollup
0c61b1f 
Bumps [rollup](https://github.com/rollup/rollup) from 4.9.2 to 4.9.4.
- [Release notes](https://github.com/rollup/rollup/releases)
- [Changelog](https://github.com/rollup/rollup/blob/master/CHANGELOG.md)
- [Commits](rollup/rollup@v4.9.2...v4.9.4)

---
updated-dependencies:
- dependency-name: rollup
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@dependabot @wistefan
Bump rollup from 4.9.2 to 4.9.4 in /js
890bce0 
Bumps [rollup](https://github.com/rollup/rollup) from 4.9.2 to 4.9.4.
- [Release notes](https://github.com/rollup/rollup/releases)
- [Changelog](https://github.com/rollup/rollup/blob/master/CHANGELOG.md)
- [Commits](rollup/rollup@v4.9.2...v4.9.4)

---
updated-dependencies:
- dependency-name: rollup
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@dependabot @wistefan
Bump @typescript-eslint/eslint-plugin from 6.17.0 to 6.18.0 in /js
a15e3cf 
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 6.17.0 to 6.18.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v6.18.0/packages/eslint-plugin)

---
updated-dependencies:
- dependency-name: "@typescript-eslint/eslint-plugin"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@dependabot @wistefan
Bump @types/react from 18.2.46 to 18.2.47 in /js
76ff4ca 
Bumps [@types/react](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react) from 18.2.46 to 18.2.47.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react)

---
updated-dependencies:
- dependency-name: "@types/react"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@dependabot @wistefan
Bump jsdom from 23.0.1 to 23.2.0 in /js (keycloak#25970)
3290bd0 
Bumps [jsdom](https://github.com/jsdom/jsdom) from 23.0.1 to 23.2.0.
- [Release notes](https://github.com/jsdom/jsdom/releases)
- [Changelog](https://github.com/jsdom/jsdom/blob/main/Changelog.md)
- [Commits](jsdom/jsdom@23.0.1...23.2.0)

---
updated-dependencies:
- dependency-name: jsdom
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@dependabot @wistefan
Bump @types/node from 20.10.6 to 20.10.7 in /js
ff97b69 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.10.6 to 20.10.7.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@tondrusk @wistefan
Update web element of the LinkedIn login page (keycloak#25905)
b6c6115 
Signed-off-by: Tomas Ondrusko <tondrusk@redhat.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@potterhe @wistefan
account console locale zh-CN (keycloak#25828)
5f1c7ac 
Signed-off-by: potterhe <potter.he@gmail.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@dependabot @wistefan
Bump i18next from 23.7.15 to 23.7.16 in /js (keycloak#25923)
0bd418c 
Bumps [i18next](https://github.com/i18next/i18next) from 23.7.15 to 23.7.16.
- [Release notes](https://github.com/i18next/i18next/releases)
- [Changelog](https://github.com/i18next/i18next/blob/master/CHANGELOG.md)
- [Commits](i18next/i18next@v23.7.15...v23.7.16)

---
updated-dependencies:
- dependency-name: i18next
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@jonkoops @wistefan
Add release announcement and migration for new welcome theme (keycloa…
fee7de6 
…k#25895)

Closes keycloak#25894

Signed-off-by: Jon Koops <jonkoops@gmail.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@agagancarczyk @jonkoops @wistefan
Localization tabs (keycloak#25532)
9320815 
* Add new localization tabs to Administration Console

Closes keycloak#23057

Signed-off-by: Agnieszka <agancarc@redhat.com>
Signed-off-by: Jon Koops <jonkoops@gmail.com>

* css cleanup

Signed-off-by: Agnieszka Gancarczyk <agancarc@redhat.com>

* css cleanup

Signed-off-by: Agnieszka Gancarczyk <agancarc@redhat.com>

---------

Signed-off-by: Agnieszka <agancarc@redhat.com>
Signed-off-by: Jon Koops <jonkoops@gmail.com>
Signed-off-by: Agnieszka Gancarczyk <agancarc@redhat.com>
Co-authored-by: Jon Koops <jonkoops@gmail.com>
Co-authored-by: Agnieszka Gancarczyk <agancarc@redhat.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
edewit and others added 8 commits January 17, 2024 10:48
@edewit @wistefan
added choose as an option to reset (keycloak#26065)
029fa71 
fixes: keycloak#25939

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@pkeuter @wistefan
fix: permissions tab should be only shown with the correct rights (ke…
c0b2ac3 
…ycloak#26034)

Signed-off-by: Peter Keuter <github@peterkeuter.nl>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@BlackVoid @wistefan
Add login/ui (keycloak#26218)
297eda4 
Signed-off-by: Felix Gustavsson <felix.gustavsson@topgolf.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@Aboullos @wistefan
Fix flaky client scopes test for Firefox (keycloak#26195)
4769af2 
Closes keycloak#26148

Signed-off-by: Alfredo Moises Boullosa <aboullos@redhat.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@mabartos @wistefan
Do not use general debug log level for tests (keycloak#26242)
0e5088d 
Closes keycloak#26241

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@wistefan
fix indention
6a4b4a5 
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@wistefan
b900a41 
make provider factory an interface

Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@wistefan
add feature flag
c81dff9 
Signed-off-by: Stefan Wiedemann <wistefan@googlemail.com>
@wistefan
wistefan force-pushed the 25937-create-spi-and-provider-for-verifiable-credentials-signing branch from 1e5d94d to c81dff9 Compare January 17, 2024 09:49
@wistefan
wistefan requested a review from a team as a code owner January 17, 2024 09:49
@wistefan
wistefan requested a review from a team January 17, 2024 09:49
@wistefan
wistefan requested review from a team as code owners January 17, 2024 09:49
@jonkoops

jonkoops commented Jan 17, 2024

Copy link
Copy Markdown
Contributor

Closing this PR as a bunch of unrelated commits have been added. Feel free to open up a new one so the reviewers are reset.

@jonkoops jonkoops closed this Jan 17, 2024
@wistefan wistefan mentioned this pull request Jan 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mposolda mposolda mposolda left review comments
@tnorimat tnorimat Awaiting requested review from tnorimat
@thomasdarimont thomasdarimont Awaiting requested review from thomasdarimont

Assignees

@mposolda mposolda

Labels

team/cloud-native

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create SPI and Provider for Verifiable Credentials Signing