ICredentials Class Reference

Interface representing credentials in an Integrated Security (Kerberos) environment. There may be more than one user principal stored in an ICredentials object. Methods on this may allow users to specify which principal to use. More...

List of all members.

Classes

struct  PrivilegedAction
 Functor struct base class for privileged actions that can be executed as the principal represented by an ICredentials instance. More...

Public Member Functions

virtual void * ExecuteAs (PrivilegedAction &in_action)=0
 Executes a privileged action as the principal represented by these credentials. Uses the default credentials.
virtual simba_wstring GetName ()=0
 Gets the default name associated with these credentials.
virtual AutoPtr< ISecurityContextGetSecurityContext (const simba_wstring &in_userPrincipalName, const simba_wstring &in_spn)=0
 Gets a security context to be used for establishing credentials with a service. Uses credentials for a specific user principal if those credentials are part of this ICredentials object. Note that the principal name must be of the form "username@REALM". Throws an exception if in_userPrincipalName credentials are not available.
virtual AutoPtr< ISecurityContextGetSecurityContext (const simba_wstring &in_spn)=0
 Gets a security context to be used for establishing credentials with a service. Uses the default credentials.
virtual ~ICredentials ()
 Destructor.

Protected Member Functions

 ICredentials ()
 Constructor.

Detailed Description

Interface representing credentials in an Integrated Security (Kerberos) environment. There may be more than one user principal stored in an ICredentials object. Methods on this may allow users to specify which principal to use.


Constructor & Destructor Documentation

virtual ~ICredentials (  )  [inline, virtual]

Destructor.

ICredentials (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual void* ExecuteAs ( PrivilegedAction in_action  )  [pure virtual]

Executes a privileged action as the principal represented by these credentials. Uses the default credentials.

Parameters:
in_action Action to execute. This action may not throw exceptions. Error states should be returned through the return value or as state information within the structure to be checked after.
Returns:
void* meaning and ownership is defined by the action being passed.
Exceptions:
ErrorException if unable to establish the impersonation.
virtual simba_wstring GetName (  )  [pure virtual]

Gets the default name associated with these credentials.

Returns:
simba_wstring of the name associated with these credentials.
virtual AutoPtr<ISecurityContext> GetSecurityContext ( const simba_wstring in_userPrincipalName,
const simba_wstring in_spn 
) [pure virtual]

Gets a security context to be used for establishing credentials with a service. Uses credentials for a specific user principal if those credentials are part of this ICredentials object. Note that the principal name must be of the form "username@REALM". Throws an exception if in_userPrincipalName credentials are not available.

Parameters:
in_userPrincipalName Name of user principal to use. Must be of the form "username@REALM".
in_spn Service Principal Name of the remote service.
virtual AutoPtr<ISecurityContext> GetSecurityContext ( const simba_wstring in_spn  )  [pure virtual]

Gets a security context to be used for establishing credentials with a service. Uses the default credentials.

Parameters:
in_spn Service Principal Name of the remote service.

The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:19 2017 for SimbaEngine 10.1.3.1011 by simba