Local Interface TransportSecurity::CredentialsCurator

local interface CredentialsCurator

  ORB.resolve_initial_references("TransportSecurity:CredentialsCurator");
 

The following pseudo code describes the process of TLS credentials acquisition using CredentialsCurator.

 // Resolve the Credentials Curator
 CredentialsCurator curator = ....
     resolve_initial_references("TransportSecurity:CredentialsCurator");

 // Build up an acquisition argument (e.g., using SL3TLS::TLSArgBuilder)
 Any arg = ...

 // Acquire credentials
 CredentialsAcquirer acquirer =
     curator.acquire_credentials("SL3TLSAQArgs",arg);

 // Get credentials and destroy the Credentials Acquirer
 OwnCredentials own = acquirer.get_credentials(false);
 

Attribute Index

default_creds_list

This is the default list of own credentials.

supported_mechanisms

This attribute lists the transport mechanism that are supported, such as TCPIP, TLS, SECIOP-Kerberos.

Operation Index

acquire_credentials

This operation starts the process of credentials acquisition and create a CredentialsAcquirer for a particular acquisition method.

get_own_credentials

This operation retrieves the OwnCredentials, if still available by its credentials identifier.

get_supported_acquisition_methods

This operation returns a list of the supported acquisition methods for the particular mechanism.

release_credentials

This operation provides management of the own credentials list, since the own credentials list is used as default credentials policy.

remove_credentials

This operation removes the own credentials from the default_creds_list.

Attributes

default_creds_list

readonly attribute OwnCredentialsList default_creds_list;

This is the default list of own credentials.

supported_mechanisms

readonly attribute MechanismList supported_mechanisms;

This attribute lists the transport mechanism that are supported, such as TCPIP, TLS, SECIOP-Kerberos.

Operations

acquire_credentials

CredentialsAcquirer acquire_credentials(in MechanismId mechanism_id,
                                        in AcquisitionMethod acquisition_method,
                                        in any acquisition_arguments);

This operation starts the process of credentials acquisition and create a CredentialsAcquirer for a particular acquisition method. It takes an initial set of arguments for the acquisition. The content of the arguments are based on the acquisiton method. Depending on the method, it is possible that the credentials may be immediately available from a call to get_credentials on the returned CredentialsAcquirer.

If the process of credentials acquisition is not completed upon the return of the acquire_credentials operation, the returned CredentialsAcquirer object shall have its current_status at AQST_Continued. In this case, the get_continuation_data and continue_acquisition operations shall be used to complete the credentials acquisition process.

If the process of credentials acquisition fails, it is up to the implementation to either throw a system exception or return a CredentialsAcquirer with the AQST_Failed status.

The acquisition_arguments parameter is a CORBA any that is constructed according to the acquisition method used. The ArgumentFactory from the SL3AQArgs module is a local object that helps immensely with the construction of this complex argument. Extensions of that object are defined in their own separate modules that pertain to the particular acquisition mechanism, such as the SL3TLS, SL3TCPIP, SL3KRB5 modules.

Parameters:

acquisition_method - The identifier of the desired acquisition method. A CORBA BAD_PARAM exception will be raised if the named method is not supported.

acquisition_arguments - The argument of the desired acquisition method. This CORBA any type is constructed according to the particular acquisition method.

See Also:

"SL3AQArgs"

"SL3TLS"

"SL3TCPIP"

"SL3KRB5"

get_own_credentials

OwnCredentials get_own_credentials(in CredentialsId creds_id);

This operation retrieves the OwnCredentials, if still available by its credentials identifier.

get_supported_acquisition_methods

AcquisitionMethodList get_supported_acquisition_methods(in MechanismId mech_id);

This operation returns a list of the supported acquisition methods for the particular mechanism. Method identifiers are defined in modules that signify their support.

See Also:

"SL3TLS"

"SL3TCPIP"

"SL3KRB5"

release_credentials

void release_credentials(in CredentialsId creds_id);

This operation provides management of the own credentials list, since the own credentials list is used as default credentials policy. This should be to remove the credentials from the default_credentials_list, if there, and calls release() on the credentials. A BAD_PARAM exception is thrown if the credentials do not exist.

remove_credentials

void remove_credentials(in CredentialsId creds_id);

This operation removes the own credentials from the default_creds_list. However, it does not release the credentials. A BAD_PARAM exception is thrown if the credentials are not on the default credentials list.

Generated by the ORBacus IDL-to-HTML translator