7fc1614d3d3fa7b5eaab4c86ee30747ebcdb69b4
[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 "NetworkSession.h"
32 #include "WebProcessSupplement.h"
33 #include <WebCore/AuthenticationChallenge.h>
34 #include <wtf/Forward.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 class AuthenticationManager : public WebProcessSupplement, public NetworkProcessSupplement, public IPC::MessageReceiver {
52     WTF_MAKE_NONCOPYABLE(AuthenticationManager);
53 public:
54     explicit AuthenticationManager(ChildProcess*);
55
56     static const char* supplementName();
57
58 #if USE(NETWORK_SESSION)
59     void didReceiveAuthenticationChallenge(uint64_t pageID, uint64_t frameID, const WebCore::AuthenticationChallenge&, ChallengeCompletionHandler&&);
60     void didReceiveAuthenticationChallenge(PendingDownload&, const WebCore::AuthenticationChallenge&, ChallengeCompletionHandler&&);
61 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
62     void continueCanAuthenticateAgainstProtectionSpace(DownloadID, bool canAuthenticate);
63 #endif
64 #endif
65     // Called for resources in the WebProcess (NetworkProcess disabled)
66     void didReceiveAuthenticationChallenge(WebFrame*, const WebCore::AuthenticationChallenge&);
67     // Called for resources in the NetworkProcess (NetworkProcess enabled)
68     void didReceiveAuthenticationChallenge(uint64_t pageID, uint64_t frameID, const WebCore::AuthenticationChallenge&);
69 #if !USE(NETWORK_SESSION)
70     void didReceiveAuthenticationChallenge(Download&, const WebCore::AuthenticationChallenge&);
71 #endif
72
73     void useCredentialForChallenge(uint64_t challengeID, const WebCore::Credential&, const WebCore::CertificateInfo&);
74     void continueWithoutCredentialForChallenge(uint64_t challengeID);
75     void cancelChallenge(uint64_t challengeID);
76     void performDefaultHandling(uint64_t challengeID);
77     void rejectProtectionSpaceAndContinue(uint64_t challengeID);
78
79     uint64_t outstandingAuthenticationChallengeCount() const { return m_challenges.size(); }
80
81     static void receivedCredential(const WebCore::AuthenticationChallenge&, const WebCore::Credential&);
82     static void receivedRequestToContinueWithoutCredential(const WebCore::AuthenticationChallenge&);
83     static void receivedCancellation(const WebCore::AuthenticationChallenge&);
84     static void receivedRequestToPerformDefaultHandling(const WebCore::AuthenticationChallenge&);
85     static void receivedChallengeRejection(const WebCore::AuthenticationChallenge&);
86
87 private:
88     struct Challenge {
89         uint64_t pageID;
90         WebCore::AuthenticationChallenge challenge;
91 #if USE(NETWORK_SESSION)
92         ChallengeCompletionHandler completionHandler;
93 #endif
94     };
95     
96     // IPC::MessageReceiver
97     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
98
99     bool tryUseCertificateInfoForChallenge(const WebCore::AuthenticationChallenge&, const WebCore::CertificateInfo&, const ChallengeCompletionHandler&);
100
101     uint64_t addChallengeToChallengeMap(Challenge&&);
102     bool shouldCoalesceChallenge(uint64_t pageID, uint64_t challengeID, const WebCore::AuthenticationChallenge&) const;
103
104     void useCredentialForSingleChallenge(uint64_t challengeID, const WebCore::Credential&, const WebCore::CertificateInfo&);
105     void continueWithoutCredentialForSingleChallenge(uint64_t challengeID);
106     void cancelSingleChallenge(uint64_t challengeID);
107     void performDefaultHandlingForSingleChallenge(uint64_t challengeID);
108     void rejectProtectionSpaceAndContinueForSingleChallenge(uint64_t challengeID);
109
110     Vector<uint64_t> coalesceChallengesMatching(uint64_t challengeID) const;
111
112     ChildProcess* m_process;
113
114     HashMap<uint64_t, Challenge> m_challenges;
115 };
116
117 } // namespace WebKit
118
119 #endif // AuthenticationManager_h