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            //%/////////////////////////////////////////////////////////////////////////////
 33            
 34            #ifndef Pegasus_BasicAuthenticationHandler_h
 35            #define Pegasus_BasicAuthenticationHandler_h
 36            
 37            #include <Pegasus/Common/Config.h>
 38            #include <Pegasus/Common/String.h>

 39 kumpf 1.4  

 40 mike  1.2  #include "Authenticator.h"

 41 kumpf 1.4  #include "BasicAuthenticator.h"

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

 44 mike  1.2  

 45 kumpf 1.4  

 46 mike  1.2  PEGASUS_NAMESPACE_BEGIN
 47            

 48 kumpf 1.13 /**

 49 mike  1.2      Implements the AuthenticationHandler for Basic authentication
 50            */
 51            

 52 kumpf 1.13 static const char BASIC_AUTHENTICATION_FAILED_KEY [] =
 53                "Security.Authentication.BasicAuthenticationHandler."
 54                    "BASIC_AUTHENTICATION_FAILED";

 55 w.otsuka 1.11 

 56 kumpf    1.13 static const char BASIC_AUTHENTICATION_FAILED [] =
 57                   "Authentication failed for user=$0.";

 58 w.otsuka 1.11 

 59 kumpf    1.13 class PEGASUS_SECURITY_LINKAGE BasicAuthenticationHandler
 60                   : public Authenticator

 61 mike     1.2  {
 62               public:
 63               
 64                   /** Constructors  */
 65                   BasicAuthenticationHandler();
 66               
 67                   /** Destructor  */
 68                   ~BasicAuthenticationHandler();

 69 kumpf    1.13 
 70                   /** Verify the authentication of the user passed in the authorization
 71                       header.

 72 kumpf    1.4          @param authHeader String containing the Authorization header
 73                       @param authInfo Reference to AuthenticationInfo object
 74                       @return true on successful authentication, false otherwise

 75 mike     1.2      */

 76 kumpf    1.3      Boolean authenticate(

 77 kumpf    1.13         const String& authHeader,

 78 kumpf    1.3          AuthenticationInfo* authInfo);

 79 kumpf    1.13 

 80 kumpf    1.4      /** Construct and return the Basic authentication challenge header

 81 kumpf    1.13         @param authType An optional string containing the HTTP authentication
 82                       type
 83                       @param userName An optional string containing the user name
 84                       (Parameters are not used to generate the Basic authentication challenge
 85                        header, hence they are optional)

 86 kumpf    1.4          @return A string containing the authentication challenge header.

 87 kumpf    1.3      */
 88                   String getAuthResponseHeader(

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

 92 mike     1.2  

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

 95 w.otsuka         1.11 

 96 mike             1.2  private:
 97                       

 98 kumpf            1.4      BasicAuthenticator* _basicAuthenticator;

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