Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Credential Issuance and Identity Wallet Integration Wrapper #647

Closed
jjeroch opened this issue Apr 9, 2024 · 6 comments
Closed

Credential Issuance and Identity Wallet Integration Wrapper #647

jjeroch opened this issue Apr 9, 2024 · 6 comments
Assignees
Labels
portal Feature/Bug for Portal component Prep-R24.12 ssi Self-Sovereign Identity
Milestone

Comments

@jjeroch
Copy link

jjeroch commented Apr 9, 2024

Summary:

The objective of this ticket is to create a wrapper that abstracts the complexity of interacting with two separate endpoints for storing and signing credentials in the identity wallet. The wrapper will provide a unified interface to the portal, which will interact with a single endpoint to perform the operations that are currently handled by 'store credential' and 'sign credential' endpoints.

Objectives:

  • To simplify the interaction with the identity wallet by merging two endpoints into one.
  • To create a standardized interface for credential issuance and signing.
  • To encapsulate wallet-specific implementations and provide a consistent experience to the portal.

Architecture

image

Acceptance Criteria:

  1. Wrapper Creation:

    • Develop a wrapper that interfaces with both 'store credential' and 'sign credential' endpoints.
    • The wrapper should expose a single, standardized endpoint to the portal.
  2. Functionality:

    • The wrapper must support all functionalities provided by the two separate endpoints.
    • Ensure that the wrapper can store and sign credentials as per the current implementation.
  3. Error Handling:

    • Implement comprehensive error handling within the wrapper to manage any issues arising from the underlying endpoints.
    • Ensure that meaningful error messages are relayed back to the portal.
  4. Security:

    • Ensure that the wrapper maintains the security standards required for handling credentials.
    • Implement necessary authentication and authorization checks within the wrapper.
  5. Testing:

    • Write unit tests for the wrapper to ensure that both functionalities work as expected.
    • Conduct integration tests to verify that the wrapper interacts correctly with the identity wallet.
  6. Documentation:

    • Document the API exposed by the wrapper, including request and response formats.
    • Update any existing documentation to reflect the change to a single endpoint.

Non-Functional Requirements:

  • The wrapper should be designed to be scalable and maintainable.
  • Performance should not be negatively impacted by the introduction of the wrapper.

Dependencies:

  • Issuance Component code change (main component)
  • MIW (impacted)
    After pre-analyzing with MIW no technical adaptations on MIW side are expected.

Risks:

  • Potential security risks associated with merging two endpoints into one.
  • The complexity of handling different operations in a single endpoint without introducing bugs.

Documentation:

  • A detailed API specification for the new wrapper endpoint.
  • Developer guide on how to integrate with the new wrapper.
  • Update architectural diagrams to include the wrapper component.
  • Standard document update needed CX-0149
@jjeroch jjeroch added miw Feature/Bug for Managed Identity Wallet component portal Feature/Bug for Portal component Prep-PI13 Open Planning Preparation Issues for R24.08 labels Apr 9, 2024
@jjeroch jjeroch self-assigned this Apr 9, 2024
@github-project-automation github-project-automation bot moved this to NEW USER REQUEST in Portal Apr 9, 2024
@jjeroch jjeroch moved this from Inbox to Backlog in Release Planning Apr 10, 2024
@stephanbcbauer
Copy link
Member

Was presented in the open planning ⇾ responsible committers are already defined

@stephanbcbauer stephanbcbauer added this to the 24.08 milestone Apr 10, 2024
@stephanbcbauer
Copy link
Member

Hello @jjeroch , @evegufy

Since the feature is a 24.08 feature and the development phase is coming to an end, we need a status on the feature.

  • Currently you are assigned (Responsible) → Is this correct? If not, please assign the correct contact person
  • Please check whether the status (backlog, work in progress ...) is set correctly
  • Please check whether there is an assignment to a committee or expert group (supported-by) to be found on the board
  • Please comment on the current status of the feature
  • Are all SubTasks (issues from other repositories that deal with the feature) linked? → The easiest way is to mention the feature here in the issue (via the ID) so we can see which teams/repositories are involved.

If you need any clarification, please get in touch, thank you very much.
Stephan

@jjeroch jjeroch modified the milestones: 24.08, 24.12 Jun 20, 2024
@jjeroch
Copy link
Author

jjeroch commented Jun 20, 2024

Updates

  • release updated to 24.12.
  • implementation not yet started

@jjeroch jjeroch moved this from NEW USER REQUEST to BACKLOG in Portal Jul 26, 2024
@jjeroch jjeroch added Prep-R24.12 and removed Prep-PI13 Open Planning Preparation Issues for R24.08 labels Jul 26, 2024
@evegufy evegufy removed this from the 24.12 milestone Jul 29, 2024
@MaximilianHauer MaximilianHauer self-assigned this Jul 30, 2024
@evegufy
Copy link
Contributor

evegufy commented Jul 31, 2024

Committers:
@evegufy
@Phil91
@ntruchsess
@oyo

@Phil91
Copy link
Member

Phil91 commented Oct 8, 2024

@MaximilianHauer the special character issue: SAP/ssi-dim-middle-layer#110

@MaximilianHauer MaximilianHauer moved this from Backlog to Done in Release Planning Oct 16, 2024
@MaximilianHauer MaximilianHauer moved this from IN PROGRESS to USER READY in Portal Oct 16, 2024
@MaximilianHauer MaximilianHauer added the ssi Self-Sovereign Identity label Oct 16, 2024
@MaximilianHauer MaximilianHauer removed the miw Feature/Bug for Managed Identity Wallet component label Oct 16, 2024
@MaximilianHauer
Copy link
Contributor

@Phil91 / @jjeroch i assume we can close this issue ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
portal Feature/Bug for Portal component Prep-R24.12 ssi Self-Sovereign Identity
Projects
Archived in project
Status: Done
Development

No branches or pull requests

5 participants