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            //%/////////////////////////////////////////////////////////////////////////////
33            
34            #ifndef Pegasus_Authenticator_h
35            #define Pegasus_Authenticator_h
36            
37            #include <Pegasus/Common/Config.h>
38            #include <Pegasus/Common/String.h>
39            #include <Pegasus/Common/AuthenticationInfo.h>

40 kumpf 1.4  #include <Pegasus/Common/AuthenticationInfoRep.h>
41            

42 chuck 1.6  #include <Pegasus/Security/Authentication/Linkage.h>

43 mike  1.2  
44            
45            PEGASUS_NAMESPACE_BEGIN
46            

47 kumpf 1.4  /** This is an abstract class that the authentication handlers will extend and
48                provide the implementation.

49 mike  1.2  */
50            class PEGASUS_SECURITY_LINKAGE Authenticator
51            {
52            public:
53            
54                /** Constructors  */
55                Authenticator() { };
56            
57                /** Destructor  */
58                virtual ~Authenticator() { };
59            

60 kumpf 1.12     /** Verify the authentication of the user passed in the HTTP authorization
61                    header.

62 kumpf 1.4          @param authHeader String containing the Authorization header
63                    @param authInfo Reference to AuthenticationInfo object
64                    @return true on successful authentication, false otherwise

65 mike  1.2      */

66 kumpf 1.3      virtual Boolean authenticate(

67 kumpf 1.12         const String& authHeader,

68 kumpf 1.3          AuthenticationInfo* authInfo) = 0;

69 mike  1.2  

70 kumpf 1.4      /** Construct and return the Basic authentication challenge header
71                    @param authType String containing the authentication type
72                    @param userName String containing the user name
73                    @param authInfo Reference to AuthenticationInfo object
74                    @return A string containing the authentication challenge header.

75 mike  1.2      */
76                virtual String getAuthResponseHeader(

77 kumpf 1.4          const String& authType = String::EMPTY,
78                    const String& userName = String::EMPTY,

79 kumpf 1.3          AuthenticationInfo* authInfo = 0) = 0;

80 sushma.fernandes 1.10 
81                           /**
82                               Verify whether the user is valid.
83                               @param userName String containing the user name
84                               @return true on successful validation, false otherwise
85                           */
86                           virtual Boolean validateUser(const String& userName) = 0;

87 mike             1.2  };
88                       
89                       PEGASUS_NAMESPACE_END
90                       
91                       #endif   /* Pegasus_Authenticator_h*/