PKWARE Support Details

Support Hours and Contact Information

Monday through Friday 8:00AM - 6:00PM Eastern Time Zone
Technical Support 937-847-2687
Customer Service 937-847-2374
Request Tech Support Form

Support Links

About This Guide

Welcome to PKWARE® Smartcrypt®. You have taken an important step to take control of sensitive data across your enterprise. This guide will help you to deploy Smartcrypt throughout your enterprise. In this guide, you’ll learn to:

Plan your Smartcrypt Installation: What you need to know, and have on hand before setting up Smartcrypt.
Install the Smartcrypt Enterprise Manager: Whether you’re using Windows Server or a Linux-based appliance.
Set up system backups and restores to ensure the Smartcrypt database is always available
Deploying PKWARE agents: Sensitive data lives on a variety of remote client devices. This chapter helps you get Smartcrypt running on Windows, Mac and Linux/UNIX.

Uninstall agents from client devices: Smartcrypt users and their devices are always changing. Ensure that sensitive data stays with you when a device goes out of service.

Planning a PKWARE Installation

Error rendering macro 'include'

com.atlassian.renderer.v2.macro.MacroException: No page title provided.

Error rendering macro 'include'

com.atlassian.renderer.v2.macro.MacroException: No page title provided.

Installing a PKWARE Enterprise Manager

Error rendering macro 'include'

com.atlassian.renderer.v2.macro.MacroException: No page title provided.

Error rendering macro 'include'

com.atlassian.renderer.v2.macro.MacroException: No page title provided.

Installing PKWARE Agents

Windows Installation

Graphical Installation

Right click on the Windows Installer and choose "Run as administrator".
Review and accept the license agreement.
Select a setup type of either typical or custom.
1. Typical will install all program features.
2. Custom allows you to choose which programs and features you wish to install.
Launch Smartcrypt by double clicking on the Smartcrypt icon from the desktop.

Command Line Installation

You can install Smartcrypt from the Windows command-line prompt or a batch file. In the command line, you can set values for various properties to customize the installation.

The command line looks like this:

<name of smartcrypt installation file> /S /v"<properties>"

CODE

where:

/S is a switch that tells InstallShield^® to run silently and not to display various initial screens (that say, for example, Preparing to install )
/v is a switch that must be used to pass any specified Smartcrypt properties to the Windows installer.
<properties> is a list of property settings

You can also optionally pass in a switch to specify either the Basic UI, that displays a dialog containing only a Cancel button to allow canceling of the installation; or No UI, that displays no dialog. Both Basic UI and No UI can run unattended. The default is the full, graphical UI, which is interactive and so cannot run unattended.

Switch	Specifies
/qb	Basic UI
/qn	No UI

Any quotes (") in the parameters must be escaped with a backslash (\).

<name of smartcrypt installation file> /S /v/qb
<name of smartcrypt installation file> /S /v"/qb PKPGPASSOC=0"

CODE

The properties you can set or change are described below:

Disable add to Path...

By default, the Smartcrypt installer adds the command line program to the system's PATH. To disable the Smartcrypt command line interface from being added to the system PATH environment variable, type a command like this:

<name of smartcrypt installation file> /S /v"ADD_TO_PATH=0"

CODE

Disable Command Line Interface (CLI)...

By default, the command line interface is included in your Smartcrypt installation. If you prefer to only use the graphical interface, use this command:

<name of smartcrypt installation file> /S /v"CLI=0"

CODE

Do not install graphical (GUI) components...

If you want to only run Smartcrypt through its command-line interface, you can disable all graphical elements by setting the GUI property to 0 using a command line like this:

<name of smartcrypt installation file> /S /v"GUI=0"

CODE

Caution: Disabling the graphical interface also turns off Smartcrypt Attachments, SaveSecure Office Integration and all file associations.

Associate file types with Smartcrypt…

By default, the installation associates with Smartcrypt the types of files listed in the following table. These file associations enable you to open a file of any of these types in Smartcrypt by double-clicking it in Windows Explorer.

File Type	Property
ZIP	PKZIPASSOC
UUEncode/XXencoded	PKUUEASSOC
GZIP and TAR	PKGZASSOC
BZIP2	PKBZ2ASSOC
ARJ	PKARJASSOC
RAR	PKRARASSOC
LZH	PKLZHASSOC
OpenPGP	PKPGPASSOC
CAB	PKCABASSOC
Z (UNIX compress)	PKZASSOC
7Zip	PK7ZASSOC

If you do not want a particular file type associated with Smartcrypt, set the corresponding property to 0 in the command line. For example:

<name of smartcrypt installation file> /S /v"PKPGPASSOC=0"

CODE

Shortcuts...

By default, the installation creates shortcuts to Smartcrypt. If you do not want a shortcut created in one of the places listed in the table below, set the corresponding property to 0.

Location	Property
Program group on start menu	PKSTARTMENU
Desktop	PKDESKTOP

Do not install Smartcrypt Attachments...

Smartcrypt Attachments, the extension module for zipping email messages and attachments, installs by default if Outlook is detected. To not install Smartcrypt Attachments, set the MAIL property to No using a command line like this:

<name of smartcrypt installation file> /S /v"MAIL=0"

CODE

macOS Installation

Screens	Instructions
	Double click the Smartcrypt installer package provided from your PKWARE representative.
	Press, "Continue" to be guided through the steps necessary to install the Smartcrypt Client for Mac.
	Read through the software license agreement. Click, "Continue" to progress through the installation.
	After pressing, "Continue" a prompt will show to verify that you agree to the terms of the software license agreement. Click "Agree" to continue the software installation.
	Click, "Install" to perform a standard installation of Smartcryt for Mac.
	Enter the administrative password to authorize the installation of Smartcrypt for Mac
	Verify the installation has completed by seeing this prompt and click, "Close"

Linux/Unix Installation and Removal

Installing on Debian Linux based distribution

 [user@deb-host ~]# dpkg -i Smartcrypt_CLI-15.10.0034-x86_64.deb

CODE

Removing on Debian Linux based distribution

[user@deb-host ~]# dpkg -r pkzip-server

CODE

Installing on RPM Linux based distribution

[user@rhel-host ~]# rpm -i Smartcrypt_CLI-15.10.0034-x86_64.rpm

CODE

Removing on RPM Linux based distribution

[user@rhel-host ~]# rpm -qa | grep PK
PKZIP_Server-15.10.0034-1.x86_64
[user@rhel-host ~]# rpm -e PKZIP_Server

CODE

Installing on Solaris

SPARC
# pkgadd -d Smartcrypt_CLI-15.10.0034-sun4u.pkg all
x86
# pkgadd -d Smartcrypt_CLI-15.10.0034-i86pc.pkg all

CODE

Removing from Solaris

# pkgrm PKWpkzs

CODE

Installing on AIX

# installp -a -d <filename>.bff all

CODE

Removing from AIX

# installp -u pkzip-server.\*

CODE

Starting and Stopping the Agent

Running the program will automatically start the agent. If you wish the agent to start with a specific set of credentials, please see the next section on managing login credentials.

Starting the Agent

[user@rhel-host ~]$ pkzipc

CODE

Stopping the Agent on Linux

[user@rhel-host ~]$ /usr/pkware/pkzip/bin/pkagent --stop
PKWARE pkagent for Linux 15.10.0034
Portions copyright (C) 1989-2016 PKWARE, Inc.
Stopping agent, PID=2991

CODE

Stopping the Agent on Solaris

$ /opt/pkware/pkzip/bin/pkagent --stop
PKWARE pkagent for Solaris 15.10.0034
Portions copyright (C) 1989-2016 PKWARE, Inc.
Stopping agent, PID=2991

CODE

Help

[user@rhel-host ~]$ pkzipc -help
Smartcrypt(TM) Version 15 for Linux X86-64 Licensed Version 
Portions copyright (C) 1989-2016 PKWARE, Inc.  All Rights Reserved. 
Reg. U.S. Pat. and Tm. Off.  Patent No. 5,051,745  7,793,099  7,844,579 
7,890,465  7,895,434;  Other patents pending  
Usage: PKZIPC [command] [options] zipfile [@list] [files...]
   View .zip file contents: PKZIPC zipfile
   Create a .zip file:      PKZIPC -add zipfile file(s)...
   Extract files from .zip: PKZIPC -extract zipfile
The above usages are only basic examples of Smartcrypt's capability.

Enter 'C' to list Commands, 'O' to list Options or <Esc> to exit

CODE

Login Credentials

Creating your managed login credentials in the settings.json file

/usr/pkware/pkzip/bin/pkagent --config --interactive

PKWARE pkagent for Linux 17.10.0017
Portions copyright (C) 1989-2021 PKWARE, Inc.

Enter your Smartcrypt Server URL (optional): https://<SEMURL>/mds
Enter the email address: michael@supportad.int
Does the account "michael@supportad.int" authenticate with Active Directory
credentials [y/n]: y
Enter the Active Directory credentials for "michael@supportad.int": **********
PKMeta Initializing - Built Jan 13 2022 at 15:35:25
PKMeta initialized
Initialized Cluster Evaluator
Would you like to use a Smartcard for Multi-factor authentication (MFA)? [y/N]:
n

CODE

Click here to expand...

This method is not recommended as it can leave passwords exposed in history.

Creating your managed login credentials in the settings.json file

/usr/pkware/pkzip/bin/pkagent --config --email user@domain.ext --iwa password

CODE

Creating your unmanaged login credentials in the settings.json file

 /usr/pkware/pkzip/bin/pkagent --config --email user@domain.ext --master password

CODE

Listing Current Smartkeys

Listing current Smartkeys

ubuntu@ip-172-31-55-199:~$ pkzipc -listsm
Smartcrypt(TM) Version 15 for Linux X86-64 Licensed Version 
Portions copyright (C) 1989-2015 PKWARE, Inc.  All Rights Reserved. 
Reg. U.S. Pat. and Tm. Off.  Patent No. 5,051,745  7,793,099  7,844,579 
7,890,465  7,895,434;  Other patents pending

 ---------------------------------------------------------------- 
                             Smartkeys                            
 -------------------------------  ------------------------------- 
             Name/URN                        Owner                
 -------------------------------  ------------------------------- 
 ubuntu's Shareable Smartkey      ubuntu@smartcrypt.com           
 default--MA_16_pRVZLqxK4LtDuUZPJQ0NQn4WVSbG3oywEHIcSEcJvcU=
 ---------------------------------------------------------------- 
 Personal Smartkey                ubuntu@smartcrypt.com           
 priv--MA_16_pRVZLqxK4LtDuUZPJQ0NQn4WVSbG3oywEHIcSEcJvcU=
 ----------------------------------------------------------------

CODE

Encrypting a file to a Smartkey encrypted archive

ubuntu@test-box:~$ pkzipc -add ~/sc-installs/file1.zip ~/sc-installs/test-smartkey.txt -smartkey=default--MA_16_pRVZLqxK4LtDuUZPJQ0NQn4WVSbG3oywEHIcSEcJvcU=
Smartcrypt(TM) Version 15 for Linux X86-64 Licensed Version 
Portions copyright (C) 1989-2015 PKWARE, Inc.  All Rights Reserved. 
Reg. U.S. Pat. and Tm. Off.  Patent No. 5,051,745  7,793,099  7,844,579 
7,890,465  7,895,434;  Other patents pending
* Strongly encrypting files with a passphrase using AES (256-bit)
* Using UTF-8 file names and comments
* Using default compression method
Creating .ZIP: /home/ubuntu/sc-installs/file1.zip
  Adding File: test-smartkey.txt Deflating    ( 0.0%), Encrypting, done.

CODE

View passphrase on Smartkey encrypted archive

ubuntu@test-box:~$ pkzipc -test -smartkeypass ~/sc-installs/file1.zip</p><pre>Smartcrypt(TM) Version 15 for Linux X86-64 Licensed Version 
Portions copyright (C) 1989-2015 PKWARE, Inc.  All Rights Reserved. 
Reg. U.S. Pat. and Tm. Off.  Patent No. 5,051,745  7,793,099  7,844,579 
7,890,465  7,895,434;  Other patents pending

Testing files from .ZIP: /home/ubuntu/sc-installs/file1.zip


Smartkey passphrase: P4EhUuGKuaoDIJk3YKM4LVyhH0Qhin/aHjPSkwUgMRo=

Testing: test-smartkey.txt  OK

CODE

Create new Smartkey encrypted archive and output passphrase

ubuntu@test-box:~$ pkzipc -add ~/sc-installs/file3.zip ~/sc-installs/test-smartkey.txt -smartkey=default--MA_16_pRVZLqxK4LtDuUZPJQ0NQn4WVSbG3oywEHIcSEcJvcU= -smartkeypass

Smartcrypt(TM) Version 15 for Linux X86-64 Licensed Version 
Portions copyright (C) 1989-2015 PKWARE, Inc.  All Rights Reserved. 
Reg. U.S. Pat. and Tm. Off.  Patent No. 5,051,745  7,793,099  7,844,579 
7,890,465  7,895,434;  Other patents pending
* Strongly encrypting files with a passphrase using AES (256-bit)
* Using UTF-8 file names and comments
* Using default compression method

Creating .ZIP: /home/ubuntu/sc-installs/file3.zip

Smartkey passphrase: YKlOSQMq7opMbPwKRBEin/PGQ9vBoVPaxMOvdO+n5ZI=

  Adding File: test-smartkey.txt Deflating    ( 0.0%), Encrypting, done.

CODE

Commands

Command	Description	Example
-SmartkeyCreate	Create a new smartkey	pkzipc -smartkeycreate=test
-SmartkeyModify	Use SmartkeyModify to change a Smartkey’s name, and access rights to data encrypted with this Smartkey.	pkzipc -smartkeymodify=Test -smartkeyn="Test A" -smartkeya=a@example.com pkzipc -smartkeymodify="Test AB" -smartkeyn="Test AC" -smartkeya=c@example.org -smartkeyd=b@example.net pkzipc -smartkeymodify="urn=smartcrypt--something-something" -smartkeys
-SmartkeyRemove	Delete any Smartkey with the SmartkeyRemove command	pkzipc -smartkeyremove=”urn=Smartcrypt--something-something”
-Listsmartkeys	Displays a list of your Smartkeys and with =, displays a list of the users allowed to use that smartkey.	pkzipc -listsm pkzipc -listsm="Accounting"

Options

Command	Description	Example
-Smartkey	Specify a smartkey to be used	pkzipc -add -smartkey="urn=smartcrypt--something-something" save.zip * pkzipc -add -smartkey="Accounting" save.zip *
-SmartkeyAllow	Allows specified recipient(s) access to the Smartkey.	pkzipc -smartkeym="urn=smartcrypt--something-something" -smartkeya=a@example.com -smartkeya=b@example.net
-SmartkeyDeny	Denies specified recipient(s) access to the Smartkey.	pkzipc -smartkeym="urn=smartcrypt--something-something" -smartkeyd=a@example.com -smartkeyd=b@example.net pkzipc -smartkeym="urn=smartcrypt--something-something" -smartkeyd=@file.txt
-SmartkeyName	Renames the specified Smartkey	pkzipc -smartkeym="urn=smartcrypt--something-something" -smartkeyn="Test123" pkzipc -smartkeym="Test 123" -smartkeyn="Test 12345"
-SmartkeyPass	Display or write the random passphrase used in Smartkey based encryption to the console or a file.	pkzipc -add -smartkey="Sales Materials" -smartkeypass pkzipc -add -smartkey="Sales Materials" -smartkeypass=mypass.txt
-SmartkeySet	Specifies recipients allowed access to the Smartkey, denying all others.	pkzipc -smartkeym="urn=smartcrypt--something-something"-smartkeys=a@example.com -smarkeys=b@example.net pkzipc -smartkeym="urn=smartcrypt--something-something" -smartkeys=@file.txt pkzipc -smartkeym="urn=smartcrypt--something-something" -smartkeys

Uninstalling PKWARE Agents