| ActivID® ActivClient for Windows |
RELEASE DATE: 2016-07-20
BUILD: 7.1.0.153
This document provides the latest information about the ActivID®
ActivClient for Windows. For product details, please refer to the formal
technical publications delivered with the release.
Table of Contents
NEW FEATURES
What's New in ActivClient
7.1
ActivID ActivClient 7.1 is a new version providing support for the
latest environments and additional functional improvements:
- Microsoft® Edge and improved Windows® 10 support
- With this release, ActivClient extends its support for the Windows
10 and Windows Server 2016 platforms to provide increased coverage
of smart card usage scenarios.
- For example, customers can now use the latest Microsoft Edge
browser for SSL and TLS-based smart card authentication to web
sites (requires Windows 10 Anniversary Update).
- Customers can now use Internet Explorer browser for SSL and
TLS-based smart card authentication to web sites, even when
configured in Enhanced Protected Mode.
- Windows Universal Apps can now also leverage ActivClient for smart
card authentication, leveraging ActivClient Mini Driver.
- ActivClient notifications have been updated to better fit in
Windows 10 toast notifications; new policies are available to
customize these notifications.
- Microsoft
Office® 2013 and 2016 support
- Enterprise customers can now leverage ActivClient for smart
card-based authentication, signature and encryption with the
latest Microsoft Office versions.
- ActivClient automatically configures the Outlook® security profile
based on smart card certificates, reducing the configuration
effort for smart card users.
- Publish to GAL, Auto-Contact and Auto-Decrypt are also supported
with these new Outlook versions.
- Bundled Software Development Kit
- ActivID ActivClient now comes bundled with samples and
documentation for the standard-based APIs it supports: Microsoft
Mini Driver / CNG, PKCS#11, PIV and BSI.
- These APIs provide access to Public Key cryptography (PKI),
One-Time Password and data storage services on smart cards. C and
Java interfaces are available.
- The ACOMX API is now obsolete and replaced by PKCS#11 for One-Time
Password services.
- The ActivClient PKCS#11 library now supports PKCS #1 v2 key
wrapping with OAEP padding algorithm, as an alternative to PKCS #1
v1.5 algorithm.
- Functional Enhancements
- The certificate friendly names used on PIV cards have been updated
to be shorter and easier to understand. For example, "PIV
Authentication - <username>" and "Key Management
-<username>" are respectively replaced by "Authentication -
<username>" and "Encryption - <username>".
- ActivID AAA customers can now initialize smart cards using
ActivClient 7.1 and the ActivID Device Initialization Tool.
(P1008-83302)
- The "unattended card notification" can now be customized: the
default "three beeps" can be replaced by any sound in .wav format.
- Updated Branding
- ActivClient is now rebranded HID Global ActivID ActivClient. The
user interface and all icons are updated to reflect the new
branding.
ActivClient 7.1 also includes a large number of bug fixes and minor
enhancements, such as:
- New card support: Gemalto TOP DL GX4 v2 144k FIPS with Gemalto PIV
1.51 applet (P1389-100336)
- New card support: Gemalto TOP DL GX4 v2 144k (FIPS) with Gemalto PIV
applet 1.55 (P1389-100324)
- New card support: Oberthur ID-One Cosmo v8.0 128K with PIV 2.4.0
(P1389-100329)
- New card support: Oberthur ID-One Cosmo v8.0 128K with PIV 2.3.5
(P1389-100321)
- New card support: Oberthur ID-One Cosmo v8.0 128K card (P1008-100032)
- New card support: HID Global Crescendo C1300 (P1389-100300)
- New card support: Giesecke & Devrient SmartCafe Expert 144K DI
v7.0 (P1008-100033)
- MiniDriver: CardEnumFiles function now correctly lists files in a
custom directory (P1389-100341)
- BSI API: gscBsiSkiInternalAuthenticate support (P1389-100235)
- PKCS#11: no longer returns the same unlock code (P1008-100096)
- PKCS#11: CKA_PUBLIC_EXPONENT value of Public Keys is now correct
(P1008-100050)
- PKCS#11: Now able to unlock standalone cards V2 and C1150
(P1008-100044)
- PKCS#11: Now able to decrypt email with Thunderbird (P1008-100027)
- User Console: Benefits are now displayed for CAC v1 card
(P1389-100356)
- User Console: With ActivID v1 applets, default certificate set first
by ActivClient 7.0.2 is now visible in ActivClient 6.2 (P1389-100334)
- CMS: No longer "Bad AID error" on CMS when issuing C1300 card with
pre-loaded profile (P1389-100354)
- CMS: No longer signature issue during PIV card issuance with CMS
(P1389-100351)
- CMS: After CMS re-issuance, User Console no longer displays wrong
information (P1389-100294)
- CMS: After a successful Card Update, Card Removal is now detected
(P1008-100080)
- Middleware: Now able to enter PIN if Microsoft Hot-fix for KB2706168
is installed on Windows 7 (P1389-100331)
- Middleware: New policy to enable PIN pad reader support (P1389-100311)
- Middleware: Smart Card Removal Policy Service no longer crashes
(P1389-100299)
- Middleware: Customization of card auto-update alert message now works
(P1389-100287)
- Middleware: Fixed regression since 7.0.2.436: ActivClient processes
are consuming a lot of CPU (P1389-100274)
- Middleware: Fixed regression since ActivClient 7.0.2.308: breaks
Horizon View connections from Macs (P1389-100269)
- Middleware: Now compatible with ActivID Device Initialization Tool
(P1389-100266, P1389-100260, P1008-100077)
- Middleware: Fixes issue with Certificate Key Container not printable
(P1389-100207)
- Middleware: On Windows 8.1, Non-Admin User Requesting Elevated
Permission CMD Prompt now successful (P1389-100150)
- Middleware: Strange characters are no longer displayed in Insert PIN
GUI (P1008-100019)
- Middleware: No longer prompt "PIN could not be changed" although
password was changed successful (P1008-100016)
- Outlook Enhancements: ActivClient now compatible with Microsoft
Outlook 2016 (P1389-100250)
- Firefox: ActivClient Security Module can now be verified for use in
Firefox (P1389-100138)
- Install: Fixes Administrative Install Failure - Error 1328.Error
applying patch to file C:\Config.Msi\PT7BA7.tmp (P1008-100056)
- Install: Fixes Error 1721. There is a problem with this Windows
Installer package (P1008-100020)ActivClient 7.1 also includes a large
number of bug fixes and minor enhancements, such as:
- New card support: Gemalto TOP DL GX4 v2 144k FIPS with Gemalto PIV
1.51 applet (P1389-100336)
- New card support: Oberthur ID-One Cosmo v8.0 128K with PIV 2.4.0
(P1389-100329)
- New card support: Gemalto TOP DL GX4 v2 144k (FIPS) with Gemalto PIV
applet 1.55 (P1389-100324)
- New card support: Oberthur ID-One PIV 2.3.5 (P1389-100321)
- New card support: HID Global Crescendo C1300 (P1389-100300)
- New card support: Giesecke & Devrient SmartCafe Expert 144K DI
v7.0 (P1008-100033)
- New card support: Oberthur ID-One Cosmo v8.0 128K card (P1008-100032)
- MiniDriver: CardEnumFiles function now correctly lists files in a
custom directory (P1389-100341)
- BSI API: gscBsiSkiInternalAuthenticate support (P1389-100235)
- PKCS#11: no longer returns the same unlock code (P1008-100096)
- PKCS#11: CKA_PUBLIC_EXPONENT value of Public Keys is now correct
(P1008-100050)
- PKCS#11: Now able to unlock standalone cards V2 and C1150
(P1008-100044)
- PKCS#11: Now able to decrypt email with Thunderbird (P1008-100027)
- User Console: Benefits are now displayed for CAC v1 card
(P1389-100356)
- User Console: With ActivID v1 applets, default certificate set first
by ActivClient 7.0.2 is now visible in ActivClient 6.2 (P1389-100334)
- CMS: No longer "Bad AID error" on CMS when issuing C1300 card with
pre-loaded profile (P1389-100354)
- CMS: No longer signature issue during PIV card issuance with CMS
(P1389-100351)
- CMS: After CMS re-issuance, User Console no longer displays wrong
information (P1389-100294)
- CMS: After a successful Card Update, Card Removal is now detected
(P1008-100080)
- Middleware: Now able to enter PIN if Microsoft Hot-fix for KB2706168
is installed on Windows 7 (P1389-100331)
- Middleware: New policy to enable PIN pad reader support (P1389-100311)
- Middleware: Smart Card Removal Policy Service no longer crashes
(P1389-100299)
- Middleware: Customization of card auto-update alert message now works
(P1389-100287)
- Middleware: Fixed regression since 7.0.2.436: ActivClient processes
are consuming a lot of CPU (P1389-100274)
- Middleware: Fixed regression since ActivClient 7.0.2.308: breaks
Horizon View connections from Macs (P1389-100269)
- Middleware: Now compatible with ActivID Device Initialization Tool
(P1389-100266)
- Middleware: Now compatible with ActivID Device Initialization Tool (V1
applets) (P1389-100260)
- Middleware: Now compatible with ActivID Device Initialization Tool
(P1008-100077)
- Middleware: Fixes issue with Certificate Key Container not printable
(P1389-100207)
- Middleware: On Windows 8.1, Non-Admin User Requesting Elevated
Permission CMD Prompt now successful (P1389-100150)
- Middleware: Strange characters are no longer displayed in Insert PIN
GUI (P1008-100019)
- Middleware: No longer prompt "PIN could not be changed" although
password was changed successful (P1008-100016)
- Outlook Enhancements: ActivClient now compatible with Microsoft
Outlook 2016 (P1389-100250)
- Firefox: ActivClient Security Module can now be verified for use in
Firefox (P1389-100138)
- Install: Fixes Administrative Install Failure - Error 1328.Error
applying patch to file C:\Config.Msi\PT7BA7.tmp (P1008-100056)
- Install: Fixes Error 1721. There is a problem with this Windows
Installer package (P1008-100020)
See the product documentation for a full product description:
- ActivClient Overview (includes the list of all supported
environments)
- ActivCIient Installation Guide
- ActivClient User Guide
- ActivClient Administration Guide
- ActivClient SDK Overview
- ActivClient SDK PKCS#11 API Reference Guide
- ActivClient SDK PIV API Reference Guide
- ActivClient SDK BSI API Reference Guide
What was New in Previous
Releases
ActivClient 7.0.2 Update
(June 2014)
ActivClient now supports PIN pad readers − when such a reader is connected
to the Microsoft® Windows® platform, ActivClient
prompts the user to enter the PIN on the PIN pad reader instead of the
keyboard.
- Supported readers:
- OMNIKEY® 3621 and 3821
- PIN pad readers compliant with PC/SC part 10 and CCID v1.1
- Supported cards − Cards supported by ActivClient 7 that have a numeric
PIN with 8 digit maximum length.
Card profiles with secure messaging (SMA) are not supported.
- Supported use cases:
- Secure web access with Internet Explorer®, Google®
Chrome®, Mozilla® Firefox®
- Email signature/decryption in Microsoft Outlook®
- Some card management operations in ActivClient User Console
- Supported integrations − Applications based on PKCS#11 that support
the CKF_PROTECTED_AUTHENTICATION flag.
- Not supported:
- Windows Logon authentication
- Windows network share authentication
- Windows BitLocker
- PIN change (via Windows credential provider or Firefox)
- PIN unlock
- PIN change at first use
Notes:
- ActivClient PIN Cache is not applicable to PIN pad reader
configurations. Users are prompted for their PIN for every PIN-protected
card operation.
- Some applications might cause multiple PIN prompts due to their
internal design. For example, web authentication with Firefox will cause
a double PIN prompt – Internet Explorer and Chrome will only cause a
single PIN prompt.
- PIV+ card profiles (with standard PIV credentials and additional
non-PIV certificates) will lead to multiple PIN prompts for some use
cases.
ActivClient 7.0.2 Update
(December 2013)
ActivClient now supports the following platforms:
- Microsoft Windows 8.1 and Windows Server® 2012 R2
- Microsoft Internet Explorer 11.
Note: Make sure that you add your
smart card-protected web sites to your list of "trusted sites".
ActivClient now includes a full-featured PKCS#11 library, providing both
read and write access to the smart card (if applicable to the card profile).
Initialization and key generation features are also now supported.
Other improvements:
- Support for card profiles with secure messaging (SMA).
- Microsoft Outlook security profile configuration and Publish to GAL on
card insertion is now supported with Microsoft Outlook 2013.
- ActivClient now recognizes an ActivID ActivKey USB key in Mozilla
Firefox (or other PKCS#11-based applications) when the key is inserted
after the application has started.
ActivClient 7.0.2
ActivClient 7.0.2 is a maintenance version of ActivClient. It brings the
following improvements.
Improved support for Microsoft Windows 8 and Windows Server 2012:
- Full compliance with the Microsoft Windows 8 logon experience.
- With ActivClient 7.0.1, you can select the Smart Card icon in the main
logon screen and perform a successful Windows logon; or you can select
the User icon and perform a password logon. The "Sign-in options"
feature is not available to enable switching the authentication mode
from the User authentication screen.
- With ActivClient 7.0.2, you see only one icon per user in the main
logon screen. When selecting this user icon, you can logon with a
password; or also access certificates as Sign-In options. If you select
a certificate and enter the PIN, you will successfully logon and have
access to ActivClient PIN cache – leading to improved user experience
during the Windows session.
- Change PIN (accessible via the Windows "Change Password" menu) is now
supported.
- ActivClient Unlock PIN dialog box and ActivClient PIN Initialization
Tool now display automatically on card insertion when the relevant card
is inserted (desktop mode only).
Other functional improvements:
- Support for all ActivClient standalone Java cards – standalone
profiles and standalone / mini profiles. (Note that Cryptoflex®
smart cards are not supported with ActivClient 7.x.)
- Support for all ActivClient standalone features such as card
initialization, certificate download, card unlock, card reset, and
selection of a "default" certificate stored on the card (same features
as in ActivClient 6.2).
- Automatic root certificate installation in the Microsoft Windows
certificate store (78495).
ActivClient 7.0.1
ActivClient 7.0.1 is a maintenance version of ActivClient. It brings the
following improvements:
- The User Console adds the Import Certificate capability (PFX and P12
formats) – availability dependent on the card configuration
- The ActivClient MSI Installer is updated to support installation on
workstations connected to a large Active Directory domain (76469, 76617
and 78979)
ActivClient 7.0.1 also brings partial support for Microsoft Windows 8; full
support will be provided in the upcoming ActivClient 7.0.2.
The following is a list of compatibility issues between ActivClient 7.0 and
Microsoft Windows 8 that are resolved in ActivClient 7.0.1:
- ActivClient 7.0 installation might fail if a reader is not connected
during installation
- In the Windows logon screen, if you select a Smart Card icon under
"Sign-in options", you will be able to successfully log on to Microsoft
Windows, but the ActivClient PIN cache will not be enabled, which will
lead to repeated PIN prompts.
- If you access remote resources, Microsoft Windows displays the list of
available credentials in a Windows Security dialog box, but certificates
are displayed twice. Selecting some of these doubled certificates leads
to a second PIN prompt after a successful Microsoft Windows
authentication.
- If you try to authenticate to a web site with your smart card using
Internet Explorer for the desktop, the browser might freeze.
- When a PIN prompt appears, you might run into issues if you enter the
PIN too slowly. This applies to several use cases, including with
Internet Explorer.
ActivClient 7.0
ActivClient 7.0 is a major version of ActivClient. It includes a brand new
middleware architecture designed to better address new security requirements
and enhanced integration with the Microsoft Windows platform.
- ActivClient now includes a smart card mini driver compatible with
Windows Base Smart Card Crypto Provider; this replaces the ActivClient
CSP. This new component enables new services such as PIN Change and PIN
Unlock integrated into the Windows user interface. It also enables
access to SHA-2 hashing algorithms for digital signature operations with
applications such as Outlook and Outlook Web Access.
- ActivClient includes a PKCS#11 library compatible with version 2.2.
This upgrade enables access to SHA-2 hashing algorithms and AES
encryption.
- ActivClient is compatible with the latest generation of Personal
Identity Verification (PIV) cards compliant with NIST Special
Publication 800-73-3. Specifically, ActivClient supports on-card key
history – if history encryption keys are stored on the card, ActivClient
enables the user to access them, for example to decrypt older emails
encrypted with these history keys. For non-federal issuers, ActivClient
also supports GUIDs in the form of a UUID (instead of a FASC-N for
federal issuers). ActivClient User Console has been enhanced to display
additional personal information stored on the card.
- ActivClient provides more flexibility for Commercial Identity
Verification (CIV) and PIV-like cards, cards that use a PIV-compliant
card edge, but that might implement different policies when FIPS 201
compliance is not required. ActivClient complies with the policies
stored on the card during issuance with ActivID CMS. For example, if the
card profile allows it, ActivClient supports challenge/response unlock,
supports the "change PIN on first use" option, or enables the Digital
Signature key to be used without enforcing the PIN for every signature
(leveraging the ActivClient PIN cache).
- ActivClient PIN Cache service has been updated to be compatible with
the mini driver component. It has also been simplified compared to
previous versions.
- ActivClient Outlook Enhancements have been enhanced. For example,
administrators can now configure automatically the hashing and
encryption algorithms. On card insertion, ActivClient updates the
Outlook security profile to the selected algorithms (e.g. SHA-256 and
AES).
- ActivClient integrates better with Firefox and Thunderbird. During
installation, on both 32- and 64-bit platforms, ActivClient registers
the PKCS#11 library into these applications. This automatic registration
is also performed on application startup, in order to support new users
automatically.
- ActivClient packaging is simplified – ActivClient CAC and ActivClient
are now merged in a single package; a "US Department of Defense
Configuration" option appears in the setup that automatically configures
ActivClient with DoD policies.
- ActivClient configuration settings have been simplified –
configuration is now performed via Windows policies. ActivClient
includes administrative templates that can be configured and deployed
centrally (from a Group Policy Object), or locally (using local group
policies). ActivClient provides access to the Resultant Set of Policy
tool from the User Console, to provide a view of policies active on
workstations. Configuration via registry keys and with the Advanced
Configuration Manager is no longer supported.
Note: Some policies have changed
to better align with Microsoft recommendations; for example the "Setup
email certificates in Outlook on card insertion" policy has been
replaced by the "Turn off setup email certificates in Microsoft Outlook
on card insertion" policy, the default value preserves the policy
functionality.
- To better leverage and avoid redundancy with Microsoft Windows and
Office capabilities, some ActivClient features and policies have been
removed. For example, certificate registration into the CAPI store is
now provided by Windows, the PIN Change Tool is replaced by the native
Windows PIN Change feature; the certificate viewer in the User Console
leverages Windows dialogs.
- ActivClient supports the latest environments, such as:
- Windows Vista, Windows 7, Windows Server 2008 and Windows Server
2008 R2 – with latest service packs
Note: Windows XP and Windows
Server 2003 remain supported with ActivClient 6.2.
- Microsoft Office 2007 and 2010 (including 64-bit); full support
with the ActivClient Outlook Usability Enhancements
- Microsoft Exchange 2007 and 2010
- Internet Explorer 8 and 9
- Mozilla Firefox 4 and later
- Google Chrome 11 and later
- Citrix XenApp 5 and 6
- New smart cards from HID Global (the Crescendo® C800
and C1100), Gemalto, Giesecke & Devrient and Oberthur, including
new PIV cards (SP 800-73-3 compliant)
- A large number of bug fixes and minor enhancements, such as:
- Ability to customize the PIN length for PIV cards (within the
allowed 6-8 standardized length) using the ActivClient policies. For
example, an organization might force a PIN to be 6 digits long.
(64188)
- Transparent support for T=0 and T=1 cards (64409, 63961, 63694)
- ActivClient setup now automatically configures ActivClient
components on the Citrix server; this avoids issues described at http://support.citrix.com/article/CTX891671.
(72898)
- Extended length for the customized card / certificate expiration
warning message. (75401)
- ActivClient PKCS#11 API includes extensions that provide access to
PIV objects (the user’s personal information). (74127)
- Certificate friendly names have been improved for CAC and PIV
cards – they now start with the certificate type instead of the
username to better suit small user interfaces that truncate the
friendly name.
- Outlook profile configuration now supports a configuration where
the certificate email and the Exchange email do not match. (60691)
- Card auto-registration now supports PIV cards on Windows 7.
(63101)
- New ActivClient policy to have option to not clear the PIN from
the PIN cache when the screen locks. (64812)
- Unattended smart card alert is improved to cause repeated beeps,
for increased user awareness. (72833)
The following capabilities are not supported with ActivClient 7.0. They will
be supported in an upcoming release.
- Standalone mode:
- Smart cards with a standalone profile based on ActivID Applets v1
or standalone / mini profile are supported for usage service – not
management services.
- Smart cards with a standalone profile based on ActivID Applets
v2.x are not supported.
- PIN initialization, Unlock with static unlock key and card reset
are not supported for the standalone and standalone / mini profiles.
- Certificate download and certificate import are not supported with
any card profile.
- Limited one-time password services:
- ActivClient 7.0 supports OTP generation via the User Console and
ActivClient Agent; it also supports OTP synchronization.
- However, Check Point SAA support and the ACOMX API are not
supported.
- Initialization of a smart card via the 4TRESS AAA Server requires
ActivClient 6.2 on the issuance station; once the card is issued, it
can be used with ActivClient 7.0 for OTP generation.
- Troubleshooting wizard
- ActivClient SDK – API documentation and samples – refer to the
relevant standards (NIST for PIV, RSA Labs for PKCS#11, Microsoft for
the mini driver, GSA for BSI) for details.
- Card profiles with secure messaging (SMA)
- Compatibility with ActivID SecureLogin
- Compatibility with Entrust Authority and Entrust Entelligence Security
Provider
The following capabilities are no longer supported with ActivClient 7.x.:
- Support for Cryptoflex cards, ActivKey v1 and v2
- Compatibility with Entrust Entelligence Desktop Solution
KNOWN PROBLEMS, SYSTEM
REQUIREMENTS AND LIMITATIONS
This section describes issues known by HID Global as of the release date,
but which have not been addressed in the current product version. When
possible, fixes and workarounds are suggested. This section also describes
known limitations of this release.
Installation and
Uninstallation
- Before you install/uninstall/upgrade ActivClient, you must remove
your smart card from the smart card reader.
- Windows local administrative privileges or domain administrative
privileges are required to install/uninstall ActivClient.
- Close all opened applications before you install or uninstall
ActivClient.
- Do not install another application while using the ActivClient setup.
Installing
- If Microsoft Script Debugger is installed on your workstation, a
Microsoft Script Debugger error message might appear during the
ActivClient setup. Ignore this error message.
- Running the setup from a .zip file is not supported. First unzip the
installation files into a temporary folder and then launch the setup
from that folder.
- In some cases, when you copy the ActivClient installation files to a
disk with a FAT32 file system, you might see a "Confirm Stream Loss"
error message. When asked if you want to proceed, click Yes and continue
the installation.
- If you copy the CD image on a network drive, the welcome page
(start.exe) will not work if the path is longer than 113 characters. Use
directly the Product\Setup.exe instead.
- When you run the ActivClient installer, you might see a filename such
as 226ac5.msi – this name is automatically generated and is the internal
InstallShield file name for the ActivClient MSI.
- On Microsoft Windows Server 2008 and Windows Server 2008 R2 – Server
Core edition, install ActivClient from the command line using the
msiexec command. As Internet Explorer is not present on the Server Core
edition, ActivClient components related to Internet Explorer will not
work.
- When installing ActivClient 7.1 on Windows 7 or Windows Server 2008
R2, you may see a Windows Untrusted Publisher security warning. This is
due to HID Global using a SHA2 certificate, as recommended by NIST and
Microsoft. Install a Windows Hot Fix to avoid this warning. See
https://support.microsoft.com/en-us/kb/2921916 for details and
access to the hot fix.
- ActivClient 7.1 installer installs automatically some Microsoft Visual
Studio Redistributable components. If a previous version of these
redistributable components is already installed on the workstation and
loaded by Windows, you may need to reboot at the end of the ActivClient
installation process. (IAAC-226)
Upgrading and Updating
- When you install an ActivClient update (MSP file), you might see a
message stating that the ActivClient Agent is running. Press OK to
continue with the installation.
- Due to a Microsoft Windows Installer limitation, when adding a
feature during the modify process, you might be prompted for the source
media (that is, the CD-ROM, local or remote directory). The same applies
if you install a software update (MSI or MSP file). Access to the
initial source media is recommended for any software update. (74378)
- With ActivClient 7.1, ActivClient policies are now under the HID
Global tree (rather than ActivIdentity). When upgrading from ActivClient
7.0.x, clear the older policies and configure the new policies.
Uninstalling
- To uninstall the product, use the Add/Remove Programs in the Windows
Control Panel. Do NOT delete DLLs or files manually. ActivClient uses
shared libraries. Deleting libraries might lead to subsequent problems
when a new version is installed.
- The HID Global\ActivClient folder (typically in C:\Program Files)
remains after you uninstall the software. This has no adverse effect on
the behavior of the workstation or on a future re-installation process.
(75797)
Software Deployment with
Microsoft SCCM
- If the user is logged on while a remote SCCM installation of
ActivClient is performed, the ActivClient Agent icon is not started
automatically. The user can either log out and then log back on, or
start the ActivClient Agent manually from the startup folder.
- The ActivClient Agent icon is still active after a remote uninstall
with SCCM. You must log off and log on again for the uninstall to be
completely effective. Use the install process to configure SCCM so that
it requests logoff/logon after package uninstallation.
- When ActivClient is removed by SCCM, it still appears in Add/Remove
Programs in the Windows Control Panel. When you try to uninstall, an
error message appears the first time, then the option disappears.
- If ActivClient is installed using Active Directory software push, then
the ActivClient tiles (PIN Initialization, User Console, Advanced
Diagnostics, Smart Card Agent) are not automatically pinned to the
Windows 8 Start screen. (80619)
ActivClient PKI Services
Certificate Availability
- The ActivClient "Remove certificates from Windows on logoff" option
requires the card to still be inserted in the reader during the logoff
operation. It is not compatible with "logoff on card removal".
- ActivClient 7.x relies on Microsoft Windows Certificate Propagation
service. Make sure that this service is set to Automatic for ActivClient
to operate properly. (80522)
Windows PKI Authentication
- If your smart card has been configured so that you are required to
change your PIN code on first use, and if the first application you log
on to is Windows PKI Logon, then you will immediately be prompted to
change your PIN code after you have logged on.
- If your smart card has been configured so that you are required to
change your PIN code on first use, and if your first use is the Windows
Logon, then ActivClient displays an ActivClient – Change PIN dialog
right after Windows Logon, when the desktop appears. Do not press
Ctrl-Alt-Del and select Change Password (to change the PIN) when the
ActivClient Change PIN dialog is open. (75689)
- ActivClient supports the "PIN change on first use" feature for CIV
cards issued by ActivID CMS. This is a value-add capability of ActivID
PIV Applets and ActivID CMS personalization capabilities. This requires
ActivID CMS 4.2.1 or later and ActivClient 7.0 or later. (74165)
- If you enter too many incorrect PIN codes, the warning "Last Attempt"
is not displayed during a Windows PKI login. This is due to Microsoft
Windows calling the ActivClient Mini Driver in silent mode.
- If you lock your smart card by entering several incorrect PIN codes,
ActivClient reports the card as "locked". However, if you attempt to log
on to Windows with this card, Windows will report this card as
"blocked"; this is the terminology used by Microsoft.
Microsoft Outlook
- Outlook certificate operations (including the Outlook Usability
Enhancements) do not function properly when the user certificates are
not trusted. Make sure that the issuing CA’s are trusted by Microsoft
CAPI.
- If you receive a signed or encrypted email that was sent with the
'Request S/MIME receipt for all S/MIME signed messages' option enabled,
and if you use a PIV card with the signature certificate configured for
‘PIN Always’, then you will need to authenticate with your PIN when
Outlook sends the receipt to the sender. This is a Microsoft limitation.
(74326)
Microsoft Outlook Usability
Enhancements
- If you use ActivClient to automatically configure your Outlook
security profile, and if you uninstall ActivClient, and then try to send
a signed email, you will see an error: "An error occurred in the
underlying system". To solve this issue, you need to delete the Outlook
security profile after ActivClient un-installation. (57870)
- The ActivClient Publish to GAL feature relies on an authenticated
connection to Exchange / Active Directory. If Outlook prompts you for
the Exchange password on logon / reconnect (instead of authenticating
you automatically by leveraging your Windows authentication), then
ActivClient is not able to connect to Exchange and to publish your
certificates to the GAL. In such a configuration, you can publish your
certificates to the GAL by using the ActivClient User Console – Tools –
Advanced – Publish to GAL menu. (58442)
- If ActivClient is configured to setup email certificates in Microsoft
Outlook on card insertion (the default behavior), but if Outlook is not
installed, the operation will fail. This will cause error events to be
created in the Windows Event Log. To prevent these events, enable the
ActivClient policy "Turn off setup email certificates in Microsoft
Outlook on card insertion". (75106)
- If you are using Microsoft Outlook on Windows 8/10 in the Windows UI
(not on the desktop), then the Publish to GAL operation might not work
if ActivClient requires the user to enter his PIN, as the PIN prompt
appears on the desktop, invisible to the user. The Publish to GAL
function is fully supported when Outlook is used on the Windows 8/10
desktop. (80547)
- If you are using Microsoft Outlook on Windows 8/10 in the Windows UI
(not on the desktop), then the Auto-Contact operation might not work if
ActivClient requires user feedback, as the potential ActivClient prompt
(for example, to confirm that a certificate that does not match the
Outlook account will be used) appears on the desktop, invisible to the
user. The Auto-Contact function is fully supported when Outlook is used
on the Windows 8/10 desktop. (80574)
- With Microsoft Outlook 2013 and later, the ActivClient plugin for
Outlook may become disabled if the user is slow responding to an
ActivClient prompt (e.g. confirmation about adding a certificate to a
contact). This is due to Microsoft Outlook only allowing plugins 500 ms
when opening emails. When Microsoft Outlook displays a warning, select
"Always enable this add-in" to make sure that "ActivClient add-in for
Outlook" is enabled. (IAAC-149)
Internet Explorer, Microsoft
Edge and Google Chrome
- The U.S. Department of Defense-issued Common Access Cards'
certificate names are not differentiated in the Internet Explorer
browser. When visualizing card certificates in Internet Explorer or
during an SSL authentication, all three certificates have the same name.
The workaround is to use the friendly name (ID, Signature or Encryption
certificate) visible in the same window. This also applies to FIPS 201
compliant PIV cards.
- If Internet Explorer is configured in Protected Mode or Enhanced
Protected Mode, it does not have access to ActivClient PIN cache – by
design of the protected mode feature. End users might then see more PIN
prompts than they would without the protected mode.
- Microsoft Edge does not have access to ActivClient PIN cache, by
design. End users might see an additional PIN prompt when using Edge,
even if they have already entered it in a previous application.
Windows EFS
For detailed information about Microsoft Encrypting File System, refer to
Microsoft documentation.
- ActivClient includes an automatic EFS configuration feature (by
automatically selecting the smart card certificate that EFS will use).
This configuration option, "Configure Windows EFS with smart card
certificate", is enabled by default. This option is applicable only for
the initial configuration. If you want to update the EFS certificate
later and re-encrypt your files with a new certificate, you will need to
use the "Manage your encryption certificate wizard" – see the ActivClient
User Guide for details.
- Smart card-based file encryption with EFS is supported only if you use
the smart card for Windows Logon. (74060)
- With Windows 8/10, when configuring EFS, make sure the option "Create
caching-capable user key from smart card" is selected. (82048, IAAC-174)
Firefox / Thunderbird
The card authentication certificate of a PIV smart card is not displayed by
Firefox. This is because the web browser does not support empty subject
names.
Microsoft certutil
In order to import a certificate with the Microsoft certutil tool, you must:
- Set the values of the following Microsoft registry keys to DWORD:0x1:
- HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider\Microsoft
Base Smart Card Crypto Provider\AllowPrivateExchangeKeyImport
- HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider\Microsoft
Base Smart Card Crypto Provider\AllowPrivateSignatureKeyImport
Note: You need to add the
keys to the system if they are not already present.
- Make the certificate and the keys available as a PFX file using the
Certificate Export Wizard.
- Import the PFX file into a smart card using the following command:
certutil –csp "Microsoft Base Smart Card Crypto Provider" –importpfx
{PFXfile}
See
http://blogs.technet.com/b/pki/archive/2007/11/13/manually-importing-keys-into-a-smart-card.aspx
for further information.
Other PKI Applications
- If you have an application using PKCS#11 with a PIV card or a smart
card with ActivID Applets v2, and if you lock and then unlock the
Windows workstation with a password, PKCS#11 will not erase the private
key attributes (CKA_ID, CKA_LABEL, CKA_SUBJECT). However, use of the RSA
private key will require re-entering your PIN code.
- The ActivClient PKCS#11 library supports the
CKF_PROTECTED_AUTHENTICATION_PATH flag defined in the PKCS#11 standard.
Some PKCS#11 enabled applications do not support this flag; this might
lead to integration issues. If you run into such issues, you might
configure ActivClient to disable this feature by creating the
isCKF_PROTECTED_AUTHENTICATION_PATHsupported key (as a DWORD) in
[HKLM]\SOFTWARE\HID Global\ActivClient\PKCS11\ and setting it to 0.
- If you use Microsoft Outlook Web Access to access emails via Internet
Explorer, and close the Outlook Web Access session, you will see some of
your certificates being removed from the local Windows CAPI store
(certificates are unregistered). This is a Microsoft limitation of the
S/MIME ActiveX control used by Outlook Web Access. Contact Microsoft for
further information.
- If you develop an application leveraging several ActivClient APIs
(e.g. Mini Driver and PKCS#11), then an API may not see objects created
by another API. For example the PKCS#11 C_FindObjects will not see
objects created in parallel by the MiniDriver. (IAAC-211)
ActivClient Common Services
User Console
- The certificate time (Valid from/Valid to) displayed in the
ActivClient User Console might differ from the time displayed in
Internet Explorer. This difference is due to Internet Explorer using GMT
while the ActivClient User Console uses the local time zone.
- Do not remove the card from the smart card reader while it is being
accessed by applications (when the ActivClient icon on the taskbar is
red). It is OK to remove the card when the icon is green.
- On some models of the US Department of Defense Common Access Cards,
there is an extra eight digit number at the end of the serial number
printed on the back of the card. This extra number is not electronically
recorded on the chip and thus is not part of the serial number displayed
by the ActivClient User Console.
- Deleting a certificate using the ActivClient User Console does not
remove the link to the certificate in Microsoft CAPI. The certificate
will still appear to be present in CAPI-enabled applications such as
Internet Explorer or Microsoft Outlook, even though no private key
operation will be available.
- ActivClient User Console has some limitations with regards to
compatibility with Microsoft Narrator when navigating the menus. HID
Global is currently working with the third-party company providing the
User Console interface to provide a solution to this problem.
- Icons in the User Console will display the first time after they are
disabled. Those icons will be hidden in subsequent use of the User
Console.
- If you view the content of a PIV card with the ActivClient User
Console, you might see "RSA Key Pair" for the credentials that have not
been personalized yet – there is no API in the PIV standard to determine
if an RSA key pair has been created or not, so ActivClient displays "RSA
key pair" in either case, when the certificate is not detected. This
applies to the 4 PIV-defined digital certificates.
- ActivClient utilities (User Console, PIN Initialization Tool, Smart
Card Agent, Notifications, etc.) are supported on the desktop; they are
not supported in the Windows UI (formerly referred to as "Metro mode")
relevant to tablets.
ActivClient Agent
- If you insert a smart card upside down or on the wrong side, and then
properly reinsert the card, the ActivClient Agent icon might still
display "no smart card".
- If you insert and remove your smart card several times in the smart
card reader, the ActivClient Agent icon might still display "no smart
card". Remove and reinsert the card in the smart card reader and the
icon will be refreshed.
- If more than one smart card reader is connected to your system, the
ActivClient Agent only supports the first smart card it detects and does
not support more than one smart card connected at the same time.
- The ActivClient Agent might fail to detect the card insertion if a
card is inserted briefly and removed immediately. In this case, you
might be prompted twice for the PIN when you reinsert the card.
- The ActivClient Agent might start slowly, and the menus (available
via right or left-click) might appear slowly; the ActivClient Agent icon
informs the user of this status – this appears only at the beginning of
the Windows session. This is due to user processes started in
"BelowNormal" Priority, to speed up services startup – this is a
Microsoft Windows design. Once all services are started, user processes
such as the ActivClient Agent return to "Normal" Priority and become
responsive.
- If you generate a One-Time Password via the ActivClient Agent, the
OTP is placed in the Windows Clipboard. Previous content of the
Clipboard is no longer available for a Paste operation even after the
OTP has been pasted.
Card Auto Update with
ActivID CMS
- If you have configured ActivClient PIN Cache service in "per process"
mode, or if Internet Explorer is configured in Protected Mode, then you
might see multiple PIN prompts during a card update. The default
configuration for ActivClient PIN Cache service is "per session" and it
will not display this behavior. (59341, 75601)
- The card auto-update feature requires the ActivClient BSI library,
included in the "Common Services". This feature is not supported if you
configure ActivClient to install without the BSI component. (75518)
- If you perform a card auto-update on a workstation that does not have
the ActivID CMS ActiveX component installed, it will be downloaded
automatically. However, if this process takes time, the card update
process might timeout. You might then need to restart the update process
for it to succeed. An alternative is to deploy the CMS ActiveX
components in advance. (75546)
- The card auto-update feature supports only one connected smart card;
if two smart cards are inserted at the same time in two readers, only
the default reader will be used. (75590)
- If a card update fails with the ActivClient card auto-update feature,
and if you then recycle the card on an ActivID CMS operator station, you
might need to use the ActivClient "reset optimization cache" before you
can use the card again. (75603)
Generic Smart Card Services
- The ActivClient smart card automatic registration is supported on
Microsoft Windows 7, Windows Server 2008 R2 and later. It enables
recognizing any new PIV card without requiring any software update; the
new PIV cards then benefit from all ActivClient capabilities. (73643)
- If you update the content of the smart card, and if the card is not
recognized properly anymore after the update, then it is recommended to
start the ActivClient User Console, use the "Reset optimization cache"
option from the menu Tools – Advanced and then remove and reinsert the
smart card in the smart card reader.
- If you use a smart card on workstation A and then update the card
content (including the PIN policy) on workstation B, you might need to
perform a "Reset optimization cache" on workstation A for the changes to
be visible.
- If you update the ActivClient policy from GSC-IS preference to PIV
preference (or vice versa), you will need to perform a "Reset
optimization cache" in the User Console to guarantee that cards
previously used on the workstation will be seen with their new
configuration.
- The ActivClient policies "Prevent entry of PIN code shorter than the
minimum PIN length" and "Allow entry PIN code longer than the maximum
PIN length" apply to the ActivClient PIN entry window; they do not apply
to third-party PIN entry windows, such as the Windows Logon. (73957,
73958)
ActivID CMS Issuance Station
- When ActivClient is used on an issuance station with the ActivID
Credential Management System, the recommended card removal behavior
option is "no action." In addition, we recommend disabling ActivClient
smart card discovery information caching; see the ActivClient
Administration Guide for details.
- If you use the Microsoft Certificate Authority, ActivID CMS 4.2 SP1
or higher is required for certificate issuance.
ActivID CMS My Digital ID
Card
- Support for ActivID CMS My Digital ID Card from a Windows x64
environment requires CMS version 4.2 or later – refer to your ActivID
CMS documentation for further information.
- If you use the Microsoft Certificate Authority, ActivID CMS 4.2 SP1
or higher is required for certificate update.
Citrix XenApp Sessions
- Because of a limitation of the Windows plug and play feature, it is
recommended to install ActivClient on a Citrix server directly on the
physical console. If it is not the case, then the first use of each
smart card type might not be successful until the card has been removed
and reinserted. As well, the exact card model will not be available.
- When ActivClient is installed on the Citrix server, card management
operations such as PIN change operations are not available within the
Citrix session.
- If ActivClient is installed both on the Citrix client and on the
Citrix server, and if you perform a Change PIN operation using
ActivClient installed on the client workstation, you are prompted to
re-authenticate when you access the smart card using ActivClient on the
Citrix server. Note that the "PIN try" counter is then decremented by 1.
- If you use your smart card locally on your workstation, you will be
prompted for the PIN to access the smart card again from your Citrix
session – independently of your ActivClient PIN policy (PIN cache). This
is due to the fact that both instances of ActivClient (on your
workstation and on the Citrix server) are independent.
- If you use your smart card to login to the Citrix session with a PKI
login, a new PIN prompt will appear for additional smart card services
inside the Citrix session. This is a Citrix limitation.
- Under some stress conditions (network bandwidth, latency, load of the
Citrix server), card events such as card removal might be reported with
a few seconds delay to ActivClient. Until ActivClient is aware of those
changes, it will try to function as if the card was still present in the
reader.
- If you open a session on the Citrix server with computer A with a
smart card and then moved on to computer B and establish a session to
the same Citrix server, you will have to type your PIN code twice.
- If you enable ActivClient log files on a Citrix server, be aware that
log files will grow very fast due to the logging of all users’
operations. Only enable logging when prompted by HID Global customer
support.
Microsoft Remote Desktop
Sessions
- When ActivClient is installed on the Terminal Server, card management
operations such as certificate download or PIN change operations are not
available within the RDP session.
- If ActivClient is installed both on the RDP client and on the
Terminal Server, and if you perform a Change PIN operation using
ActivClient installed on the client workstation, you are prompted to
re-authenticate when you access the smart card using ActivClient on the
Terminal Server. Note that the "PIN try" counter is then decremented by
1.
- If you use smart card services inside a RDP session, some
PIN-protected operations might require a new authentication even if an
authentication already occurred.
- If you enable ActivClient log files on a Windows Terminal Server, be
aware that log files will grow very fast due to the logging of all
users’ operations. Only enable logging when prompted by HID Global
customer support.
- When a user opens a RDP session to a Windows Server 2016, the
ActivClient Agent may not start automatically for the first logon; it
starts automatically for the next logon. (IAAC-232)
Notification Services
- Smart Card and Certificates Expiration Notification – For CAC cards,
if the user did not perform a Windows PKI logon, then ActivClient uses
the smart card certificate expiration date to determine the smart card
expiration date.
- Unattended Smart Card Notification – When you disconnect from a Citrix
XenApp Server or a Windows Terminal Server or Remote Desktop session,
ActivClient does not trigger the unattended smart card alert if the
smart card is left in the smart card reader.
Technical Support and
Copyright Notice
If you purchased your product from a third party, then please contact that
third party for Technical Support. For products purchased directly from HID
Global, please use the following Technical Support address:
www.hidglobal.com/support
hidglobal.com
© 2008-2016 HID Global Corporation/ASSA ABLOY
AB. All rights reserved. HID, HID Global, the HID Blue Brick logo, the
Chain Design and 4TRESS, ActivIdentity and ActivID are trademarks or
registered trademarks of HID Global or its licensor(s)/supplier(s) in the
US and other countries and may not be used without permission. The absence
of a mark, product, service name or logo from this list does not
constitute a waiver of the HID Global trademark or other intellectual
property rights concerning that name or logo. All other trademarks,
service marks, and product or service names are trademarks or registered
trademarks of their respective owners.
| Americas |
+1 510.574.0100 |
| US Federal |
+1 571.522.1000 |
| Europe |
+33 (0) 1.42.04.84.00 |
| Asia Pacific |
+61 (0) 3.9809.2892 |
Corporate
Headquarters
611 Center Ridge Drive
Austin, TX 78753
www.hidglobal.com
+1 800.237.7769