Skip to content

docs(identity): clarify extension points and add custom identity prov… - #1326

Merged
adecaro merged 2 commits into
LFDT-Panurus:mainfrom
sid200727:docs/identity-service-improvements
Feb 17, 2026
Merged

docs(identity): clarify extension points and add custom identity prov…#1326
adecaro merged 2 commits into
LFDT-Panurus:mainfrom
sid200727:docs/identity-service-improvements

Conversation

@sid200727

Copy link
Copy Markdown
Contributor

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

@sid200727
sid200727 force-pushed the docs/identity-service-improvements branch from 18721b5 to 86a8aaf Compare February 12, 2026 04:24
@sid200727
sid200727 force-pushed the docs/identity-service-improvements branch from 2ab86d2 to 2421ad0 Compare February 12, 2026 06:14
@sid200727

Copy link
Copy Markdown
Contributor Author

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.

@adecaro
adecaro self-requested a review February 13, 2026 09:14
@adecaro

adecaro commented Feb 13, 2026

Copy link
Copy Markdown
Contributor

Hi @sid200727 , thanks for submitting this PR.
First two comments:

Thanks much, I will now look at additions.

Comment thread docs/services/identity.md Outdated
on the Identity Service interfaces, allowing different identity implementations
to be plugged in transparently.

## Extending the Identity Service

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.

Please, move this section at the end of document because it contains content for pro developers.

Comment thread docs/services/identity.md Outdated

Typical extension scenarios include:
- Supporting a new identity type
- Customizing signature generation or verification

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.

indeed, via key managers

Comment thread docs/services/identity.md Outdated
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

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.

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.

Comment thread docs/services/identity.md Outdated
implementing the required identity and wallet interfaces.

Typical extension scenarios include:
- Supporting a new identity type

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.

this can be done via introducing a key manager or composing existing identity types, examples are in the Other Identity Types section

@adecaro adecaro left a comment

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 a lot for the effort. Left comments to help moving forward.

@adecaro adecaro self-assigned this Feb 13, 2026
@adecaro adecaro added the documentation Improvements or additions to documentation label Feb 13, 2026
@adecaro adecaro added this to the Q1/26 milestone Feb 13, 2026
@adecaro adecaro linked an issue Feb 13, 2026 that may be closed by this pull request
@sid200727
sid200727 force-pushed the docs/identity-service-improvements branch from 4cfe49e to fa4af6a Compare February 13, 2026 20:30
@sid200727

Copy link
Copy Markdown
Contributor Author

Hi,
Thank you for the detailed feedback.

I’ve made the requested changes:
• Moved the “Extending the Identity Service” section to the end of the document
• Updated the extension scenarios to clearly reference KeyManager and KeyManagerProvider
• Refocused the example on KeyManager/KeyManagerProvider under identity/membership
• Linked identity.md from docs/services.md
• Fixed DCO sign-off

Please let me know if any further refinements are needed.

@adecaro
adecaro force-pushed the docs/identity-service-improvements branch from fa4af6a to bd2dabe Compare February 14, 2026 06:35
Comment thread docs/services/identity.md Outdated
on the Identity Service interfaces, allowing different identity implementations
to be plugged in transparently.

### Example: Custom KeyManager Implementation

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.

I think we can remove this section because it does not match the current code.

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.

HI @sid200727 , just this one is left and then we are good. Thanks 👍

@sid200727

Copy link
Copy Markdown
Contributor Author

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.

@adecaro

adecaro commented Feb 16, 2026

Copy link
Copy Markdown
Contributor

Hi @sid200727 , did you push your last changes?
There are also changes to config.go. These look like as belonging to a different PR.

@adecaro
adecaro self-requested a review February 16, 2026 05:42
@sid200727

Copy link
Copy Markdown
Contributor Author

Hi @adecaro,

Thanks for spotting this.
You're right the changes to config.go belong to a different PR and were accidentally pushed to this branch.
I will remove those commits from this PR and keep it focused strictly on documentation.

Thanks for the patience.

@sid200727
sid200727 force-pushed the docs/identity-service-improvements branch 2 times, most recently from 9453f1d to 0c47076 Compare February 16, 2026 06:46
@adecaro

adecaro commented Feb 16, 2026

Copy link
Copy Markdown
Contributor

@sid200727 , please, don't forget to always use -s when generating commits. Please, address the DCO requirement following the instructions here: https://github.com/hyperledger-labs/fabric-token-sdk/pull/1326/checks?check_run_id=63714459289

There is only one section that needs to be removed and then we are done.

Thanks very much for this effort.

@sid200727
sid200727 force-pushed the docs/identity-service-improvements branch from 0c47076 to f35114c Compare February 16, 2026 09:12
@sid200727

Copy link
Copy Markdown
Contributor Author

Hi @adecaro,

Thanks again for the guidance.
I’ve rebuilt the branch cleanly on top of main, and this PR now contains only the intended documentation changes in docs/services/identity.md.
All unrelated changes have been removed, and the history has been simplified into a single signed-off commit.

Please let me know if anything else should be refined.

@adecaro

adecaro commented Feb 16, 2026

Copy link
Copy Markdown
Contributor

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?

@sid200727

Copy link
Copy Markdown
Contributor Author

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.

@sid200727

Copy link
Copy Markdown
Contributor Author

@adecaro

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.

@adecaro adecaro left a comment

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.

LGTM

…ocumentation

Signed-off-by: Siddhi Khandelwal <siddhi.200727@gmail.com>
Signed-off-by: Siddhi Khandelwal <siddhi.200727@gmail.com>
@adecaro
adecaro force-pushed the docs/identity-service-improvements branch from 7e5d259 to 4852d5a Compare February 17, 2026 17:17
@adecaro
adecaro merged commit 828a56e into LFDT-Panurus:main Feb 17, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

identity service: documentation

2 participants