docs(identity): clarify extension points and add custom identity prov… - #1326
Conversation
18721b5 to
86a8aaf
Compare
2ab86d2 to
2421ad0
Compare
|
It looks like the failures are coming from cache restore errors (/usr/bin/tar exit code 2) across multiple matrix jobs. Since this PR only updates documentation, I suspect this may be a CI/cache issue rather than a change-related failure. Please let me know if you’d like me to rebase or try anything specific. |
|
Hi @sid200727 , thanks for submitting this PR.
Thanks much, I will now look at additions. |
| on the Identity Service interfaces, allowing different identity implementations | ||
| to be plugged in transparently. | ||
|
|
||
| ## Extending the Identity Service |
There was a problem hiding this comment.
Please, move this section at the end of document because it contains content for pro developers.
|
|
||
| Typical extension scenarios include: | ||
| - Supporting a new identity type | ||
| - Customizing signature generation or verification |
| A custom identity provider is expected to implement the interfaces exposed by | ||
| the token driver layer, allowing it to be seamlessly injected into the SDK. | ||
|
|
||
| ### Example: Custom Identity Provider |
There was a problem hiding this comment.
I would rather focus on two interfaces required by the local membership: KeyManagerProvider and KeyManager both under identity/membership. The default implementations are X509 based and idemix as described in the Default Key Managers section.
| implementing the required identity and wallet interfaces. | ||
|
|
||
| Typical extension scenarios include: | ||
| - Supporting a new identity type |
There was a problem hiding this comment.
this can be done via introducing a key manager or composing existing identity types, examples are in the Other Identity Types section
adecaro
left a comment
There was a problem hiding this comment.
Thanks a lot for the effort. Left comments to help moving forward.
4cfe49e to
fa4af6a
Compare
|
Hi, I’ve made the requested changes: Please let me know if any further refinements are needed. |
fa4af6a to
bd2dabe
Compare
| on the Identity Service interfaces, allowing different identity implementations | ||
| to be plugged in transparently. | ||
|
|
||
| ### Example: Custom KeyManager Implementation |
There was a problem hiding this comment.
I think we can remove this section because it does not match the current code.
There was a problem hiding this comment.
HI @sid200727 , just this one is left and then we are good. Thanks 👍
|
Hi @adecaro, Thanks for the clarification. I’ve removed the “Custom KeyManager Implementation” example section that did not match the current codebase. Please let me know if any further refinements are needed. |
|
Hi @sid200727 , did you push your last changes? |
|
Hi @adecaro, Thanks for spotting this. Thanks for the patience. |
9453f1d to
0c47076
Compare
|
@sid200727 , please, don't forget to always use There is only one section that needs to be removed and then we are done. Thanks very much for this effort. |
0c47076 to
f35114c
Compare
|
Hi @adecaro, Thanks again for the guidance. Please let me know if anything else should be refined. |
|
Hi @sid200727 , it is strange, when I check the files here: https://github.com/hyperledger-labs/fabric-token-sdk/pull/1326/changes I still see the paragraph we agreed to remove. What can it be? |
|
Hi @adecaro, Thanks, I’ve now removed the remaining “Custom KeyManager Implementation” example section. This PR should now reflect only the intended documentation changes. Please let me know if anything else needs refinement. |
|
After updating the branch with latest main, the coverage check shows a -0.009% decrease (25.6%). This PR only contains documentation changes, so no code or test logic was modified. Please let me know if you would like me to take any action here, or if this can be overridden. Thanks again. |
…ocumentation Signed-off-by: Siddhi Khandelwal <siddhi.200727@gmail.com>
Signed-off-by: Siddhi Khandelwal <siddhi.200727@gmail.com>
7e5d259 to
4852d5a
Compare
Summary:
This PR improves the Identity Service documentation to make it easier for new contributors and users to understand how it works and how it can be extended.
What’s included:
• A brief explanation of how the Identity Service is used within the SDK
• Clear guidance on common extension points (identity providers, key managers, roles)
• A simple Go example showing how a custom identity provider could be implemented
Why this change:
The existing documentation explains the architecture well but does not clearly show how developers can extend the Identity Service.
These additions aim to reduce confusion and lower the learning curve.
Related issue:
#1008