Skip to content

Added server profile design doc in eSignet - #2115

Merged
anushasunkada merged 3 commits into
mosip:developfrom
Infosys:ES-ServerProfile
Aug 3, 2026
Merged

Added server profile design doc in eSignet#2115
anushasunkada merged 3 commits into
mosip:developfrom
Infosys:ES-ServerProfile

Conversation

@Md-Humair-KK

@Md-Humair-KK Md-Humair-KK commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive design guide for the new Server Profile feature.
    • Documented global profile settings, startup behavior, and how effective security settings are resolved per transaction.
    • Included supported profile values, database schema details, example configurations, and guidance for introducing new profiles.
    • Added notes covering enforced behaviors for key OpenID/FAPI security features and backward compatibility.

Signed-off-by: Md-Humair-KK <mdhumair.kankudti@gmail.com>
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

A new design document describes the Server Profile feature, including global configuration, database mappings, runtime resolution, OIDC/FAPI enforcement for PAR, PKCE, and DPoP, custom profiles, and backward compatibility.

Changes

Server Profile Design Document

Layer / File(s) Summary
Server profile design doc
docs/design/server-profile.md
Documents the global toggle, server_profile schema and seed mappings, runtime priority rules, PAR/PKCE/DPoP enforcement, custom profile setup, and compatibility guidance.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A profile guides the server’s flight,
PAR and PKCE guard the night,
DPoP joins the safety crew,
One toggle makes the pathway true.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: adding a server profile design document to eSignet.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Comment thread docs/design/server-profile.md Outdated
Comment thread docs/design/server-profile.md Outdated
Comment thread docs/design/server-profile.md Outdated
Signed-off-by: Md-Humair-KK <mdhumair.kankudti@gmail.com>
Signed-off-by: Md-Humair-KK <mdhumair.kankudti@gmail.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/design/server-profile.md`:
- Around line 7-10: Document and enforce startup validation for the server
profile configuration: when mosip.esignet.server.profile is anything other than
"none", require matching mandatory server_profile mappings and fail startup with
a configuration error if the profile is unknown or incomplete. Preserve the
existing behavior for the "none" profile and prevent empty mappings from falling
back to client-level configuration.
- Around line 7-10: Update the fapi2.0 server profile documentation and its
corresponding database mappings to either enforce the missing FAPI 2.0
controls—PKCE S256, MTLS or DPoP sender-constrained tokens, and a 60-second
authorization-code lifetime—or rename the profile and descriptions to accurately
reflect the narrower policy. Keep the documented profile behavior and database
configuration consistent.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b4c9f33c-adaa-42e8-b3de-115671c85e37

📥 Commits

Reviewing files that changed from the base of the PR and between 4c85b97 and 0556fd7.

📒 Files selected for processing (1)
  • docs/design/server-profile.md

Comment thread docs/design/server-profile.md
@anushasunkada
anushasunkada merged commit 0431363 into mosip:develop Aug 3, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants