AGENTS.md

1# Transport Security Interface (TSI)
2 
3This directory contains the implementation of gRPC's Transport Security Interface (TSI), which is an abstraction for different transport security mechanisms like TLS and ALTS.
4 
5## Overarching Purpose
6 
7TSI provides a unified interface for performing transport-level security handshakes and protecting data. This allows gRPC to support different security mechanisms without having to change the core transport code.
8 
9## Files and Subdirectories
10 
11- **`transport_security_interface.h`**: Defines the core `tsi_handshaker` and `tsi_frame_protector` interfaces.
12- **`transport_security.h` / `transport_security.cc`**: Defines the `tsi_transport_security` interface, which is a higher-level abstraction that combines the `tsi_handshaker` and `tsi_frame_protector` interfaces.
13- **`transport_security_grpc.h` / `transport_security_grpc.cc`**: Provides a gRPC-specific implementation of the `tsi_transport_security` interface.
14- **`ssl/`**: An implementation of TSI that uses OpenSSL.
15- **`alts/`**: An implementation of TSI that uses ALTS.
16- **`fake_transport_security.h` / `fake_transport_security.cc`**: A fake implementation of TSI for testing.
17- **`local_transport_security.h` / `local_transport_security.cc`**: An implementation of TSI for local (e.g., UDS) connections.
18 
19## Notes
20 
21- TSI is a key component of gRPC's security infrastructure.
22- It provides a flexible and extensible way to add new security mechanisms to gRPC.
23- The TSI interfaces are designed to be simple and easy to implement, which makes it easy to add support for new security mechanisms.
24