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
|
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.adservices.service.measurement.registration;
import static com.android.adservices.service.measurement.SystemHealthParams.MAX_ATTRIBUTION_FILTERS;
import static com.android.adservices.service.measurement.SystemHealthParams.MAX_BYTES_PER_ATTRIBUTION_AGGREGATE_KEY_ID;
import static com.android.adservices.service.measurement.SystemHealthParams.MAX_BYTES_PER_ATTRIBUTION_FILTER_STRING;
import static com.android.adservices.service.measurement.SystemHealthParams.MAX_REDIRECTS_PER_REGISTRATION;
import static com.android.adservices.service.measurement.SystemHealthParams.MAX_VALUES_PER_ATTRIBUTION_FILTER;
import static com.android.adservices.service.stats.AdServicesStatsLog.AD_SERVICES_MEASUREMENT_REGISTRATIONS;
import android.annotation.NonNull;
import android.net.Uri;
import com.android.adservices.LogUtil;
import com.android.adservices.service.Flags;
import com.android.adservices.service.measurement.AsyncRegistration;
import com.android.adservices.service.measurement.util.AsyncRedirect;
import com.android.adservices.service.measurement.util.Web;
import com.android.adservices.service.stats.AdServicesLogger;
import com.android.adservices.service.stats.MeasurementRegistrationResponseStats;
import org.json.JSONArray;
import org.json.JSONObject;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* Common handling for Response Based Registration
*
* @hide
*/
class FetcherUtil {
static final String REDIRECT_LIST_HEADER_KEY = "Attribution-Reporting-Redirect";
static final String REDIRECT_DAISY_CHAIN_HEADER_KEY = "Location";
/**
* Determine all redirects.
*
* <p>Generates a list of: (url, allows_regular_redirects) tuples. Returns true if all steps
* succeed. Returns false if there are any failures.
*/
static AsyncRedirect parseRedirects(@NonNull Map<String, List<String>> headers,
@AsyncRegistration.RedirectType int redirectType) {
List<Uri> redirects = new ArrayList<>();
switch (redirectType) {
case AsyncRegistration.RedirectType.ANY:
if (headers.containsKey(REDIRECT_LIST_HEADER_KEY)) {
return parseListRedirects(headers, redirects);
} else if (headers.containsKey(REDIRECT_DAISY_CHAIN_HEADER_KEY)) {
return parseDaisyChainRedirects(headers, redirects);
}
return new AsyncRedirect(redirects, AsyncRegistration.RedirectType.NONE);
case AsyncRegistration.RedirectType.DAISY_CHAIN:
return parseDaisyChainRedirects(headers, redirects);
case AsyncRegistration.RedirectType.NONE:
default:
return new AsyncRedirect(redirects, AsyncRegistration.RedirectType.NONE);
}
}
/**
* Check HTTP response codes that indicate a redirect.
*/
static boolean isRedirect(int responseCode) {
// TODO: Decide if all of thse should be allowed.
return responseCode == 301 || // Moved Permanently.
responseCode == 308 || // Permanent Redirect.
responseCode == 302 || // Found
responseCode == 303 || // See Other
responseCode == 307; // Temporary Redirect.
}
/**
* Check HTTP response code for success.
*/
static boolean isSuccess(int responseCode) {
return responseCode == 200;
}
/**
* Validate aggregate key ID.
*/
static boolean isValidAggregateKeyId(String id) {
return id != null && id.getBytes().length <= MAX_BYTES_PER_ATTRIBUTION_AGGREGATE_KEY_ID;
}
/**
* Validate aggregate key-piece.
*/
static boolean isValidAggregateKeyPiece(String keyPiece) {
if (keyPiece == null) {
return false;
}
int length = keyPiece.getBytes().length;
// Key-piece is restricted to a maximum of 128 bits and the hex strings therefore have at
// most 32 digits.
return (keyPiece.startsWith("0x") || keyPiece.startsWith("0X"))
&& 2 < length && length < 35;
}
/**
* Validate attribution filters JSON.
*/
static boolean areValidAttributionFilters(JSONObject filtersObj) {
if (filtersObj == null || filtersObj.length() > MAX_ATTRIBUTION_FILTERS) {
return false;
}
Iterator<String> keys = filtersObj.keys();
while (keys.hasNext()) {
String key = keys.next();
if (key.getBytes().length > MAX_BYTES_PER_ATTRIBUTION_FILTER_STRING) {
return false;
}
JSONArray values = filtersObj.optJSONArray(key);
if (values == null || values.length() > MAX_VALUES_PER_ATTRIBUTION_FILTER) {
return false;
}
for (int i = 0; i < values.length(); i++) {
String value = values.optString(i);
if (value == null
|| value.getBytes().length > MAX_BYTES_PER_ATTRIBUTION_FILTER_STRING) {
return false;
}
}
}
return true;
}
static void emitHeaderMetrics(
Flags flags,
AdServicesLogger logger,
int registrationType,
Map<String, List<String>> headers,
Uri registrationUri) {
long headerSize = calculateHeadersCharactersLength(headers);
long maxSize = flags.getMaxResponseBasedRegistrationPayloadSizeBytes();
String adTechDomain = null;
if (headerSize > maxSize) {
adTechDomain =
Web.topPrivateDomainAndScheme(registrationUri).map(Uri::toString).orElse(null);
}
logger.logMeasurementRegistrationsResponseSize(
new MeasurementRegistrationResponseStats.Builder(
AD_SERVICES_MEASUREMENT_REGISTRATIONS, registrationType, headerSize)
.setAdTechDomain(adTechDomain)
.build());
}
private static AsyncRedirect parseListRedirects(Map<String, List<String>> headers,
List<Uri> redirects) {
List<String> field = headers.get("Attribution-Reporting-Redirect");
if (field != null) {
for (int i = 0; i < Math.min(field.size(), MAX_REDIRECTS_PER_REGISTRATION); i++) {
redirects.add(Uri.parse(field.get(i)));
}
}
return new AsyncRedirect(redirects, AsyncRegistration.RedirectType.NONE);
}
private static AsyncRedirect parseDaisyChainRedirects(
Map<String, List<String>> headers, List<Uri> redirects) {
List<String> field = headers.get("Location");
if (field != null) {
redirects.add(Uri.parse(field.get(0)));
if (field.size() > 1) {
LogUtil.d("Expected one Location redirect only, others ignored!");
}
}
return new AsyncRedirect(redirects, AsyncRegistration.RedirectType.DAISY_CHAIN);
}
private static long calculateHeadersCharactersLength(Map<String, List<String>> headers) {
long size = 0;
for (String headerKey : headers.keySet()) {
if (headerKey != null) {
size = size + headerKey.length();
List<String> headerValues = headers.get(headerKey);
if (headerValues != null) {
for (String headerValue : headerValues) {
size = size + headerValue.length();
}
}
}
}
return size;
}
}
|
