version 1.24, 2005/02/05 22:59:23
|
version 1.35, 2007/05/25 18:35:13
|
|
|
//%2005//////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development | // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. | // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
|
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. | // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; | // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// EMC Corporation; VERITAS Software Corporation; The Open Group. | // EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Nag Boranna, Hewlett-Packard Company (nagaraja_boranna@hp.com) |
|
// |
|
// Modified By: Jair Santos, Hewlett-Packard Company (jair.santos@hp.com) |
|
// Heather Sterling, IBM (hsterl@us.ibm.com) |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_AuthenticationInfo_h | #ifndef Pegasus_AuthenticationInfo_h |
|
|
{ | { |
public: | public: |
| |
/** Constructor - Creates an uninitiated new AuthenticationInfo |
/** Constructor - Creates an uninitialized new AuthenticationInfo |
object reprenting a AuthenticationInfo class. The class object |
object representing an AuthenticationInfo class. The class object |
created by this constructor can only be used in an operation such as the | created by this constructor can only be used in an operation such as the |
copy constructor. It cannot be used to do method calls like |
copy constructor. It cannot be used to do method calls such as |
setAuthStatus, getAuthType, etc. since it is unitiated. |
getAuthType, since it is uninitialized. |
| |
Use one of the other constructors to create an initiated new | Use one of the other constructors to create an initiated new |
AuthenticationInfo class object. Throws an exception | AuthenticationInfo class object. Throws an exception |
|
|
PEG_METHOD_EXIT(); | PEG_METHOD_EXIT(); |
} | } |
| |
/** Get the authentication status of the request |
/** Sets the connection authentication status of the request to the |
@return the current authentication status |
status specified. |
*/ |
|
AuthenticationInfoRep::AuthStatus getAuthStatus() const |
|
{ |
|
_checkRep(); |
|
return _rep->getAuthStatus(); |
|
} |
|
|
|
/** Sets the authentication status of the request to the status |
|
specified. |
|
@param status - the new authentication status | @param status - the new authentication status |
*/ | */ |
void setAuthStatus(AuthenticationInfoRep::AuthStatus status) |
void setConnectionAuthenticated(Boolean status) |
{ | { |
_checkRep(); | _checkRep(); |
_rep->setAuthStatus(status); |
_rep->setConnectionAuthenticated(status); |
} | } |
| |
/** Get the previously authenticated user name | /** Get the previously authenticated user name |
|
|
_rep->setAuthenticatedPassword(password); | _rep->setAuthenticatedPassword(password); |
} | } |
| |
/** Get the authentication challenge that was sent to the client |
/** Get the local authentication file path that was sent to client |
@return string containing the authentication challenge |
@return string containing the authentication file path |
*/ | */ |
String getAuthChallenge() const |
String getLocalAuthFilePath() const |
{ | { |
_checkRep(); | _checkRep(); |
return _rep->getAuthChallenge(); |
return _rep->getLocalAuthFilePath(); |
} | } |
| |
/** Sets the authentication challenge to the specified challenge |
/** Set the local authentication file path to the specified file path |
@param challenge - string containing the authentication challenge |
@param filePath String containing the authentication file path |
*/ | */ |
void setAuthChallenge(const String& challenge) |
void setLocalAuthFilePath(const String& filePath) |
{ | { |
_checkRep(); | _checkRep(); |
_rep->setAuthChallenge(challenge); |
_rep->setLocalAuthFilePath(filePath); |
} | } |
| |
/** Get the authentication secret that was sent to client |
/** Get the local authentication secret that was sent to client |
@return string containing the authentication secret | @return string containing the authentication secret |
*/ | */ |
String getAuthSecret() const |
String getLocalAuthSecret() const |
{ | { |
_checkRep(); | _checkRep(); |
return _rep->getAuthSecret(); |
return _rep->getLocalAuthSecret(); |
} | } |
| |
/** Set the authentication secret to the specified secret |
/** Set the local authentication secret to the specified secret |
@param secret - string containing the authentication secret | @param secret - string containing the authentication secret |
*/ | */ |
void setAuthSecret(const String& secret) |
void setLocalAuthSecret(const String& secret) |
{ |
|
_checkRep(); |
|
_rep->setAuthSecret(secret); |
|
} |
|
|
|
/** Returns the connection type of the previous authenticated request |
|
@return true if the connection is privileged, false otherwise |
|
*/ |
|
Boolean isPrivileged() const |
|
{ | { |
_checkRep(); | _checkRep(); |
return _rep->isPrivileged(); |
_rep->setLocalAuthSecret(secret); |
} |
|
|
|
/** Set the privileged flag to the specified value |
|
@param privileged - boolean flag indicating the connection type |
|
*/ |
|
void setPrivileged(Boolean privileged) |
|
{ |
|
_checkRep(); |
|
_rep->setPrivileged(privileged); |
|
} | } |
| |
/** Is the request authenticated | /** Is the request authenticated |
|
|
/** Returns the authentication status of the current connection. | /** Returns the authentication status of the current connection. |
@return true if the connection was authenticated, false otherwise | @return true if the connection was authenticated, false otherwise |
*/ | */ |
Boolean isAuthenticated() const |
Boolean isConnectionAuthenticated() const |
{ | { |
_checkRep(); | _checkRep(); |
return _rep->isAuthenticated(); |
return _rep->isConnectionAuthenticated(); |
} | } |
| |
/** Set the authentication type to the specified type | /** Set the authentication type to the specified type |
|
|
return _rep->getAuthType(); | return _rep->getAuthType(); |
} | } |
| |
|
/** |
|
Set the IP address to the specified IP address |
|
@param string containing the IP address |
|
*/ |
|
void setIpAddress(const String& ipAddress) |
|
{ |
|
_checkRep(); |
|
_rep->setIpAddress(ipAddress); |
|
} |
|
|
|
/** |
|
Get the IP address of the connection |
|
|
|
NOTE: The IP address is for debug use only. |
|
It should not be used for authentication purposes. |
|
|
|
@return string containing the IP address |
|
*/ |
|
String getIpAddress() const |
|
{ |
|
_checkRep(); |
|
return _rep->getIpAddress(); |
|
} |
|
|
|
|
#ifdef PEGASUS_KERBEROS_AUTHENTICATION | #ifdef PEGASUS_KERBEROS_AUTHENTICATION |
/** Get the CIM Security Association | /** Get the CIM Security Association |
@return a pointer to the CIM Security Association | @return a pointer to the CIM Security Association |
|
|
} | } |
#endif | #endif |
| |
/** Indicate whether the export connection flag is set or not |
Array<SSLCertificateInfo*> getClientCertificateChain() |
*/ |
|
Boolean isExportConnection() const |
|
{ | { |
_checkRep(); | _checkRep(); |
return _rep->isExportConnection(); |
return _rep->getClientCertificateChain(); |
} | } |
| |
/** Set the export connection flag |
void setClientCertificateChain(Array<SSLCertificateInfo*> clientCertificate) |
*/ |
|
void setExportConnection(Boolean exportConnection) |
|
{ | { |
_checkRep(); | _checkRep(); |
_rep->setExportConnection(exportConnection); |
_rep->setClientCertificateChain(clientCertificate); |
} | } |
| |
//PEP187 |
/** Set flag to show that isRemotePrivilegedUserAccess check has been done |
SSLCertificateInfo* getClientCertificate() |
this function should only be used by OpenPegasus AuthenticationHandlers |
|
*/ |
|
void setRemotePrivilegedUserAccessChecked() |
{ | { |
_checkRep(); | _checkRep(); |
return _rep->getClientCertificate(); |
_rep->setRemotePrivilegedUserAccessChecked(); |
} | } |
| |
//PEP187 |
/** Indicates whether the isRemotePrivilegedUserAccess check has been |
void setClientCertificate(SSLCertificateInfo* clientCertificate) |
performed. This method should only be used by OpenPegasus |
|
AuthenticationHandlers |
|
*/ |
|
Boolean getRemotePrivilegedUserAccessChecked() |
{ | { |
_checkRep(); | _checkRep(); |
_rep->setClientCertificate(clientCertificate); |
return _rep->getRemotePrivilegedUserAccessChecked(); |
} | } |
| |
private: | private: |