1 karl  1.12 //%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.12 // 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            // Author: Nag Boranna, Hewlett-Packard Company(nagaraja_boranna@hp.com)
 33            //
 34            // Modified By:

 35 sushma.fernandes 1.10 //            Sushma Fernandes, Hewlett-Packard Company(sushma_fernandes@hp.com)

 36 mike             1.2  //
 37                       //%/////////////////////////////////////////////////////////////////////////////
 38                       
 39                       #ifndef Pegasus_BasicAuthenticationHandler_h
 40                       #define Pegasus_BasicAuthenticationHandler_h
 41                       
 42                       #include <Pegasus/Common/Config.h>
 43                       #include <Pegasus/Common/String.h>

 44 kumpf            1.4  

 45 mike             1.2  #include "Authenticator.h"

 46 kumpf            1.4  #include "BasicAuthenticator.h"

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

 49 mike             1.2  

 50 kumpf            1.4  

 51 mike             1.2  PEGASUS_NAMESPACE_BEGIN
 52                       
 53                       /** 
 54                           Implements the AuthenticationHandler for Basic authentication
 55                       */
 56                       

 57 w.otsuka         1.11 static const char BASIC_AUTHENTICATION_FAILED_KEY [] = 
 58                           "Security.Authentication.BasicAuthenticationHandler.BASIC_AUTHENTICATION_FAILED";
 59                       
 60                       static const char BASIC_AUTHENTICATION_FAILED [] = 
 61                         "Authentication failed for user=$0.";
 62                       

 63 mike             1.2  class PEGASUS_SECURITY_LINKAGE BasicAuthenticationHandler : public Authenticator
 64                       {
 65                       public:
 66                       
 67                           /** Constructors  */
 68                           BasicAuthenticationHandler();
 69                       
 70                           /** Destructor  */
 71                           ~BasicAuthenticationHandler();
 72                           

 73 kumpf            1.4      /** Verify the authentication of the user passed in the authorization header.
 74                               @param authHeader String containing the Authorization header
 75                               @param authInfo Reference to AuthenticationInfo object
 76                               @return true on successful authentication, false otherwise

 77 mike             1.2      */

 78 kumpf            1.3      Boolean authenticate(
 79                               const String& authHeader, 
 80                               AuthenticationInfo* authInfo);

 81 mike             1.2      

 82 kumpf            1.4      /** Construct and return the Basic authentication challenge header
 83                               @param authType An optional string containing the HTTP authentication type 
 84                               @param userName An optional string containing the user name 
 85                               (Parameters are not used to generate the Basic authentication challenge 
 86                                header, hence they are optional) 
 87                               @return A string containing the authentication challenge header.

 88 kumpf            1.3      */
 89                           String getAuthResponseHeader(

 90 kumpf            1.4          const String& authType = String::EMPTY,
 91                               const String& userName = String::EMPTY,
 92                               AuthenticationInfo* authInfo = 0);

 93 mike             1.2  

 94 sushma.fernandes 1.10     Boolean validateUser(const String& userName);
 95                       

 96 w.otsuka         1.11 

 97 mike             1.2  private:
 98                       

 99 kumpf            1.4      BasicAuthenticator* _basicAuthenticator;

100 mike             1.2  };
101                       
102                       PEGASUS_NAMESPACE_END
103                       
104                       #endif /* Pegasus_BasicAuthenticationHandler_h*/