1 karl  1.7 //%2003////////////////////////////////////////////////////////////////////////

 2 mike  1.2 //

 3 karl  1.7 // 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           // IBM Corp.; EMC Corporation, The Open Group.

 7 mike  1.2 //

 8 kumpf 1.5 // Permission is hereby granted, free of charge, to any person obtaining a copy
 9           // of this software and associated documentation files (the "Software"), to
10           // deal in the Software without restriction, including without limitation the
11           // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12           // sell copies of the Software, and to permit persons to whom the Software is
13           // furnished to do so, subject to the following conditions:
14           // 
15           // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
16           // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
17           // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
18           // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
19           // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20           // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21           // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22           // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

23 mike  1.2 //
24           //==============================================================================
25           //
26           // Author: Nag Boranna, Hewlett-Packard Company(nagaraja_boranna@hp.com)
27           //
28           // Modified By:
29           //
30           //%/////////////////////////////////////////////////////////////////////////////
31           
32           #ifndef Pegasus_LocalAuthenticator_h
33           #define Pegasus_LocalAuthenticator_h
34           
35           #include <Pegasus/Common/Config.h>
36           #include <Pegasus/Common/String.h>

37 kumpf 1.4 

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

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

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

66 mike  1.2     virtual Boolean authenticate(

67 kumpf 1.3         const String& userName, 
68                   const String& secretReceived, 
69                   const String& secretKept) = 0;

70 mike  1.2 

71 kumpf 1.4     /** Construct and return the Peagaus Local authentication challenge header
72                   @param authType String containing the authentication type
73                   @param userName String containing the user name
74                   @param challenge String to store the authentication challenge secret
75                   @return A string containing the authentication challenge header.
76               */

77 mike  1.2     virtual String getAuthResponseHeader(

78 kumpf 1.3         const String& authType, 
79                   const String& userName, 

80 mike  1.2         String& challenge) = 0;
81           };
82           
83           
84           PEGASUS_NAMESPACE_END
85           
86           #endif /* Pegasus_LocalAuthenticator_h */