docs(security): document default deployment trust model#5611
Open
ibondarenko1 wants to merge 1 commit into
Open
docs(security): document default deployment trust model#5611ibondarenko1 wants to merge 1 commit into
ibondarenko1 wants to merge 1 commit into
Conversation
A deployed BentoML service has no built-in authentication on its HTTP or gRPC endpoints. The bento author is expected to add Starlette middleware or a gRPC interceptor before exposing the service to untrusted networks. Document this expectation in SECURITY.md so that operators reading the security policy see the boundary up front, and so that reports of 'service has no auth' can be triaged against a written design choice instead of being argued in every advisory.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
SECURITY.mddoes not document the default authentication posture of a deployed BentoML service. A bento started withbentoml servelistens on0.0.0.0:3000and accepts HTTP and gRPC requests without authentication; there is no built-in API-key validation, JWT check, or OAuth flow.A search of past issues (#1273, #2768, #2809, #1031) shows that the "add auth to bentoml" question keeps coming up and getting closed without a documented design answer. Peer projects (HuggingFace transformers, NVIDIA Triton, vLLM) document their default-auth posture up front and route the responsibility to the operator. This PR brings BentoML in line with that practice.
What
Adds a new section "Default deployment trust model" to
SECURITY.md, between "Reporting a Vulnerability" and "Exceptions". The section:svc.add_asgi_middleware(...)(defined atsrc/bentoml/_internal/service/service.py:445).bentoml.grpc.interceptors.No code change. No behavior change. No backwards compatibility risk.
Impact
Testing
Pure docs PR; no automated test applies. Verification:
svc.add_asgi_middlewareexists on HEADe570eb2b(grep verified).bentoml.grpc.interceptorspackage exists (verified).References
Checklist