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_LocalAuthenticator_h
35            #define Pegasus_LocalAuthenticator_h
36            
37            #include <Pegasus/Common/Config.h>
38            #include <Pegasus/Common/String.h>

39 kumpf 1.4  

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

41 mike  1.2  
42            PEGASUS_NAMESPACE_BEGIN
43            
44               
45            /**
46                This is an abstract class that the local authenticators will extend and 
47                provide the implementation. Sample implementation can be seen in 
48                SecureLocalAuthenticator.cpp
49            */ 
50            class PEGASUS_SECURITY_LINKAGE LocalAuthenticator
51            {
52            public:
53            
54                /** constructor. */ 
55                LocalAuthenticator() { };
56            
57                /** destructor. */ 
58                virtual ~LocalAuthenticator() { };
59            

60 kumpf 1.4      /** Verify the authentication of the requesting user.
61                    @param userName String containing the user name
62                    @param secretReceived String containing the authentication secret
63                    sent by the client.
64                    @param secretKept String containing the authentication secret that
65                    was sent to client as part of the challenge.
66                    @return true on successful authentication, false otherwise
67                */

68 mike  1.2      virtual Boolean authenticate(

69 kumpf 1.3          const String& userName, 
70                    const String& secretReceived, 
71                    const String& secretKept) = 0;

72 mike  1.2  

73 kumpf 1.4      /** Construct and return the Peagaus Local authentication challenge header
74                    @param authType String containing the authentication type
75                    @param userName String containing the user name

76 kumpf 1.13         @param filePath String to store the authentication file path

77 sushma.fernandes 1.12         @param secret String to store the authentication secret

78 kumpf            1.4          @return A string containing the authentication challenge header.
79                           */

80 mike             1.2      virtual String getAuthResponseHeader(

81 kumpf            1.3          const String& authType, 
82                               const String& userName, 

83 kumpf            1.13         String& filePath, 

84 sushma.fernandes 1.12         String& secret) = 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                       
95                       PEGASUS_NAMESPACE_END
96                       
97                       #endif /* Pegasus_LocalAuthenticator_h */