-
Notifications
You must be signed in to change notification settings - Fork 0
Document authentication and TLS requirements in proto comments #9
Copy link
Copy link
Open
Labels
area/protoProto definitions, message design, or wire compatibility work.Proto definitions, message design, or wire compatibility work.good first issueSmall, well-scoped tasks for new contributors.Small, well-scoped tasks for new contributors.help wantedLooking for community contributions.Looking for community contributions.kind/docsDocumentation, examples, or community health updates.Documentation, examples, or community health updates.priority/mediumNormal priority item.Normal priority item.
Metadata
Metadata
Assignees
Labels
area/protoProto definitions, message design, or wire compatibility work.Proto definitions, message design, or wire compatibility work.good first issueSmall, well-scoped tasks for new contributors.Small, well-scoped tasks for new contributors.help wantedLooking for community contributions.Looking for community contributions.kind/docsDocumentation, examples, or community health updates.Documentation, examples, or community health updates.priority/mediumNormal priority item.Normal priority item.
Problem statement
The gRPC service definitions (
TransportConnectorServiceandHubService) contain no authentication, authorization, or TLS requirements in their documentation. All four streaming RPCs are defined without security annotations or guidance. Implementations may omit security controls if the contract doesn't specify them.Additionally:
metadatamap fields don't warn against storing secretsBindingInfo.endpointaccepts arbitrary protocol schemes with no guidance on allowed formatsProposed change
Add security documentation to proto comments:
Add metadata warnings:
Add endpoint format guidance:
Affected area
Compatibility / migration
Comment-only change. No wire or code impact.
Additional context
Identified during security review. The contract layer is the right place to document security expectations because every downstream consumer reads the proto files.