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
|
/*
* 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.reporting;
import android.annotation.NonNull;
import androidx.annotation.Nullable;
import com.android.adservices.service.measurement.aggregation.AggregateCryptoConverter;
import com.android.adservices.service.measurement.aggregation.AggregateEncryptionKey;
import com.android.adservices.service.measurement.util.UnsignedLong;
import com.google.common.annotations.VisibleForTesting;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
/**
* Class for constructing the report body of an aggregate report.
*/
public class AggregateReportBody {
private String mAttributionDestination;
private String mSourceRegistrationTime;
private String mScheduledReportTime;
private String mApiVersion;
private String mReportId;
private String mReportingOrigin;
private String mDebugCleartextPayload;
@Nullable private UnsignedLong mSourceDebugKey;
@Nullable private UnsignedLong mTriggerDebugKey;
private static final String API_NAME = "attribution-reporting";
private interface PayloadBodyKeys {
String SHARED_INFO = "shared_info";
String AGGREGATION_SERVICE_PAYLOADS = "aggregation_service_payloads";
String SOURCE_DEBUG_KEY = "source_debug_key";
String TRIGGER_DEBUG_KEY = "trigger_debug_key";
}
private interface AggregationServicePayloadKeys {
String PAYLOAD = "payload";
String KEY_ID = "key_id";
String DEBUG_CLEARTEXT_PAYLOAD = "debug_cleartext_payload";
}
private interface SharedInfoKeys {
String API_NAME = "api";
String ATTRIBUTION_DESTINATION = "attribution_destination";
String REPORT_ID = "report_id";
String REPORTING_ORIGIN = "reporting_origin";
String SCHEDULED_REPORT_TIME = "scheduled_report_time";
String SOURCE_REGISTRATION_TIME = "source_registration_time";
String API_VERSION = "version";
}
private AggregateReportBody() { };
private AggregateReportBody(AggregateReportBody other) {
mAttributionDestination = other.mAttributionDestination;
mSourceRegistrationTime = other.mSourceRegistrationTime;
mScheduledReportTime = other.mScheduledReportTime;
mApiVersion = other.mApiVersion;
mReportId = other.mReportId;
mReportingOrigin = other.mReportingOrigin;
mDebugCleartextPayload = other.mDebugCleartextPayload;
mSourceDebugKey = other.mSourceDebugKey;
mTriggerDebugKey = other.mTriggerDebugKey;
}
/** Generate the JSON serialization of the aggregate report. */
public JSONObject toJson(AggregateEncryptionKey key) throws JSONException {
JSONObject aggregateBodyJson = new JSONObject();
final String sharedInfo = sharedInfoToJson().toString();
aggregateBodyJson.put(PayloadBodyKeys.SHARED_INFO, sharedInfo);
aggregateBodyJson.put(
PayloadBodyKeys.AGGREGATION_SERVICE_PAYLOADS,
aggregationServicePayloadsToJson(sharedInfo, key));
if (mSourceDebugKey != null) {
aggregateBodyJson.put(PayloadBodyKeys.SOURCE_DEBUG_KEY, mSourceDebugKey.toString());
}
if (mTriggerDebugKey != null) {
aggregateBodyJson.put(PayloadBodyKeys.TRIGGER_DEBUG_KEY, mTriggerDebugKey.toString());
}
return aggregateBodyJson;
}
/**
* Generate the JSON serialization of the shared_info field of the aggregate report.
*/
@VisibleForTesting
JSONObject sharedInfoToJson() throws JSONException {
JSONObject sharedInfoJson = new JSONObject();
sharedInfoJson.put(SharedInfoKeys.API_NAME, API_NAME);
sharedInfoJson.put(SharedInfoKeys.ATTRIBUTION_DESTINATION, mAttributionDestination);
sharedInfoJson.put(SharedInfoKeys.REPORT_ID, mReportId);
sharedInfoJson.put(SharedInfoKeys.REPORTING_ORIGIN, mReportingOrigin);
sharedInfoJson.put(SharedInfoKeys.SCHEDULED_REPORT_TIME, mScheduledReportTime);
sharedInfoJson.put(SharedInfoKeys.SOURCE_REGISTRATION_TIME, mSourceRegistrationTime);
sharedInfoJson.put(SharedInfoKeys.API_VERSION, mApiVersion);
return sharedInfoJson;
}
/** Generate the JSON array serialization of the aggregation service payloads field. */
@VisibleForTesting
JSONArray aggregationServicePayloadsToJson(String sharedInfo, AggregateEncryptionKey key)
throws JSONException {
JSONArray aggregationServicePayloadsJson = new JSONArray();
final String encryptedPayload =
AggregateCryptoConverter.encrypt(
key.getPublicKey(), mDebugCleartextPayload, sharedInfo);
final JSONObject aggregationServicePayload = new JSONObject();
aggregationServicePayload.put(AggregationServicePayloadKeys.PAYLOAD, encryptedPayload);
aggregationServicePayload.put(AggregationServicePayloadKeys.KEY_ID, key.getKeyId());
if (mSourceDebugKey != null || mTriggerDebugKey != null) {
aggregationServicePayload.put(
AggregationServicePayloadKeys.DEBUG_CLEARTEXT_PAYLOAD,
AggregateCryptoConverter.encode(mDebugCleartextPayload));
}
aggregationServicePayloadsJson.put(aggregationServicePayload);
return aggregationServicePayloadsJson;
}
/**
* Builder class for AggregateReportBody.
*/
public static final class Builder {
private AggregateReportBody mBuilding;
public Builder() {
mBuilding = new AggregateReportBody();
}
/**
* The attribution destination set on the source.
*/
public @NonNull Builder setAttributionDestination(@NonNull String attributionDestination) {
mBuilding.mAttributionDestination = attributionDestination;
return this;
}
/**
* The registration time of the source.
*/
public @NonNull Builder setSourceRegistrationTime(@NonNull String sourceRegistrationTime) {
mBuilding.mSourceRegistrationTime = sourceRegistrationTime;
return this;
}
/**
* The initial scheduled report time for the report.
*/
public @NonNull Builder setScheduledReportTime(@NonNull String scheduledReportTime) {
mBuilding.mScheduledReportTime = scheduledReportTime;
return this;
}
/**
* The version of the API used to generate the aggregate report.
*/
public @NonNull Builder setApiVersion(@NonNull String version) {
mBuilding.mApiVersion = version;
return this;
}
/**
* The ad tech domain for the report.
*/
public @NonNull Builder setReportingOrigin(@NonNull String reportingOrigin) {
mBuilding.mReportingOrigin = reportingOrigin;
return this;
}
/**
* The unique id for this report.
*/
public @NonNull Builder setReportId(@NonNull String reportId) {
mBuilding.mReportId = reportId;
return this;
}
/**
* The cleartext payload for debug.
*/
public @NonNull Builder setDebugCleartextPayload(@NonNull String debugCleartextPayload) {
mBuilding.mDebugCleartextPayload = debugCleartextPayload;
return this;
}
/** Source debug key */
public @NonNull Builder setSourceDebugKey(@Nullable UnsignedLong sourceDebugKey) {
mBuilding.mSourceDebugKey = sourceDebugKey;
return this;
}
/** Trigger debug key */
public @NonNull Builder setTriggerDebugKey(@Nullable UnsignedLong triggerDebugKey) {
mBuilding.mTriggerDebugKey = triggerDebugKey;
return this;
}
/**
* Build the AggregateReportBody.
*/
public @NonNull AggregateReportBody build() {
return new AggregateReportBody(mBuilding);
}
}
}
|
