Skip to content

Docs: surface serialization security guidance on the remoting security page#8177

Merged
Aaronontheweb merged 2 commits into
akkadotnet:devfrom
Aaronontheweb:docs/serialization-security-visibility
Apr 23, 2026
Merged

Docs: surface serialization security guidance on the remoting security page#8177
Aaronontheweb merged 2 commits into
akkadotnet:devfrom
Aaronontheweb:docs/serialization-security-visibility

Conversation

@Aaronontheweb
Copy link
Copy Markdown
Member

@Aaronontheweb Aaronontheweb commented Apr 23, 2026

Summary

Follow-up to #8173, which added the allow-unregistered-types = false setting (v1.5.66+) and documented it in the serialization page. This PR makes that security guidance more visible on the remoting/network security page without duplicating the full content.

  • Expands the Security Layers section from 3 to 4, adding Serialization Safety as a layer
  • Adds a dedicated Serialization Security section on the remoting security page (between Untrusted Mode and VPNs) explaining the fallback deserialization risk and the key HOCON setting, with a link out to the full serialization docs
  • Rewrites several prose sections on both pages to be more direct and readable (mTLS benefits, programmatic validation intro, startup validation, TLS optional/recommended bullet lists)
  • Fixes grammar in the polymorphic serializer warning in serialization.md
  • Updates the cross-reference in serialization.md to point to the new section on the remoting page

Test plan

  • DocFX build passes with zero warnings (dotnet docfx build ./docs/docfx.json --warningsAsErrors)
  • Remoting security page shows Serialization Safety as the 4th security layer
  • Serialization Security section appears between Untrusted Mode and VPNs on the remoting security page
  • Cross-reference link from serialization.md resolves correctly to the new section

…y page

The `allow-unregistered-types = false` setting added in v1.5.66 was only
documented in the serialization page. This adds it as a visible layer on
the network security page as well, without duplicating the full content.

Changes:
- remoting/security.md: expand Security Layers from 3 to 4, adding
  Serialization Safety; add a dedicated Serialization Security section
  between Untrusted Mode and VPNs explaining the fallback risk and the
  HOCON setting; improve prose throughout (mTLS benefits, programmatic
  validation intro, startup validation, TLS optional/recommended lists)
- serialization/serialization.md: rewrite the Disabling Default Serializer
  Fallback prose to drop inline-header bullet list; fix grammar in the
  polymorphic serializer section; update cross-reference link to point to
  the new section on the remoting security page

Closes the follow-up requested in akkadotnet#8173.
@Aaronontheweb Aaronontheweb enabled auto-merge (squash) April 23, 2026 14:34
@Aaronontheweb Aaronontheweb merged commit 2210ecc into akkadotnet:dev Apr 23, 2026
12 checks passed
@Aaronontheweb Aaronontheweb deleted the docs/serialization-security-visibility branch April 23, 2026 15:32
Aaronontheweb added a commit that referenced this pull request Apr 24, 2026
…y page (#8177)

The `allow-unregistered-types = false` setting added in v1.5.66 was only
documented in the serialization page. This adds it as a visible layer on
the network security page as well, without duplicating the full content.

Changes:
- remoting/security.md: expand Security Layers from 3 to 4, adding
  Serialization Safety; add a dedicated Serialization Security section
  between Untrusted Mode and VPNs explaining the fallback risk and the
  HOCON setting; improve prose throughout (mTLS benefits, programmatic
  validation intro, startup validation, TLS optional/recommended lists)
- serialization/serialization.md: rewrite the Disabling Default Serializer
  Fallback prose to drop inline-header bullet list; fix grammar in the
  polymorphic serializer section; update cross-reference link to point to
  the new section on the remoting security page

Closes the follow-up requested in #8173.
This was referenced Apr 27, 2026
This was referenced May 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant