Storage Access API: Cap the number of times an iframe document can request access
[WebKit-https.git] / Source / WebCore / dom / DocumentStorageAccess.h
1 /*
2  * Copyright (C) 2019 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(RESOURCE_LOAD_STATISTICS)
29
30 #include "Supplementable.h"
31 #include <wtf/WeakPtr.h>
32
33 namespace WebCore {
34
35 class DeferredPromise;
36 class Document;
37 class UserGestureIndicator;
38
39 enum class StorageAccessWasGranted : bool {
40     No,
41     Yes
42 };
43
44 enum class StorageAccessPromptWasShown : bool {
45     No,
46     Yes
47 };
48
49 const unsigned maxNumberOfTimesExplicitlyDeniedFrameSpecificStorageAccess = 2;
50
51 class DocumentStorageAccess final : public Supplement<Document>, public CanMakeWeakPtr<DocumentStorageAccess> {
52     WTF_MAKE_FAST_ALLOCATED;
53 public:
54     explicit DocumentStorageAccess(Document& document)
55         : m_document(document)
56     {
57     }
58
59     static void hasStorageAccess(Document&, Ref<DeferredPromise>&&);
60     static void requestStorageAccess(Document&, Ref<DeferredPromise>&&);
61
62 private:
63     void hasStorageAccess(Ref<DeferredPromise>&&);
64     void requestStorageAccess(Ref<DeferredPromise>&&);
65     static DocumentStorageAccess* from(Document&);
66     static const char* supplementName();
67     bool hasFrameSpecificStorageAccess() const;
68     void setHasFrameSpecificStorageAccess(bool);
69     void setWasExplicitlyDeniedFrameSpecificStorageAccess() { ++m_numberOfTimesExplicitlyDeniedFrameSpecificStorageAccess; };
70     bool isAllowedToRequestFrameSpecificStorageAccess() { return m_numberOfTimesExplicitlyDeniedFrameSpecificStorageAccess < maxNumberOfTimesExplicitlyDeniedFrameSpecificStorageAccess; };
71     void enableTemporaryTimeUserGesture();
72     void consumeTemporaryTimeUserGesture();
73
74     std::unique_ptr<UserGestureIndicator> m_temporaryUserGesture;
75     
76     Document& m_document;
77
78     uint8_t m_numberOfTimesExplicitlyDeniedFrameSpecificStorageAccess = 0;
79 };
80
81 } // namespace WebCore
82
83 #endif // ENABLE(RESOURCE_LOAD_STATISTICS)