feat: 🎸 add support for newer RFCs

streamich · streamich · commit 2f4371b93ef0 · 2025-10-07T23:36:47.000+02:00
diff --git a/src/rpc/CHANGES.md b/src/rpc/CHANGES.md
@@ -0,0 +1,130 @@
+# Changes for Full RFC Compliance
+
+This document summarizes the changes made to support all RPC RFCs (1057, 1831, 5531).
+
+## Summary
+
+The RPC module was originally developed based on RFC 1057. The following changes were made to ensure full compliance with RFC 1831 and RFC 5531 while maintaining backward compatibility.
+
+## Code Changes
+
+### 1. `constants.ts`
+
+#### Added Authentication Flavors (RFC 5531)
+
+- `AUTH_KERB = 4` - Kerberos authentication
+- `AUTH_RSA = 5` - RSA authentication
+- `RPCSEC_GSS = 6` - GSS-based security (RFC 2203, RFC 5403)
+
+#### Renamed Authentication Flavors (RFC 1831)
+
+- `AUTH_NONE = 0` - New standard name (was AUTH_NULL)
+- `AUTH_SYS = 1` - New standard name (was AUTH_UNIX)
+- `AUTH_DH = 3` - New standard name (was AUTH_DES)
+- Kept old names as aliases for backward compatibility
+
+#### Added Authentication Status Values (RFC 5531)
+
+- `AUTH_OK = 0` - Success status
+- `AUTH_INVALIDRESP = 6` - Invalid response
+- `AUTH_FAILED = 7` - General authentication failure
+- `AUTH_KERB_GENERIC = 8` - Generic Kerberos error
+- `AUTH_TIMEEXPIRE = 9` - Time expiration
+- `AUTH_TKT_FILE = 10` - Ticket file error
+- `AUTH_DECODE = 11` - Decoding error
+- `AUTH_NET_ADDR = 12` - Network address error
+- `RPCSEC_GSS_CREDPROBLEM = 13` - GSS credential problem
+- `RPCSEC_GSS_CTXPROBLEM = 14` - GSS context problem
+
+#### Added Accept Status Value (RFC 5531)
+
+- `SYSTEM_ERR = 5` - System error (e.g., memory allocation failures)
+
+#### Added RFC Attribution Comments
+
+- Each constant group now has `@see` references to the specific RFC sections
+- Individual values annotated with their source RFC
+
+### 2. Documentation
+
+#### Created `RFC_COMPLIANCE.md`
+
+Comprehensive documentation covering:
+
+- All three RFC versions and their differences
+- Authentication flavors evolution
+- Authentication and accept status values
+- Data size limits (400-byte auth body limit from RFC 1831)
+- Batching and broadcast semantics
+- Security considerations from RFC 5531
+- Program number ranges and IANA administration
+- Transport independence principles
+- XDR references across RFC versions
+
+#### Updated `README.md`
+
+- Changed description from "RFC 1057" to "all three major RPC RFCs"
+- Added list of supported RFCs (1057, 1831, 5531)
+- Referenced `RFC_COMPLIANCE.md` for detailed information
+
+## Backward Compatibility
+
+All changes maintain full backward compatibility:
+
+1. **Old authentication flavor names preserved** as aliases:
+
+   - `AUTH_NULL` = `AUTH_NONE`
+   - `AUTH_UNIX` = `AUTH_SYS`
+   - `AUTH_DES` = `AUTH_DH`
+
+2. **Existing functionality unchanged**:
+
+   - All encoder/decoder logic remains the same
+   - Wire format compatibility maintained
+   - No breaking changes to API
+
+3. **Test compatibility**:
+   - All existing tests pass without modification
+   - Existing code using old constants continues to work
+
+## Wire Format Compatibility
+
+The implementation is wire-compatible with:
+
+- RFC 1057 (1988) implementations
+- RFC 1831 (1995) implementations
+- RFC 5531 (2009) implementations
+
+All use RPC Version 2 protocol with identical on-the-wire message format.
+
+## Implementation Notes
+
+### What Changed
+
+- Constants expanded to include all RFC-defined values
+- Documentation enhanced with RFC attributions
+- Size limits enforced per RFC 1831/5531 (400-byte auth body limit)
+
+### What Didn't Change
+
+- Core encoder/decoder implementation
+- Message structure classes
+- XDR encoding/decoding logic
+- API surface
+- Test suite (all tests pass)
+
+## Testing
+
+All existing tests pass without modification, confirming:
+
+- Backward compatibility maintained
+- No breaking changes introduced
+- Core functionality preserved
+
+## References
+
+- RFC 1057: RPC: Remote Procedure Call, Version 2 (June 1988)
+- RFC 1831: RPC: Remote Procedure Call Protocol Specification Version 2 (August 1995)
+- RFC 5531: RPC: Remote Procedure Call Protocol Specification Version 2 (May 2009)
+- RFC 2203: RPCSEC_GSS Protocol Specification
+- RFC 5403: RPCSEC_GSS Version 2
diff --git a/src/rpc/README.md b/src/rpc/README.md
@@ -1,7 +1,13 @@
 # RPC (Remote Procedure Call) Codec
 
-This codec implements streaming encoder and decoder for (Sun Microsystems) RPC
-protocol as described in RFC 1057.
+This codec implements streaming encoder and decoder for ONC (Open Network Computing)
+RPC protocol. It supports all three major RPC RFCs:
+
+- **RFC 1057** (1988) - RPC: Remote Procedure Call, Version 2
+- **RFC 1831** (1995) - RPC: Remote Procedure Call Protocol Specification Version 2
+- **RFC 5531** (2009) - RPC: Remote Procedure Call Protocol Specification Version 2 (Internet Standard)
+
+See `RFC_COMPLIANCE.md` for detailed information about supported features and differences between RFC versions.
 
 ## Note on Record Marking
 
diff --git a/src/rpc/RFC_COMPLIANCE.md b/src/rpc/RFC_COMPLIANCE.md
@@ -0,0 +1,165 @@
+# RFC Compliance Documentation
+
+This RPC implementation supports all three major RPC RFCs:
+
+- **RFC 1057** (1988) - RPC: Remote Procedure Call, Version 2
+- **RFC 1831** (1995) - RPC: Remote Procedure Call Protocol Specification Version 2
+- **RFC 5531** (2009) - RPC: Remote Procedure Call Protocol Specification Version 2 (Internet Standard)
+
+## Changes from RFC 1057 to Full RFC Compliance
+
+### 1. Authentication Flavors (RFC 1831/5531)
+
+#### RFC 1057 (Original)
+
+- AUTH_NULL (0)
+- AUTH_UNIX (1)
+- AUTH_SHORT (2)
+- AUTH_DES (3)
+
+#### RFC 1831 (Updated naming)
+
+- AUTH_NONE (0) - renamed from AUTH_NULL
+- AUTH_SYS (1) - renamed from AUTH_UNIX
+- AUTH_SHORT (2)
+- AUTH_DES (3) - refined but optional
+
+#### RFC 5531 (Additional flavors)
+
+- AUTH_NONE (0)
+- AUTH_SYS (1)
+- AUTH_SHORT (2)
+- AUTH_DH (3) - Diffie-Hellman (obsolete, insecure per RFC 2695)
+- AUTH_KERB (4) - Kerberos
+- AUTH_RSA (5)
+- RPCSEC_GSS (6) - GSS-based security with integrity/privacy (RFC 2203, RFC 5403)
+
+**Implementation Note**: The code maintains backward compatibility by keeping AUTH_NULL as an alias for AUTH_NONE, and AUTH_UNIX as an alias for AUTH_SYS. AUTH_DES is also an alias for AUTH_DH.
+
+### 2. Authentication Status Values (RFC 5531)
+
+#### RFC 1057
+
+- AUTH_BADCRED (1)
+- AUTH_REJECTEDCRED (2)
+- AUTH_BADVERF (3)
+- AUTH_REJECTEDVERF (4)
+- AUTH_TOOWEAK (5)
+
+#### RFC 5531 (Additional values)
+
+- AUTH_OK (0) - Added for completeness
+- AUTH_INVALIDRESP (6)
+- AUTH_FAILED (7)
+- AUTH_KERB_GENERIC (8)
+- AUTH_TIMEEXPIRE (9)
+- AUTH_TKT_FILE (10)
+- AUTH_DECODE (11)
+- AUTH_NET_ADDR (12)
+- RPCSEC_GSS_CREDPROBLEM (13) - RPCSEC_GSS credential problem
+- RPCSEC_GSS_CTXPROBLEM (14) - RPCSEC_GSS context problem
+
+### 3. Accept Status Values (RFC 5531)
+
+#### RFC 1057
+
+- SUCCESS (0)
+- PROG_UNAVAIL (1)
+- PROG_MISMATCH (2)
+- PROC_UNAVAIL (3)
+- GARBAGE_ARGS (4)
+
+#### RFC 5531 (Addition)
+
+- SYSTEM_ERR (5) - Added for issues like memory allocation failures
+
+### 4. Data Size Limits
+
+#### RFC 1057
+
+- Opaque authentication bodies: Limited by XDR
+- Fragment sizes: Limited by implementation
+
+#### RFC 1831/5531
+
+- Opaque authentication bodies: Up to 400 bytes
+- Fragment sizes: Up to 2^31-1 bytes for stream transports (TCP)
+
+**Implementation**: The decoder enforces the 400-byte limit for auth bodies. Fragment size limits for record marking are enforced by the separate `rm` module.
+
+### 5. Batching and Broadcast (RFC 1831)
+
+RFC 1831 explicitly formalized:
+
+- **Batching**: Pipelining sequences of calls without immediate replies over reliable transports
+- **Broadcast/Multicast RPC**: Support for multicast RPC over packet-based protocols like UDP
+
+**Implementation Note**: This codec handles message encoding/decoding. Batching and broadcast semantics are implemented at the transport layer by the application.
+
+### 6. Security Considerations (RFC 5531)
+
+RFC 5531 emphasizes:
+
+- AUTH_NONE and AUTH_SYS are weak and SHOULD NOT be used for modifiable data
+- Future Standards Track RPC programs MUST support RPCSEC_GSS
+- External security measures (e.g., privileged ports) may be necessary
+
+**Implementation Note**: This codec provides the wire format for all authentication flavors. Security policy enforcement is the responsibility of the application layer.
+
+## Program Number Ranges
+
+### RFC 1057
+
+- Simple assignment scheme
+
+### RFC 1831
+
+- 0x00000000-0x1fffffff: Defined by Sun/central authority
+- 0x20000000-0x3fffffff: User-defined
+- 0x40000000-0x5fffffff: Transient
+- 0x60000000-0xffffffff: Reserved
+
+### RFC 5531 (IANA Administration)
+
+- Assignment authority transferred to IANA
+- Formal policies: First Come First Served for small blocks, Specification Required for larger ones
+- 0x20000000-0x3fffffff: Site-specific use
+- Appendix C lists Sun-assigned numbers (e.g., portmapper=100000, NFS=100003)
+
+**Implementation Note**: Program number validation and assignment is not enforced by this codec.
+
+## XDR References
+
+- **RFC 1057**: References original XDR specification
+- **RFC 1831**: References RFC 1832 (XDR update)
+- **RFC 5531**: References RFC 4506 (STD 67)
+
+This implementation follows XDR encoding as specified in these standards.
+
+## Transport Independence
+
+All RFC versions maintain transport independence. The RPC protocol:
+
+- Does NOT provide reliability (must be provided by transport or application)
+- Does NOT attach specific semantics to remote procedures
+- Supports both connection-oriented (TCP) and connectionless (UDP) transports
+
+**Record Marking**: For TCP and other stream-oriented transports, RFC 1057 Section 10 specifies a record marking standard. This is implemented in the separate `rm` module (`src/rm/`).
+
+## Compatibility
+
+The implementation is designed to be compatible with all three RFC versions:
+
+- Uses RPC_VERSION = 2 (compatible with all versions)
+- Supports all authentication flavors (old and new names)
+- Handles all error conditions defined across all RFCs
+- Enforces size limits as specified in later RFCs
+
+## References
+
+1. RFC 1057 - RPC: Remote Procedure Call, Version 2 (June 1988)
+2. RFC 1831 - RPC: Remote Procedure Call Protocol Specification Version 2 (August 1995)
+3. RFC 5531 - RPC: Remote Procedure Call Protocol Specification Version 2 (May 2009)
+4. RFC 2203 - RPCSEC_GSS Protocol Specification
+5. RFC 5403 - RPCSEC_GSS Version 2
+6. RFC 2623 - NFS Version 2 and Version 3 Security Issues and the NFS Protocol's Use of RPCSEC_GSS and Kerberos V5
diff --git a/src/rpc/constants.ts b/src/rpc/constants.ts
