Support for external authorization grpc service.

include/envoy/ext_authz/BUILD

@@ -0,0 +1,18 @@
+licenses(["notice"])  # Apache 2
+
+load(
+    "//bazel:envoy_build_system.bzl",
+    "envoy_cc_library",
+    "envoy_package",
+)
+
+envoy_package()
+
+envoy_cc_library(
+    name = "ext_authz_interface",
+    hdrs = ["ext_authz.h"],
+    deps = [
+        "//include/envoy/tracing:http_tracer_interface",
+        "@envoy_api//envoy/service/auth/v2:external_auth_cc",
+    ],
+)

include/envoy/ext_authz/ext_authz.h

@@ -0,0 +1,67 @@
+#pragma once
+
+#include <chrono>
+#include <memory>
+#include <string>
+#include <vector>
+
+#include "envoy/common/pure.h"
+#include "envoy/service/auth/v2/external_auth.pb.h"
+#include "envoy/tracing/http_tracer.h"
+
+namespace Envoy {
+namespace ExtAuthz {
+
+/**
+ * Possible async results for a check call.
+ */
+enum class CheckStatus {
+  // The request is authorized.
+  OK,
+  // The authz service could not be queried.
+  Error,
+  // The request is denied.
+  Denied
+};
+
+/**
+ * Async callbacks used during check() calls.
+ */
+class RequestCallbacks {
+public:
+  virtual ~RequestCallbacks() {}
+
+  /**
+   * Called when a check request is complete. The resulting status is supplied.
+   */
+  virtual void onComplete(CheckStatus status) PURE;
+};
+
+class Client {
+public:
+  // Destructor
+  virtual ~Client() {}
+
+  /**
+   * Cancel an inflight Check request.
+   */
+  virtual void cancel() PURE;
+
+  /**
+   * Request a check call to an external authorization service which can use the
+   * passed request parameters to make a permit/deny decision.
+   * @param callback supplies the completion callbacks.
+   *        NOTE: The callback may happen within the calling stack.
+   * @param request is the proto message with the attributes of the specific payload.
+   * @param parent_span source for generating an egress child span as part of the trace.
+   *
+   */
+  virtual void check(RequestCallbacks& callback,
+                     const envoy::service::auth::v2::CheckRequest& request,
+                     Tracing::Span& parent_span) PURE;
+};
+
+typedef std::unique_ptr<Client> ClientPtr;
+
+} // namespace ExtAuthz
+} // namespace Envoy

include/envoy/request_info/request_info.h

@@ -43,8 +43,10 @@ enum ResponseFlag {
   FaultInjected = 0x400,
   // Request was ratelimited locally by rate limit filter.
   RateLimited = 0x800,
+  // Request was unauthorized.
+  Unauthorized = 0x1000,
   // ATTENTION: MAKE SURE THIS REMAINS EQUAL TO THE LAST FLAG.
-  LastFlag = RateLimited
+  LastFlag = Unauthorized
 };
 
 /**

source/common/access_log/grpc_access_log_impl.cc

@@ -69,7 +69,7 @@ void HttpGrpcAccessLog::responseFlagsToAccessLogResponseFlags(
     envoy::config::filter::accesslog::v2::AccessLogCommon& common_access_log,
     const RequestInfo::RequestInfo& request_info) {
 
-  static_assert(RequestInfo::ResponseFlag::LastFlag == 0x800,
+  static_assert(RequestInfo::ResponseFlag::LastFlag == 0x1000,
                 "A flag has been added. Fix this code.");
 
   if (request_info.getResponseFlag(RequestInfo::ResponseFlag::FailedLocalHealthCheck)) {

source/common/config/well_known_names.h

@@ -78,13 +78,15 @@ class NetworkFilterNameValues {
   const std::string REDIS_PROXY = "envoy.redis_proxy";
   // IP tagging filter
   const std::string TCP_PROXY = "envoy.tcp_proxy";
+  // Authorization filter
+  const std::string EXT_AUTHORIZATION = "envoy.ext_authz";
 
   // Converts names from v1 to v2
   const V1Converter v1_converter_;
 
   NetworkFilterNameValues()
       : v1_converter_({CLIENT_SSL_AUTH, ECHO, HTTP_CONNECTION_MANAGER, MONGO_PROXY, RATE_LIMIT,
-                       REDIS_PROXY, TCP_PROXY}) {}
+                       REDIS_PROXY, TCP_PROXY, EXT_AUTHORIZATION}) {}
 };
 
 typedef ConstSingleton<NetworkFilterNameValues> NetworkFilterNames;
@@ -131,13 +133,16 @@ class HttpFilterNameValues {
   const std::string LUA = "envoy.lua";
   // Squash filter
   const std::string SQUASH = "envoy.squash";
+  // External Authorization filter
+  const std::string EXT_AUTHORIZATION = "envoy.ext_authz";
 
   // Converts names from v1 to v2
   const V1Converter v1_converter_;
 
   HttpFilterNameValues()
       : v1_converter_({BUFFER, CORS, DYNAMO, FAULT, GRPC_HTTP1_BRIDGE, GRPC_JSON_TRANSCODER,
-                       GRPC_WEB, HEALTH_CHECK, IP_TAGGING, RATE_LIMIT, ROUTER, LUA}) {}
+                       GRPC_WEB, HEALTH_CHECK, IP_TAGGING, RATE_LIMIT, ROUTER, LUA,
+                       EXT_AUTHORIZATION}) {}
 };
 
 typedef ConstSingleton<HttpFilterNameValues> HttpFilterNames;

source/common/ext_authz/BUILD

@@ -0,0 +1,35 @@
+licenses(["notice"])  # Apache 2
+
+load(
+    "//bazel:envoy_build_system.bzl",
+    "envoy_cc_library",
+    "envoy_package",
+)
+
+envoy_package()
+
+envoy_cc_library(
+    name = "ext_authz_lib",
+    srcs = ["ext_authz_impl.cc"],
+    hdrs = ["ext_authz_impl.h"],
+    deps = [
+        "//include/envoy/ext_authz:ext_authz_interface",
+        "//include/envoy/grpc:async_client_interface",
+        "//include/envoy/grpc:async_client_manager_interface",
+        "//include/envoy/http:filter_interface",
+        "//include/envoy/http:header_map_interface",
+        "//include/envoy/http:protocol_interface",
+        "//include/envoy/network:address_interface",
+        "//include/envoy/network:connection_interface",
+        "//include/envoy/network:filter_interface",
+        "//include/envoy/ssl:connection_interface",
+        "//include/envoy/upstream:cluster_manager_interface",
+        "//source/common/common:assert_lib",
+        "//source/common/grpc:async_client_lib",
+        "//source/common/http:headers_lib",
+        "//source/common/http:utility_lib",
+        "//source/common/network:utility_lib",
+        "//source/common/protobuf",
+        "//source/common/tracing:http_tracer_lib",
+    ],
+)

source/common/ext_authz/ext_authz_impl.cc

@@ -0,0 +1,191 @@
+#include "common/ext_authz/ext_authz_impl.h"
+
+#include <chrono>
+#include <cstdint>
+#include <string>
+#include <vector>
+
+#include "envoy/access_log/access_log.h"
+#include "envoy/ssl/connection.h"
+
+#include "common/common/assert.h"
+#include "common/grpc/async_client_impl.h"
+#include "common/http/headers.h"
+#include "common/http/utility.h"
+#include "common/network/utility.h"
+#include "common/protobuf/protobuf.h"
+
+#include "fmt/format.h"
+
+namespace Envoy {
+namespace ExtAuthz {
+
+GrpcClientImpl::GrpcClientImpl(Grpc::AsyncClientPtr&& async_client,
+                               const Optional<std::chrono::milliseconds>& timeout)
+    : service_method_(*Protobuf::DescriptorPool::generated_pool()->FindMethodByName(
+          "envoy.service.auth.v2.Authorization.Check")),
+      async_client_(std::move(async_client)), timeout_(timeout) {}
+
+GrpcClientImpl::~GrpcClientImpl() { ASSERT(!callbacks_); }
+
+void GrpcClientImpl::cancel() {
+  ASSERT(callbacks_ != nullptr);
+  request_->cancel();
+  callbacks_ = nullptr;
+}
+
+void GrpcClientImpl::check(RequestCallbacks& callbacks,
+                           const envoy::service::auth::v2::CheckRequest& request,
+                           Tracing::Span& parent_span) {
+  ASSERT(callbacks_ == nullptr);
+  callbacks_ = &callbacks;
+
+  request_ = async_client_->send(service_method_, request, *this, parent_span, timeout_);
+}
+
+void GrpcClientImpl::onSuccess(std::unique_ptr<envoy::service::auth::v2::CheckResponse>&& response,
+                               Tracing::Span& span) {
+  CheckStatus status = CheckStatus::OK;
+  ASSERT(response->status().code() != Grpc::Status::GrpcStatus::Unknown);
+  if (response->status().code() != Grpc::Status::GrpcStatus::Ok) {
+    status = CheckStatus::Denied;
+    span.setTag(Constants::get().TraceStatus, Constants::get().TraceUnauthz);
+  } else {
+    span.setTag(Constants::get().TraceStatus, Constants::get().TraceOk);
+  }
+
+  callbacks_->onComplete(status);
+  callbacks_ = nullptr;
+}
+
+void GrpcClientImpl::onFailure(Grpc::Status::GrpcStatus status, const std::string&,
+                               Tracing::Span&) {
+  ASSERT(status != Grpc::Status::GrpcStatus::Ok);
+  UNREFERENCED_PARAMETER(status);
+  callbacks_->onComplete(CheckStatus::Error);
+  callbacks_ = nullptr;
+}
+
+void CreateCheckRequest::setAttrContextPeer(envoy::service::auth::v2::AttributeContext_Peer& peer,
+                                            const Network::Connection& connection,
+                                            const std::string& service, const bool local) {
+
+  // Set the address
+  auto addr = peer.mutable_address();
+  if (!local) {
+    Envoy::Network::Utility::addressToProtobufAddress(*connection.remoteAddress(), *addr);
+  } else {
+    Envoy::Network::Utility::addressToProtobufAddress(*connection.localAddress(), *addr);
+  }
+
+  // Set the principal
+  // Preferably the SAN from the peer's cert or
+  // Subject from the peer's cert.
+  std::string principal;
+  Ssl::Connection* ssl = const_cast<Ssl::Connection*>(connection.ssl());
+  if (ssl != nullptr) {
+    if (!local) {
+      principal = ssl->uriSanPeerCertificate();
+
+      if (principal.empty()) {
+        principal = ssl->subjectPeerCertificate();
+      }
+    } else {
+      principal = ssl->uriSanLocalCertificate();
+
+      if (principal.empty()) {
+        principal = ssl->subjectLocalCertificate();
+      }
+    }
+  }
+  peer.set_principal(principal);
+
+  if (!service.empty()) {
+    peer.set_service(service);
+  }
+}
+
+std::string CreateCheckRequest::getHeaderStr(const Envoy::Http::HeaderEntry* entry) {
+  if (entry) {
+    return entry->value().getString();
+  }
+  return "";
+}
+
+void CreateCheckRequest::setHttpRequest(
+    ::envoy::service::auth::v2::AttributeContext_HttpRequest& httpreq,
+    const Envoy::Http::StreamDecoderFilterCallbacks* callbacks,
+    const Envoy::Http::HeaderMap& headers) {
+
+  // Set id
+  // The streamId is not qualified as a const. Although it is as it does not modify the object.
+  Envoy::Http::StreamDecoderFilterCallbacks* sdfc =
+      const_cast<Envoy::Http::StreamDecoderFilterCallbacks*>(callbacks);
+  httpreq.set_id(std::to_string(sdfc->streamId()));
+
+  // Set method
+  httpreq.set_method(getHeaderStr(headers.Method()));
+  // Set path
+  httpreq.set_path(getHeaderStr(headers.Path()));
+  // Set host
+  httpreq.set_host(getHeaderStr(headers.Host()));
+  // Set scheme
+  httpreq.set_scheme(getHeaderStr(headers.Scheme()));
+
+  // Set size
+  // need to convert to google buffer 64t;
+  httpreq.set_size(sdfc->requestInfo().bytesReceived());
+
+  // Set protocol
+  if (sdfc->requestInfo().protocol().valid()) {
+    httpreq.set_protocol(
+        Envoy::Http::Utility::getProtocolString(sdfc->requestInfo().protocol().value()));
+  }
+
+  // Fill in the headers
+  auto mutable_headers = httpreq.mutable_headers();
+  headers.iterate(
+      [](const Envoy::Http::HeaderEntry& e, void* ctx) {
+        Envoy::Protobuf::Map<::std::string, ::std::string>* mutable_headers =
+            static_cast<Envoy::Protobuf::Map<::std::string, ::std::string>*>(ctx);
+        (*mutable_headers)[e.key().getString()] = e.value().getString();
+        return Envoy::Http::HeaderMap::Iterate::Continue;
+      },
+      mutable_headers);
+}
+
+void CreateCheckRequest::setAttrContextRequest(
+    ::envoy::service::auth::v2::AttributeContext_Request& req,
+    const Envoy::Http::StreamDecoderFilterCallbacks* callbacks,
+    const Envoy::Http::HeaderMap& headers) {
+  setHttpRequest(*req.mutable_http(), callbacks, headers);
+}
+
+void CreateCheckRequest::createHttpCheck(const Envoy::Http::StreamDecoderFilterCallbacks* callbacks,
+                                         const Envoy::Http::HeaderMap& headers,
+                                         envoy::service::auth::v2::CheckRequest& request) {
+
+  auto attrs = request.mutable_attributes();
+
+  Envoy::Http::StreamDecoderFilterCallbacks* cb =
+      const_cast<Envoy::Http::StreamDecoderFilterCallbacks*>(callbacks);
+
+  std::string service = getHeaderStr(headers.EnvoyDownstreamServiceCluster());
+
+  setAttrContextPeer(*attrs->mutable_source(), *cb->connection(), service, false);
+  setAttrContextPeer(*attrs->mutable_destination(), *cb->connection(), "", true);
+  setAttrContextRequest(*attrs->mutable_request(), callbacks, headers);
+}
+
+void CreateCheckRequest::createTcpCheck(const Network::ReadFilterCallbacks* callbacks,
+                                        envoy::service::auth::v2::CheckRequest& request) {
+
+  auto attrs = request.mutable_attributes();
+
+  Network::ReadFilterCallbacks* cb = const_cast<Network::ReadFilterCallbacks*>(callbacks);
+  setAttrContextPeer(*attrs->mutable_source(), cb->connection(), "", false);
+  setAttrContextPeer(*attrs->mutable_destination(), cb->connection(), "", true);
+}
+
+} // namespace ExtAuthz
+} // namespace Envoy