KMSG_CRED subtypes
[Message Types]


Defines

#define KMSG_CRED_ROOTDELTA   1
 Root credential set changed.
#define KMSG_CRED_REFRESH   2
 Re-enumerate credentials.
#define KMSG_CRED_PASSWORD   16
 Change the password.
#define KMSG_CRED_NEW_CREDS   17
 Initiate the process of obtaining new credentials.
#define KMSG_CRED_RENEW_CREDS   18
 Renew credentials.
#define KMSG_CRED_DIALOG_SETUP   19
 Dialog setup.
#define KMSG_CRED_DIALOG_PRESTART   20
 Dialog pre-start.
#define KMSG_CRED_DIALOG_START   21
 Dialog start.
#define KMSG_CRED_DIALOG_NEW_IDENTITY   22
 The primary identity of the new credentials dialog has changed.
#define KMSG_CRED_DIALOG_NEW_OPTIONS   23
 New credentials options have changed.
#define KMSG_CRED_PROCESS   24
 Process dialog.
#define KMSG_CRED_END   25
 End a credentials acquisition operation.
#define KMSG_CRED_IMPORT   26
 Import credentials from the operating system.
#define KMSG_CRED_DESTROY_CREDS   32
 Destroy credentials.
#define KMSG_CRED_PP_BEGIN   128
 A property page is being launced.
#define KMSG_CRED_PP_PRECREATE   129
 A property page is about to be created.
#define KMSG_CRED_PP_END   130
 A property page has finished processing.
#define KMSG_CRED_PP_DESTROY   131
 A property page has been destroyed.
#define KMSG_CRED_ADDR_CHANGE   140
 An IP address change occurred.
#define IS_CRED_ACQ_MSG(msg)   ((msg) >= 16 && (msg) <=31)
 Check if a KMSG_CRED subtype is a credentials acquisition message.


Define Documentation

#define IS_CRED_ACQ_MSG ( msg   )     ((msg) >= 16 && (msg) <=31)

Check if a KMSG_CRED subtype is a credentials acquisition message.

Dialog messages are those that deal with the new or initial credentials acquisition dialog, from initial announcement to dialog completion.

Currently, the dialog messages are:

All dialog message numbers are allocated in a contigous block.

Note that while KMSG_CRED_PROCESS and KMSG_CRED_END are not specific to dialogs, they are still included in this predicate because they are also part of the dialog message sequence.

#define KMSG_CRED_ADDR_CHANGE   140

An IP address change occurred.

There are no parameters for this message. The NetIDMgr application handles this message and depending on configuration, posts message for the individual credentials providers to either obtain new credentials or renew old ones.

#define KMSG_CRED_DESTROY_CREDS   32

Destroy credentials.

Notification that the specified credentials should be destroyed. Once this message has completed processing a KMSG_CRED_REFRESH message will be issued.

The credentials that should be destroyed are specified by a khui_action_context structure. The context that should be used is the selection context. Hence, the credentials that must be destroyed are the ones lised in the credential set (credset).

Message parameters:

#define KMSG_CRED_DIALOG_NEW_IDENTITY   22

The primary identity of the new credentials dialog has changed.

This message is not sent out by the UI, but is reserved here for use by individual credentials providers. The message may be sent from the dialog procedure to the plugin.

Message parameters:

Note:
Be careful when sending this message. All messages that are not sent by the system should not be sent via broadcast. Instead, create a subscription using kmq_create_subscription() for the individual plugin that you want to send the message and use one of the per-subscription message functions to send the actual message.

#define KMSG_CRED_DIALOG_NEW_OPTIONS   23

New credentials options have changed.

This message is not sent out by the UI, but is reserved here for use by individual credentials providers. The message may be sent from the dialog procedure to the plugin.

Message parameters:

Note:
Be careful when sending this message. All messages that are not sent by the system should not be sent via broadcast. Instead, create a subscription using kmq_create_subscription() for the individual plugin that you want to send the message and use one of the per-subscription message functions to send the actual message.

#define KMSG_CRED_DIALOG_PRESTART   20

Dialog pre-start.

Sent after all the credentials providers have responded to KMSG_CRED_DIALOG_SETUP and all the initialization has been completed. Credentials providers are expected to respond to this message by loading any default data into the dialog controls for each credential type.

Message parameters:

Note:
May be sent to individual credential subscriptions.

#define KMSG_CRED_DIALOG_SETUP   19

Dialog setup.

Once KMSG_CRED_NEW_CREDS has been responded to by all the credential types, the UI creates the dialog windows using the data supplied in the khui_new_creds_by_type structures and issues this message. Each credentials provider is expected to respond by finalizing dialog creation operations.

Message parameters:

Note:
May be sent to individual credential subscriptions.

#define KMSG_CRED_DIALOG_START   21

Dialog start.

A notification that the dialog is now in progress.

Message parameters:

Note:
May be sent to individual credential subscriptions.

#define KMSG_CRED_END   25

End a credentials acquisition operation.

A notification that the credentials acquisition operation has ended.

Message parameters:

Note:
May be sent to individual credential subscriptions.

#define KMSG_CRED_IMPORT   26

Import credentials from the operating system.

Notification to all credentials providers to import any available credentials from the operating system.

Message parameters:

#define KMSG_CRED_NEW_CREDS   17

Initiate the process of obtaining new credentials.

The UI sends this message to start the process of obtaining new credentials. See Managed credential acquisition for more information about handling this message.

A plug-in handling this message that wishes to participate in the new credentials acquisition operation is expected to add a khui_new_creds_by_type to hte list of participants in the khui_new_creds structure by calling khui_cw_add_type().

Message parameters:

See also:
Managed credential acquisition, khui_cw_add_type(), khui_new_creds, khui_new_creds_by_type

#define KMSG_CRED_PASSWORD   16

Change the password.

This message notifies credentials providers that a password change request has been received.

A plug-in handling this message that wishes to participate in the password change operation is expected to add a khui_new_creds_by_type to the list of participants in the khui_new_creds structure by calling khui_cw_add_type().

The password change operation requires user interaction. Any plug-ins that are participating in the operation need to provide a user-interface.

Message parameters:

See also:
khui_cw_add_type(), khui_new_creds, khui_new_creds_by_type

#define KMSG_CRED_PP_BEGIN   128

A property page is being launced.

Handlers of this message should determine whether or not they should participate in the property sheet and if so, add a khui_property_page structure to the property sheet.

Message parameters:

#define KMSG_CRED_PP_DESTROY   131

A property page has been destroyed.

Message parameters:

Note:
This is a notification that the property sheet processing has been completed and that the property sheet data structures should be freed. Any property page data structures should have already been freed while processing KMSG_CRED_PP_END. The validity of the khui_property_sheet structure should not be relied upon while processing this message.

#define KMSG_CRED_PP_END   130

A property page has finished processing.

Handlers of this message should remove any khui_property_page structures they added when processing KMSG_CRED_PP_BEGIN.

Message parameters:

#define KMSG_CRED_PP_PRECREATE   129

A property page is about to be created.

Message parameters:

Note:
This message is merely a notification that the property sheet is being created. Handlers should not modify the state of the property sheet or pages at this time.

#define KMSG_CRED_PROCESS   24

Process dialog.

Sent to all the credential providers to look at the contents of the given khui_new_creds structure and do any required processing.

If the result field in the structure is set to KHUI_NC_RESULT_PROCESS, then new credentials should be obtained using the given data.

Set the response field in the structure to indicate how the UI should proceed from here.

Message parameters:

Note:
May be sent to individual credential subscriptions.

#define KMSG_CRED_REFRESH   2

Re-enumerate credentials.

A notice to all credential providers to re-enumerate their respective credentials.

Note:
May be sent to individual credential subscriptions.

#define KMSG_CRED_RENEW_CREDS   18

Renew credentials.

This is a notification sent to individual credentials providers that a specified identity's credentials should be renewed.

A plug-in handling this message that wishes to participate in the renew credentials operation is expected to add a khui_new_creds_by_type to the list of participants in the khui_new_creds structure by calling khui_cw_add_type().

Message parameters:

See also:
khui_cw_add_type(), khui_new_creds, khui_new_creds_by_type

#define KMSG_CRED_ROOTDELTA   1

Root credential set changed.

This message is issued when the root credential set successfully collected credentials from another credential set.

uparam of the message is set to a bitmask indicating the change that occured. It is a combination of KCDB_DELTA_ADD, KCDB_DELTA_DEL and KCDB_DELTA_MODIFY.


Generated on Fri Aug 3 08:27:13 2007 for Network Identity Manager by Doxygen 1.5.2
© 2004-2007 Massachusetts Institute of Technology.
© 2005-2007 Secure Endpoints Inc.
Contact khimaira@mit.edu