Move WebCore into Source
[WebKit-https.git] / Source / WebCore / platform / network / ProtectionSpace.h
1 /*
2  * Copyright (C) 2007 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 COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25 #ifndef ProtectionSpace_h
26 #define ProtectionSpace_h
27
28 #include "PlatformString.h"
29
30 namespace WebCore {
31
32 enum ProtectionSpaceServerType {
33     ProtectionSpaceServerHTTP = 1,
34     ProtectionSpaceServerHTTPS = 2,
35     ProtectionSpaceServerFTP = 3,
36     ProtectionSpaceServerFTPS = 4,
37     ProtectionSpaceProxyHTTP = 5,
38     ProtectionSpaceProxyHTTPS = 6,
39     ProtectionSpaceProxyFTP = 7,
40     ProtectionSpaceProxySOCKS = 8
41 };
42
43 enum ProtectionSpaceAuthenticationScheme {
44     ProtectionSpaceAuthenticationSchemeDefault = 1,
45     ProtectionSpaceAuthenticationSchemeHTTPBasic = 2,
46     ProtectionSpaceAuthenticationSchemeHTTPDigest = 3,
47     ProtectionSpaceAuthenticationSchemeHTMLForm = 4,
48     ProtectionSpaceAuthenticationSchemeNTLM = 5,
49     ProtectionSpaceAuthenticationSchemeNegotiate = 6,
50     ProtectionSpaceAuthenticationSchemeClientCertificateRequested = 7,
51     ProtectionSpaceAuthenticationSchemeServerTrustEvaluationRequested = 8,
52     ProtectionSpaceAuthenticationSchemeUnknown = 100,
53 };
54   
55 class ProtectionSpace {
56
57 public:
58     ProtectionSpace();
59     ProtectionSpace(const String& host, int port, ProtectionSpaceServerType, const String& realm, ProtectionSpaceAuthenticationScheme);
60
61     // Hash table deleted values, which are only constructed and never copied or destroyed.
62     ProtectionSpace(WTF::HashTableDeletedValueType) : m_isHashTableDeletedValue(true) { }
63     bool isHashTableDeletedValue() const { return m_isHashTableDeletedValue; }
64     
65     const String& host() const;
66     int port() const;
67     ProtectionSpaceServerType serverType() const;
68     bool isProxy() const;
69     const String& realm() const;
70     ProtectionSpaceAuthenticationScheme authenticationScheme() const;
71     
72     bool receivesCredentialSecurely() const;
73
74 private:
75     String m_host;
76     int m_port;
77     ProtectionSpaceServerType m_serverType;
78     String m_realm;
79     ProtectionSpaceAuthenticationScheme m_authenticationScheme;
80     bool m_isHashTableDeletedValue;
81 };
82
83 bool operator==(const ProtectionSpace& a, const ProtectionSpace& b);
84 inline bool operator!=(const ProtectionSpace& a, const ProtectionSpace& b) { return !(a == b); }
85     
86 } // namespace WebCore
87
88 #endif // ProtectionSpace_h