Clean up AuthenticationChallengeProxy
[WebKit-https.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 #ifndef AuthenticationManager_h
27 #define AuthenticationManager_h
28
29 #include "MessageReceiver.h"
30 #include "NetworkProcessSupplement.h"
31 #include "WebProcessSupplement.h"
32 #include <WebCore/AuthenticationChallenge.h>
33 #include <wtf/CompletionHandler.h>
34 #include <wtf/Forward.h>
35 #include <wtf/HashMap.h>
36 #include <wtf/WeakPtr.h>
37
38 namespace IPC {
39 class MessageSender;
40 }
41
42 namespace WebCore {
43 class AuthenticationChallenge;
44 class Credential;
45 }
46
47 namespace WebKit {
48
49 class ChildProcess;
50 class Download;
51 class DownloadID;
52 class WebFrame;
53
54 enum class AuthenticationChallengeDisposition {
55     UseCredential,
56     PerformDefaultHandling,
57     Cancel,
58     RejectProtectionSpaceAndContinue
59 };
60 using ChallengeCompletionHandler = CompletionHandler<void(AuthenticationChallengeDisposition, const WebCore::Credential&)>;
61
62 class AuthenticationManager : public NetworkProcessSupplement, public IPC::MessageReceiver, public CanMakeWeakPtr<AuthenticationManager> {
63     WTF_MAKE_NONCOPYABLE(AuthenticationManager);
64 public:
65     explicit AuthenticationManager(ChildProcess&);
66
67     static const char* supplementName();
68
69     void didReceiveAuthenticationChallenge(uint64_t pageID, uint64_t frameID, const WebCore::AuthenticationChallenge&, ChallengeCompletionHandler&&);
70     void didReceiveAuthenticationChallenge(IPC::MessageSender& download, const WebCore::AuthenticationChallenge&, ChallengeCompletionHandler&&);
71
72     void useCredentialForChallenge(uint64_t challengeID, const WebCore::Credential&);
73     void continueWithoutCredentialForChallenge(uint64_t challengeID);
74     void cancelChallenge(uint64_t challengeID);
75     void performDefaultHandling(uint64_t challengeID);
76     void rejectProtectionSpaceAndContinue(uint64_t challengeID);
77
78     uint64_t outstandingAuthenticationChallengeCount() const { return m_challenges.size(); }
79
80 private:
81     struct Challenge {
82         uint64_t pageID;
83         WebCore::AuthenticationChallenge challenge;
84         ChallengeCompletionHandler completionHandler;
85     };
86
87 #if HAVE(SEC_KEY_PROXY)
88     // NetworkProcessSupplement
89     void initializeConnection(IPC::Connection*) final;
90 #endif
91     
92     // IPC::MessageReceiver
93     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
94
95     uint64_t addChallengeToChallengeMap(Challenge&&);
96     bool shouldCoalesceChallenge(uint64_t pageID, uint64_t challengeID, const WebCore::AuthenticationChallenge&) const;
97
98     void useCredentialForSingleChallenge(uint64_t challengeID, const WebCore::Credential&);
99     void continueWithoutCredentialForSingleChallenge(uint64_t challengeID);
100     void cancelSingleChallenge(uint64_t challengeID);
101     void performDefaultHandlingForSingleChallenge(uint64_t challengeID);
102     void rejectProtectionSpaceAndContinueForSingleChallenge(uint64_t challengeID);
103
104     Vector<uint64_t> coalesceChallengesMatching(uint64_t challengeID) const;
105
106     ChildProcess& m_process;
107
108     HashMap<uint64_t, Challenge> m_challenges;
109 };
110
111 } // namespace WebKit
112
113 #endif // AuthenticationManager_h