1 karl  1.11 //%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.11 // 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_LocalAuthenticator_h
 40                       #define Pegasus_LocalAuthenticator_h
 41                       
 42                       #include <Pegasus/Common/Config.h>
 43                       #include <Pegasus/Common/String.h>

 44 kumpf            1.4  

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

 46 mike             1.2  
 47                       PEGASUS_NAMESPACE_BEGIN
 48                       
 49                          
 50                       /**
 51                           This is an abstract class that the local authenticators will extend and 
 52                           provide the implementation. Sample implementation can be seen in 
 53                           SecureLocalAuthenticator.cpp
 54                       */ 
 55                       class PEGASUS_SECURITY_LINKAGE LocalAuthenticator
 56                       {
 57                       public:
 58                       
 59                           /** constructor. */ 
 60                           LocalAuthenticator() { };
 61                       
 62                           /** destructor. */ 
 63                           virtual ~LocalAuthenticator() { };
 64                       

 65 kumpf            1.4      /** Verify the authentication of the requesting user.
 66                               @param userName String containing the user name
 67                               @param secretReceived String containing the authentication secret
 68                               sent by the client.
 69                               @param secretKept String containing the authentication secret that
 70                               was sent to client as part of the challenge.
 71                               @return true on successful authentication, false otherwise
 72                           */

 73 mike             1.2      virtual Boolean authenticate(

 74 kumpf            1.3          const String& userName, 
 75                               const String& secretReceived, 
 76                               const String& secretKept) = 0;

 77 mike             1.2  

 78 kumpf            1.4      /** Construct and return the Peagaus Local authentication challenge header
 79                               @param authType String containing the authentication type
 80                               @param userName String containing the user name
 81                               @param challenge String to store the authentication challenge secret
 82                               @return A string containing the authentication challenge header.
 83                           */

 84 mike             1.2      virtual String getAuthResponseHeader(

 85 kumpf            1.3          const String& authType, 
 86                               const String& userName, 

 87 mike             1.2          String& challenge) = 0;

 88 sushma.fernandes 1.10 
 89                           /**
 90                               Verify whether the user is valid.
 91                               @param userName String containing the user name
 92                               @return true on successful validation, false otherwise
 93                           */
 94                           virtual Boolean validateUser(const String& userName) = 0;

 95 mike             1.2  };
 96                       
 97                       
 98                       PEGASUS_NAMESPACE_END
 99                       
100                       #endif /* Pegasus_LocalAuthenticator_h */