envoy-types 0.7.3

Collection of protobuf types and other assets to work with the Envoy Proxy through Rust gRPC services.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# envoy-types

Collection of protobuf types and other assets to work with the
[Envoy Proxy](https://www.envoyproxy.io) through Rust gRPC services.

Among other use cases, this crate can be used to implement an
[Envoy External Authorization](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/ext_authz_filter)
(ExtAuthz) gRPC Server written in Rust.

[![Crates.io Badge](https://img.shields.io/crates/v/envoy-types)](https://crates.io/crates/envoy-types)
[![Documentation Badge](https://docs.rs/envoy-types/badge.svg)](https://docs.rs/envoy-types)
[![License Badge](https://img.shields.io/crates/l/envoy-types)](https://github.com/flemosr/envoy-types/blob/main/LICENSE)
![CI Badge](https://github.com/flemosr/envoy-types/actions/workflows/ci.yml/badge.svg)

[Repository](https://github.com/flemosr/envoy-types) |
[Examples](https://github.com/flemosr/envoy-types/tree/main/examples) |
[Documentation](https://docs.rs/envoy-types/latest/envoy_types)

## Getting Started

### Rust Version

This project's MSRV is `1.82`.

### Dependencies

```toml
[dependencies]
envoy-types = "<envoy-types-version>"
```

The protobuf types made available are already pre-compiled, so the latest stable Protocol Buffer
Compiler (`protoc`) is only needed to run the crate's tests. Generated code may vary across `protoc`
versions, and the use of the latest stable version is enforced by CI. Installation instructions can
be found [here](https://grpc.io/docs/protoc-installation/).

## Examples

The example bellow covers a bare-bones implementation of an Envoy ExtAuthz gRPC
`AuthorizationServer`, with [`tonic`](https://github.com/hyperium/tonic). A more complete
implementation, including query parameters and header manipulation, can be found at the
[examples](https://github.com/flemosr/envoy-types/tree/main/examples) directory.

```rust,ignore
use std::env;
use tonic::{transport::Server, Request, Response, Status};

use envoy_types::ext_authz::v3::pb::{
    Authorization, AuthorizationServer, CheckRequest, CheckResponse,
};
use envoy_types::ext_authz::v3::{CheckRequestExt, CheckResponseExt};

#[derive(Default)]
struct MyServer;

#[tonic::async_trait]
impl Authorization for MyServer {
    async fn check(
        &self,
        request: Request<CheckRequest>,
    ) -> Result<Response<CheckResponse>, Status> {
        let request = request.into_inner();

        let client_headers = request
            .get_client_headers()
            .ok_or_else(|| Status::invalid_argument("client headers not populated by envoy"))?;

        let mut request_status = Status::unauthenticated("not authorized");

        if let Some(authorization) = client_headers.get("authorization") {
            if authorization == "Bearer valid-token" {
                request_status = Status::ok("request is valid");
            }
        }

        Ok(Response::new(CheckResponse::with_status(request_status)))
    }
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let server_port = env::var("SERVER_PORT").unwrap_or("50051".into());
    let addr = format!("0.0.0.0:{server_port}").parse().unwrap();
    let server = MyServer;

    println!("AuthorizationServer listening on {addr}");

    Server::builder()
        .add_service(AuthorizationServer::new(server))
        .serve(addr)
        .await?;

    Ok(())
}
```

## Compatibility

The table bellow outlines the correspondence between the versions of
[`tonic`](https://github.com/hyperium/tonic) and the compatible versions of
[`envoy-types`](https://crates.io/crates/envoy-types).

`tonic` | `envoy-types`
:-      | :-
v0.14   | [v0.7](https://crates.io/crates/envoy-types/0.7.3)
v0.13   | [v0.6](https://crates.io/crates/envoy-types/0.6.1)
v0.12   | [v0.5](https://crates.io/crates/envoy-types/0.5.6)
v0.11   | [v0.4](https://crates.io/crates/envoy-types/0.4.0)
v0.10   | [v0.3](https://crates.io/crates/envoy-types/0.3.0)
v0.9    | [v0.2](https://crates.io/crates/envoy-types/0.2.0)

## License

This project is licensed under the
[Apache License (Version 2.0)](https://github.com/flemosr/envoy-types/blob/main/LICENSE).

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion by
you, shall be licensed as Apache-2.0, without any additional terms or conditions.