[SOUP] Add NetworkSession implementation and switch to use it
[WebKit-https.git] / Source / WebKit2 / 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/Forward.h>
34 #include <wtf/Function.h>
35 #include <wtf/HashMap.h>
36
37 namespace WebCore {
38 class AuthenticationChallenge;
39 class CertificateInfo;
40 class Credential;
41 }
42
43 namespace WebKit {
44
45 class ChildProcess;
46 class Download;
47 class DownloadID;
48 class PendingDownload;
49 class WebFrame;
50
51 enum class AuthenticationChallengeDisposition {
52     UseCredential,
53     PerformDefaultHandling,
54     Cancel,
55     RejectProtectionSpace
56 };
57 typedef Function<void(AuthenticationChallengeDisposition, const WebCore::Credential&)> ChallengeCompletionHandler;
58
59 class AuthenticationManager : public WebProcessSupplement, public NetworkProcessSupplement, public IPC::MessageReceiver {
60     WTF_MAKE_NONCOPYABLE(AuthenticationManager);
61 public:
62     explicit AuthenticationManager(ChildProcess*);
63
64     static const char* supplementName();
65
66 #if USE(NETWORK_SESSION)
67     void didReceiveAuthenticationChallenge(uint64_t pageID, uint64_t frameID, const WebCore::AuthenticationChallenge&, ChallengeCompletionHandler&&);
68     void didReceiveAuthenticationChallenge(PendingDownload&, const WebCore::AuthenticationChallenge&, ChallengeCompletionHandler&&);
69 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
70     void continueCanAuthenticateAgainstProtectionSpace(DownloadID, bool canAuthenticate);
71 #endif
72 #endif
73     // Called for resources in the WebProcess (NetworkProcess disabled)
74     void didReceiveAuthenticationChallenge(WebFrame*, const WebCore::AuthenticationChallenge&);
75     // Called for resources in the NetworkProcess (NetworkProcess enabled)
76     void didReceiveAuthenticationChallenge(uint64_t pageID, uint64_t frameID, const WebCore::AuthenticationChallenge&);
77 #if !USE(NETWORK_SESSION)
78     void didReceiveAuthenticationChallenge(Download&, const WebCore::AuthenticationChallenge&);
79 #endif
80
81     void useCredentialForChallenge(uint64_t challengeID, const WebCore::Credential&, const WebCore::CertificateInfo&);
82     void continueWithoutCredentialForChallenge(uint64_t challengeID);
83     void cancelChallenge(uint64_t challengeID);
84     void performDefaultHandling(uint64_t challengeID);
85     void rejectProtectionSpaceAndContinue(uint64_t challengeID);
86
87     uint64_t outstandingAuthenticationChallengeCount() const { return m_challenges.size(); }
88
89     static void receivedCredential(const WebCore::AuthenticationChallenge&, const WebCore::Credential&);
90     static void receivedRequestToContinueWithoutCredential(const WebCore::AuthenticationChallenge&);
91     static void receivedCancellation(const WebCore::AuthenticationChallenge&);
92     static void receivedRequestToPerformDefaultHandling(const WebCore::AuthenticationChallenge&);
93     static void receivedChallengeRejection(const WebCore::AuthenticationChallenge&);
94
95 private:
96     struct Challenge {
97         uint64_t pageID;
98         WebCore::AuthenticationChallenge challenge;
99 #if USE(NETWORK_SESSION)
100         ChallengeCompletionHandler completionHandler;
101 #endif
102     };
103     
104     // IPC::MessageReceiver
105     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
106
107     bool tryUseCertificateInfoForChallenge(const WebCore::AuthenticationChallenge&, const WebCore::CertificateInfo&, const ChallengeCompletionHandler&);
108
109     uint64_t addChallengeToChallengeMap(Challenge&&);
110     bool shouldCoalesceChallenge(uint64_t pageID, uint64_t challengeID, const WebCore::AuthenticationChallenge&) const;
111
112     void useCredentialForSingleChallenge(uint64_t challengeID, const WebCore::Credential&, const WebCore::CertificateInfo&);
113     void continueWithoutCredentialForSingleChallenge(uint64_t challengeID);
114     void cancelSingleChallenge(uint64_t challengeID);
115     void performDefaultHandlingForSingleChallenge(uint64_t challengeID);
116     void rejectProtectionSpaceAndContinueForSingleChallenge(uint64_t challengeID);
117
118     Vector<uint64_t> coalesceChallengesMatching(uint64_t challengeID) const;
119
120     ChildProcess* m_process;
121
122     HashMap<uint64_t, Challenge> m_challenges;
123 };
124
125 } // namespace WebKit
126
127 #endif // AuthenticationManager_h