Skip to content

docs: Add documentation for Phase 2 SSH config options#53

Merged
inureyes merged 1 commit into
mainfrom
feature/manual-for-forwarding-options
Oct 23, 2025
Merged

docs: Add documentation for Phase 2 SSH config options#53
inureyes merged 1 commit into
mainfrom
feature/manual-for-forwarding-options

Conversation

@inureyes

Copy link
Copy Markdown
Member

Summary

Comprehensive documentation update for the new SSH configuration options added in PR #52.

Documentation Updates

Files Modified

  • docs/man/bssh.1: Added SSH CONFIGURATION OPTIONS section with detailed option descriptions
  • README.md: Added SSH Configuration Support section with practical examples
  • CHANGELOG.md: Updated Unreleased section with Phase 2 features
  • ARCHITECTURE.md: Added Supported SSH Configuration Options subsection with technical details

New Options Documented

Certificate Authentication Options:

  • CertificateFile - SSH certificate files for PKI authentication (max 100)
  • CASignatureAlgorithms - CA signature algorithms for certificate validation (max 50)
  • HostbasedAuthentication - Enable/disable host-based authentication
  • HostbasedAcceptedAlgorithms - Accepted algorithms for host-based auth (max 50)

Port Forwarding Control Options:

  • GatewayPorts - Control remote port forwarding (yes/no/clientspecified)
  • ExitOnForwardFailure - Terminate connection on forwarding failure
  • PermitRemoteOpen - Allowed destinations for remote forwarding (max 1000)

Examples Included

  • Certificate-based PKI authentication configuration
  • Strict port forwarding control setup
  • Complete configuration with Include and Match directives
  • Usage examples with bssh commands

Security Features Documented

  • Path validation to prevent system file misuse
  • Memory exhaustion prevention with entry limits
  • Automatic deduplication for multi-valued options
  • Algorithm list validation

Related Issue

Testing

  • ✓ All limits are consistent across all documentation files
  • ✓ All 7 options documented in all 4 files
  • ✓ Examples demonstrate real-world usage scenarios
  • ✓ Technical details align with actual implementation

User Impact

Users can now:

  • Configure enterprise PKI authentication via SSH certificates
  • Control port forwarding with fine-grained security options
  • Use advanced SSH configuration features compatible with OpenSSH
  • Understand security limits and best practices

Update all documentation files to reflect the new certificate authentication
and advanced port forwarding options added in PR #52:

Certificate Authentication Options:
- CertificateFile: SSH certificate files for PKI auth (max 100)
- CASignatureAlgorithms: CA signature algorithms (max 50)
- HostbasedAuthentication: Enable/disable host-based auth
- HostbasedAcceptedAlgorithms: Accepted algorithms (max 50)

Port Forwarding Control Options:
- GatewayPorts: Control remote forwarding (yes/no/clientspecified)
- ExitOnForwardFailure: Terminate on forwarding failure
- PermitRemoteOpen: Allowed forwarding destinations (max 1000)

Files Updated:
- docs/man/bssh.1: Added SSH CONFIGURATION OPTIONS section
- README.md: Added SSH Configuration Support section with examples
- CHANGELOG.md: Updated Unreleased section with Phase 2 features
- ARCHITECTURE.md: Added Supported SSH Configuration Options subsection

All security features, limits, and best practices are documented.
Examples demonstrate real-world usage scenarios.
@inureyes inureyes added type:enhancement New feature or request status:ready Ready to be worked on priority:medium Medium priority issue labels Oct 23, 2025
@inureyes inureyes self-assigned this Oct 23, 2025
@inureyes inureyes merged commit 14e7b50 into main Oct 23, 2025
2 checks passed
@inureyes inureyes added status:done Completed and removed status:ready Ready to be worked on labels Oct 23, 2025
@inureyes inureyes deleted the feature/manual-for-forwarding-options branch October 30, 2025 00:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority:medium Medium priority issue status:done Completed type:enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant