envoyproxy/envoy

xDS gRPC CallCredentials: support loading service account key from file system

Open

#10,459 opened on Mar 19, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/grpchelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Today when using a service account key as xDS gRPC call credentials, the content of the service account key needs to be included in Envoy bootstrap config. E.g.

grpc_services:
    - google_grpc:
        ...
        call_credentials:
          service_account_jwt_access:
            json_key: <content of service account key>
            token_lifetime_seconds: xxx

It would be better, if there is an option to keep service account key outside of bootstrap config in a file and reference the file path in bootstrap config.

Contributor guide

Research direction
Examine the bootstrap config parsing code in Envoy, particularly for gRPC call credentials. Look for how json key is currently handled and consider adding a file path option similar to other config fields that support file references. Review existing patterns for file based secrets in Envoy's configuration.
Tech stack
cpp
Domain
infrastructuresecurityauthentication
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++EnvoygRPCAuthentication
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30