1 karl 1.11 //%2006////////////////////////////////////////////////////////////////////////
|
2 mike 1.2 //
|
3 karl 1.8 // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
4 // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
5 // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
|
6 karl 1.7 // IBM Corp.; EMC Corporation, The Open Group.
|
7 karl 1.8 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
8 // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
|
9 karl 1.9 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
10 // EMC Corporation; VERITAS Software Corporation; The Open Group.
|
11 karl 1.11 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
12 // EMC Corporation; Symantec Corporation; The Open Group.
|
13 mike 1.2 //
|
14 kumpf 1.5 // Permission is hereby granted, free of charge, to any person obtaining a copy
15 // of this software and associated documentation files (the "Software"), to
16 // deal in the Software without restriction, including without limitation the
17 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
18 // sell copies of the Software, and to permit persons to whom the Software is
19 // furnished to do so, subject to the following conditions:
20 //
21 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
22 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
23 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
24 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
25 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
26 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
27 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
29 mike 1.2 //
30 //==============================================================================
31 //
32 // Author: Bapu Patil, Hewlett-Packard Company (bapu_patil@hp.com)
33 //
34 // Modified By:
35 // Nag Boranna, Hewlett-Packard Company(nagaraja_boranna@hp.com)
|
36 sushma.fernandes 1.10 // Sushma Fernandes, Hewlett-Packard Company(sushma_fernandes@hp.com)
|
37 mike 1.2 //
38 //%/////////////////////////////////////////////////////////////////////////////
39
40 #ifndef Pegasus_Authenticator_h
41 #define Pegasus_Authenticator_h
42
43 #include <Pegasus/Common/Config.h>
44 #include <Pegasus/Common/String.h>
45 #include <Pegasus/Common/AuthenticationInfo.h>
|
46 kumpf 1.4 #include <Pegasus/Common/AuthenticationInfoRep.h>
47
|
48 chuck 1.6 #include <Pegasus/Security/Authentication/Linkage.h>
|
49 mike 1.2
50
51 PEGASUS_NAMESPACE_BEGIN
52
|
53 kumpf 1.4 /** This is an abstract class that the authentication handlers will extend and
54 provide the implementation.
|
55 mike 1.2 */
56 class PEGASUS_SECURITY_LINKAGE Authenticator
57 {
58 public:
59
60 /** Constructors */
61 Authenticator() { };
62
63 /** Destructor */
64 virtual ~Authenticator() { };
65
|
66 kumpf 1.4 /** Verify the authentication of the user passed in the HTTP authorization header.
67 @param authHeader String containing the Authorization header
68 @param authInfo Reference to AuthenticationInfo object
69 @return true on successful authentication, false otherwise
|
70 mike 1.2 */
|
71 kumpf 1.3 virtual Boolean authenticate(
72 const String& authHeader,
73 AuthenticationInfo* authInfo) = 0;
|
74 mike 1.2
|
75 kumpf 1.4 /** Construct and return the Basic authentication challenge header
76 @param authType String containing the authentication type
77 @param userName String containing the user name
78 @param authInfo Reference to AuthenticationInfo object
79 @return A string containing the authentication challenge header.
|
80 mike 1.2 */
81 virtual String getAuthResponseHeader(
|
82 kumpf 1.4 const String& authType = String::EMPTY,
83 const String& userName = String::EMPTY,
|
84 kumpf 1.3 AuthenticationInfo* authInfo = 0) = 0;
|
85 sushma.fernandes 1.10
86 /**
87 Verify whether the user is valid.
88 @param userName String containing the user name
89 @return true on successful validation, false otherwise
90 */
91 virtual Boolean validateUser(const String& userName) = 0;
|
92 mike 1.2 };
93
94 PEGASUS_NAMESPACE_END
95
96 #endif /* Pegasus_Authenticator_h*/
|