1 martin 1.14 //%LICENSE////////////////////////////////////////////////////////////////

 2 martin 1.15 //

 3 martin 1.14 // Licensed to The Open Group (TOG) under one or more contributor license
 4             // agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
 5             // this work for additional information regarding copyright ownership.
 6             // Each contributor licenses this file to you under the OpenPegasus Open
 7             // Source License; you may not use this file except in compliance with the
 8             // License.

 9 martin 1.15 //

10 martin 1.14 // Permission is hereby granted, free of charge, to any person obtaining a
11             // copy of this software and associated documentation files (the "Software"),
12             // to deal in the Software without restriction, including without limitation
13             // the rights to use, copy, modify, merge, publish, distribute, sublicense,
14             // and/or sell copies of the Software, and to permit persons to whom the
15             // Software is furnished to do so, subject to the following conditions:

16 martin 1.15 //

17 martin 1.14 // The above copyright notice and this permission notice shall be included
18             // in all copies or substantial portions of the Software.

19 martin 1.15 //

20 martin 1.14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

21 martin 1.15 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

22 martin 1.14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23             // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
24             // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25             // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26             // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

27 martin 1.15 //

28 martin 1.14 //////////////////////////////////////////////////////////////////////////

29 mike   1.2  //
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 kumpf  1.16 

43 mike   1.2  /**

44 kumpf  1.16     This is an abstract class that the local authenticators will extend and
45                 provide the implementation. Sample implementation can be seen in

46 mike   1.2      SecureLocalAuthenticator.cpp

47 kumpf  1.16 */

48 mike   1.2  class PEGASUS_SECURITY_LINKAGE LocalAuthenticator
49             {
50             public:
51             

52 kumpf  1.16     /** constructor. */

53 mike   1.2      LocalAuthenticator() { };
54             

55 kumpf  1.16     /** destructor. */

56 mike   1.2      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.16         const String& userName,
68                     const String& secretReceived,

69 kumpf  1.3          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 kumpf  1.13         @param filePath String to store the authentication file path

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

76 kumpf            1.4          @return A string containing the authentication challenge header.
77                           */

78 mike             1.2      virtual String getAuthResponseHeader(

79 kumpf            1.16         const String& authType,
80                               const String& userName,
81                               String& filePath,

82 sushma.fernandes 1.12         String& secret) = 0;

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

90 mike             1.2  };
91                       
92                       
93                       PEGASUS_NAMESPACE_END
94                       
95                       #endif /* Pegasus_LocalAuthenticator_h */