Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add two new attributes: request.url_path and request.queries #1837

Merged
merged 2 commits into from
Aug 10, 2018
Merged

Add two new attributes: request.url_path and request.queries #1837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55107f3
Add two new attributes: request.url_path and request.queries
bianpengyuan Jul 3, 2018
4191995
Update api in repositories.bzl
bianpengyuan Aug 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions include/istio/control/http/check_data.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,15 @@ class CheckData {
// Returns a pointer to the authentication result from request info dynamic
// metadata, if available. Otherwise, returns nullptr.
virtual const ::google::protobuf::Struct *GetAuthenticationResult() const = 0;

// Get request url path, which strips query part from the http path header.
// Return true if url path is found, otherwise return false.
virtual bool GetUrlPath(std::string *url_path) const = 0;

// Get request queries with string map format. Return true if query params are
// found, otherwise return false.
virtual bool GetRequestQueryParams(
std::map<std::string, std::string> *query_params) const = 0;
};

// An interfact to update request HTTP headers with Istio attributes.
Expand Down
2 changes: 2 additions & 0 deletions include/istio/utils/attribute_names.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ struct AttributeName {
static const char kRequestPath[];
static const char kRequestReferer[];
static const char kRequestScheme[];
static const char kRequestUrlPath[];
static const char kRequestQueryParams[];
static const char kRequestBodySize[];
// Total size of request received, including request headers, body, and
// trailers.
Expand Down
4 changes: 2 additions & 2 deletions istio.deps
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"name": "ISTIO_API",
"repoName": "api",
"file": "repositories.bzl",
"lastStableSHA": "123b0a79a4dba5bd653dcac09cf731b8002e5341"
"lastStableSHA": "85f06ac32da4744449da69643bf9d4e149e14892"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you actually have to modify repositories.bzl file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

},
{
"_comment": "",
Expand All @@ -13,4 +13,4 @@
"file": "WORKSPACE",
"lastStableSHA": "346059548e135199eb0b7f0006f3ef19e173bf79"
}
]
]
3 changes: 2 additions & 1 deletion repositories.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ cc_library(
actual = "@googletest_git//:googletest_prod",
)

ISTIO_API = "123b0a79a4dba5bd653dcac09cf731b8002e5341"
ISTIO_API = "85f06ac32da4744449da69643bf9d4e149e14892"

def mixerapi_repositories(bind=True):
BUILD = """
Expand Down Expand Up @@ -168,6 +168,7 @@ cc_proto_library(
srcs = glob(
["envoy/config/filter/http/authn/v2alpha1/*.proto",
"authentication/v1alpha1/*.proto",
"common/v1alpha1/*.proto",
],
),
default_runtime = "//external:protobuf",
Expand Down
23 changes: 23 additions & 0 deletions src/envoy/http/mixer/check_data.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,29 @@ const ::google::protobuf::Struct* CheckData::GetAuthenticationResult() const {
return Utils::Authentication::GetResultFromMetadata(metadata_);
}

bool CheckData::GetUrlPath(std::string* url_path) const {
if (!headers_.Path()) {
return false;
}
const HeaderString& path = headers_.Path()->value();
const char* query_start = Utility::findQueryStringStart(path);
if (query_start != nullptr) {
*url_path = std::string(path.c_str(), query_start - path.c_str());
} else {
*url_path = std::string(path.c_str(), path.size());
}
return true;
}

bool CheckData::GetRequestQueryParams(
std::map<std::string, std::string>* query_params) const {
if (!headers_.Path()) {
return false;
}
*query_params = Utility::parseQueryString(headers_.Path()->value().c_str());
return true;
}

} // namespace Mixer
} // namespace Http
} // namespace Envoy
5 changes: 5 additions & 0 deletions src/envoy/http/mixer/check_data.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ class CheckData : public ::istio::control::http::CheckData,

const ::google::protobuf::Struct* GetAuthenticationResult() const override;

bool GetUrlPath(std::string* url_path) const override;

bool GetRequestQueryParams(
std::map<std::string, std::string>* query_params) const override;

private:
const HeaderMap& headers_;
const envoy::api::v2::core::Metadata& metadata_;
Expand Down
10 changes: 10 additions & 0 deletions src/istio/control/http/attributes_builder.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,16 @@ void AttributesBuilder::ExtractRequestHeaderAttributes(CheckData *check_data) {
builder.AddString(it.name, it.default_value);
}
}

std::string query_path;
if (check_data->GetUrlPath(&query_path)) {
builder.AddString(utils::AttributeName::kRequestUrlPath, query_path);
}

std::map<std::string, std::string> query_map;
if (check_data->GetRequestQueryParams(&query_map) && query_map.size() > 0) {
builder.AddStringMap(utils::AttributeName::kRequestQueryParams, query_map);
}
}

void AttributesBuilder::ExtractAuthAttributes(CheckData *check_data) {
Expand Down
79 changes: 72 additions & 7 deletions src/istio/control/http/attributes_builder_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ attributes {
}
entries {
key: "path"
value: "/books"
value: "/books?a=b&c=d"
}
}
}
Expand All @@ -99,7 +99,22 @@ attributes {
attributes {
key: "request.path"
value {
string_value: "/books"
string_value: "/books?a=b&c=d"
}
}
attributes {
key: "request.query_params"
value {
string_map_value {
entries {
key: "a"
value: "b"
}
entries {
key: "c"
value: "d"
}
}
}
}
attributes {
Expand All @@ -115,6 +130,12 @@ attributes {
}
}
}
attributes {
key: "request.url_path"
value {
string_value: "/books"
}
}
)";

const char kCheckAttributes[] = R"(
Expand All @@ -134,7 +155,7 @@ attributes {
}
entries {
key: "path"
value: "/books"
value: "/books?a=b&c=d"
}
}
}
Expand All @@ -147,10 +168,31 @@ attributes {
}
attributes {
key: "request.path"
value {
string_value: "/books?a=b&c=d"
}
}
attributes {
key: "request.url_path"
value {
string_value: "/books"
}
}
attributes {
key: "request.query_params"
value {
string_map_value {
entries {
key: "a"
value: "b"
}
entries {
key: "c"
value: "d"
}
}
}
}
attributes {
key: "request.scheme"
value {
Expand Down Expand Up @@ -531,15 +573,15 @@ TEST(AttributesBuilderTest, TestCheckAttributesWithoutAuthnFilter) {
EXPECT_CALL(mock_data, GetRequestHeaders())
.WillOnce(Invoke([]() -> std::map<std::string, std::string> {
std::map<std::string, std::string> map;
map["path"] = "/books";
map["path"] = "/books?a=b&c=d";
map["host"] = "localhost";
return map;
}));
EXPECT_CALL(mock_data, FindHeaderByType(_, _))
.WillRepeatedly(Invoke(
[](CheckData::HeaderType header_type, std::string *value) -> bool {
if (header_type == CheckData::HEADER_PATH) {
*value = "/books";
*value = "/books?a=b&c=d";
return true;
} else if (header_type == CheckData::HEADER_HOST) {
*value = "localhost";
Expand All @@ -550,6 +592,18 @@ TEST(AttributesBuilderTest, TestCheckAttributesWithoutAuthnFilter) {
EXPECT_CALL(mock_data, GetAuthenticationResult())
.WillOnce(testing::Return(nullptr));

EXPECT_CALL(mock_data, GetUrlPath(_))
.WillOnce(Invoke([](std::string *path) -> bool {
*path = "/books";
return true;
}));
EXPECT_CALL(mock_data, GetRequestQueryParams(_))
.WillOnce(Invoke([](std::map<std::string, std::string> *map) -> bool {
(*map)["a"] = "b";
(*map)["c"] = "d";
return true;
}));

RequestContext request;
AttributesBuilder builder(&request);
builder.ExtractCheckAttributes(&mock_data);
Expand Down Expand Up @@ -590,15 +644,15 @@ TEST(AttributesBuilderTest, TestCheckAttributes) {
EXPECT_CALL(mock_data, GetRequestHeaders())
.WillOnce(Invoke([]() -> std::map<std::string, std::string> {
std::map<std::string, std::string> map;
map["path"] = "/books";
map["path"] = "/books?a=b&c=d";
map["host"] = "localhost";
return map;
}));
EXPECT_CALL(mock_data, FindHeaderByType(_, _))
.WillRepeatedly(Invoke(
[](CheckData::HeaderType header_type, std::string *value) -> bool {
if (header_type == CheckData::HEADER_PATH) {
*value = "/books";
*value = "/books?a=b&c=d";
return true;
} else if (header_type == CheckData::HEADER_HOST) {
*value = "localhost";
Expand All @@ -612,6 +666,17 @@ TEST(AttributesBuilderTest, TestCheckAttributes) {

EXPECT_CALL(mock_data, GetAuthenticationResult())
.WillOnce(testing::Return(&authn_result));
EXPECT_CALL(mock_data, GetUrlPath(_))
.WillOnce(Invoke([](std::string *path) -> bool {
*path = "/books";
return true;
}));
EXPECT_CALL(mock_data, GetRequestQueryParams(_))
.WillOnce(Invoke([](std::map<std::string, std::string> *map) -> bool {
(*map)["a"] = "b";
(*map)["c"] = "d";
return true;
}));

RequestContext request;
AttributesBuilder builder(&request);
Expand Down
3 changes: 3 additions & 0 deletions src/istio/control/http/mock_check_data.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ class MockCheckData : public CheckData {
const ::google::protobuf::Struct *());
MOCK_CONST_METHOD0(IsMutualTLS, bool());
MOCK_CONST_METHOD1(GetRequestedServerName, bool(std::string *name));
MOCK_CONST_METHOD1(GetUrlPath, bool(std::string *));
MOCK_CONST_METHOD1(GetRequestQueryParams,
bool(std::map<std::string, std::string> *));
};

// The mock object for HeaderUpdate interface.
Expand Down
2 changes: 2 additions & 0 deletions src/istio/utils/attribute_names.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ const char AttributeName::kRequestMethod[] = "request.method";
const char AttributeName::kRequestPath[] = "request.path";
const char AttributeName::kRequestReferer[] = "request.referer";
const char AttributeName::kRequestScheme[] = "request.scheme";
const char AttributeName::kRequestUrlPath[] = "request.url_path";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

have these attributes been added to the global dictionary in istio/api ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just added: istio/api#566

const char AttributeName::kRequestQueryParams[] = "request.query_params";
const char AttributeName::kRequestBodySize[] = "request.size";
const char AttributeName::kRequestTotalSize[] = "request.total_size";
const char AttributeName::kRequestTime[] = "request.time";
Expand Down