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