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
|
/*
* Copyright (C) 2019 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "AttributionSecondsUntilSendData.h"
#include "AttributionTimeToSendData.h"
#include "AttributionTriggerData.h"
#include "EphemeralNonce.h"
#include "PCMSites.h"
#include "RegistrableDomain.h"
#include <wtf/CompletionHandler.h>
#include <wtf/text/Base64.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
namespace PCM {
enum class AttributionEphemeral : bool { No, Yes };
}
class PrivateClickMeasurement {
public:
enum class PcmDataCarried : bool { NonPersonallyIdentifiable, PersonallyIdentifiable };
enum class IsRunningLayoutTest : bool { No, Yes };
using SourceID = uint8_t;
PrivateClickMeasurement(SourceID sourceID, const PCM::SourceSite& sourceSite, const PCM::AttributionDestinationSite& destinationSite, const String& sourceApplicationBundleID, WallTime timeOfAdClick, PCM::AttributionEphemeral isEphemeral)
: m_sourceID { sourceID }
, m_sourceSite { sourceSite }
, m_destinationSite { destinationSite }
, m_timeOfAdClick { timeOfAdClick }
, m_isEphemeral { isEphemeral }
, m_sourceApplicationBundleID { sourceApplicationBundleID }
{
}
PrivateClickMeasurement(SourceID&& sourceID, PCM::SourceSite&& sourceSite, PCM::AttributionDestinationSite&& destinationSite, WallTime&& timeOfAdClick, PCM::AttributionEphemeral&& isEphemeral, std::optional<uint64_t>&& adamID, std::optional<PCM::AttributionTriggerData>&& attributionTriggerData, PCM::AttributionTimeToSendData&& timesToSend, std::optional<PCM::EphemeralNonce>&& ephemeralSourceNonce, String&& sourceApplicationBundleID)
: m_sourceID(WTFMove(sourceID))
, m_sourceSite(WTFMove(sourceSite))
, m_destinationSite(WTFMove(destinationSite))
, m_timeOfAdClick(WTFMove(timeOfAdClick))
, m_isEphemeral(WTFMove(isEphemeral))
, m_adamID(WTFMove(adamID))
, m_attributionTriggerData(WTFMove(attributionTriggerData))
, m_timesToSend(WTFMove(timesToSend))
, m_ephemeralSourceNonce(WTFMove(ephemeralSourceNonce))
, m_sourceApplicationBundleID(WTFMove(sourceApplicationBundleID))
{
}
WEBCORE_EXPORT static const Seconds maxAge();
WEBCORE_EXPORT bool isNeitherSameSiteNorCrossSiteTriggeringEvent(const RegistrableDomain& redirectDomain, const URL& firstPartyURL, const PCM::AttributionTriggerData&);
WEBCORE_EXPORT static Expected<PCM::AttributionTriggerData, String> parseAttributionRequest(const URL& redirectURL);
WEBCORE_EXPORT PCM::AttributionSecondsUntilSendData attributeAndGetEarliestTimeToSend(PCM::AttributionTriggerData&&, IsRunningLayoutTest);
WEBCORE_EXPORT bool hasHigherPriorityThan(const PrivateClickMeasurement&) const;
WEBCORE_EXPORT URL attributionReportClickSourceURL() const;
WEBCORE_EXPORT URL attributionReportClickDestinationURL() const;
WEBCORE_EXPORT Ref<JSON::Object> attributionReportJSON() const;
const PCM::SourceSite& sourceSite() const { return m_sourceSite; };
const PCM::AttributionDestinationSite& destinationSite() const { return m_destinationSite; };
WallTime timeOfAdClick() const { return m_timeOfAdClick; }
WEBCORE_EXPORT bool hasPreviouslyBeenReported();
PCM::AttributionTimeToSendData timesToSend() const { return m_timesToSend; };
void setTimesToSend(PCM::AttributionTimeToSendData data) { m_timesToSend = data; }
const SourceID& sourceID() const { return m_sourceID; }
const std::optional<PCM::AttributionTriggerData>& attributionTriggerData() const { return m_attributionTriggerData; }
void setAttribution(PCM::AttributionTriggerData&& attributionTriggerData) { m_attributionTriggerData = WTFMove(attributionTriggerData); }
const String& sourceApplicationBundleID() const { return m_sourceApplicationBundleID; }
WEBCORE_EXPORT void setSourceApplicationBundleIDForTesting(const String&);
PCM::AttributionEphemeral isEphemeral() const { return m_isEphemeral; }
void setEphemeral(PCM::AttributionEphemeral isEphemeral) { m_isEphemeral = isEphemeral; }
// MARK: - Fraud Prevention
WEBCORE_EXPORT const std::optional<const URL> tokenPublicKeyURL() const;
WEBCORE_EXPORT static const std::optional<const URL> tokenPublicKeyURL(const RegistrableDomain&);
WEBCORE_EXPORT const std::optional<const URL> tokenSignatureURL() const;
WEBCORE_EXPORT static const std::optional<const URL> tokenSignatureURL(const RegistrableDomain&);
WEBCORE_EXPORT Ref<JSON::Object> tokenSignatureJSON() const;
WEBCORE_EXPORT void setEphemeralSourceNonce(PCM::EphemeralNonce&&);
std::optional<PCM::EphemeralNonce> ephemeralSourceNonce() const { return m_ephemeralSourceNonce; };
void clearEphemeralSourceNonce() { m_ephemeralSourceNonce.reset(); };
#if PLATFORM(COCOA)
WEBCORE_EXPORT std::optional<String> calculateAndUpdateSourceUnlinkableToken(const String& serverPublicKeyBase64URL);
WEBCORE_EXPORT static Expected<PCM::DestinationUnlinkableToken, String> calculateAndUpdateDestinationUnlinkableToken(const String& serverPublicKeyBase64URL);
WEBCORE_EXPORT std::optional<String> calculateAndUpdateSourceSecretToken(const String& serverResponseBase64URL);
WEBCORE_EXPORT static Expected<PCM::DestinationSecretToken, String> calculateAndUpdateDestinationSecretToken(const String& serverResponseBase64URL, PCM::DestinationUnlinkableToken&);
#endif
PCM::SourceUnlinkableToken& sourceUnlinkableToken() { return m_sourceUnlinkableToken; }
void setSourceUnlinkableTokenValue(const String& value) { m_sourceUnlinkableToken.valueBase64URL = value; }
const std::optional<PCM::SourceSecretToken>& sourceSecretToken() const { return m_sourceSecretToken; }
WEBCORE_EXPORT void setSourceSecretToken(PCM::SourceSecretToken&&);
WEBCORE_EXPORT void setDestinationSecretToken(PCM::DestinationSecretToken&&);
static std::optional<uint64_t> appStoreURLAdamID(const URL&);
bool isSKAdNetworkAttribution() const { return !!m_adamID; }
std::optional<uint64_t> adamID() const { return m_adamID; };
void setAdamID(uint64_t adamID) { m_adamID = adamID; };
WEBCORE_EXPORT PrivateClickMeasurement isolatedCopy() const &;
WEBCORE_EXPORT PrivateClickMeasurement isolatedCopy() &&;
private:
static Expected<PCM::AttributionTriggerData, String> parseAttributionRequestQuery(const URL&);
bool isValid() const;
#if PLATFORM(COCOA)
static std::optional<String> calculateAndUpdateUnlinkableToken(const String& serverPublicKeyBase64URL, PCM::UnlinkableToken&, const String& contextForLogMessage);
static std::optional<String> calculateAndUpdateSecretToken(const String& serverResponseBase64URL, PCM::UnlinkableToken&, PCM::SecretToken&, const String& contextForLogMessage);
#endif
SourceID m_sourceID;
PCM::SourceSite m_sourceSite;
PCM::AttributionDestinationSite m_destinationSite;
WallTime m_timeOfAdClick;
PCM::AttributionEphemeral m_isEphemeral;
std::optional<uint64_t> m_adamID;
std::optional<PCM::AttributionTriggerData> m_attributionTriggerData;
PCM::AttributionTimeToSendData m_timesToSend;
std::optional<PCM::EphemeralNonce> m_ephemeralSourceNonce;
PCM::SourceUnlinkableToken m_sourceUnlinkableToken;
std::optional<PCM::SourceSecretToken> m_sourceSecretToken;
String m_sourceApplicationBundleID;
};
} // namespace WebCore
|
