AGENTS.md

1# gRPC Handshaker
2 
3This directory contains the implementation of gRPC's handshaker framework, which is responsible for establishing a secure connection between a client and a server.
4 
5## Overarching Purpose
6 
7The handshaker framework provides a pluggable mechanism for performing various handshakes, such as TLS, ALTS, and HTTP CONNECT. It is designed to be extensible, allowing new handshaker implementations to be added easily.
8 
9## Files and Subdirectories
10 
11- **`handshaker.h` / `handshaker.cc`**: Defines the core `Handshaker` class, which represents a single handshaking operation.
12- **`handshaker_factory.h`**: Defines the `HandshakerFactory` class, which is responsible for creating `Handshaker` instances.
13- **`handshaker_registry.h` / `handshaker_registry.cc`**: Defines a registry for `HandshakerFactory` instances, allowing handshakers to be looked up by name.
14- **`proxy_mapper.h`**: Defines the `ProxyMapper` interface, which is used to determine the proxy settings for a given target address.
15- **`proxy_mapper_registry.h` / `proxy_mapper_registry.cc`**: Defines a registry for `ProxyMapper` instances.
16- **`endpoint_info/`**: Contains the `EndpointInfo` class, which is a data structure that contains information about the local and remote endpoints of a connection.
17- **`http_connect/`**: Contains the implementation of the HTTP CONNECT handshaker.
18- **`security/`**: Contains the implementation of the security handshakers, which are responsible for performing TLS and ALTS handshakes.
19- **`tcp_connect/`**: Contains a basic handshaker for TCP connections.
20 
21## Notes
22 
23- The handshaker framework is a critical component of gRPC's security infrastructure.
24- It is responsible for ensuring that all connections are properly authenticated and encrypted.
25- The framework is designed to be flexible and extensible, allowing it to be adapted to different security requirements.
26