1 martin 1.13 //%LICENSE////////////////////////////////////////////////////////////////

 2 martin 1.14 //

 3 martin 1.13 // 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.14 //

10 martin 1.13 // 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.14 //

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

19 martin 1.14 //

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

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

22 martin 1.13 // 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.14 //

28 martin 1.13 //////////////////////////////////////////////////////////////////////////

29 mike   1.2  //
30             //%/////////////////////////////////////////////////////////////////////////////
31             
32             #ifndef Pegasus_Authenticator_h
33             #define Pegasus_Authenticator_h
34             
35             #include <Pegasus/Common/Config.h>
36             #include <Pegasus/Common/String.h>
37             #include <Pegasus/Common/AuthenticationInfo.h>

38 kumpf  1.4  #include <Pegasus/Common/AuthenticationInfoRep.h>
39             

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

41 marek  1.16 #include <Pegasus/Security/Authentication/AuthenticationStatus.h>

42 mike   1.2  
43             PEGASUS_NAMESPACE_BEGIN
44             

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

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

58 kumpf  1.12     /** Verify the authentication of the user passed in the HTTP authorization
59                     header.

60 kumpf  1.4          @param authHeader String containing the Authorization header
61                     @param authInfo Reference to AuthenticationInfo object

62 marek  1.16         @return AuthenticationStatus holding http status code and error detail

63 mike   1.2      */

64 marek  1.16     virtual AuthenticationStatus authenticate(

65 kumpf  1.12         const String& authHeader,

66 kumpf  1.3          AuthenticationInfo* authInfo) = 0;

67 mike   1.2  

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

73 mike   1.2      */
74                 virtual String getAuthResponseHeader(

75 kumpf  1.4          const String& authType = String::EMPTY,
76                     const String& userName = String::EMPTY,

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

78 sushma.fernandes 1.10 
79                           /**
80                               Verify whether the user is valid.
81                               @param userName String containing the user name

82 marek            1.15         @param authInfo reference to AuthenticationInfo object that holds the
83                               authentication information for the given connection.

84 marek            1.16         @return AuthenticationStatus holding http status code and error detail

85 sushma.fernandes 1.10     */

86 marek            1.16     virtual AuthenticationStatus validateUser(

87 marek            1.15         const String& userName,
88                               AuthenticationInfo* authInfo) = 0;

89 mike             1.2  };
90                       
91                       PEGASUS_NAMESPACE_END
92                       
93                       #endif   /* Pegasus_Authenticator_h*/