AGENTS.md

1# Transport-Specific Credentials
2 
3This directory contains credentials implementations that are tied to a specific transport security type.
4 
5## Overarching Purpose
6 
7These credentials are used to configure the security of the underlying transport. For example, the `TlsCredentials` are used to configure TLS for the Chttp2 transport.
8 
9## Files
10 
11- **`alts_credentials.h` / `alts_credentials.cc`**: An implementation of credentials that uses ALTS.
12- **`google_compute_engine_credentials.h` / `google_compute_engine_credentials.cc`**: An implementation of credentials that uses GCE credentials.
13- **`google_iam_credentials.h` / `google_iam_credentials.cc`**: An implementation of credentials that uses Google IAM credentials.
14- **`insecure_credentials.h` / `insecure_credentials.cc`**: An implementation of credentials that does not use any security.
15- **`local_credentials.h` / `local_credentials.cc`**: An implementation of credentials that uses local credentials (e.g., UDS).
16- **`tls_credentials.h` / `tls_credentials.cc`**: An implementation of credentials that uses TLS.
17- **`xds_credentials.h` / `xds_credentials.cc`**: An implementation of credentials that uses XDS.
18 
19## Notes
20 
21- These credentials are used to configure the security of the underlying transport.
22- They are typically used in conjunction with channel credentials to provide a complete security solution.
23- The credentials in this directory are specific to certain transport security types, and will not work with other transport security types.
24