Installroot 5.2 User Guide For Unclassified Systems: Dod Public Key Enablement (Pke) Reference Guide
Installroot 5.2 User Guide For Unclassified Systems: Dod Public Key Enablement (Pke) Reference Guide
Contact: [email protected]
URL: http://iase.disa.mil/pki-pke
15 November 2017
Version 1.2
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Revision History
ii
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Table of Contents
OVERVIEW ........................................................................................................................................................... 6
INSTALLROOT 5.2 SYSTEM REQUIREMENTS .......................................................................................................... 7
PREREQUISITE SOFTWARE REQUIREMENTS ......................................................................................................................... 7
SUPPORTED OPERATING SYSTEMS .................................................................................................................................... 7
SUPPORTED BROWSERS .................................................................................................................................................. 7
SUPPORTED NETWORK SECURITY SERVICE (NSS) ................................................................................................................. 7
VERIFYING THE DIGITAL SIGNATURE OF INSTALLROOT ......................................................................................... 8
INSTALLATION ...................................................................................................................................................... 9
MIGRATING CONFIGURATION SETTINGS TO INSTALLROOT 5.2 .............................................................................................. 10
INSTALLROOT 5.2 QUICK START GUIDE ............................................................................................................... 11
INSTALLROOT 5.2 INTERFACE INFORMATION .................................................................................................................... 12
CONFIGURATION AND DEPLOYMENT OPTIONS .................................................................................................. 13
CONFIGURING INSTALLROOT ......................................................................................................................................... 13
Registry Configuration ....................................................................................................................................... 13
UI Configuration ................................................................................................................................................. 13
INSTALLING ENTERPRISE CERTIFICATES ............................................................................................................................. 13
InstallRoot Windows Service .............................................................................................................................. 13
Command-line Utility ......................................................................................................................................... 14
CONFIGURING TAMP MESSAGE SOURCES ....................................................................................................................... 14
DISA source location .......................................................................................................................................... 14
Local Server Cache ............................................................................................................................................. 14
GETTING TO KNOW INSTALLROOT 5.2 ................................................................................................................ 15
INSTALLROOT USER PRIVILEGES ...................................................................................................................................... 15
NAVIGATING THE INSTALLROOT UI ................................................................................................................................. 15
Selecting Stores, Groups, and Certificates ......................................................................................................... 16
Viewing certificate information ......................................................................................................................... 16
Managing certificate subscription and installation ........................................................................................... 16
HOME TAB ......................................................................................................................................................... 17
INSTALLING CERTIFICATES .............................................................................................................................................. 17
ONLINE UPDATE .......................................................................................................................................................... 18
MANAGING PREFERENCES ............................................................................................................................................. 18
SAVE SETTINGS ........................................................................................................................................................... 19
RESTART AS ADMINISTRATOR ......................................................................................................................................... 19
STORE TAB ......................................................................................................................................................... 20
ADDING AN NSS STORE ................................................................................................................................................ 21
ADDING A JAVA TRUST STORE ........................................................................................................................................ 21
ADDING AN ACTIVE DIRECTORY NTAUTH STORE ............................................................................................................... 22
REMOVING A TRUST STORE ........................................................................................................................................... 22
NTAUTH COMPARISON REPORT ..................................................................................................................................... 23
iii
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
iv
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
v
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Overview
DoD Public Key Infrastructure (PKI) is built on a trust model which requires the
establishment of a trust chain between an end entity certificate and a trusted root
certification authority (CA). These root CA certificates are the basis for the trust
relationship that must exist between servers and connecting clients, or any other
application that uses certificates for digital signature or authentication. The certificate
validation process verifies trust by checking each certificate in the chain from the end
entity certificate to the root CA. If the root CA is not trusted, all other certificates in the
chain, including the end entity certificate, are considered untrusted.
InstallRoot 5.2 installs DoD-specific root and intermediate CA certificates into trust
stores on Microsoft servers and workstations, thereby establishing trust of the installed
CA certificates. It can also manage DoD PKI CA certificates and other PKI CA
certificates that may be necessary for conducting DoD business across a variety of
certificate stores in a system. The contents of each certificate store dictate whether
applications (such as web browsers, email clients, and document viewers) will trust a
particular PKI and the certificates it issues.
A Graphical User Interface (GUI), Command-Line Interface (CLI), and the InstallRoot
Windows Service are available to suit different user preferences and needs. Each
version is contained within a single .MSI and is available from the DoD Public Key
Enablement (PKE) web site at http://iase.disa.mil/pki-pke. Three .MSI installers are
available: 32-bit, 64-bit, and a non-administrative (non-admin) version which does not
require administrative privileges to install.
InstallRoot is available for both NIPRNet and SIPRNet. SIPRNet .MSIs for the
application are available at http://iase.disa.smil.mil/pki-pke and come packaged with
a SIPRNet version of this guide.
NOTE: The Windows Service feature is not included in the non-admin version of
InstallRoot 5.2.
6
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
7
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
5) Close the DoD Root CA 3 certificate. If it is not already open, view the CS.DoD PKE
Engineering.DoDPKE60002 certificate by clicking View Certificate in the Digital
Signature Details window. Select the Certification Path tab to verify the
certification path reads “DoD Root CA 3 > DoD SW-CA-37 > CS.DoD PKE
Engineering.DoDPKE60003.”
NOTE: If the digital signature is not OK, do NOT proceed with installation as the
version of the tool may not be authentic.
8
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Installation
Use the following steps to install the application on an individual machine. For
information on installing the application using an Active Directory Group Policy Object
(GPO), see Appendix D: Active Directory Installation Overview.
NOTE: Please uninstall any previously installed versions of InstallRoot before
proceeding. Configuration changes made using previous versions of InstallRoot will
be removed upon uninstallation. See the “Migrating Configuration Settings to
InstallRoot 5.2” section for additional details on recovering and importing these
settings.
1) After verifying the correct digital signature on the desired InstallRoot .MSI file (see
Verifying the Digital Signature of InstallRoot), double-click InstallRoot5.2.msi,
InstallRoot5.2_x64.msi or InstallRoot5.2_non-admin.msi to launch the installation
wizard.
See the InstallRoot 5.2 System Requirements section to ensure the proper software
requirements are met for the MSI chosen.
NOTE: SIPRNet versions of the application are also available. SIPRNet .MSIs for
the application are available at http://iase.disa.smil.mil/pki-pke and come
packaged with a SIPRNet version of this guide.
2) On the Welcome screen of the wizard, click Next.
3) On the Choose a file location screen of the wizard, enter the desired installation
location for InstallRoot and click Next. The default path for both versions of
InstallRoot 5.2 is:
C:\Program Files\DoD-PKE\InstallRoot
4) On the InstallRoot Features screen of the wizard, check the features desired for
installation. By default, all features will be installed. Unless there is a specific reason
not to install a feature, it is recommended that all features are selected and installed.
NOTE: The option to install the Windows Service feature is not present in the
non-admin version of InstallRoot 5.2.
5) On the Begin Installation screen, click Install to install the program. If prompted,
click Yes in the Microsoft User Account Control (UAC) window to allow the
installer to run with administrative rights.
6) When the wizard completes installation, click Close to exit or Run InstallRoot to
launch the GUI.
9
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
10
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
11
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Store, Group, Certificate tabs contain options for Use preferences to customize
managing certificate stores, certificate groups, windows service and update options
and individual certificates and save settings to save changes to
subscriptions and stores
Install
certificates to
“checked”
certificate
stores
Tab between
open Expand
certificate certificate
stores groups to
view the
certificates
within
Certificate
groups
located in Click to
each store. toggle
Click ( ) or subscription
( ) to toggle status of
subscription certificates
status
Double-click to
uninstall certificates
Lightbulbs
represent new
certificates
12
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
13
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Command-line Utility
Organizations who want to use user logon scripts to update certificate installations
across multiple workstations may also use the --update argument of the command-line.
This command will pull new InstallRoot TAMP messages from the DISA IASE. See the
Command-line Utility section for more information.
Configuring TAMP Message Sources
DISA source location
During an Online Update, InstallRoot checks for new InstallRoot TAMP messages on
the IASE website. This is the default source location for InstallRoot TAMP message
updates. See the Editing Certificate Groups section for instructions on configuring a
new source location for InstallRoot TAMP messages.
Local Server Cache
Organizations who want to use a local server to cache TAMP messages have the option
to do so with InstallRoot 5.2. A server may be used to host the InstallRoot TAMP
message (.ir4 file) cache which may be copied to a new location for web publishing.
Once published, local workstations running InstallRoot 5.2 may be pointed to that
location to download TAMP messages. The figure below depicts a high-level
deployment example of how InstallRoot might be used with a local cache server.
Workstation
Workstation
14
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Tab Expand
between certificate
open groups to
certificate view the
stores certificates
within
Certificate
groups Click to
located in select
each store. individual
Click ( ) or certificates
( ) to
toggle the
subscription
Click to
status of
toggle
certificate
subscription
groups
and
installation
status
16
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Home Tab
The Home tab is the first tab of the InstallRoot toolbar and contains the primary
functions of InstallRoot.
Check for TAMP messages to
Restart as Administrator to open the Local Computer Certificate
update certificates
store instead the default of Microsoft Current User.
Installing Certificates
To install certificates to a trust store, subscribe to the relevant certificate groups by
selecting the ( ). This will mark the certificates contained within for installation. The
subscription status for individual certificates may also be toggled in the same manner.
Once the desired groups and certificates have been subscribed, select Install
Certificates.
Once installed, the results of the installation will be displayed in the Certificate Action
Summary window shown below:
17
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
NOTE: The desired subscriptions must be configured individually for each trust
store before the subscribed certificates will be installed for each.
Important! An NSS store cannot be modified while an
application that uses it, such as Firefox or Thunderbird, is
running. If InstallRoot is launched or a request to install
certificates is issued while an NSS application is running, a
warning will be displayed and the operation will not be
performed. To update the NSS store, close all applications
using that store and then perform the desired operation.
Contact the system administrator if unsure of the
application(s) using the NSS store on the system.
Online Update
InstallRoot checks for and accepts TAMP messages in order to update certificate
information within the tool. TAMP messages are digitally signed files containing CA
certificates and associated instructions (such as add or remove) that can be used by
InstallRoot to update trust stores.
Select Online Update to check if there are new InstallRoot TAMP messages available
and, if so, download and process the messages. By default, InstallRoot will check for
new messages coming from the IASE website. This location may be changed using the
group Edit button located in the Group tab. See Editing Certificate Groups for more
information.
NOTE: Online Update requires internet access. Online updates will happen
automatically if the InstallRoot service is running, but can be performed manually if
desired.
Managing Preferences
InstallRoot 5.2 contains several options for update scheduling and customizing
windows service preferences.
Administrator
rights are
required to start
or stop the
windows service
18
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Save Settings
Selecting Save Settings will save any changes that have been made to certificate
subscriptions, added certificate stores, or to the InstallRoot UI.
Restart as Administrator
Use Restart as Administrator to restart the application with administrative privileges.
Administrator features can be found in the InstallRoot User Privileges section. Clicking
this button provides the same functionality as launching InstallRoot by right-clicking
the program and selecting Run as administrator.
NOTE: Users restarting as an administrator will be prompted for the proper
credentials prior to opening InstallRoot as an administrator. Any settings that were
selected when running without administrative privileges are not preserved when the
tool is re-launched with administrative privileges.
19
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Store Tab
The Store tab displays options for managing the three types of certificate trust stores in
InstallRoot:
• NSS stores are used by Mozilla Firefox, Thunderbird, and Apache web server
when run with mod_nss. InstallRoot supports NSS stores with passwords and in
FIPS mode.
• Java key stores are contained in Java Runtime Environment (JRE) and Java
Development Kit (JDK) installations, which are used for the basis of trust for Java
applets running in web browsers and for Java apps.
• The Microsoft Current User and Local Computer (Administrator only) stores
control which PKIs Microsoft applications (e.g. Internet Explorer, Microsoft
Outlook, etc.) trust. Many third-party applications that run on Microsoft
operating systems (e.g. Google Chrome) also use the Microsoft certificate stores.
If InstallRoot is being run as a user without administrative rights, the Microsoft
Current User store will be opened by default. Selecting the Restart as Administrator
button will restart InstallRoot with administrative privileges and display the
Microsoft Local Computer store.
• The Active Directory NTAuth store controls which PKIs can be used for domain
smart card logon.
NOTE: A Microsoft trust store can be removed, but it will return upon restarting
the GUI. If deleted and restarted, the group subscription information will need to
be re-enabled.
20
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Open
certificate
stores will
be tabbed
Right-click stores to view store details. If a “multi-store” is added, details will display all
currently known stores
21
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
The Add a Java Store dialogue will appear and automatically present any Java
profiles that InstallRoot has found on the system. By default, InstallRoot will add all
Java profiles into a single multi-store. This option is recommended for the simplicity
of managing multiple stores at once. As new Java versions are installed on the
computer, the multi-store will automatically find those new installations and
manage the certificates appropriately.
Stores may be added individually by selecting the Manage a single (selected) Java
key store option. If the desired Java profile is not listed, use the Browse… button to
navigate to the correct location.
NOTE: If a Java store is managed individually and it was part of a multi-store,
that Java store will be removed from the multi-store
2) In the New Store Name field, choose a name for the Java trust store. InstallRoot will
suggest a name based on the Java store type, which can be changed as desired.
3) Once the store’s name and location has been determined, select OK.
Adding an Active Directory NTAuth Store
NOTE: The machine running InstallRoot must be domain-joined, with the user
running InstallRoot having domain administrator rights in order to add the Active
Directory NTAuth store. To manage the NTAuth store, it is not necessary to run
InstallRoot from a domain controller; just a machine in the domain.
1) Select the Active Directory NTAuth button within the Store tab of the toolbar.
2) Upon selection, a security window will appear warning that any actions in the
NTAuth store impact the entire domain. Select OK to continue.
NOTE: The Active Directory NTAuth button will be active so long as the machine
is a member of a domain and the user has administrative rights. The NTAuth
Store will be disabled if both of these criteria have not been met.
3) A new store called NTAuth will be created. The certificates in the NTAuth store can
now be managed using the same procedures as for any other store types.
Removing a Trust Store
1) Select the tabbed store name desired for removal.
2) Click the Remove button located in the Store tab of the toolbar.
3) Confirm the removal.
NOTE: InstallRoot may reopen stores which have been previously removed upon
launch. Select Save settings before closing InstallRoot to prevent removed stores
from opening upon future launches.
22
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
23
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Group Tab
Certificate Groups are visible under each trust store tab. Each group is comprised of
certificates and actions contained in an InstallRoot TAMP message. Groups may be
expanded to view the individual certificates stored within.
Click the
group name
to select it for
management
Right-click to Click to
view group expand
management certificate
options group
Click to toggle
group subscription
status
24
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Selecting a Group
1) Select a group by clicking the group name. Selected group names will be
highlighted in bold.
NOTE: Groups must be selected prior to using the edit, remove, subscribe,
and unsubscribe functions located in the Group tab of the toolbar.
2) Click the ▼ button on the right side to expand a certificate group and view the
certificates within that group. The certificate table lists the following certificate
information:
• Subject : The certificate subject common name (CN)
• Issuer: The certificate issuer CN
• Sub-location: The location where the certificate will be installed within the
trust store
• Installed: The certificate’s installation status in the selected trust store ( for
installed or for uninstalled)
• Subscribed: The certificate’s subscription status in the selected trust store (
for subscribed or for unsubscribed) - A certificate will be installed,
deleted, or updated depending on the subscription status when the Install
Certificates button is clicked.
NOTE: Certificates listed in red are marked for deletion. These certificates will
initially display as subscribed, but will display as uninstalled after running
the Install Certificates action.
Adding Certificate Groups
1) Click the Add button within the Group tab of the toolbar.
2) When prompted, specify the Location of the group as desired. Administrators
hosting InstallRoot TAMP files on a local server may wish to specify a local URI
from which InstallRoot pulls TAMP messages. This could be a network file system
25
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
location or URL of an InstallRoot TAMP message (.ir4 file) that specifies the group’s
contents.
26
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Certificate Tab
The Certificate tab displays options for managing individual certificates. Expand a
certificate group by clicking the ▼ button located to the far right of the group name in
order to view the individual certificates located within.
Click to
expand
certificate
group
Click to select
a certificate.
Double-click Click to
to view toggle
certificate subscription
information and
installation
status
Uninstalling Certificates
To uninstall individual and/or multiple certificates from a selected trust store:
1) Navigate to the Certificate tab in the InstallRoot toolbar.
2) Select the appropriate trust store.
3) Select the drop-down arrow for the desired group to expand the list of certificates.
4) Select the certificate(s) to be uninstalled. Ctrl+click can be used to select multiple
individual certificates and Shift+click can be used to select a list of adjacent
certificates. Using Ctrl+A will select all of the certificates in the group.
5) Select the Uninstall button in the Certificate tab.
NOTE: Individual certificates may also be uninstalled by double-clicking the ( ) in
the Installed column of the certificate grid.
27
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
certificates using the Uninstall, Subscribe, and Unsubscribe buttons in the Certificate
tab.
NOTE: Unsubscribing to an individual certificate will prevent that certificate from
being installed.
Once the desired subscriptions have been configured, navigate to the Home button and
click Install Certificates.
Exporting Certificates
To export certificates:
1) Select the Certificate tab in the InstallRoot toolbar.
2) Expand the desired certificate group and select the certificate(s) to be exported.
Ctrl+click can be used to select multiple individual certificates and Shift+click can
be used to select a list of certificates.
3) Select the PEM, DER, or PKCS7 button, depending on the format desired.
4) In the pop-up window, specify the directory to which the certificate(s) should be
exported and click OK.
NOTE: When exporting as a PKCS7, please choose an appropriate name for the
file. By default, InstallRoot will choose YYYY-MM-DD.p7b. (ex. 11-19-2015.p7b)
5) Click Save.
Cleaning Certificates
The certificate cleanup tool is a new feature within InstallRoot 5.2. Selecting this option
will open a new window within InstallRoot for filtering and cleaning certificate stores.
See the Certificate Cleanup section for more information.
Refresh Certificates
Changes to subscription or installation status may cause some inconsistencies in the
certificate UI list. Use the Refresh Certificates button to refresh certificate lists within
the InstallRoot UI.
28
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Help Tab
The help tab includes links to log files, the user guide, and the quick start guide.
Note: Administrative privileges are required to view windows service logs.
Click to access
the
InstallRoot 5.2
user guide
and quick
start tutorial
Help
Displays a PDF version of this user guide.
About
Displays the version number, the DoD PKE web site, and the DoD PKE email address.
Quick Start
Opens the InstallRoot Quick Start tutorial that is presented at the first use of the tool.
29
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Certificate Cleanup
The certificate cleanup function is a new feature in InstallRoot 5.2 designed to help
remove undesirable certificates across any certificate stores configured within
InstallRoot. Certificates may be deleted, exported, or untrusted using the cleanup tool.
To open the cleanup tool, select the Certificate Cleanup button located in the
Certificates tab. This will open a new window alongside the primary InstallRoot UI.
Delete, untrust, or export certificates Click to show or hide the corresponding list columns
Use the
certificate
filters to
locate
certificates
which may
require
cleanup
Search for
certificate
within
configured
InstallRoot
stores
Locating Certificates
The InstallRoot cleanup tool contains a variety of options for locating certificates which
should be considered for cleanup.
Certificates
• Known compromised certificates: Check to locate compromised certificates
known to DoD PKE. It is recommended to remove any compromised certificates
found.
30
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
• Test (JITC) certificates: Check to locate test certificates. Test certificates (JITC)
should not be installed on production systems and are recommended for
removal.
• Expired certificates: Check to locate expired certificates. Users who validate
historically signed documents may wish to keep expired certificates on their
system.
• Non-root certificates located in the root store: Check to locate non-root
certificates inappropriately located in the root store.
• RSA/DSA key sizes 1024, 2048, 4096 or smaller: Check to locate the selected RSA
or DSA key sizes. Certificates using key sizes smaller than 1024 should be
removed at the recommendation of the National Institute of Standards and
Technology (NIST).
• Hashing algorithms MD5, SHA 1, SHA 256 or older: Check to locate the
selected hashing algorithm type. Certificates using hashing algorithms MD5 or
older should be removed.
InstallRoot Stores
The cleanup tool searches for certificates contained within configured InstallRoot stores.
By default, all configured stores will be checked upon launch of the cleanup tool.
Unchecking a store selection will prevent InstallRoot from locating any certificates
within that store.
Countries
Select countries to view their certificates. Selected countries will serve as a basis for
further certificate searches.
Sorting and Cleaning Certificates
Once located, certificates may be deleted, untrusted, or exported using the
corresponding functions in the ribbon bar of the cleanup tool.
Sorting Certificates
Sort certificates by clicking on the desired column. Show or hide columns using the
checkboxes located at the top of the ribbon bar. To maximize the size of the certificates
list, hide the certificate filters panel using the ( ) button.
As users apply filters to the certificates list, take note that the Reason column displays
why certificates may require cleanup. The reasons displayed are based off of what filter
selections have been made by the user. The following certificate reasons may be shown:
• Compromised
• Expired
31
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
• Test
• Non-Root
• KeySize
• HashAlg
• Country
Selecting Certificates
Click to select a certificate, or select multiple certificates using CTRL+click and
SHIFT+Click. Once certificates have been selected, they may be deleted, untrusted, or
exported.
Deleting Certificates
Select the delete button ( ) to delete the selected certificates from the trust store.
NOTE: Deleting certificates using the cleanup tool will PERMANENTLY delete them
from the trust store. It is recommended to backup certificates by exporting them to a
PKCS#7 file before deletion.
Untrusting Certificates
Select the untrust button ( ) to move certificates in Microsoft certificate stores to the
untrusted sub-store. This function is only supported for Microsoft Local Computer and
Microsoft Current User trust stores.
Because Java, NSS, and NTAuth stores do not have untrusted stores, an error message
will be produced. InstallRoot will request certificates belonging to Java, NSS, and
NTAuth stores be deleted as an alternative. This prevents the certificates from being
trusted. It is recommended to backup any certificates before untrusting them by
exporting to a PKCS #7 file.
Exporting Certificates
Select the export button ( ) to export certificates to a desired file location in PKCS #7
format.
32
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Command-Line Utility
The command-line utility can be used to manage InstallRoot trust stores. The utility
may be run locally, from portable media, or as a logon script. Command-line Interface
Exit Codes are provided in Appendix B: Log Information to facilitate using the utility
in batch scripts.
Preparation
For InstallRoot 5.2, the .MSI file must be used to install the command line utility. The
utility requires .NET framework version 2.0 or above.
NOTE: If the 32-bit version is installed on a 64-bit system, the CLI will be located
in c:\program files(x86)\DoD-PKE\InstallRoot\ .
2) Enter the desired command arguments when running InstallRoot. See the Using
Commands section below for available command arguments.
To run the utility as part of a logon script, see the Microsoft Windows: Deploying DoD
PKI CA Certificates Using Group Policy Objects guide available on the DoD PKE
website at http://iase.disa.mil/pki-pke under PKE A-Z > Guides.
Using Commands
The command-line utility provides a number of options for manipulating certificates
and groups. Some of the more commonly-used commands are listed below along with
examples. For help within the CLI use: InstallRoot.exe --help .
Installing certificates
InstallRoot.exe: When run without command arguments, will install all DoD
certificates into the appropriate Microsoft certificate store: Microsoft Current User for
non-privileged users and Microsoft Local Computer for privileged users.
InstallRoot.exe –-insert: Used to install certificates. By default, it will install all of the
certificates from the DoD group into the appropriate Microsoft certificate store (Local
Computer if run as administrator, Current User if not). Example usage:
• To install all DoD certificates into the appropriate Microsoft certificate store:
InstallRoot.exe –-insert
33
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
• To install just ECA certificates into the appropriate Microsoft certificate store:
InstallRoot.exe –-insert -–group ECA
• To install JITC and DoD certificates into an NSS store (arbitrarily named for the
example): InstallRoot.exe –-insert –-group DoD,JITC –-store NSS --storepath
%APPDATA%\Roaming\Mozilla\Firefox\Profiles\vvof92ga.default
NOTE: InstallRoot will request a password if the NSS or Java database is
password-protected. To automate the password input, use the --password
parameter followed by the password.
Removing Certificates
InstallRoot.exe –-delete: Used to delete certificates. The certificates and targets for this
command are defined in the exact way as the insert command above. However, the
delete command removes certificates and the insert command adds them. Example
usage:
• To delete all DoD certificates from the appropriate Microsoft certificate store:
InstallRoot.exe –-delete
• To delete ECA certificates from the appropriate Microsoft certificate store:
InstallRoot.exe –-delete –-group ECA
• To delete JITC and DoD certificates from an NSS store (arbitrarily named for the
example): InstallRoot.exe –-delete –-group DoD,JITC –-store NSS --storepath
%APPDATA%\Roaming\Mozilla\Firefox\Profiles\vvof92ga.default
NOTE: InstallRoot will request a password if the NSS or Java database is
password-protected. To automate the password input, use the --password
parameter followed by the password.
• To delete all certificate groups from the appropriate Microsoft certificate store:
InstallRoot.exe –-delete –-group ECA,DoD,JITC
InstallRoot.exe –-deletekey [KEY]: Used to delete certificates by their public key. Use
the --listkey command to determine the [KEY] prior to running this command.
Cache Clearing
InstallRoot.exe --clearcache: Used to clear the InstallRoot cache folder located at
%LOCALAPPDATA%/DoD-PKE/InstallRoot/5.0/cache .
InstallRoot.exe –-addtocache [FILE]: Used to add a TAMP message file to the UI or
command line cache folder.
Managing Trust Stores
InstallRoot.exe –-store [STORE]: Used to identify a Microsoft certificate store against
which to perform an operation. This argument is not run on its own; instead, it is used
to identify targets for other commands.
34
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
InstallRoot.exe –-liststores: Used to list all of the stores that can be used as inputs for
the –-store command. The available stores are: MSCAPI_LC, MSCAPI_CU,
NT_AUTH, NSS, JAVA, MULTI_NSS, MULTI_JAVA.
InstallRoot.exe –-storepath [PATH]: Used to identify the path of a NSS or Java store
against which to perform an operation. This argument is not run on its own; instead, it
is used to identify targets for the --store argument.
For example: InstallRoot.exe –-insert –-group DoD,JITC --store NSS --storepath
%APPDATA%\Roaming\Mozilla\Firefox\Profiles\vvof92ga.default
Managing Groups
InstallRoot.exe –-listgroups: Lists all of the groups that can be used as inputs for the –-
group command. The available groups are DoD, JITC, and ECA.
InstallRoot.exe –-group [GROUP]: This command is used to identify targets for other
commands. Multiple groups can be specified by separating groups with commas.
For example: InstallRoot.exe --delete –-group ECA,DoD,JITC or InstallRoot.exe --
insert --group JITC
Managing Individual Certificates
InstallRoot.exe -–list: Used to list certificates. The certificates and targets for this
command are defined in the same way as for the --insert and --delete commands above.
The difference is that the list command displays all certificates in the chosen group(s)
and whether or not they are installed in the chosen store. The certificate number next to
each certificate can be used with the --certs command explained below. Example usage:
• To list all certificates in the Microsoft certificate store: InstallRoot.exe –-list
• To list just ECA certificates in the Microsoft certificate store: InstallRoot.exe –-
list –-group ECA
• To list DoD and ECA certificates in an NSS store (arbitrarily named for the
example): InstallRoot.exe –-list –-group DoD,ECA –-store NSS --storepath
%APPDATA%\Roaming\Mozilla\Firefox\Profiles\vvof92ga.default
InstallRoot.exe –-certs [NUMBERS]: Specifies an action to be performed with a
specific certificate(s). Use the --list command to display the certificate number.
Example usage: InstallRoot.exe --delete --group ECA --certs 2,3,4
InstallRoot.exe --listkeys: Used to list the public keys for all certificates. The --listkey
argument displays all certificates in the chosen group(s). Example usage:
• To list all the public keys: InstallRoot.exe --listkeys
NOTE: This argument is not recommended to be run with output to the
command line since the list will be very long and typically will require the
35
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
screen buffer size on the command line to be increased in order to display all
keys. It is recommended that this argument be used in conjunction with the --
group argument. It is also recommended to redirect output to a file.
• To list the public keys for certificates in the ECA group: InstallRoot.exe --
listkeys --group ECA
• To output the public keys for certificates in the DoD group to a file:
InstallRoot.exe --listkeys --group DoD > %USERPROFILE%\dod_keys.txt
Managing Logs
InstallRoot.exe –-level [LEVEL]: Used to define the logging level. Used with Fatal,
Error, Warn, Info, or Debug. Default is set to Info. Example usage: InstallRoot.exe --
level Debug
InstallRoot.exe –-logfile [FILE]: Used to define the path to the log file. Can be used
with the --level argument. Example usage:
• To specify a location and to capture Info (default) information: InstallRoot.exe --
logfile %USERPROFILE%\InstallRoot.log
• To specify a location and to capture debugging information: InstallRoot.exe --
logfile %USERPROFILE%\InstallRoot.log --level debug
Exporting certificates
InstallRoot.exe –-export [EXPORT]: Specify the path location when exporting
certificates. When exporting PKCS7 format certificates, include the file name with the
path location. If a format type is not specified using the –-exportformat argument,
certificates will be exported in PEM format. Example usage:
• Export all DoD certificates in PEM Format: InstallRoot.exe --export
c:\exported_certficates\
• Export all DoD Certificates in DER format: InstallRoot.exe --export
c:\exported_certficates\ --exportformat DER
• Export all ECA Certificates in PKCS7 format: InstallRoot.exe --export
c:\exported_certficates\DoD_certs.p7b --exportformat pkcs7 --group ECA
NOTE: If the file name is not specified along with the path location, the CLI
will produce an error.
InstallRoot.exe –-exportformat [FORMAT]: Specifies the format type to be used when
exporting certificates. PEM, DER, or PKCS7 are acceptable.
Managing Online Update Options
InstallRoot.exe –-uri [URI]: Retrieve TAMP messages from a specified URI instead of
the default InstallRoot URIs.
36
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
37
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Uninstalling InstallRoot
Uninstall any currently installed InstallRoot versions before updating InstallRoot to a
newer version.
NOTE: Registry settings will be deleted on uninstall in most cases.
To uninstall InstallRoot:
1) Navigate to the Windows Control Panel.
2) Select Programs and Features.
3) Select Uninstall a program.
4) Select InstallRoot from the list of programs on the system.
5) Click Uninstall.
38
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Release Notes
5.2 General Changes
• Removed expired CAs from TAMP messages
This update removes expired CAs (CA 27, 28, 29, 30).
• Add support for TLS 1.1 and TLS 1.2
This update provides support for TLS 1.1 and TLS 1.2. Client machines need at
least .NET 3.5 SP 1 installed.
39
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Acronyms
AD Active Directory
CA Certification Authority
CAC Common Access Card
CN Common Name
CRL Certificate Revocation List
CLI Command-Line Interface
DER Distinguished Encoding Rules
DoD Department of Defense
ECA External Certificate Authority
FIPS Federal Information Processing Standard
GDS Global Directory Service
GPO Group Policy Object
GUI User Interface
IASE Information Assurance Support Environment
JDK Java Development Kit
JITC Joint Interoperability Test Command
JRE Java Runtime Environment
MMC Microsoft Management Console
MS CAPI Microsoft Cryptographic Application Programming Interface
MSI Microsoft installer
NIPRNet Non-Classified Internet Protocol Router Network
40
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
41
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
• GUI logs:
%LOCALAPPDATA%\DoD-PKE\InstallRoot\5.0\InstallRoot.log
Both log files can be found in the Help tab of the InstallRoot toolbar. Refer to these log
files if unexpected behavior is observed or unexpected errors are encountered.
By default, the logs are set to capture Information, Warning, Error, and Fatal messages.
If more logging information is desired, the logs can be set to Debug mode. This is done
via the registry.
1) Run regedit.exe.
2) To set the DebugMode flag for the administrator GUI and service events, navigate
to:
HKEY_LOCAL_MACHINE\SOFTWARE\DoD-PKE\InstallRoot\5.0\
To set the DebugMode flag for the user GUI events navigate to:
HKEY_CURRENT_USER\Software\DoD-PKE\InstallRoot\5.0
42
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
<lockingModel
type="log4net.Appender.FileAppender+MinimalLock" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date %-5level -
%message%newline"/>
</layout>
</appender>
<root>
<appender-ref ref="RollingLogFileAppender"/>
</root>
</log4net>
Two lines in the configuration file can be changed if necessary:
• To change the size of when the log file is rolled over, edit the maximumFileSize
value. Allowable size values are a minimum of one with no maximum, followed
by a KB or MB.
• To change the maximum number of files, edit the maxSizeRollBackups value.
Allowable size values are a minimum of one with no maximum. It is
recommended that this value not be changed.
Windows Error Logging
InstallRoot will also log events to the Windows Event Log system. To make the events
easier to find, InstallRoot creates its own log file under the Applications and Services
Logs tree called DoD-PKE InstallRoot.
43
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
2 Initialization errors
• Runtime Configuration Generator Initialization error
• NSS DLL Load error
• Process Runtime Configuration error
• InstallRoot attempted to load TAMP messages that were signed with an
algorithm that your Operating System does not support
• Logfile directory does not exist, Logfile does not exist, or Logfile
directory is not writeable
44
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
45
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
• FormatException
• IOException
• Generic Exception
30 InstallRoot has identified running NSS processes that will conflict with the
importing and removal of certificates
InstallRoot Cache
InstallRoot maintains a local cache of the latest TAMP messages received for each group
so the online update will only download new TAMP messages when they have been
46
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
updated. Depending on the method used to download the TAMP messages, they will
be stored in different locations, as follows:
• The shared cache for the CLI and GUI is located at:
%LOCALAPPDATA%\DoD-PKE\InstallRoot\4.1\cache
47
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
48
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
49
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
50
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
51
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
52
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
53
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
54
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
55
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
different InstallRoot components to consume local TAMP messages rather than the
default messages hosted on IASE. All actions should be performed with administrative
privileges (e.g., by launching the tool or command prompt using the Run as
Administrator option) if available.
Automatic Certificate Updates: Windows Service
The InstallRoot Windows service must be installed to enable the tool to automatically
check for and install certificate updates. Follow these instructions to configure the
InstallRoot Windows service to check a local TAMP message location rather than IASE
for updates. These configuration steps must only be performed once. Once the
InstallRoot Windows Service is configured, the tool will automatically update the
workstation’s trust store whenever a new TAMP message is made available at the
configured location.
NOTE: If hosting TAMP messages on a network file share, the InstallRoot service
must be configured to run under an account with access to the share rather than the
default Local System account.
Enterprise Deployment
For enterprise deployments, the Windows Service can be configured using the registry
as described in the Configuring InstallRoot section. For disconnected environments,
the URL value(s) for the appropriate group(s) under the
HKEY_LOCAL_MACHINE\SOFTWARE\DoD-PKE\InstallRoot\5.0\Groups registry
key should be set to reflect the local TAMP message location (e.g. within the DoD group
key, set the URL value to http://localserver.localdomain.mil/IRTAMP/DoD.ir4,
\\localshare.localdomain.mil\IRTAMP\DoD.ir4 or C:\TAMP\DoD.ir4 for a web
server, network file share, or local directory location, respectively).
56
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
Individual Deployment
For individuals installing the tool on their local workstations, it is recommended that
the GUI be installed with the service to eliminate the need to directly configure registry
settings. Follow instructions for GUI Initial Setup in the Manual Certificate Updates
section, ensuring that the Windows Service is selected to be installed in Step 1.
Manual Certificate Updates
If the InstallRoot Windows service has not been installed and configured to
automatically update the certificate trust store, certificate updates can be performed
manually using either the InstallRoot GUI or CLI by following the instructions below.
GUI
Initial Setup
These configuration steps must only be performed once.
NOTE: Prior to beginning, ensure that the latest TAMP message is available locally
at one of the locations detailed in the Redistributing the Latest TAMP Message
section.
6) Run the InstallRoot installer (MSI) according to the standard installation
instructions.
7) Update the tool configuration to point to the local TAMP message(s) rather than
IASE.
a) Launch the InstallRoot GUI. An error message will display indicating that the
tool failed to perform an online update. Close the message.
b) Select the Group tab.
c) Select the certificate group (e.g. Install DoD Certificates) for which the TAMP
message is being hosted locally and click the Edit button on the header ribbon.
d) Delete the IASE URL (http://iase.disa.mil/pki-pke/data/ir4/DoD.ir4) in the
URI field and replace it with the URL or local file location for the local TAMP
message (e.g. http://localserver.localdomain.mil/IRTAMP/DoD.ir4,
\\localshare.localdomain.mil\IRTAMP\DoD.ir4 or C:\TAMP\DoD.ir4).
Click OK. A message should display indicating that the URI for the selected
group was successfully changed.
e) Select the Home tab and click the Save Settings button.
8) Remove any of the default groups (e.g. ECA, JITC) not being used by right-clicking
the group and selecting Remove. This will prevent the tool from generating errors
57
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
when attempting to perform updates due to those groups’ TAMP messages not
being available.
NOTE: Groups can be added back into the tool at any time by clicking the Add
button under the Group tab and entering the URL or local file location for the
group’s TAMP message.
9) Follow the instructions in the Certificate Updates section to install the certificates
contained within the locally hosted TAMP message.
Certificate Updates
Perform these steps each time a new TAMP message is released.
1) Ensure the updated TAMP message is available from the local server URL or file
share.
2) If the machines to be updated have not been configured to automatically install
updates from the local server URL using the Windows Service, manually perform
the update:
a) Click the Online Update button. The tool should display a message indicating
an updated TAMP message was found.
b) Verify desired certificates for installation display in the appropriate group (e.g.
expand the Install DoD Certificates line to verify that the latest CAs are listed).
c) Click the Install Certificates button to install the updates.
Command Line
Initial Setup
1) Run the InstallRoot installer (MSI). On the InstallRoot Features screen of the
InstallRoot Setup Wizard, uncheck the GUI and Windows Service options.
NOTE: If running the Non-Admin version of the InstallRoot installer, the
Windows Service option is not available and therefore unchecking that option is
unnecessary.
2) Follow the instructions in the Error! Reference source not found. section to install the
certificates contained within the local TAMP message.
Certificate Updates
Perform these steps each time a new TAMP message is released.
1) Ensure the updated TAMP messages for each group to be updated are available
from the local server URL, file share, or local file system location.
2) Manually perform the update and installation for each group to be updated:
58
UNCLASSIFIED
InstallRoot 5.2 for Unclassified Systems UNCLASSIFIED
59
UNCLASSIFIED