1 martin 1.15 //%LICENSE////////////////////////////////////////////////////////////////
2 //
3 // 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 //
10 // 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 //
17 // The above copyright notice and this permission notice shall be included
18 // in all copies or substantial portions of the Software.
19 //
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 martin 1.15 // 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 kumpf 1.5 //
|
28 martin 1.15 //////////////////////////////////////////////////////////////////////////
|
29 mike 1.2 //
30 //%/////////////////////////////////////////////////////////////////////////////
31
32 #ifndef Pegasus_SecureLocalAuthenticator_h
33 #define Pegasus_SecureLocalAuthenticator_h
34
35 #include "LocalAuthenticator.h"
|
36 chuck 1.6
37 #include <Pegasus/Security/Authentication/Linkage.h>
|
38 mike 1.2
39
40 PEGASUS_NAMESPACE_BEGIN
41
|
42 kumpf 1.14 /** This class implements file based secure local authentication mechanism.
|
43 kumpf 1.4 It extends the LocalAuthenticator and provides implementation.
|
44 kumpf 1.14 */
45 class PEGASUS_SECURITY_LINKAGE SecureLocalAuthenticator
46 : public LocalAuthenticator
|
47 mike 1.2 {
48 public:
49
|
50 kumpf 1.14 /** constructor. */
|
51 mike 1.2 SecureLocalAuthenticator();
52
|
53 kumpf 1.14 /** destructor. */
|
54 mike 1.2 ~SecureLocalAuthenticator();
55
|
56 kumpf 1.4 /** Verify the authentication of the requesting user.
57 @param userName String containing the user name
58 @param secretReceived String containing the authentication secret
59 sent by the client.
60 @param secretKept String containing the authentication secret that
61 was sent to client as part of the challenge.
62 @return true on successful authentication, false otherwise
63 */
|
64 mike 1.2 Boolean authenticate(
|
65 kumpf 1.14 const String& userName,
66 const String& secretReceived,
|
67 kumpf 1.3 const String& secretKept);
|
68 mike 1.2
|
69 sushma.fernandes 1.10 /**
70 Verify whether the user is valid.
71 @param userName String containing the user name
72 @return true on successful validation, false otherwise
73 */
74 Boolean validateUser(const String& userName);
75
|
76 kumpf 1.4 /** Construct and return the Peagaus Local authentication challenge header
77 @param authType String containing the authentication type
78 @param userName String containing the user name
|
79 kumpf 1.13 @param filePath String to store the authentication file path
|
80 sushma.fernandes 1.12 @param secret String to store the authentication secret
|
81 kumpf 1.4 @return A string containing the authentication challenge header.
82 */
|
83 kumpf 1.3 String getAuthResponseHeader(
|
84 kumpf 1.13 const String& authType,
85 const String& userName,
86 String& filePath,
|
87 sushma.fernandes 1.12 String& secret);
|
88 mike 1.2 };
89
90 PEGASUS_NAMESPACE_END
91
92 #endif /* Pegasus_SecureLocalAuthenticator_h */
|