From: Jeffrey Altman The change password dialog can be invoked from the Credentials menu. This is used to
change the password for the primary credentials provider (currently
-Kerberos 5).
+Kerberos v5).
For the default identity provider (Kerberos 5), there are two input
+ For the default identity provider (Kerberos v5), there are two input
boxes to specify the identity for which the password is to be changed.
The identity uniquely maps to the Kerberos principal of the same name.
Then the current password must be entered along with the new password
@@ -23,7 +24,7 @@ twice.
Note that currently, when the password for an identity is being
-changed, only the associated Kerberos 5 password is changed.
+changed, only the associated Kerberos v5 password is changed.
This action will attempt to destroy the credentials that are
-currently selected in the credentials window. How the credentials are
-destroyed is up to each credentials provider.
+currently selected in the credentials window.
In some cases, you may need to select all the credentials of a
diff --git a/src/windows/identity/help/html/act_import_creds.htm b/src/windows/identity/help/html/act_import_creds.htm
index 550bb39e2..2ccd01a45 100644
--- a/src/windows/identity/help/html/act_import_creds.htm
+++ b/src/windows/identity/help/html/act_import_creds.htm
@@ -1,26 +1,25 @@
Allows you to import credentials from the Windows LSA credentials
-cache into any of the caches under the control of any credentials
-provider. Currently, the only credentials provider that supports
-importing is Kerberos 5.
+ Allows you to import credentials from the Microsoft Windows LSA credentials
+cache. Currently, the only credentials provider that supports
+importing is Kerberos v5.
This action can be invoked via the Credentials menu or by pressing Ctrl + I. In addition, the Kerberos 5
+class="pre">Ctrl + I. In addition, the Kerberos v5
configuration pane accessible via the Options menu provides an options that
-control how the importing of credentials happen.
+href="menu_options.htm">Options menu contain settings that
+control when the importing of credentials are performed at startup.
The new credentials dialog can be invoked from the Credentials menu, by typing
-
+
If the Kerberos 5 identity provider is used, the dialog will ask
+ If the Kerberos v5 identity provider is used, the dialog will ask
for a username and a realm to determine the identity for which new
credentials will be obtained for. Depending on the selected identity,
you may be required to provide a password or other form of
@@ -36,31 +33,35 @@ authentication for new credentials to be obtained.
Below the prompts is the credentials summary window. This window
-provides an overview of the credentals that will be obtained when the
+provides an overview of the credentials that will be obtained when the
dialog is completed.
If you click any of the credentials type hyperlinks in the
-credentials summary window or select the Options
->> button, the dialog will switch to the exanded view.
+credentials summary window or select the >> button, the dialog will switch to the expanded view.
An example of this is shown below:
-
-
The expanded view provides access to additional options available for
-each credential provider. For example, the Kerberos 5 credentials
+each credential provider. For example, the Kerberos v5 credentials
provider allows you to set the lifetime of the obtained Kerberos
ticket as well as ticket flags such as renewable or
forwardable.
+Note that the above screenshot is
+from an instance of NetIDMgr with Kerberos v5, Kerberos v4, OpenAFS and
+Kerberized Certificate Authority providers with a Kerberos v5 identity provider. Actual display may be
+different depending on the providers that are active.Change Password
+Network Identity Manager - Change Password
Destroy Credentials
+Network Identity Manager - Destroy Credentials
Import Credentials
+Network Identity Manager - Import Credentials
-New Credentials
+Network Identity Manager - New Credentials
Expanded view
Credentials summary window
@@ -76,22 +77,21 @@ window will display a message describing the problem. For example:
- +
The above is an example of what you would see if the provided identity -is invalid. Once the identity provider (in this case, Kerberos 5) +is invalid. Once the identity provider (in this case, Kerberos v5) indicates that the identity is invalid, it will be displayed as above along with a brief description of why the identity was found to be -invalid. Here, the Kerberos 5 identity provider is reporting that the +invalid. Here, the Kerberos v5 identity provider is reporting that the specified principal does not exist in the Kerberos database.
-The new credentials dialog can be invoked from the command line using +
The new credentials dialog can be invoked from the command line using the -i or --kinit command line option. Additionally, if you specify the -a or --autoinit @@ -100,10 +100,9 @@ there are no credentials available.
-Setting the Prompt for new credentials if there -aren't any at startup option is set in the General configuration panel, then the behavior is -similar to the --autoinit option. +Setting the Obtain new credentials at startup (if none are present) option in the General configuration panel causes NetIDMgr to behave as if +the --autoinit option is specified at each execution.
diff --git a/src/windows/identity/help/html/act_renew_creds.htm b/src/windows/identity/help/html/act_renew_creds.htm index 0bd196ad5..7e8a6637c 100644 --- a/src/windows/identity/help/html/act_renew_creds.htm +++ b/src/windows/identity/help/html/act_renew_creds.htm @@ -1,32 +1,31 @@ -The renew credentials action can be invoked via the Credential menu or by pressing Ctrl + -R. Additionally, if Monitor credentials +R. Additionally, if the Monitor credential expiration option is enabled for all identities or for a specific identity, then those credentials will be automatically -renewed before they expire.
+renewed whenever possible before they expire.An identity must be selected before invoking the renew credentials action.
Not all credentials can be renewed. The actual logic of renewing -the credentials is up to each credentials provider. In general -NetIDMgr will invoke each credentials provider to renew their -respective credentials. For Kerberos 5, if the initial ticket is +the credentials is up to each credentials provider. In general, NetIDMgr will invoke each credentials provider to renew their +respective credentials. For Kerberos v5, if the initial ticket is renewable and not expired, then it will obtain a renewed initial -ticket. For Kerberos 4, once a renewed Kerberos 5 initial ticket is +ticket. For Kerberos v4, once a renewed Kerberos v5 initial ticket is obtained, it will try to use a Krb524 translator to obtain a new -Kerberos 4 initial ticket.
+Kerberos v4 initial ticket. \ No newline at end of file diff --git a/src/windows/identity/help/html/act_set_default.htm b/src/windows/identity/help/html/act_set_default.htm index 382b3c1ce..6dccd235c 100644 --- a/src/windows/identity/help/html/act_set_default.htm +++ b/src/windows/identity/help/html/act_set_default.htm @@ -1,15 +1,19 @@ -+One identity can be designated as the default identity. The default identity is the +identity used by Kerberos v5 and GSS-API based applications which use the default +Kerberos v5 credential cache and +never request the use of a network identity by name.
diff --git a/src/windows/identity/help/html/bugs.htm b/src/windows/identity/help/html/bugs.htm index fcc563c9a..f934dffd2 100644 --- a/src/windows/identity/help/html/bugs.htm +++ b/src/windows/identity/help/html/bugs.htm @@ -1,22 +1,21 @@ -If you encounter a bug in the software, please email -kfw-bugs@MIT.EDU -and report it. Please include as much information as possible to -enable us to reproduce the problem. +
If you encounter a bug in the software, please send a bug report via e-mail to +kfw-bugs@MIT.EDU. +Please include as much information as possible to assist us in reproducing the problem.
kerberos@MIT.EDU -is a mailing list set up for discussing Kerberos issues. It is +is a mailing list set up for discussing end user Kerberos issues. It is gatewayed to the Usenet newsgroup 'comp.protocols.kerberos'. If you prefer to read it via mail, send a subscription request to kerberos-request@MIT.EDU diff --git a/src/windows/identity/help/html/cmdline_netidmgr.htm b/src/windows/identity/help/html/cmdline_netidmgr.htm new file mode 100644 index 000000000..f77c47598 --- /dev/null +++ b/src/windows/identity/help/html/cmdline_netidmgr.htm @@ -0,0 +1,38 @@ + +
+Command line options for Network Identity Manager are:
+-a or --autoinit | +Automatic Initialization of Credentials | +
-i or --kinit | +Obtain New Credentials and then exit | +
-d or --destroy | +Destroy Credentials belonging to the default identity + and then exit | +
-r or --renew | +Renew all Credentials and then exit | +
-x or --exit | +Signal the running instance of Network Identity + Manager to exit | +
+Network Identity Manager relies on plug-ins to provide the majority +of its functionality. A credentials provider is a plug-in +that manages one or more types of credentials. The responsibilities +of a credential provider are:
+MIT Kerberos for Windows ships with two Network Identity Manager credential +providers supporting Kerberos v5 and Kerberos v4. Credential providers for +the Andrew File System and the Kerberized Certificate Authority are available +separately.
++
+ \ No newline at end of file diff --git a/src/windows/identity/help/html/concept_credential.htm b/src/windows/identity/help/html/concept_credential.htm new file mode 100644 index 000000000..eca302ef3 --- /dev/null +++ b/src/windows/identity/help/html/concept_credential.htm @@ -0,0 +1,31 @@ + + ++In Network Identity Manager, a credential is any digital object that can +be used by a network authentication protocol to assert a specific +identity.
++As of this writing, Network Identity Manager supports four different types of +credentials:
+Of these, only Kerberos v5 initial ticket granting tickets can be used as an +identity provider credential.
++ + + + \ No newline at end of file diff --git a/src/windows/identity/help/html/concept_ident_pro.htm b/src/windows/identity/help/html/concept_ident_pro.htm index 5c4601c06..d17c23b94 100644 --- a/src/windows/identity/help/html/concept_ident_pro.htm +++ b/src/windows/identity/help/html/concept_ident_pro.htm @@ -1,16 +1,32 @@ -
-
+Network Identity Manager relies on plug-ins to provide the majority +of its functionality. One of the requirements is that there be at +least one plug-in that is registered as an identity provider. The identity +provider: + +Naturally, the identity provider plug-in that is distributed with MIT Kerberos for Windows +is Kerberos v5 based and obtains Kerberos v5 ticket granting tickets as the network credential +that represents the identity.
+ + \ No newline at end of file diff --git a/src/windows/identity/help/html/concept_identity.htm b/src/windows/identity/help/html/concept_identity.htm index ae2dda074..434067916 100644 --- a/src/windows/identity/help/html/concept_identity.htm +++ b/src/windows/identity/help/html/concept_identity.htm @@ -1,18 +1,18 @@ -While there are many approaches to defining what an identity is, as -far as the NetIDMgr framework is considered, an identity is the unique -security principal that is identified by a service. Each credential -that is managed by NetIDMgr is assumed to map to a unique identity. +far as the Network Identity Manager (NetIDMgr) is considered, an identity is the unique +user identifier that is accepted by a network service. Each credential +that is managed by NetIDMgr is assumed to map to a single identity. The collection of credentials that map to a single identity is considered to belong to that identity.
@@ -23,16 +23,11 @@ considered to belong to that identity.The default identity is the identity that will be picked up by -other applications as being the default. For example, an application -that uses Kerberos 5 can use the credentials found in the default -Kerberos 5 credentials cache. Therefore, the Kerberos 5 plug-in -considers the principal that corresponds to the default credentials -cache as being the default identity. +
The default identity is the identity that will be used by +applications when a specific identity has not been requested. +The Kerberos v5 plug-in will mark the credential cache that +contains the default identity as the default credentials +cache for the current logon session.
- --
- \ No newline at end of file diff --git a/src/windows/identity/help/html/concepts.htm b/src/windows/identity/help/html/concepts.htm index 003187205..2ce38e97f 100644 --- a/src/windows/identity/help/html/concepts.htm +++ b/src/windows/identity/help/html/concepts.htm @@ -1,32 +1,31 @@ -The Network Identity manager organizes and manages your credentials -based on how they identify you to external services which use those -credentials for authentication. To this end, it is assumed that each -credential will uniquely identify the user to a service as a single -principal or identity. For -Kerberos, the identity is conceptually the same as the principal. +
The Network Identity Manager (NetIDMgr) organizes and manages credentials +based on how they identify the user to network services. To this end, it is assumed that each +credential will uniquely identify the user to a service as a single +identity. When using Kerberos v5 the +identity is the Kerberos principal name.
-At it's core, NetIDMgr does not possess any knowlege about specific -credentials that might be available for the user or how to manage -them. It relies on several types of plugins to provide the +
At it's core, NetIDMgr does not possess any knowledge about specific +credentials that might be available to the user or how to manage +them. It relies on several types of plug-ins to provide the information it needs, and to carry out credentials management tasks. One primary task is to identify and manage identities. These services -are provided by a plugin called the identity provider. Information about individual credentials are provided by credentials providers. Other plugins -may extend the functionaility of these plugins or provide additional +href="concept_cred_pro.htm">credential providers. Other plug-ins +may extend the functionality of these plug-ins or provide additional functionality for NetIDMgr.
@@ -41,7 +40,9 @@ functionality for NetIDMgr.This software is being provided to you, the LICENSEE, by the Massachusetts Institute of Technology (M.I.T) under the following @@ -23,7 +23,7 @@ the same appear on ALL copies of the software and documentation, including modifications that you make for internal use or for distribution:
-Copyright 1992-2006 by the Massachusetts Institute of Technology. All +
Copyright 1992-2007 by the Massachusetts Institute of Technology. All rights reserved.
THIS SOFTWARE IS PROVIDED "AS IS", AND M.I.T. MAKES NO REPRESENTATIONS diff --git a/src/windows/identity/help/html/howdoi.htm b/src/windows/identity/help/html/howdoi.htm index 7a380c8d2..9826ac20a 100644 --- a/src/windows/identity/help/html/howdoi.htm +++ b/src/windows/identity/help/html/howdoi.htm @@ -1,18 +1,18 @@
-Click an item on the menu to go to the description of the submenu, or @@ -26,7 +26,7 @@ highlighted character on the submenu.
- +
Click an item on the menu to go to the description of the action, or choose from the list below. You can activate the by pressing Alt + C and you can activate each action by -pressing the highlited character. +pressing the highlighted character.
@@ -22,21 +22,21 @@ right of the action. You can use the hot key to trigger the action without invoking the Credential menu.
- -- + +
See Renew Credentials Action for more information.
Click an item on the menu to go to the description of the action, or @@ -22,22 +22,21 @@ right of the action. You can use the hot key to trigger the action without invoking the File menu.
- -- + +
You can activate the menu by pressing Alt + H @@ -21,32 +21,30 @@ the question mark icon in the title bar and then clicking on the dialog box control that you want help with.
-- + +
Click an item on the menu to go to the description of the action, or -choose from the list below. You can activate the by pressing Alt + O and you can activate each action by -pressing the highlited character. +pressing the highlighted character.
--Actions which have an associated hot key show this hot key to the -right of the action. You can use the hot key to trigger the action -without invoking the Options menu. -
- -- + +
Click an item on the menu to go to the description of the action, or @@ -22,28 +22,38 @@ right of the action. You can use the hot key to trigger the action without invoking the View menu.
- -- + +
The standard toolbar appears below along with descriptions of what each button does.
- +
All NetIDMgr configuration options can be accessed via the Options menu. The available configuration panels -are: +
All Network Identity Manager configuration options can be accessed via the +Options menu. The available configuration panels are:
- -+
General: General application options - for NetIDMgr.
- -Obtain new credentials at - startup: If checked, NetIDMgr will check there are initial - credentials for the default identity. If no such credentials are - found, NetIDMgr will display a new credentials dialog.
Run NetIDMgr in system tray after - window close: If checked, NetIDMgr will continue running in - the system notification area (sometimes referred to as the system - tray) after you close the NetIDMgr window.
Monitor network connectivity: When - changes to network connectivity are detected, NetIDMgr can notify - individual plug-ins about these changes. Doing so allows each - plug-in to respond to the change by obtaining new credentials etc. - If this option is cleared, no such notifications are sent and the - application would not respond to network changes.
Log trace events: NetIDMgr can - generate debugging information during the course of performing - certain actions. This information aids the developers in fixing - problems that you may encounter while using NetIDMgr.
Appearance: Allows you to set the - font used by NetIDMgr.
Identities: Default settings for all - identities and settings for each identity. Details below.
Notifications: Notification and timer - options. NetIDMgr can issue warnings when credentials are about to - expire. This configuration panel allows you to set the thresholds at - which these warnings are issued. For example, if the warning - timeout is set for 10 minutes, NetIDMgr will issue a warning 10 - minutes before a credential expires.
- -The panel also allows you to control the credentials renew timer. - If the timer is disabled, NetIDMgr will not automatically attempt to - renew credentials. If the Renew at half life - intervals when possible option is set, then the timer will - expire after the credential has less than half its lifetime left. - If the renewal operation fails, it will attempt another renwal after - half of the remaining liftime is over (i.e. when the credential has - less than 1/4 of its original lifetime left) and so on. -
- -Plugins: Enable/disable and check - the status of registered plug-ins. Enabling or disabling a plug-in - only takes effect after a restart of NetIDMgr.
General: General application options for NetIDMgr.
+Obtain new credentials at startup: If checked, + NetIDMgr will check there are initial credentials for the default identity. + If no such credentials are found, NetIDMgr will display a new credentials + dialog.
+Run NetIDMgr in system tray after window close: + If checked, NetIDMgr will continue running in the system notification area + (sometimes referred to as the system tray) after you close the NetIDMgr + window.
+Monitor network connectivity: When changes + to network connectivity are detected, NetIDMgr can notify individual plug-ins + about these changes. Doing so allows each plug-in to respond to the change + by obtaining new credentials etc. If this option is cleared, no such notifications + are sent and the application would not respond to network changes.
+Log trace events: NetIDMgr can generate debugging + information during the course of performing certain actions. This information + aids the developers in fixing problems that you may encounter while using + NetIDMgr.
+Appearance: Allows you to set the font used by + NetIDMgr.
+Identities: Default settings for all identities + and settings for each identity. Details below.
+Notifications: Notification and timer options. + NetIDMgr can issue warnings when credentials are about to expire. This configuration + panel allows you to set the thresholds at which these warnings are issued. For + example, if the warning timeout is set for 10 minutes, NetIDMgr will issue a + warning 10 minutes before a credential expires.
+The panel also allows you to control the credentials renew timer. If the + timer is disabled, NetIDMgr will not automatically attempt to renew credentials. + If the Renew at half life intervals when possible option + is set, then the timer will expire after the credential has less than half its + lifetime left. If the renewal operation fails, it will attempt another renwal + after half of the remaining liftime is over (i.e. when the credential has less + than 1/4 of its original lifetime left) and so on.
+Plugins: Enable/disable and check the status of + registered plug-ins. Enabling or disabling a plug-in only takes effect after + a restart of NetIDMgr.
+The General options dialog, accessed via the Options menu, allows you to configure +operational properties specific to the NetIdMgr application.
++
The Obtain new credentials at startup (if none are present) checkbox will +determine whether or not NetIdMgr will display the New Credentials dialog at startup +when no valid credentials exist.
+The Destroy all credentials on exit option can be used to empty all of +the credential caches when the NetIdMgr is terminated.
+The Run NetIdMgr in taskbar notification area after window close checkbox +determines the behavior of the window close button. When checked, NetIdMgr will +close the window but will continue running and can be accessed from the taskbar +notification area. When unchecked, NetIdMgr will behave as if File->Exit was selected +from the menu.
+Clicking on the notification icon can be configured to either Show Network +Identity Manager or Obtain New Credentials. This option controls which menu item +on the notification icon menu is the default action.
+The Monitor network connectivity option determines whether or not NetIdMgr +monitors the configuration of IP addresses on the machine. When IP addresses are +added or removed and this feature is activated, the NetIdMgr will probe the identity +management servers (e.g., Kerberos Key Distribution Centers) to determine if they +are reachable and if so will automatically obtain credentials.
+The Log trace events to trace log at the following location option is +used to activate a log file that can be used to help debug the behavior of NetIdMgr +and its plug-ins. Press the Show log button to view the log file in Windows +Notepad.
--
+The Appearance Options page can be used to select an alternate typeface to be +used when displaying credentials in the NetIdMgr.
+- + +
The Identities configuration panel allows you to set +the defaults that will be used for all identities. However, most of the settings +displayed here can be overridden with specific per-identity settings.
+The panel will have a number of sub panels (or tabs) corresponding to each plug-in +that maintains per-identity configuration.
+A list of identities for which configuration information is maintained will be +shown under the main Identities configuration panel name. +Each of these correspond to a per identity configuration +panel.
+Note that adding or removing an identity in the configuration panel only has +the effect of adding or removing the identity to or from the list of identities +for which configuration information is maintained.
-The Identities configuration panel allows -you to set the defaults that will be used for all identities. -However, most of the settings displayed here can be overridden with -specific per-identity settings. -
++
There are three general settings that can be used to set +global defaults.
+The Monitor credential expiration setting determines +whether or not NetIdMgr should monitor the credential lifetimes and issue +expiration notifications. This value is used as the default for all new +identities.
+The Automatically renew setting determines if +renewable credentials are automatically renewed prior to expiration. This +value is used as the default for all new identities.
+The Always show in the credentials list (Pinned) +setting determines whether new identities are always pinned within the +credentials list. A pinned identity will always be displayed regardless of +whether or not there are credentials associated with it.
-The panel will have a number of sub panels (or tabs) corresponding -to each plug-in that maintains per-identity configuration. -
++
The global Kerberos v5 settings define default credential +lifetimes and minimum and maximum values for use in constructing the slider +controls used to set the lifetimes.
+There are two expiration times associated with Kerberos +tickets. The first specifies the length of the time period during which the +tickets are valid for use. The second specifies the length of the renewable +lifetime. Valid Kerberos tickets may have their valid use lifetime repeatedly +extended up until the renewable lifetime expires. The settings on this page are +used to configure default lifetime values for NetIdMgr to use when requesting +Kerberos tickets from the Kerberos server (key distribution center). The +Kerberos server may issue tickets with shorter lifetimes than were requested.
+The Renewable, Forwardable, and +Addressless options determine whether or not new identities default to +obtaining Kerberos v5 tickets with these options.
+When Forwardable tickets are received from the +Kerberos Server, these tickets can be forwarded to a remote host when you +connect via telnet, ssh, ftp, rlogin, or similar applications. When tickets are +forwarded, there is no need to obtain Kerberos tickets again to access +Kerberized services on the remote host. Forwardable tickets are often +required when authenticating to a remote host using ssh or ftp when the remote +host requires the ability to authenticate to a remote file system such as AFS.
+When Renewable tickets are received from the +Kerberos Server, the ticket lifetimes may be renewed without prompting the user +for her password. This allows Kerberos tickets to be issued with short +lifetimes allowing compromised accounts to be disabled on short notice without +requiring the user to enter a password every few hours. When combined with +Automatic Ticket Renewal, NetIdMgr can maintain valid tickets for a week, a +month, or longer by automatically renewing tickets prior to their expiration. +The ability to renew tickets without a password is limited by the tickets +renewable lifetime as issued by the Kerberos Server.
+When Addressless is selected, the tickets do not +contain IP address information. This enables the tickets to be used from behind +Network Address Translators which are frequently found in Cable and DSL Modems.
+The minimum and maximum ranges are used by the ticket +initialization dialog box when constructing the Lifetime and Renewable Lifetime +sliders. These sliders can be used to modify the requested ticket lifetimes +when Kerberos tickets are initialized.
-A list of identities for which configuration information is -maintained will be shown under the main Identities configuration panel name. Each of these -correspond to a per identity configuration -panel. -
++
When the Obtain Kerberos v4 credentials button is +checked, NetIdMgr will attempt to retrieve Kerberos v4 credentials when ticket +initialization, renewal, or importation is performed. Kerberos realms are +increasingly configured to support only Kerberos v5 (e.g., Windows Active +Directory Domains.) If the realms you use do not support Kerberos v4 it is +suggested that this button be unchecked.
+Be aware that only the default identity can obtain Kerberos +v4 credentials. This limitation is due to the inability of Kerberos v4 +applications on Microsoft Windows to specify a credentials cache.
-Note that adding or removing an identity in the configuration panel -only has the effect of adding or removing the identity to or from the -list of identities for which configuration information is maintained. -
- --
- +You can access the per-identity configuration panel for a specific identity by +selecting the identity name from the list of configuration panels in the configuration +dialog.
+These panels are similar to the Identities configuration +panel, but they change per-identity settings. Changes you make in these panels will +override the defaults set in the Identities panel.
++
The General page contains a Remove Identity button +that can be used to delete this Identity from the Network Identity Manager.
-You can access the per-identity configuration panel for a specific -identity by selecting the identity name from the list of configuration -panels in the configuration dialog. -
+These panels are similar to the Identities -configuration panel, but they change per-identity settings. Changes -you make in these panels will override the defaults set in the Identities panel. -
++
The Kerberos v5 page displays the name of the credential +cache currently associated with the Identity.
--
+The Kerberos v4 page is optional and may not appear on all +systems. Only one identity can obtain Kerberos v4 credentials at a time.
+ ++
The Renew automatically at check box determines +whether or not renewable tickets will be renewed by NetIdMgr when they reach the +specified time remaining.
+The Initial warning at check box determines whether +or not a warning will be issued when the specified time remaining is reached.
+The Final warning at check box determines whether or +not a warning will be issued when the specified time remaining is reached.
+Notifications are performed in two ways. First, icons are +displayed next to the affected credentials in the flags column of the display. +Second, a balloon tip is displayed off of the NetIdMgr taskbar notification area +icon.
+ ++
The Plug-ins +and Modules page provides status information on the currently loaded plug-ins +and modules include a description of their purpose; whether or not it was loaded +properly; which other modules are required; and what organization developed it. +
+ ++
The Kerberos v5 Configuration tab allows you to +alter the behavior of the Kerberos v5 identity provider.
+In the Default Realm field, select a Kerberos realm +from the dropdown list.
+The Include all +configured realms in New Credentials realm list determines whether all of +the realms declared in the Kerberos v5 Configuration file are included in the +realms list of the Obtain New Credentials dialog. If disabled, only the +realms previously used to obtain credentials are displayed.
+The Configuration File +field displays the path to the Kerberos v5 configuration file, krb5.ini.
++
The field labeled Host Name displays the name of +your local machine. The Domain Name field displays the domain to which +your local machine currently belongs.
+The Import Tickets listbox allows you to configure +how NetIdMgr interacts with the Microsoft Kerberos Authentication Provider. +NetIdMgr will automatically import Kerberos Tickets from the Microsoft LSA at +startup depending upon the selected option and whether or not the Kerberos +Authentication Provider was used for Windows Logon authorization.
+When the Windows Logon identity is imported and is +configured as the default identity, the MIT credential cache will be used in +preference to the MSLSA credential cache.
+ ++ +
+
The Kerberos Realm Configuration dialog can be used to +manage the contents of the [Realms] and [Domain_Realm] sections of the Kerberos +v5 configuration file.
+ ++
Here, you can specify the +name of the in-memory cache used to store the Kerberos v4 tickets. The format +of the name is API: followed by the cache name. Disk caches are not supported +by Kerberos for Windows.
+The paths to the Kerberos v4 configuration files: krb.con +and krbrealm.con may be viewed from this dialog. The default is to store the +configuration files in the Windows directory.
- + + \ No newline at end of file diff --git a/src/windows/identity/help/html/use_icon.htm b/src/windows/identity/help/html/use_icon.htm index 212099e6a..353443fab 100644 --- a/src/windows/identity/help/html/use_icon.htm +++ b/src/windows/identity/help/html/use_icon.htm @@ -1,17 +1,16 @@ -When NetIDMgr is running, an icon will be placed in the system -notification area (sometimes referred to as the "tray" area, or the -"system tray"). The icon will change to reflect the current state of +
When Network Identity Manager is running, an icon will appear in the taskbar notification area. The icon will change to reflect the current state of the managed credentials.
The icons and their meanings are described below:
@@ -19,33 +18,56 @@ the managed credentials.+ | There are no managed credentials for any identity. | ||
+ | There are valid credentials for all the identities. | ||
Some of the + | Some of the credentials will expire in the next few minutes. This icon will be displayed even if automatic renewals are enabled. In this case, the credentials in question may get renewed before they expire, and the icon will change to reflect this change. | ||
- | some of the managed credentials have expired. | ++ | At least one identity's credentials have expired. |
A warning + | A warning message is waiting to be displayed. Click the icon to view the warning message. |
Clicking on the notification with the second mouse button displays a menu +(see right) which contains the most commonly used Network Identity Manager +operations.
+ +Clicking on the icon with the first mouse button will open or close the Network Identity Manager application window or open the Obtain New Credentials dialog based upon the current configuration. The behavior can be adjusted from the Options->General page. Clicking with the second mouse button will display a menu of commands.
+ \ No newline at end of file diff --git a/src/windows/identity/help/html/use_layout.htm b/src/windows/identity/help/html/use_layout.htm index 7a0d0705a..ab1ad6f05 100644 --- a/src/windows/identity/help/html/use_layout.htm +++ b/src/windows/identity/help/html/use_layout.htm @@ -1,13 +1,13 @@ -The credentials view layout provides an outlined view of the credentials that are being managed by NetIDMgr. The columns that are @@ -24,8 +24,8 @@ customizations that can be performed:
The predefined layouts in NetIDMgr are:
@@ -46,7 +46,7 @@ customizations that can be performed:The View Columns menu lists all the @@ -60,9 +60,9 @@ display.
area or by invoking the View menu. The menu is shown below. -+
- +
Clicking on a column header will change the sort order of the @@ -73,7 +73,7 @@ will start sorting in increasing order by that column.
Double-clicking a column that is not used for grouping will stop sorting by that column.
- +Double-clicking on a column header will start grouping by that diff --git a/src/windows/identity/help/html/use_start.htm b/src/windows/identity/help/html/use_start.htm index 1f1a7d69a..4c1b7ab83 100644 --- a/src/windows/identity/help/html/use_start.htm +++ b/src/windows/identity/help/html/use_start.htm @@ -1,24 +1,24 @@
-Depending on how you have installed NetIDMgr, it may start as soon -as you login, or it may need to be started manually. NetIDMgr is a -tray application. Hence it doesn't appear on your task bar. This is -based on the assumption that you don't need to run NetIDMgr very -often, and helps reduce clutter on the desktop.
+Depending on how Network Identity Manager was installed, it may be configured +with a shortcut in the Startup Folder, or it may require a manual start. NetIDMgr is a +notification tray application and therefore it is not listed in the Microsoft +Windows task bar. This design is based on the assumption that most users +rarely interact directly with the application.
@@ -27,14 +27,15 @@ notification area (sometimes referred to as the "system tray") as shown in figure 1. Details about the state information represented by the icon can be found here. -Clicking on this icon brings up the NetIDMgr window. Right -clicking on the icon, on the other hand, brings up a menu.
+Left clicking on this icon executes the default action which either changes +the view state of the credential list or displays the Obtain New Credentials +dialog. Right clicking on the icon displays a menu.
-If NetIDMgr was not configured to start automatically when you diff --git a/src/windows/identity/help/html/using.htm b/src/windows/identity/help/html/using.htm index c66ee8aab..de1727354 100644 --- a/src/windows/identity/help/html/using.htm +++ b/src/windows/identity/help/html/using.htm @@ -1,28 +1,35 @@
--Depending on how NetIDMgr was installed, it might already be running -in the system notification area or it might need to be started -manually. See the topic starting -NetIDMgr for details. Essentially, to open the NetIDMgr window, -you either have to click the application -icon in the system notification area, select the icon from the -start menu, or type 'netidmgr' at a command prompt. +Depending on how Network Identity Manager was installed, it might already be running +in the Windows taskbar notification area or it might need to be started +manually. See the topic Starting +Network Identity Manager for details. +
++To open the NetIDMgr window when the application +icon is displayed in the Windows taskbar notification area, click on the +icon with the 2nd mouse button (usually the right mouse button) and select Show Network Identity Manager window from the menu. +
++If NetIdMgr is not displayed in the Windows taskbar notification area, it can be +started from the +Start Menu, or type 'netidmgr' at a command prompt.
-Once you open the NetIDMgr window, you will be presented with a view -of your existing credentials, or a message notifying you that you -don't have any. Details of the credentials view objects can be found here.
@@ -31,18 +38,20 @@ Brief overviews of how to perform common tasks are linked below:-A more comprehensive list of how-to topics can be found in the How do I... section.
+A more comprehensive list of how-to topics can be found in the +How do I... section. \ No newline at end of file diff --git a/src/windows/identity/help/html/welcome.htm b/src/windows/identity/help/html/welcome.htm index 18a631277..263be8c47 100644 --- a/src/windows/identity/help/html/welcome.htm +++ b/src/windows/identity/help/html/welcome.htm @@ -4,6 +4,8 @@ +-The Network Identity Manager (or NetIDMgr for short) allows you to -manage your network identities and the associated credentials -(Kerberos tickets, AFS tokens, etc.). -
- --NetIDMgr is extensible using plugins. In fact, most of the features -are implemented in plugins, some of which are themselves extensible. -Support for additional protocols and credential types can be added by -installing the appropriate plugins. +
Network Identity Manager (NetIdMgr) is a graphical +tool designed to simplify the management of network identities and their credentials +which are used by network authentication protocols while providing +secure access to network services. When NetIDMgr is used with Kerberos v5 each +network identity is a unique Kerberos principal name and the credentials +are Kerberos v5 tickets. Kerberos v5 tickets can be used by NetIDMgr to +obtain Andrew File System (AFS) tokens and X.509 public key certificates if the +appropriate plug-ins are available.
+When you log into Microsoft Windows with a domain account, +your account name and the Windows Domain name when combined form a Kerberos +principal name. As an example, WINDOWS\jaltman is actually a short form +representation of +jaltman@WINDOWS.SECURE-ENDPOINTS.COM. Microsoft Windows uses +Kerberos-based network identities for all domain-based network authentications.
- +Since Microsoft Windows already provides a network +identity, why do you need NetIdMgr? Here are some examples:
+NetIdMgrs automated credential acquisition and renewal +makes it an invaluable tool which provides users with a Single Sign-on +experience.
+NetIdMgr is most commonly configured as a StartUp item that runs an icon in the Taskbar Notification Area until you logout. +While running, NetIDMgr automatically renews your credentials, notifies you of +pending expirations and prompts you when a Kerberized application requires +credentials that have not already been obtained.
+When configured to do so, NetIdMgr will prompt you +immediately after it starts to obtain Kerberos credentials. This is often +referred to as logging on to Kerberos. NetIdMgr does not perform a logon in the +sense of the Windows Logon Service. A logon service would do more than manage +Kerberos tickets. A logon service would authenticate you to the local machine, +validate access to your local file system and performs additional set-up tasks. +These are beyond the scope of NetIdMgr. NetIdMgr simply allows you to manage +Kerberos identities on behalf of compatible applications and to change your +Kerberos password.
-This version is distributed as a part of the MIT Kerberos for Windows -product along with the Kerberos 5 and Kerberos 4 plugins. The OpenAFS -plugin, which is required for supporting AFS tokens, is -distributed separately. -
+NetIDMgr is distributed as a part of MIT Kerberos for Windows +along with the Kerberos v5 and Kerberos v4 plug-ins. Plug-ins for additional +credential types including AFS tokens and KCA certificates are available as +separate distributions. The OpenAFS plug-in, which is required for supporting AFS tokens, is +distributed as part of OpenAFS for +Windows. The KCA plug-in is distributed by +Secure Endpoints Inc.-If you are interested in developing plugins or extending the features -of NetIDMgr, your first stop should be the NetIDMgr SDK. This is -included in the Kerberos for Windows SDK, which itself is a part of -the Kerberos for Windows distribution. -
+If you are interested in developing plug-ins or extending the features +of NetIDMgr, your first stop should be the NetIDMgr SDK which is included in the +MIT Kerberos for Windows SDK.-We highly recommend interested developers to contact the netidmgr@secure-endpoints.com -mailing list. -
+mailing list with questions or comments.The main window of Network Identity Manager is structured as follows
+The application window of Network Identity Manager can be displayed in two modes: basic and advanced.
- +The basic view provides status information of the currently available identities whereas the advanced +view provides more detailed information of all the active credentials.
+ +