Skip to content

Remove fallback for attribute builder when authn filter is not available #1887

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

Merged
istio-testing merged 1 commit into from
Aug 2, 2018
Merged

Remove fallback for attribute builder when authn filter is not available #1887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 0 additions & 28 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 @@ -111,34 +111,6 @@ void AttributesBuilder::ExtractAuthAttributes(CheckData *check_data) {
origin.raw_claims());
}
}
return;
}

// Fallback to extract from jwt filter directly. This can be removed once
// authn filter is in place.
std::map<std::string, std::string> payload;
if (check_data->GetJWTPayload(&payload) && !payload.empty()) {
// Populate auth attributes.
if (payload.count("iss") > 0 && payload.count("sub") > 0) {
builder.AddString(utils::AttributeName::kRequestAuthPrincipal,
payload["iss"] + "/" + payload["sub"]);
}
if (payload.count("aud") > 0) {
builder.AddString(utils::AttributeName::kRequestAuthAudiences,
payload["aud"]);
}
if (payload.count("azp") > 0) {
builder.AddString(utils::AttributeName::kRequestAuthPresenter,
payload["azp"]);
}
builder.AddStringMap(utils::AttributeName::kRequestAuthClaims, payload);
}
std::string source_user;
if (check_data->GetPrincipal(true, &source_user)) {
// TODO(diemtvu): remove kSourceUser once migration to source.principal is
// over. https://github.com/istio/istio/issues/4689
builder.AddString(utils::AttributeName::kSourceUser, source_user);
builder.AddString(utils::AttributeName::kSourcePrincipal, source_user);
}
} // namespace http

Expand Down
165 changes: 110 additions & 55 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 @@ -15,6 +15,7 @@

#include "src/istio/control/http/attributes_builder.h"

#include "gmock/gmock.h"
#include "google/protobuf/text_format.h"
#include "google/protobuf/util/message_differencer.h"
#include "gtest/gtest.h"
Expand All @@ -36,6 +37,88 @@ namespace control {
namespace http {
namespace {

MATCHER_P(EqualsAttribute, expected, "") {
const auto matched = MessageDifferencer::Equals(arg, expected);
if (!matched) {
std::string out_str;
TextFormat::PrintToString(arg, &out_str);
GOOGLE_LOG(INFO) << "\n===" << out_str << "===";
}
return matched;
}
const char kCheckAttributesWithoutAuthnFilter[] = R"(
attributes {
key: "connection.mtls"
value {
bool_value: true
}
}
attributes {
key: "connection.requested_server_name"
value {
string_value: "www.google.com"
}
}
attributes {
key: "context.protocol"
value {
string_value: "http"
}
}
attributes {
key: "destination.principal"
value {
string_value: "destination_user"
}
}
attributes {
key: "origin.ip"
value {
bytes_value: "1.2.3.4"
}
}
attributes {
key: "request.headers"
value {
string_map_value {
entries {
key: "host"
value: "localhost"
}
entries {
key: "path"
value: "/books"
}
}
}
}
attributes {
key: "request.host"
value {
string_value: "localhost"
}
}
attributes {
key: "request.path"
value {
string_value: "/books"
}
}
attributes {
key: "request.scheme"
value {
string_value: "http"
}
}
attributes {
key: "request.time"
value {
timestamp_value {
}
}
}
)";

const char kCheckAttributes[] = R"(
attributes {
key: "context.protocol"
Expand Down Expand Up @@ -172,6 +255,12 @@ attributes {
string_value: "thisisiss/thisissub"
}
}
attributes {
key: "request.auth.raw_claims"
value {
string_value: "test_raw_claims"
}
}
)";

const char kReportAttributes[] = R"(
Expand Down Expand Up @@ -265,7 +354,7 @@ TEST(AttributesBuilderTest, TestExtractForwardedAttributes) {
Attributes attr;
(*attr.mutable_attributes())["test_key"].set_string_value("test_value");

::testing::NiceMock<MockCheckData> mock_data;
::testing::StrictMock<MockCheckData> mock_data;
EXPECT_CALL(mock_data, ExtractIstioAttributes(_))
.WillOnce(Invoke([&attr](std::string *data) -> bool {
attr.SerializeToString(data);
Expand All @@ -275,12 +364,12 @@ TEST(AttributesBuilderTest, TestExtractForwardedAttributes) {
RequestContext request;
AttributesBuilder builder(&request);
builder.ExtractForwardedAttributes(&mock_data);
EXPECT_TRUE(MessageDifferencer::Equals(request.attributes, attr));
EXPECT_THAT(request.attributes, EqualsAttribute(attr));
}

TEST(AttributesBuilderTest, TestForwardAttributes) {
Attributes forwarded_attr;
::testing::NiceMock<MockHeaderUpdate> mock_header;
::testing::StrictMock<MockHeaderUpdate> mock_header;
EXPECT_CALL(mock_header, AddIstioAttributes(_))
.WillOnce(Invoke([&forwarded_attr](const std::string &data) {
EXPECT_TRUE(forwarded_attr.ParseFromString(data));
Expand All @@ -291,11 +380,14 @@ TEST(AttributesBuilderTest, TestForwardAttributes) {
"test_value");

AttributesBuilder::ForwardAttributes(origin_attr, &mock_header);
EXPECT_TRUE(MessageDifferencer::Equals(origin_attr, forwarded_attr));
EXPECT_THAT(forwarded_attr, EqualsAttribute(origin_attr));
}

TEST(AttributesBuilderTest, TestCheckAttributes) {
::testing::NiceMock<MockCheckData> mock_data;
TEST(AttributesBuilderTest, TestCheckAttributesWithoutAuthnFilter) {
// In production, it is expected that authn filter always available whenver
// mTLS or JWT is in used. This test case merely for completness to illustrate
// what attributes are populated if authn filter is missing.
::testing::StrictMock<MockCheckData> mock_data;
EXPECT_CALL(mock_data, GetPrincipal(_, _))
.WillRepeatedly(Invoke([](bool peer, std::string *user) -> bool {
if (peer) {
Expand Down Expand Up @@ -340,37 +432,21 @@ TEST(AttributesBuilderTest, TestCheckAttributes) {
}));
EXPECT_CALL(mock_data, GetAuthenticationResult(_))
.WillOnce(testing::Return(false));
EXPECT_CALL(mock_data, GetJWTPayload(_))
.WillOnce(Invoke([](std::map<std::string, std::string> *payload) -> bool {
(*payload)["iss"] = "thisisiss";
(*payload)["sub"] = "thisissub";
(*payload)["aud"] = "thisisaud";
(*payload)["azp"] = "thisisazp";
(*payload)["email"] = "thisisemail@email.com";
(*payload)["iat"] = "1512754205";
(*payload)["exp"] = "5112754205";
return true;
}));

RequestContext request;
AttributesBuilder builder(&request);
builder.ExtractCheckAttributes(&mock_data);

ClearContextTime(utils::AttributeName::kRequestTime, &request);

std::string out_str;
TextFormat::PrintToString(request.attributes, &out_str);
GOOGLE_LOG(INFO) << "===" << out_str << "===";

Attributes expected_attributes;
ASSERT_TRUE(
TextFormat::ParseFromString(kCheckAttributes, &expected_attributes));
EXPECT_TRUE(
MessageDifferencer::Equals(request.attributes, expected_attributes));
ASSERT_TRUE(TextFormat::ParseFromString(kCheckAttributesWithoutAuthnFilter,
&expected_attributes));
EXPECT_THAT(request.attributes, EqualsAttribute(expected_attributes));
}

TEST(AttributesBuilderTest, TestCheckAttributesWithAuthNResult) {
::testing::NiceMock<MockCheckData> mock_data;
TEST(AttributesBuilderTest, TestCheckAttributes) {
::testing::StrictMock<MockCheckData> mock_data;
EXPECT_CALL(mock_data, IsMutualTLS()).WillOnce(Invoke([]() -> bool {
return true;
}));
Expand Down Expand Up @@ -437,27 +513,14 @@ TEST(AttributesBuilderTest, TestCheckAttributesWithAuthNResult) {

ClearContextTime(utils::AttributeName::kRequestTime, &request);

std::string out_str;
TextFormat::PrintToString(request.attributes, &out_str);
GOOGLE_LOG(INFO) << "===" << out_str << "===";

Attributes expected_attributes;
ASSERT_TRUE(
TextFormat::ParseFromString(kCheckAttributes, &expected_attributes));
// kCheckAttributes is also used in TestCheckAttributes, which is a deprecated
// way to construct mixer attribute (it was a fallback when authn filter is
// not available, which can be removed after 0.8). For now, modifying expected
// data manually for this test.
(*expected_attributes
.mutable_attributes())[utils::AttributeName::kRequestAuthRawClaims]
.set_string_value("test_raw_claims");

EXPECT_TRUE(
MessageDifferencer::Equals(request.attributes, expected_attributes));
EXPECT_THAT(request.attributes, EqualsAttribute(expected_attributes));
}

TEST(AttributesBuilderTest, TestReportAttributes) {
::testing::NiceMock<MockReportData> mock_data;
::testing::StrictMock<MockReportData> mock_data;
EXPECT_CALL(mock_data, GetDestinationIpPort(_, _))
.WillOnce(Invoke([](std::string *ip, int *port) -> bool {
*ip = "1.2.3.4";
Expand Down Expand Up @@ -498,10 +561,6 @@ TEST(AttributesBuilderTest, TestReportAttributes) {

ClearContextTime(utils::AttributeName::kResponseTime, &request);

std::string out_str;
TextFormat::PrintToString(request.attributes, &out_str);
GOOGLE_LOG(INFO) << "===" << out_str << "===";

Attributes expected_attributes;
ASSERT_TRUE(
TextFormat::ParseFromString(kReportAttributes, &expected_attributes));
Expand All @@ -514,18 +573,18 @@ TEST(AttributesBuilderTest, TestReportAttributes) {
(*expected_attributes
.mutable_attributes())[utils::AttributeName::kResponseGrpcMessage]
.set_string_value("grpc-message");
EXPECT_TRUE(
MessageDifferencer::Equals(request.attributes, expected_attributes));
EXPECT_THAT(request.attributes, EqualsAttribute(expected_attributes));
}

TEST(AttributesBuilderTest, TestReportAttributesWithDestIP) {
::testing::NiceMock<MockReportData> mock_data;
::testing::StrictMock<MockReportData> mock_data;
EXPECT_CALL(mock_data, GetDestinationIpPort(_, _))
.WillOnce(Invoke([](std::string *ip, int *port) -> bool {
*ip = "2.3.4.5";
*port = 8080;
return true;
}));
EXPECT_CALL(mock_data, GetDestinationUID(_)).WillOnce(testing::Return(false));
EXPECT_CALL(mock_data, GetResponseHeaders())
.WillOnce(Invoke([]() -> std::map<std::string, std::string> {
std::map<std::string, std::string> map;
Expand All @@ -542,6 +601,7 @@ TEST(AttributesBuilderTest, TestReportAttributesWithDestIP) {
info->duration = std::chrono::nanoseconds(1);
info->response_code = 404;
}));
EXPECT_CALL(mock_data, GetGrpcStatus(_)).WillOnce(testing::Return(false));

RequestContext request;
SetDestinationIp(&request, "1.2.3.4");
Expand All @@ -550,15 +610,10 @@ TEST(AttributesBuilderTest, TestReportAttributesWithDestIP) {

ClearContextTime(utils::AttributeName::kResponseTime, &request);

std::string out_str;
TextFormat::PrintToString(request.attributes, &out_str);
GOOGLE_LOG(INFO) << "===" << out_str << "===";

Attributes expected_attributes;
ASSERT_TRUE(
TextFormat::ParseFromString(kReportAttributes, &expected_attributes));
EXPECT_TRUE(
MessageDifferencer::Equals(request.attributes, expected_attributes));
EXPECT_THAT(request.attributes, EqualsAttribute(expected_attributes));
}

} // namespace
Expand Down
10 changes: 5 additions & 5 deletions src/istio/control/http/request_handler_impl_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ TEST_F(RequestHandlerImplTest, TestHandlerDisabledCheck) {
::testing::NiceMock<MockHeaderUpdate> mock_header;
// Report is enabled so Attributes are extracted.
EXPECT_CALL(mock_data, GetSourceIpPort(_, _)).Times(1);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(2);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(1);

// Check should NOT be called.
EXPECT_CALL(*mock_client_, Check(_, _, _, _)).Times(0);
Expand All @@ -194,7 +194,7 @@ TEST_F(RequestHandlerImplTest, TestPerRouteAttributes) {
::testing::NiceMock<MockCheckData> mock_data;
::testing::NiceMock<MockHeaderUpdate> mock_header;
EXPECT_CALL(mock_data, GetSourceIpPort(_, _)).Times(1);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(2);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(1);

// Check should be called.
EXPECT_CALL(*mock_client_, Check(_, _, _, _))
Expand Down Expand Up @@ -222,7 +222,7 @@ TEST_F(RequestHandlerImplTest, TestDefaultRouteAttributes) {
::testing::NiceMock<MockCheckData> mock_data;
::testing::NiceMock<MockHeaderUpdate> mock_header;
EXPECT_CALL(mock_data, GetSourceIpPort(_, _)).Times(1);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(2);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(1);

// Check should be called.
EXPECT_CALL(*mock_client_, Check(_, _, _, _))
Expand Down Expand Up @@ -255,7 +255,7 @@ TEST_F(RequestHandlerImplTest, TestRouteAttributes) {
::testing::NiceMock<MockCheckData> mock_data;
::testing::NiceMock<MockHeaderUpdate> mock_header;
EXPECT_CALL(mock_data, GetSourceIpPort(_, _)).Times(1);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(2);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(1);

ServiceConfig route_config;
auto map3 = route_config.mutable_mixer_attributes()->mutable_attributes();
Expand Down Expand Up @@ -370,7 +370,7 @@ TEST_F(RequestHandlerImplTest, TestHandlerCheck) {
::testing::NiceMock<MockCheckData> mock_data;
::testing::NiceMock<MockHeaderUpdate> mock_header;
EXPECT_CALL(mock_data, GetSourceIpPort(_, _)).Times(1);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(2);
EXPECT_CALL(mock_data, GetPrincipal(_, _)).Times(1);

// Check should be called.
EXPECT_CALL(*mock_client_, Check(_, _, _, _)).Times(1);
Expand Down