feat: add issuer component #18

Phil91 · 2024-03-08T16:19:34Z

Description

Add the ssi issuer component

Why

To provide a api to create, sign and revoke credentials for wallets of an issuer and holder

Issue

#3 #4 #5 #6 #7 #8 #9 #13

Checklist

I have followed the contributing guidelines
I have performed IP checks for added or updated 3rd party libraries
I have created and linked IP issues or requested their creation by a committer
I have performed a self-review of my own code
I have successfully tested my changes locally
I have added tests that prove my changes work
I have checked that new and existing tests pass locally with my changes
I have commented my code, particularly in hard-to-understand areas
I have added copyright and license headers, footers (for .md files) or files (for images)

BEGIN_COMMIT_OVERRIDE
feat: establish a database to handle credential requests, verified credentials, document proof, and managing lifecycle
feat: establish a GET endpoint for retrieving own credential requests with their current status
feat: establish a GET endpoint to retrieve supported credential types, allowing customers to see all credentials that can be requested
feat: establish POST endpoints for credential requests for BPN (Business Partner Number), Membership, and Framework Agreement credentials
feat: establish an admin endpoint to retrieve credential requests for the purpose of approval or rejection
feat: establish endpoints to approve or reject customer credential requests
feat: establish a processes worker to create credentials and submit them for signature by the issuer wallet
feat: establish a job to store newly created verified credentials inside the holder wallet
feat: implement a job to run expiry validation and revocation of credentials
feat: establish a notification system for credential expiry to alert holders
END_COMMIT_OVERRIDE

github-advanced-security · 2024-03-08T16:21:18Z

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

github-advanced-security

CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

evegufy

could you please rename from src/credentials/SsiCredentialIssuer.Expiry.App.app to src/credentials/SsiCredentialIssuer.Expiry.App?

evegufy · 2024-03-13T15:36:45Z

and not sure if you saw the comment from codeql, could you please take care of the warnings?

src/credentials/SsiCredentialIssuer.Expiry.App/ExpiryCheckService.cs

tests/issuer/SsiCredentialIssuer.Service.Tests/BusinessLogic/CredentialBusinessLogicTests.cs

tests/processes/Processes.Library.Tests/ManualProcessDataExtensionsTests.cs

tests/externalservices/Wallet.Service.Tests/Services/BasicAuthTokenServiceTests.cs

tests/externalservices/Wallet.Service.Tests/Services/WalletServiceTests.cs

tests/issuer/SsiCredentialIssuer.Service.Tests/BusinessLogic/CredentialBusinessLogicTests.cs

tests/processes/CredentialProcess.Library.Tests/CredentialProcessHandlerTests.cs

tests/Tests.Shared/HttpMessageHandlerMock.cs

Refs: #2

ntruchsess

in addition to the other findings I don't think it's a good idea to exclude major parts of the code by using [ExcludeFromCodeCoverage]. If reported coverage is low than this is what it is.

ntruchsess · 2024-03-19T18:14:30Z

src/issuer/SsiCredentialIssuer.Service/BusinessLogic/CredentialBusinessLogic.cs

+    private async Task<string> GetHolderInformation(string didDocumentLocation, CancellationToken cancellationToken)
+    {
+        var client = _clientFactory.CreateClient("didDocumentDownload");
+        var result = await client.GetAsync(didDocumentLocation, cancellationToken)


didDocumentLocation url originates from post-data and therefore must be sanitized before calling the remote system. (never trust the client!)

src/issuer/SsiCredentialIssuer.Service/BusinessLogic/CredentialBusinessLogic.cs

src/issuer/SsiCredentialIssuer.Service/Controllers/CredentialController.cs

src/issuer/SsiCredentialIssuer.Service/Controllers/IssuerController.cs

Refs: #2

Phil91 · 2024-03-20T17:01:07Z

in addition to the other findings I don't think it's a good idea to exclude major parts of the code by using [ExcludeFromCodeCoverage]. If reported coverage is low than this is what it is.

I removed the [ExceludeFromCodeCoverage] attributes

evegufy

I tested again on local and after ba75b66 everything worked fine 👍

charts/ssi-credential-issuer/values.yaml

Refs: #2

evegufy

I still added two small changes 5bd8959 3f18571

Refs: #2

ntruchsess · 2024-03-21T15:00:30Z

src/issuer/SsiCredentialIssuer.Service/BusinessLogic/IssuerBusinessLogic.cs

+    private async Task<string> GetHolderInformation(string didDocumentLocation, CancellationToken cancellationToken)
+    {
+        var client = _clientFactory.CreateClient("didDocumentDownload");
+        var result = await client.GetAsync(HttpUtility.HtmlEncode(didDocumentLocation), cancellationToken)


HtmlEncode does translate special characters to their html-representation. E.g. & instead of &. This is not suitable for Urls

adjusted the validation of the url

Refs: #2

sonarcloud · 2024-03-22T14:52:29Z

Quality Gate passed

Issues
4 New issues
4 Accepted issues

Measures
0 Security Hotspots
85.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

* feat: add issuer component * build: add helm chart for issuer component * feat(notification): adjust notification endpoint * fix(build): enable build of docker images (#21) * feat: add callback process step * chore: enable helm chart (#22) * fix: remove lint issue * fix: solve templating issues * chore: change setup of cronjobs: remove hooks * chore: change name setup of job resources * chore: add line breaks * chore: move placeholder value into resources * chore: change to unique templates for db subchart * chore: change secret setup * chore: move passwords from db dependency to according section * chore: remove upgrade env file * chore: change centralidp setup * chore: rearrange health checks * chore: rearrange values file * chore: change ingress to trg-5.04 * chore: fix container name and namespace * chore: change image tag retrieval * chore: change version * chore(db-dependency): change image tag to get latest minor updates * chore: set resource limits * chore: update readme files * chore: change credentialexpiry to camelcase * chore: fix helm chart, improve workflows and docs (#23) * chore(helm-test): fix image name and tag override at upgrade * chore: fix owasp scan * chore(helm-test and owasp): change set command * chore: re-arrange values file * chore(pre-checks): run only on changes to src/** * docs(CONTRIBUTING.md): update to contribution details * chore: fix db dependency secret name in cronjobs * chore(dependencies-check): align file naming and docs * chore: remove white space --------- Refs: #2 #3 #4 #5 #6 #7 #8 #9 #13 #21 #22 #23 Reviewed-by: Evelyn Gurschler <evelyn.gurschler@bmw.de> Reviewed-by: Norbert Truchsess <norbert.truchsess@t-online.de> Co-authored-by: Evelyn Gurschler <evelyn.gurschler@bmw.de> Co-authored-by: Norbert Truchsess <norbert.truchsess@t-online.de>

github-advanced-security bot found potential problems Mar 8, 2024

View reviewed changes

Phil91 changed the title ~~Feat/2 issuer component~~ feat: issuer component Mar 8, 2024

Phil91 force-pushed the feat/2-issuer-component branch from 61c492f to 2cc883f Compare March 8, 2024 22:51

jjeroch added the priority PR needs to prioritized at review label Mar 11, 2024

jjeroch added this to the CX Release 24.05 (dev) milestone Mar 11, 2024

Phil91 force-pushed the feat/2-issuer-component branch 4 times, most recently from 5610db0 to 30638ba Compare March 12, 2024 11:04

Phil91 mentioned this pull request Mar 12, 2024

feat: add helm chart #20

Merged

9 tasks

Phil91 marked this pull request as ready for review March 13, 2024 12:06

Phil91 requested review from ntruchsess and evegufy March 13, 2024 12:07

Phil91 force-pushed the feat/2-issuer-component branch from 30638ba to f35950f Compare March 13, 2024 12:28

evegufy requested changes Mar 13, 2024

View reviewed changes

Phil91 force-pushed the feat/2-issuer-component branch from f35950f to 3ef3048 Compare March 13, 2024 18:22

github-advanced-security bot found potential problems Mar 13, 2024

View reviewed changes

src/credentials/SsiCredentialIssuer.Expiry.App/ExpiryCheckService.cs Dismissed Show dismissed Hide dismissed

Phil91 force-pushed the feat/2-issuer-component branch 2 times, most recently from 3a35c8e to d5e30ad Compare March 14, 2024 07:48

github-advanced-security bot found potential problems Mar 14, 2024

View reviewed changes

Phil91 force-pushed the feat/2-issuer-component branch from d5e30ad to 0e4854a Compare March 14, 2024 07:58

Phil91 added 3 commits March 14, 2024 09:05

feat: add issuer component

603c7b4

Refs: #2

feat: add issuer component

d6b25bd

Refs: #2

build: add helm chart for issuer component

ab909cc

Refs: #2

Phil91 force-pushed the feat/2-issuer-component branch from 0e4854a to 603c7b4 Compare March 14, 2024 08:07

chore: remove unneeded code

77dab4f

Refs: #2

Phil91 requested a review from evegufy March 14, 2024 09:28

evegufy mentioned this pull request Mar 14, 2024

fix(build): enable build of docker images #21

Merged

3 tasks

ntruchsess requested changes Mar 20, 2024

View reviewed changes

ntruchsess and others added 3 commits March 20, 2024 16:35

fix tests

3b37d4a

chore: adjust cronjobs

ee662ac

Refs: #2

feat: adjust approval

5e3f390

Refs: #2

Phil91 requested review from evegufy and ntruchsess March 20, 2024 17:01

chore(helm): fix templating of db username

ba75b66

evegufy requested changes Mar 20, 2024

View reviewed changes

charts/ssi-credential-issuer/values.yaml Outdated Show resolved Hide resolved

Phil91 added 2 commits March 21, 2024 09:04

chore: adjust jwt audience

f50d996

Refs: #2

chore: adjust env audience

296a467

Refs: #2

Phil91 requested a review from evegufy March 21, 2024 10:25

evegufy previously approved these changes Mar 21, 2024

View reviewed changes

feat: add statuslist to credential creation

93746d1

Refs: #2

Phil91 dismissed evegufy’s stale review via 93746d1 March 21, 2024 14:23

Phil91 force-pushed the feat/2-issuer-component branch from 3f18571 to 93746d1 Compare March 21, 2024 14:23

ntruchsess requested changes Mar 21, 2024

View reviewed changes

chore: adjust holder validation

213a0d5

Refs: #2

Phil91 requested a review from ntruchsess March 22, 2024 07:36

Phil91 and others added 3 commits March 22, 2024 11:00

chore: adjust url regex

03aac0b

Refs: #2

chore: adjust holder validation

82f4fa8

Refs: #2

add invalid path characters dedection to url validation

749a9e4

ntruchsess approved these changes Mar 22, 2024

View reviewed changes

evegufy approved these changes Mar 25, 2024

View reviewed changes

Phil91 merged commit 609567a into dev Mar 25, 2024
11 checks passed

Phil91 deleted the feat/2-issuer-component branch March 25, 2024 08:35

This was referenced Mar 25, 2024

chore: fix image build #28

Merged

chore: fix naming of docker images and workflow trigger #29

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add issuer component #18

feat: add issuer component #18

Phil91 commented Mar 8, 2024 •

edited by evegufy

Loading

github-advanced-security bot commented Mar 8, 2024

github-advanced-security bot left a comment

evegufy left a comment

evegufy commented Mar 13, 2024

ntruchsess left a comment

ntruchsess Mar 19, 2024

Phil91 Mar 20, 2024

Phil91 commented Mar 20, 2024

evegufy left a comment

evegufy left a comment •

edited

Loading

ntruchsess Mar 21, 2024

Phil91 Mar 22, 2024

sonarcloud bot commented Mar 22, 2024

feat: add issuer component #18

feat: add issuer component #18

Conversation

Phil91 commented Mar 8, 2024 • edited by evegufy Loading

Description

Why

Issue

Checklist

github-advanced-security bot commented Mar 8, 2024

github-advanced-security bot left a comment

Choose a reason for hiding this comment

evegufy left a comment

Choose a reason for hiding this comment

evegufy commented Mar 13, 2024

ntruchsess left a comment

Choose a reason for hiding this comment

ntruchsess Mar 19, 2024

Choose a reason for hiding this comment

Phil91 Mar 20, 2024

Choose a reason for hiding this comment

Phil91 commented Mar 20, 2024

evegufy left a comment

Choose a reason for hiding this comment

evegufy left a comment • edited Loading

Choose a reason for hiding this comment

ntruchsess Mar 21, 2024

Choose a reason for hiding this comment

Phil91 Mar 22, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Mar 22, 2024

Quality Gate passed

Phil91 commented Mar 8, 2024 •

edited by evegufy

Loading

evegufy left a comment •

edited

Loading