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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/ash/policy/enrollment/psm/rlwe_dmserver_client_impl.h"
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include "base/check.h"
#include "base/metrics/histogram_functions.h"
#include "base/sequence_checker.h"
#include "base/time/time.h"
#include "base/uuid.h"
#include "chrome/browser/ash/policy/enrollment/psm/rlwe_dmserver_client.h"
#include "components/policy/core/common/cloud/cloud_policy_constants.h"
#include "components/policy/core/common/cloud/device_management_service.h"
#include "components/policy/core/common/cloud/dmserver_job_configurations.h"
#include "components/policy/core/common/cloud/enterprise_metrics.h"
#include "components/policy/proto/device_management_backend.pb.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "third_party/private_membership/src/private_membership_rlwe.pb.h"
#include "third_party/private_membership/src/private_membership_rlwe_client.h"
namespace psm_rlwe = private_membership::rlwe;
namespace em = enterprise_management;
namespace policy::psm {
// static
std::unique_ptr<RlweDmserverClientImpl::RlweClient>
RlweDmserverClientImpl::Create(private_membership::rlwe::RlweUseCase use_case,
const psm_rlwe::RlwePlaintextId& plaintext_id) {
auto status_or_client = RlweClient::Create(use_case, {plaintext_id});
DCHECK(status_or_client.ok()) << status_or_client.status().message();
return std::move(status_or_client).value();
}
RlweDmserverClientImpl::RlweDmserverClientImpl(
DeviceManagementService* device_management_service,
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
const PlaintextId& plaintext_id,
RlweClientFactory rlwe_client_factory)
: plaintext_id_(plaintext_id),
psm_rlwe_client_(
rlwe_client_factory.Run(private_membership::rlwe::CROS_DEVICE_STATE,
plaintext_id)),
random_device_id_(base::Uuid::GenerateRandomV4().AsLowercaseString()),
url_loader_factory_(url_loader_factory),
device_management_service_(device_management_service) {
CHECK(psm_rlwe_client_);
CHECK(url_loader_factory_);
CHECK(device_management_service_);
}
RlweDmserverClientImpl::~RlweDmserverClientImpl() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
}
void RlweDmserverClientImpl::CheckMembership(CompletionCallback callback) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(callback);
// There should not be any pending PSM requests.
CHECK(!psm_request_job_);
time_start_ = base::TimeTicks::Now();
on_completion_callback_ = std::move(callback);
SendRlweOprfRequest();
}
bool RlweDmserverClientImpl::IsCheckMembershipInProgress() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return psm_request_job_ != nullptr;
}
void RlweDmserverClientImpl::RecordErrorAndStop(ResultHolder result) {
// Note that kUMAPsmResult histogram is only using initial enrollment as a
// suffix until PSM support FRE.
base::UmaHistogramEnumeration(kUMAPsmResult + uma_suffix_, result.psm_result);
// Stop the current |psm_request_job_|.
psm_request_job_.reset();
std::move(on_completion_callback_).Run(std::move(result));
}
void RlweDmserverClientImpl::SendRlweOprfRequest() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Create RLWE OPRF request.
const auto status_or_oprf_request = psm_rlwe_client_->CreateOprfRequest();
if (!status_or_oprf_request.ok()) {
// If the RLWE OPRF request hasn't been created successfully, then report
// the error and stop the protocol.
LOG(ERROR) << "PSM error: unexpected internal logic error during creating "
"RLWE OPRF request";
RecordErrorAndStop(RlweResult::kCreateOprfRequestLibraryError);
return;
}
LOG(WARNING) << "PSM: prepare and send out the RLWE OPRF request";
// Prepare the RLWE OPRF request job.
// The passed callback will not be called if |psm_request_job_| is
// destroyed, so it's safe to use base::Unretained.
std::unique_ptr<DMServerJobConfiguration> config =
CreatePsmRequestJobConfiguration(
base::BindOnce(&RlweDmserverClientImpl::OnRlweOprfRequestCompletion,
base::Unretained(this)));
em::DeviceManagementRequest* request = config->request();
em::PrivateSetMembershipRlweRequest* psm_rlwe_request =
request->mutable_private_set_membership_request()->mutable_rlwe_request();
*psm_rlwe_request->mutable_oprf_request() = status_or_oprf_request.value();
psm_request_job_ = device_management_service_->CreateJob(std::move(config));
}
void RlweDmserverClientImpl::OnRlweOprfRequestCompletion(
DMServerJobResult result) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::UmaHistogramSparse(kUMAPsmDmServerRequestStatus + uma_suffix_,
result.dm_status);
switch (result.dm_status) {
case DM_STATUS_SUCCESS: {
// Check if the RLWE OPRF response is empty.
if (!result.response.private_set_membership_response()
.has_rlwe_response() ||
!result.response.private_set_membership_response()
.rlwe_response()
.has_oprf_response()) {
LOG(ERROR) << "PSM error: empty OPRF RLWE response";
RecordErrorAndStop(RlweResult::kEmptyOprfResponseError);
return;
}
LOG(WARNING) << "PSM RLWE OPRF request completed successfully";
SendRlweQueryRequest(result.response.private_set_membership_response());
return;
}
case DM_STATUS_REQUEST_FAILED: {
LOG(ERROR)
<< "PSM error: RLWE OPRF request failed due to connection error";
base::UmaHistogramSparse(kUMAPsmNetworkErrorCode + uma_suffix_,
-result.net_error);
RecordErrorAndStop(
AutoEnrollmentDMServerError::FromDMServerJobResult(result));
return;
}
default: {
LOG(ERROR) << "PSM error: RLWE OPRF request failed due to server error";
RecordErrorAndStop(
AutoEnrollmentDMServerError::FromDMServerJobResult(result));
return;
}
}
}
void RlweDmserverClientImpl::SendRlweQueryRequest(
const em::PrivateSetMembershipResponse& psm_response) {
// Extract the oprf_response from |psm_response|.
const psm_rlwe::PrivateMembershipRlweOprfResponse oprf_response =
psm_response.rlwe_response().oprf_response();
const auto status_or_query_request =
psm_rlwe_client_->CreateQueryRequest(oprf_response);
// Create RLWE query request.
if (!status_or_query_request.ok()) {
// If the RLWE query request hasn't been created successfully, then report
// the error and stop the protocol.
LOG(ERROR) << "PSM error: unexpected internal logic error during creating "
"RLWE query request";
RecordErrorAndStop(RlweResult::kCreateQueryRequestLibraryError);
return;
}
LOG(WARNING) << "PSM: prepare and send out the RLWE query request";
// Prepare the RLWE query request job.
std::unique_ptr<DMServerJobConfiguration> config =
CreatePsmRequestJobConfiguration(
base::BindOnce(&RlweDmserverClientImpl::OnRlweQueryRequestCompletion,
base::Unretained(this), oprf_response));
em::DeviceManagementRequest* request = config->request();
em::PrivateSetMembershipRlweRequest* psm_rlwe_request =
request->mutable_private_set_membership_request()->mutable_rlwe_request();
*psm_rlwe_request->mutable_query_request() = status_or_query_request.value();
psm_request_job_ = device_management_service_->CreateJob(std::move(config));
}
void RlweDmserverClientImpl::OnRlweQueryRequestCompletion(
const OprfResponse& oprf_response,
DMServerJobResult result) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::UmaHistogramSparse(kUMAPsmDmServerRequestStatus + uma_suffix_,
result.dm_status);
switch (result.dm_status) {
case DM_STATUS_SUCCESS: {
// Check if the RLWE query response is empty.
if (!result.response.private_set_membership_response()
.has_rlwe_response() ||
!result.response.private_set_membership_response()
.rlwe_response()
.has_query_response()) {
LOG(ERROR) << "PSM error: empty query RLWE response";
RecordErrorAndStop(RlweResult::kEmptyQueryResponseError);
return;
}
const auto responses = psm_rlwe_client_->ProcessQueryResponse(
result.response.private_set_membership_response()
.rlwe_response()
.query_response());
if (!responses.ok()) {
// If the RLWE query response hasn't processed successfully, then
// report the error and stop the protocol.
LOG(ERROR) << "PSM error: unexpected internal logic error during "
"processing the "
"RLWE query response";
RecordErrorAndStop(RlweResult::kProcessingQueryResponseLibraryError);
return;
}
DCHECK_EQ(responses->membership_responses_size(), 1);
const bool is_member =
responses->membership_responses(0).membership_response().is_member();
base::UmaHistogramEnumeration(kUMAPsmResult + uma_suffix_,
RlweResult::kSuccessfulDetermination);
RecordPsmSuccessTimeHistogram();
LOG(WARNING) << "PSM determination successful. Identifier "
<< plaintext_id_.sensitive_id() << (is_member ? "" : " not")
<< " present on the server";
// Reset the |psm_request_job_| to allow another call to
// CheckMembership.
psm_request_job_.reset();
std::move(on_completion_callback_)
.Run(ResultHolder(
is_member,
/*membership_determination_time=*/base::Time::Now()));
return;
}
case DM_STATUS_REQUEST_FAILED: {
LOG(ERROR)
<< "PSM error: RLWE query request failed due to connection error";
base::UmaHistogramSparse(kUMAPsmNetworkErrorCode + uma_suffix_,
-result.net_error);
RecordErrorAndStop(
AutoEnrollmentDMServerError::FromDMServerJobResult(result));
return;
}
default: {
LOG(ERROR) << "PSM error: RLWE query request failed due to server error";
RecordErrorAndStop(
AutoEnrollmentDMServerError::FromDMServerJobResult(result));
return;
}
}
}
std::unique_ptr<DMServerJobConfiguration>
RlweDmserverClientImpl::CreatePsmRequestJobConfiguration(
DMServerJobConfiguration::Callback callback) {
return std::make_unique<DMServerJobConfiguration>(
device_management_service_,
DeviceManagementService::JobConfiguration::
TYPE_PSM_HAS_DEVICE_STATE_REQUEST,
random_device_id_,
/*critical=*/true, DMAuth::NoAuth(),
/*oauth_token=*/std::nullopt, url_loader_factory_, std::move(callback));
}
void RlweDmserverClientImpl::RecordPsmSuccessTimeHistogram() {
// These values determine bucketing of the histogram, they should not be
// changed.
static const base::TimeDelta kMin = base::Milliseconds(1);
static const base::TimeDelta kMax = base::Seconds(25);
static const int kBuckets = 50;
base::TimeTicks now = base::TimeTicks::Now();
if (!time_start_.is_null()) {
base::TimeDelta delta = now - time_start_;
base::UmaHistogramCustomTimes(kUMAPsmSuccessTime, delta, kMin, kMax,
kBuckets);
}
}
} // namespace policy::psm
|