version 1.2, 2001/12/13 14:54:31
|
version 1.16, 2013/06/05 14:09:26
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001 BMC Software, Hewlett-Packard Company, IBM, |
// Licensed to The Open Group (TOG) under one or more contributor license |
// The Open Group, Tivoli Systems |
// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
|
// this work for additional information regarding copyright ownership. |
|
// Each contributor licenses this file to you under the OpenPegasus Open |
|
// Source License; you may not use this file except in compliance with the |
|
// License. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a | // Permission is hereby granted, free of charge, to any person obtaining a |
// copy of this software and associated documentation files (the "Software"), | // copy of this software and associated documentation files (the "Software"), |
|
|
// and/or sell copies of the Software, and to permit persons to whom the | // and/or sell copies of the Software, and to permit persons to whom the |
// Software is furnished to do so, subject to the following conditions: | // Software is furnished to do so, subject to the following conditions: |
// | // |
// The above copyright notice and this permission notice shall be included in |
// The above copyright notice and this permission notice shall be included |
// all copies of substantial portions of this software. |
// in all copies or substantial portions of the Software. |
// |
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
|
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|
// DEALINGS IN THE SOFTWARE. |
|
// |
|
//============================================================================== |
|
// | // |
// Author: Bapu Patil, Hewlett-Packard Company (bapu_patil@hp.com) |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
|
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
|
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
|
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
|
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
// | // |
// Modified By: |
////////////////////////////////////////////////////////////////////////// |
// Nag Boranna, Hewlett-Packard Company(nagaraja_boranna@hp.com) |
|
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
|
|
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
#include <Pegasus/Common/String.h> | #include <Pegasus/Common/String.h> |
#include <Pegasus/Common/AuthenticationInfo.h> | #include <Pegasus/Common/AuthenticationInfo.h> |
#include "Linkage.h" |
#include <Pegasus/Common/AuthenticationInfoRep.h> |
| |
|
#include <Pegasus/Security/Authentication/Linkage.h> |
|
#include <Pegasus/Security/Authentication/AuthenticationStatus.h> |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
/** |
/** This is an abstract class that the authentication handlers will extend and |
An authentication interface that the authentication handler will implement. |
provide the implementation. |
*/ | */ |
|
|
class PEGASUS_SECURITY_LINKAGE Authenticator | class PEGASUS_SECURITY_LINKAGE Authenticator |
{ | { |
public: | public: |
|
|
/** Destructor */ | /** Destructor */ |
virtual ~Authenticator() { }; | virtual ~Authenticator() { }; |
| |
/** |
/** Verify the authentication of the user passed in the HTTP authorization |
Authenticate the request |
header. |
|
@param authHeader String containing the Authorization header |
|
@param authInfo Reference to AuthenticationInfo object |
|
@return AuthenticationStatus holding http status code and error detail |
*/ | */ |
virtual Boolean authenticate(String authHeader, AuthenticationInfo* authInfo) = 0; |
virtual AuthenticationStatus authenticate( |
|
const String& authHeader, |
/** |
AuthenticationInfo* authInfo) = 0; |
Construct and return the authentication response header |
|
|
/** Construct and return the Basic authentication challenge header |
|
@param authType String containing the authentication type |
|
@param userName String containing the user name |
|
@param authInfo Reference to AuthenticationInfo object |
|
@return A string containing the authentication challenge header. |
*/ | */ |
virtual String getAuthResponseHeader( | virtual String getAuthResponseHeader( |
String requestHeader, |
const String& authType = String::EMPTY, |
|
const String& userName = String::EMPTY, |
AuthenticationInfo* authInfo = 0) = 0; | AuthenticationInfo* authInfo = 0) = 0; |
| |
|
/** |
|
Verify whether the user is valid. |
|
@param userName String containing the user name |
|
@param authInfo reference to AuthenticationInfo object that holds the |
|
authentication information for the given connection. |
|
@return AuthenticationStatus holding http status code and error detail |
|
*/ |
|
virtual AuthenticationStatus validateUser( |
|
const String& userName, |
|
AuthenticationInfo* authInfo) = 0; |
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |