Unreviewed, rolling out r231223 and r231288.
[WebKit-https.git] / Source / WebKit / Shared / SandboxExtension.h
1 /*
2  * Copyright (C) 2010 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 #include <wtf/Forward.h>
29 #include <wtf/Noncopyable.h>
30 #include <wtf/RefCounted.h>
31 #include <wtf/RefPtr.h>
32 #include <wtf/Vector.h>
33 #include <wtf/text/WTFString.h>
34
35 namespace IPC {
36 class Encoder;
37 class Decoder;
38 }
39
40 namespace WebKit {
41     
42 class SandboxExtensionImpl;
43
44 class SandboxExtension : public RefCounted<SandboxExtension> {
45 public:
46     enum class Type {
47         ReadOnly,
48         ReadWrite,
49         Generic,
50     };
51
52     class Handle {
53         WTF_MAKE_NONCOPYABLE(Handle);
54     public:
55         Handle();
56 #if ENABLE(SANDBOX_EXTENSIONS)
57         Handle(Handle&&);
58         Handle& operator=(Handle&&);
59 #else
60         Handle(Handle&&) = default;
61         Handle& operator=(Handle&&) = default;
62 #endif
63         ~Handle();
64
65         void encode(IPC::Encoder&) const;
66         static std::optional<Handle> decode(IPC::Decoder&);
67
68     private:
69         friend class SandboxExtension;
70 #if ENABLE(SANDBOX_EXTENSIONS)
71         mutable std::unique_ptr<SandboxExtensionImpl> m_sandboxExtension;
72 #endif
73     };
74
75     class HandleArray {
76         WTF_MAKE_NONCOPYABLE(HandleArray);
77     public:
78         HandleArray();
79         HandleArray(HandleArray&&) = default;
80         ~HandleArray();
81         void allocate(size_t);
82         Handle& operator[](size_t i);
83         const Handle& operator[](size_t i) const;
84         size_t size() const;
85         void encode(IPC::Encoder&) const;
86         static bool decode(IPC::Decoder&, HandleArray&);
87        
88     private:
89 #if ENABLE(SANDBOX_EXTENSIONS)
90         Vector<Handle> m_data;
91 #else
92         Handle m_emptyHandle;
93 #endif
94     };
95     
96     static RefPtr<SandboxExtension> create(Handle&&);
97     static bool createHandle(const String& path, Type, Handle&);
98     static bool createHandleWithoutResolvingPath(const String& path, Type, Handle&);
99     static bool createHandleForReadWriteDirectory(const String& path, Handle&); // Will attempt to create the directory.
100     static String createHandleForTemporaryFile(const String& prefix, Type, Handle&);
101     static bool createHandleForGenericExtension(const String& extensionClass, Handle&);
102     ~SandboxExtension();
103
104     bool consume();
105     bool revoke();
106
107     bool consumePermanently();
108     static bool consumePermanently(const Handle&);
109
110 private:
111     explicit SandboxExtension(const Handle&);
112                      
113 #if ENABLE(SANDBOX_EXTENSIONS)
114     mutable std::unique_ptr<SandboxExtensionImpl> m_sandboxExtension;
115     size_t m_useCount { 0 };
116 #endif
117 };
118
119 #if !ENABLE(SANDBOX_EXTENSIONS)
120 inline SandboxExtension::Handle::Handle() { }
121 inline SandboxExtension::Handle::~Handle() { }
122 inline void SandboxExtension::Handle::encode(IPC::Encoder&) const { }
123 inline std::optional<SandboxExtension::Handle> SandboxExtension::Handle::decode(IPC::Decoder&) { return {{ }}; }
124 inline SandboxExtension::HandleArray::HandleArray() { }
125 inline SandboxExtension::HandleArray::~HandleArray() { }
126 inline void SandboxExtension::HandleArray::allocate(size_t) { }
127 inline size_t SandboxExtension::HandleArray::size() const { return 0; }    
128 inline const SandboxExtension::Handle& SandboxExtension::HandleArray::operator[](size_t) const { return m_emptyHandle; }
129 inline SandboxExtension::Handle& SandboxExtension::HandleArray::operator[](size_t) { return m_emptyHandle; }
130 inline void SandboxExtension::HandleArray::encode(IPC::Encoder&) const { }
131 inline bool SandboxExtension::HandleArray::decode(IPC::Decoder&, HandleArray&) { return true; }
132 inline RefPtr<SandboxExtension> SandboxExtension::create(Handle&&) { return nullptr; }
133 inline bool SandboxExtension::createHandle(const String&, Type, Handle&) { return true; }
134 inline bool SandboxExtension::createHandleWithoutResolvingPath(const String&, Type, Handle&) { return true; }
135 inline bool SandboxExtension::createHandleForReadWriteDirectory(const String&, Handle&) { return true; }
136 inline String SandboxExtension::createHandleForTemporaryFile(const String& /*prefix*/, Type, Handle&) {return String();}
137 inline bool SandboxExtension::createHandleForGenericExtension(const String& /*extensionClass*/, Handle&) { return true; }
138 inline SandboxExtension::~SandboxExtension() { }
139 inline bool SandboxExtension::revoke() { return true; }
140 inline bool SandboxExtension::consume() { return true; }
141 inline bool SandboxExtension::consumePermanently() { return true; }
142 inline bool SandboxExtension::consumePermanently(const Handle&) { return true; }
143 inline String stringByResolvingSymlinksInPath(const String& path) { return path; }
144 inline String resolvePathForSandboxExtension(const String& path) { return path; }
145 inline String resolveAndCreateReadWriteDirectoryForSandboxExtension(const String& path) { return path; }
146 #else
147 String stringByResolvingSymlinksInPath(const String& path);
148 String resolvePathForSandboxExtension(const String& path);
149 String resolveAndCreateReadWriteDirectoryForSandboxExtension(const String& path);
150 #endif
151
152 } // namespace WebKit