00ac13b1a84dc16c5cf4c1ba7e482b1c23b4b0ec
[WebKit.git] / Source / WebKit / Shared / Authentication / AuthenticationManager.h
1 /*
2  * Copyright (C) 2010, 2013 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 "MessageReceiver.h"
29 #include "NetworkProcessSupplement.h"
30 #include "WebPageProxyIdentifier.h"
31 #include "WebProcessSupplement.h"
32 #include <WebCore/AuthenticationChallenge.h>
33 #include <WebCore/FrameIdentifier.h>
34 #include <WebCore/PageIdentifier.h>
35 #include <wtf/CompletionHandler.h>
36 #include <wtf/Forward.h>
37 #include <wtf/HashMap.h>
38 #include <wtf/WeakPtr.h>
39
40 namespace IPC {
41 class MessageSender;
42 }
43
44 namespace PAL {
45 class SessionID;
46 }
47
48 namespace WebCore {
49 class AuthenticationChallenge;
50 class Credential;
51 struct SecurityOriginData;
52 }
53
54 namespace WebKit {
55
56 class Download;
57 class DownloadID;
58 class NetworkProcess;
59 class WebFrame;
60
61 enum class AuthenticationChallengeDisposition : uint8_t;
62 using ChallengeCompletionHandler = CompletionHandler<void(AuthenticationChallengeDisposition, const WebCore::Credential&)>;
63
64 class AuthenticationManager : public NetworkProcessSupplement, public IPC::MessageReceiver, public CanMakeWeakPtr<AuthenticationManager> {
65     WTF_MAKE_FAST_ALLOCATED;
66     WTF_MAKE_NONCOPYABLE(AuthenticationManager);
67 public:
68     explicit AuthenticationManager(NetworkProcess&);
69
70     static const char* supplementName();
71
72     void didReceiveAuthenticationChallenge(PAL::SessionID, WebPageProxyIdentifier, const WebCore::SecurityOriginData* , const WebCore::AuthenticationChallenge&, ChallengeCompletionHandler&&);
73     void didReceiveAuthenticationChallenge(IPC::MessageSender& download, const WebCore::AuthenticationChallenge&, ChallengeCompletionHandler&&);
74
75     void completeAuthenticationChallenge(uint64_t challengeID, AuthenticationChallengeDisposition, WebCore::Credential&&);
76
77     uint64_t outstandingAuthenticationChallengeCount() const { return m_challenges.size(); }
78
79 private:
80     struct Challenge {
81         WebPageProxyIdentifier pageID;
82         WebCore::AuthenticationChallenge challenge;
83         ChallengeCompletionHandler completionHandler;
84     };
85
86 #if HAVE(SEC_KEY_PROXY)
87     // NetworkProcessSupplement
88     void initializeConnection(IPC::Connection*) final;
89 #endif
90     
91     // IPC::MessageReceiver
92     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
93
94     uint64_t addChallengeToChallengeMap(Challenge&&);
95     bool shouldCoalesceChallenge(WebPageProxyIdentifier, uint64_t challengeID, const WebCore::AuthenticationChallenge&) const;
96
97     Vector<uint64_t> coalesceChallengesMatching(uint64_t challengeID) const;
98
99     NetworkProcess& m_process;
100
101     HashMap<uint64_t, Challenge> m_challenges;
102 };
103
104 } // namespace WebKit