PGP, Pretty Good Privacy, and the PGP logo are registered trademarks of PGP Corporation in the US and other countries. IDEA is a trademark of
Ascom Tech AG. Windows and ActiveX are registered trademarks of Microsoft Corporation. AOL is a registered trademark, and AOL Instant
Messenger is a trademark, of America Online, Inc. Red Hat and Red Hat Linux are trademarks or registered trademarks of Red Hat, Inc. Linux is a
registered trademark of Linus Torvalds. Solaris is a trademark or registered trademark of Sun Microsystems, Inc. AIX is a trademark or registered
trademark of International Business Machines Corporation. HP-UX is a trademark or registered trademark of Hewlett-Packard Company. SSH and
Secure Shell are trademarks of SSH Communications Security, Inc. Rendezvous and Mac OS X are trademarks or registered trademarks of Apple
Computer, Inc. All other registered and unregistered trademarks in this document are the sole property of their respective owners.
Licensing and Patent Information
The IDEA cryptographic cipher described in U.S. patent number 5,214,703 is licensed from Ascom Tech AG. The CAST-128 encryption algorithm,
implemented from RFC 2144, is available worldwide on a royalty-free basis for commercial and non-commercial uses. PGP Corporation has secured a
license to the patent rights contained in the patent application Serial Number 10/655,563 by The Regents of the University of California, entitled Block
Cipher Mode of Operation for Constructing a Wide-blocksize block Cipher from a Conventional Block Cipher. Some third-party software included in PGP
Universal Server is licensed under the GNU General Public License (GPL). PGP Universal Server as a whole is not licensed under the GPL. If you would
like a copy of the source code for the GPL software included in PGP Universal Server, contact
may have patents and/or pending patent applications covering subject matter in this software or its documentation; the furnishing of this software or
documentation does not give you any license to these patents.
PGP Support (https://support.pgp.com). PGP Corporation
http://www.apache.org/), Jakarta Commons (http://jakarta.apache.org/commons/license.html) and log4j, a Java-based library used to parse
server (
HTML, developed by the Apache Software Foundation. The license is at
binding framework for moving data from XML to Java programming language objects and from Java to databases, is released by the ExoLab Group
under an Apache 2.0-style license, available at
Foundation that implements the XSLT XML transformation language and the XPath XML query language, is released under the Apache Software
License, version 1.1, available at
Protocol") used for communications between various PGP products is provided under the Apache license found at
http://www.apache.org/licenses/LICENSE-2.0.txt. -- mx4j, an open-source implementation of the Java Management Extensions (JMX), is released
- JacORB, a Java object used to facilitate communication between processes written in Java and the data layer, is open source licensed under the
GNU Library General Public License (LGPL) available at
is an open-source implementation of a CORBA Object Request Broker (ORB), and is used for communication between processes written in C/C++ and
the data layer. Copyright (c) 1993-2006 by Douglas C. Schmidt and his research group at Washington University, University of California, Irvine, and
Vanderbilt University. The open source software license is available at
downloading files via common network services, is open source software provided under a MIT/X derivate license available at
http://curl.haxx.se/docs/copyright.html. Copyright (c) 1996 - 2007, Daniel Stenberg. -- libuuid, a library used to generate unique identifiers, is released
under a BSD-style license, available at
libpopt, a library that parses command line options, is released under the terms of the GNU Free Documentation License available at
http://www.cs.fsu.edu/~engelen/license.html. -- Windows Template Library (WTL) is used for developing user interface components and is distributed
under the Common Public License v1.0 found at
automate a variety of maintenance functions and is provided under the Perl Artistic License, found at
http://www.perl.com/pub/a/language/misc/Artistic.html. -- rEFIt - libeg, provides a graphical interface library for EFI, including image rendering, text
rendering, and alpha blending, and is distributed under the license found at
http://refit.svn.sourceforge.net/viewvc/*checkout*/refit/trunk/refit/LICENSE.txt?revision=288. Copyright (c) 2006 Christoph Pfisterer. All rights
reserved. -- Java Radius Client, used to authenticate PGP Universal Web Messenger users via Radius, is distributed under the Lesser General Public
License (LGPL) found at
Copyright (c) 2009, Yahoo! Inc. All rights reserved. Released under a BSD-style license, available at
JSON-lib version 2.2.1, a Java library used to convert Java objects to JSON (JavaScript Object Notation) objects for AJAX. Distributed under the
Apache 2.0 license, available at
available at
available at
available at
common configuration file format used on Windows, on other platforms. Distributed under the MIT License found at
http://www.opensource.org/licenses/mit-license.html. Copyright 2006-2008, Brodie Thiesfield. -- uSTL provides a small fast implementation of common
Standard Template Library functions and data structures and is distributed under the MIT License found at
license.html. Copyright (c) 2005-2009 by Mike Sharov <msharov@users.sourceforge.net>. -- Protocol Buffers (protobuf), Google's data interchange
format, are used to serialize structure data in the PGP SDK. Distributed under the BSD license found at
license.php. Copyright 2008 Google Inc. All rights reserved.
Additional acknowledgements and legal notices are included as part of the PGP Universal Server.
http://ezmorph.sourceforge.net/license.html. -- Apache Commons Lang, used by JSON-lib, is distributed under the Apache 2.0 license,
http://commons.apache.org/license.html. -- Apache Commons BeanUtils, used by JSON-lib, is distributed under the Apache 2.0 license,
http://commons.apache.org/license.html. -- SimpleIni is an .ini format file parser and provides the ability to read and write .ini files, a
http://www.gnu.org/licenses/lgpl.html. -- Yahoo! User Interface (YUI) library version 2.5.2, a Web UI interface library for AJAX.
http://json-lib.sourceforge.net/license.html. -- EZMorph, used by JSON-lib, is distributed under the Apache 2.0 license,
http://opensource.org/licenses/cpl1.0.php. -- The Perl Kit provides several independent utilities used to
http://developer.yahoo.com/yui/license.html. --
http://www.opensource.org/licenses/mit-
http://www.opensource.org/licenses/bsd-
Export Information
Export of this software and documentation may be subject to compliance with the rules and regulations promulgated from time to time by the Bureau
of Export Administration, United States Department of Commerce, which restricts the export and re-export of certain products and technical data.
Limitations
The software provided with this documentation is licensed to you for your individual use under the terms of the End User License Agreement provided
with the software. The information in this document is subject to change without notice. PGP Corporation does not warrant that the information meets
your requirements or that the information is free of errors. The information may include technical inaccuracies or typographical errors. Changes may be
made to the information and incorporated in new editions of this document, if and when made available by PGP Corporation.
Unsupported Third Party Products
By utilizing third party products, software, drivers, or other components ("Unsupported Third Party Product") to interact with the PGP software and/or by
utilizing any associated PGP command or code provided by to you by PGP at its sole discretion to interact with the Unsupported Third Party Product
("PGP Third Party Commands"), you acknowledge that the PGP software has not been designed for or formally tested with the Unsupported Third Party
Product, and therefore PGP provides no support or warranties with respect to the PGP Third Party Commands or the PGP software's compatibility with
Unsupported Third Party Products. THE PGP THIRD PARTY COMMANDS ARE PROVIDED "AS IS," WITH ALL FAULTS, AND THE ENTIRE RISK AS TO
SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH YOU. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE
LAW, PGP DISCLAIMS ALL REPRESENTATIONS, WARRANTIES, AND CONDITIONS, WHETHER EXPRESS OR IMPLIED, INCLUDING ANY
WARRANTIES OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, NONINFRINGEMENT, QUIET
ENJOYMENT, AND ACCURACY WITH RESPECT TO THE PGP THIRD PARTY COMMANDS OR THE PGP SOFTWARE'S COMPATIBILITY WITH THE
UNSUPPORTED THIRD PARTY PRODUCT.
Contents
Introduction 5
About PGP Whole Disk Encryption 5
About PGP Whole Disk Encryption Command Line 5
Important Terms 6
Audience 7
System Requirements 7
Installing and Uninstalling 7
PGP Whole Disk Encrypting a Drive 8
The Command-Line Interface 9
Overview 9
Scripting 10
Editing the Path 10
WDE-ADMIN Active Directory Group 11
Passphrases 11
Licensing 13
Overview 13
--license-authorize 13
Licensing via a Proxy Server 14
Generic Commands 17
--help (-h) 17
--version 18
Disk Information Commands 19
--enum 19
--info 20
--show-config 21
--status 22
User Management Commands 23
--add-user 23
--change-passphrase 25
--change-userdomain 25
--list-user 26
--offload 27
i
PGP Whole Disk Encryption Command Line Contents
--remove-user 27
--verify-user 28
Disk Management 31
--auth 31
--instrument 32
--uninstrument 32
Disk Operation 35
--decrypt 35
--encrypt 36
--resume 37
--secure 38
--stop 39
Boot Bypass Commands 41
--add-bypass 41
--check-bypass 43
--remove-bypass 43
Recovery Token Commands 45
--new-wdrt 45
PGP BootGuard Customization Commands 47
--set-background 47
--set-language 48
--set-sound 49
--set-start 50
--set-text 51
Local Self Recovery 53
--recovery-configure 54
--recovery-questions 55
--recovery-verify 56
--recovery-remove 57
--recovery-change-passphrase 57
Authenticating if you Have Forgotten Your Passphrase 58
Options 61
"Secure" Options 64
--admin-authorization 64
ii
PGP Whole Disk Encryption Command Line Contents
--admin-passphrase 64
--all 65
--answers-file 65
--auto-start 65
--beep 65
--count 66
--dedicated-mode 66
--disk (-d) 66
--display 67
--domain-name 67
--fast-mode 67
--image 68
--interactive 68
--keyboard 68
--keyid 69
--license-email 69
--license-name 69
--license-number 70
--license-organization 70
--message 70
--new-domain 70
--new-passphrase 71
--no-beep 71
--partition 71
--passphrase (-p) 72
--proxy-passphrase 72
--proxy-server 72
--proxy-username 73
--questions-file 73
--recovery-token 74
--safe-mode 74
--sso 74
--username 75
--xml 75
Quick Reference 77
Commands 77
Options 79
Troubleshooting 81
Overview 81
Encryption Does Not Begin 82
Encryption Does Not Finish 83
Problems at PGP BootGuard 85
iii
1
Introduction
This User's Guide tells you how to use PGP Whole Disk Encryption Command
Line.
In This Chapter
About PGP Whole Disk Encryption............................................................ 5
About PGP Whole Disk Encryption Command Line.................................. 5
Important Terms........................................................................................ 6
System Requirements ............................................................................... 7
Installing and Uninstalling .......................................................................... 7
PGP Whole Disk Encrypting a Drive.......................................................... 8
About PGP Whole Disk Encryption
PGP Whole Disk Encryption (WDE) is a software product from PGP Corporation
that uses encryption to lock down the entire contents of a boot disk, partition,
external disk, or removable disk.
For more information about PGP WDE, see the:
PGP Desktop User's Guide
PGP WDE Quick Start Guide
PGP WDE Data Sheet (available via the PGP WDE page on the PGP
Corporation website)
About PGP Whole Disk Encryption Command Line
PGP Whole Disk Encryption Command Line gives you access to PGP WDE
functionality using a command-line interface. Accessing PGP WDE functions
from the command line is useful for scripting PGP WDE functions,
troubleshooting problems, or if the graphical user interface is not available.
Note: Not all PGP WDE functions are available via the command line.
5
PGP Whole Disk Encryption Command Line Introduction
PGP WDE command line functionality is available for both Windows and Mac
OS X systems. This Guide covers both versions. Differences between the two
versions are noted where applicable.
Note: The Mac OS X Safe Boot feature does not work on a boot disk that has
been whole disk encrypted; if you hold down the Shift key to enter Safe
Boot, the system will fail to boot after authenticating at the PGP BootGuard
screen.
Important Terms
Understanding the following terms will help make it easier to use PGP Whole
Disk Encryption Command Line:
PGP Whole Disk Encryption (PGP WDE): a standalone product from PGP
Corporation and a feature of PGP Desktop that lets you encrypt the entire
contents of a disk; boot disks, partitions, and non-boot disks such as USB
thumb drives can all be whole disk encrypted. PGP WDE functionality is
available via a graphical user interface and through a command-line
interface.
PGP WDE command line: the command-line interface to PGP WDE
functionality. Because PGP WDE is available on both Windows and Mac
OS X systems, you can use the PGP WDE command line interface using
command line utilities such as the Command Prompt application, cmd.exe,
on Windows systems or the Terminal application on Mac OS X systems.
passphrase user: a user who can authenticate to an encrypted disk using
a passphrase.
public-key user: a user who can authenticate to an encrypted disk using
the passphrase to the corresponding private key.
encrypt: the process of "scrambling" data so that it is not usable unless you
properly authenticate.
decrypt: the process of "unscrambling" encrypted data.
master boot record (MBR): software on a disk that is "in front" of the
partition table; that is, it is implemented during the startup process
before
the operating system itself. The instructions in the MBR tells the system
how to boot.
instrument: a part of the process of whole disk encrypting a disk/partition
where the Windows or Mac OS X MBR is replaced with the PGPMBR.
PGPMBR: an MBR from PGP Corporation that implements the PGP
BootGuard. Once a disk is instrumented, even if it is not fully encrypted,
subsequent startups will bring up the PGP BootGuard.
6
PGP Whole Disk Encryption Command Line Introduction
PGP BootGuard: the screen that appears after instrumenting a disk that
requires proper authentication for the boot process to continue. If proper
authentication is
not provided, the boot process will not continue; the
operating system will not load and the system will not be usable.
uninstrument: removing the PGPMBR and replacing it with the original
Windows or Mac OS X MBR (which was saved when the disk was
instrumented).
whole disk recovery token (WDRT): an additional passphrase for a whole
disk encrypted disk that is passed to the appropriate PGP Universal Server
if the disk is part of a PGP Universal-managed environment.
PGP Universal Server: a management console for securing data from PGP
Corporation.
recovery: the process of restoring access to a disk/partition that has been
whole disk encrypted but now cannot be decrypted.
Audience
This User's Guide is for anyone who is going to be using PGP Whole Disk
Encryption Command Line to perform PGP WDE functions from the command
line.
It assumes you are familiar with using PGP WDE via the graphical user
interface, either in the standalone product or as part of PGP Desktop.
System Requirements
The system requirements for PGP Whole Disk Encryption Command Line are
the same as for PGP WDE itself; if PGP WDE (standalone or as part of PGP
Desktop) installs on a system, PGP Whole Disk Encryption Command Line will
also install and be usable.
Installing and Uninstalling
PGP Whole Disk Encryption Command Line is installed automatically when PGP
WDE or PGP Desktop is installed on a system.
To uninstall PGP Whole Disk Encryption Command Line, simply uninstall PGP
WDE or PGP Desktop.
7
PGP Whole Disk Encryption Command Line Introduction
PGP Whole Disk Encrypting a Drive
To PGP Whole Disk Encrypt a drive requires several things: the drive must be
instrumented, there must be at least one authorized user on the drive, and the
drive must be encrypted.
There are two ways to PGP Whole Disk Encrypt a drive:
using a single command, --secure: this one command instruments the
drive, creates an authorized user, and encrypts the drive. This command is
most useful when you have just installed PGP Whole Disk Encryption
Command Line and thus have not instrumented any drives, created any
authorized users, or encrypted any drives.
using multiple commands: for scenarios where you do not need all three
things required to PGP Whole Disk Encrypt at drive, or if you just prefer
using individual commands, you can use
and finally
--encrypt to PGP Whole Disk Encrypt a drive.
--instrument, --add-user,
8
The Command-Line
2
Overview
Interface
This section describes the command-line interface used by PGP Whole Disk
Encryption Command Line.
PGP Whole Disk Encryption Command Line uses a command-line interface.
You enter a valid command at the command prompt and press Enter or return.
PGP Whole Disk Encryption Command Line responds based on what you
entered: with success (if you entered a valid command) or with an error
message (if you entered an invalid or incorrectly structured command).
All PGP Whole Disk Encryption Command Line commands have a
the text "pgpwde", a space, two hyphens "
(if appropriate).
For example:
C:\>pgpwde --help [Enter]
is the command to display the built-in help information. It has no options.
(The command prompt, C:\> in the above example, and [Enter] will no longer be
shown in examples; only the necessary commands and options will be shown.)
A few commands also have a
letter or two hyphens and two letters.
For example:
-h for help instead of --help
--aa for administrative authorization instead of --adminauthorization
short form: either one hyphen and then a single
9
--", the command name, and options
long form:
PGP Whole Disk Encryption Command Line The Command-Line Interface
You can mix long forms and short forms in a single command.
Scripting
Short forms are noted where appropriate.
PGP Whole Disk Encryption Command Line commands can easily be inserted
into scripts for automating common tasks, such as encrypting a disk or getting
information about an encrypted disk.
PGP Whole Disk Encryption Command Line commands can easily be added to
scripts written with scripting languages such as Perl or Python.
Editing the Path
By default, the PGP Whole Disk Encryption Command Line application,
pgpwde.exe, is installed in C:\Program Files\PGP Corporation\PGP Desktop\ on
Windows systems.
To use PGP Whole Disk Encryption Command Line using the Windows
Command Prompt application, you need to navigate to the PGP Whole Disk
Encryption Command Line directory to execute commands (or the commands
will fail).
If you wish to be able to execute PGP Whole Disk Encryption Command Line
commands from any location when using Windows Command Prompt, you
need to change the path on the system to include the location of the PGP
Whole Disk Encryption Command Line application.
Note: On Mac OS X systems, you can use the Terminal application that ships
with Mac OS X as your command line editor. You can enter commands from
any location on the system; you do not have to navigate to a specific location.
To add the PGP Whole Disk Encryption Command Line application to your path
on a Windows 7 or Vista system:
1 On the Windows desktop, right click the
Computer icon, then select
Properties.
2 On the left side of the System Control Panel screen, click Advanced
System Settings
.
3 If you are prompted for permission to continue, click Continue.
4 At the bottom of the
Variables
.
System Properties screen, click Environment
5 In the System Variables section at the bottom of the Environment
Variables
screen, select Path, then click Edit.
10
PGP Whole Disk Encryption Command Line The Command-Line Interface
6 At the end of the existing Variable value line, enter a semicolon (;), then
add the path to the PGP Whole Disk Encryption Command Line application
7 Click
OK to save the change, then close the windows you opened.
To add the PGP Whole Disk Encryption Command Line application to your path
on a Windows XP or 2000 system:
1 On the Windows desktop, right click the
Properties.
2 On the System Properties dialog, click the Advanced tab.
3 At the bottom of the Advanced tab, click Environment Variables.
4 In the
5 At the end of the existing
System Variables section at the bottom of the Environment
Variables
screen, select Path, then click Edit.
Variable value line, enter a semicolon (;), then
add the path to the PGP Whole Disk Encryption Command Line application.
6 Click
OK to save the change, then close the windows you opened.
WDE-ADMIN Active Directory Group
If you are an administrator of PGP WDE clients in a PGP Universal environment
and using Active Directory, you can create a special Active Directory group to
allow you to run commands on your managed PGP WDE clients without
knowing the passphrase of a user on the encrypted disk.
My Computer icon, then select
Passphrases
This special Active Directory group, which
must be called WDE-ADMIN, must
be a security group, not a distribution group.
Using the
--admin-authorization option is useful for running
administrative tasks in an enterprise.
Refer to the
PGP Universal Administrator's Guide for more information about
creating and using the WDE-ADMIN Active Directory group.
For consistency, all example passphrases in this guide are shown in single
quotation marks ('). Putting passphrases between single quotation marks
ensures that reserved characters and spaces are interpreted correctly.
If you do not use any reserved characters or spaces in your passphrases, then
you do not have to enclose them in single quotation marks.
11
PGP Whole Disk Encryption Command Line The Command-Line Interface
On Windows systems, if you have a space in a passphrase, you must enclose
the passphrase in single or double quotation marks when you enter it. Also,
double quotation marks (") as part of the passphrase must be escaped with a
preceding double quotation mark.
For example, if you want to use
Thomas "Stonewall" Jackson
as your passphrase, you would have to enter it as
'Thomas ""Stonewall"" Jackson'
on the command line. You need the quotation marks at the beginning and end
for the spaces and you need to escape each double quotation mark used in the
passphrase with another double quotation mark.
If you do enclose your passphrases in single quotation marks, and you have a
single quotation mark as part of a passphrase on a *NIX system, you must
escape the single quotation mark that is part of the passphrase. Escaping
means you need to put another special character in front of the character; in this
case, a backslash (\).
For example, if you enclose your passphrases in single quotation marks and you
want to use
I can't believe it's not butter
as your passphrase, you would have to enter it as
'I can\'t believe it\'s not butter'
on the command line. You need the quotation marks at the beginning and end
for the spaces and you need to escape each single quotation mark used in the
passphrase with a backslash.
Note: If you are having problems entering certain characters in your
passphrases, check the information about how to handle reserved characters
for the operating system or shell interpreter you are using.
12
3
Licensing
This section describes how to license PGP Whole Disk Encryption Command
Line.
Licensing via a Proxy Server.................................................................... 14
Overview
PGP Whole Disk Encryption Command Line requires a valid license to operate.
This section describes how to license PGP Whole Disk Encryption Command
Line if it is currently unlicensed or if you want to change to a different license.
PGP Whole Disk Encryption Command Line supports the following licensing
scenarios:
Using a License Number
Disk Encryption Command Line. You must have your license information
and a working connection to the Internet.
Through a Proxy Server. If you connect to the Internet through a proxy
server, use this method to license PGP Whole Disk Encryption Command
Line. You must have your license information and the appropriate proxy
server information.
The licensing command is
Once PGP Whole Disk Encryption Command Line is correctly installed and
licensed on your system, you can encrypt your drive.
--license-authorize
. This is the normal method to license PGP Whole
--license-authorize.
Use --license-authorize to license PGP Whole Disk Encryption Command
Line.
(When entering this text, it all goes on a single line.)
Licensing via a Proxy Server
If the Internet access of the system hosting PGP Whole Disk Encryption
Command Line is via an HTTP proxy connection, you can still license PGP
Whole Disk Encryption Command Line directly; you simply need to add the
necessary proxy information.
Use --license-authorize to license PGP Whole Disk Encryption Command
Line via a proxy server.
The --enum command displays disk designations (for example, Disk 0 as the
boot disk), which is used in other PGP Whole Disk Encryption Command Line
commands.
The usage format is:
pgpwde --enum
Where:
--enum displays information about the disks on your system.
Examples:
pgpwde --enum
Total number of installed fixed/removable storage
device (excluding floppy and CDROM): 1
Disk 0 has 1 online volumes:
19
PGP Whole Disk Encryption Command Line Disk Information Commands
volume C is on partition 2 with offset 80325
Enumerate disks completed
This example shows that the system has one disk, Disk 0, which is drive
letter C and is the boot disk. Drive 0 is the boot disk in most cases on
Windows and Mac OS X systems.
pgpwde --enum
Total number of installed fixed/removable storage
device (excluding floppy and CDROM): 2
Disk 0 has 1 online volumes:
volume C is on partition 2 with offset 80325
Disk 1 has 1 online volumes:
volume F is on partition 1 with offset 245
Enumerate disks completed
This example shows information for the boot disk and a USB token on the
system; the token is Disk 1 and drive letter F.
--info
You can find out more information about the disks on your Windows
system in the Disk Management section of the Computer Management
tool (compmgmt.msc). You can find out more information about the disks
on your Mac OS X system using the Disk Utility application
(/Applications/Utilities/Disk Utility).
The --info command provides general status information for the specified
disk.
Use the
Information you can see about a disk using
--status command for PGP WDE-specific information about a disk.
--info includes:
model information.
total number of sectors on the disk.
The usage format is:
pgpwde --info --disk <number>
Where:
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
Examples:
pgpwde --info --disk 0
20
PGP Whole Disk Encryption Command Line Disk Information Commands
Disk information for disk disk 0.
Model Number: ST910021AS
Total number of sectors on disk: 192426569
Display disk information completed
This example shows the model number and sectors for a boot disk.
pgpwde --info --disk 1
Disk information for disk 1.
Model Number: SanDisk U3 Titanium USB 2.18
Total number of sectors on disk: 4001425
Display disk information completed
--show-config
This example shows the model number and sectors for a USB thumb drive.
The --show-config command displays information about how PGP
BootGuard is configured on an encrypted disk.
No information displays if the command is run on a disk that is not encrypted by
PGP WDE.
The usage format is:
pgpwde --show-config --disk <number>
Where:
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
Examples:
pgpwde --show-config --disk 0
Login Message:
Display Startup Screen: No
Use Audio Prompts: No
User lockout: Disabled
Allow user decrypt: Yes
Show configuration information completed
This example shows the PGP BootGuard information for a boot disk that is
encrypted.
21
PGP Whole Disk Encryption Command Line Disk Information Commands
--status
The --status command provides PGP WDE-specific status information for the
specified disk.
(Use the
Information you can see about a disk using
whether or not the disk is instrumented.
whether or not the disk is whole disk encrypted.
the number of sectors on the disk.
the highwater mark (the number of encrypted sectors on the disk).
Note: If you are decrypting a disk, and you want to check progress, you can
run --status periodically and check the high water mark; this number
decreases as the decryption progresses.
The usage format is:
Where:
Examples:
--info command for general information about a disk.)
--status includes:
pgpwde --status --disk <number>
--disk is the option specifying to which disk on the
system the information applies.
<number> is the disk number on the system.
pgpwde --status --disk 0
Disk disk0 is instrumented by bootguard.
Current key is valid.
Whole disk encrypted
Total sectors: 192426569 highwatermark: 192426569
Disk status completed
In this example, Disk 0 is instrumented by PGP BootGuard, the current key
used for authentication is valid, the disk is encrypted, the total number of
sectors on the disk is 192426569, and the high water mark (the number of
sectors encrypted) is 192426569.
pgpwde --status --disk 1
Disk disk 1 is not instrumented by bootguard.
Disk status completed
In this example, disk 1 is
not instrumented by PGP BootGuard.
22
User Management
6
Commands
The user management commands are:
--add-user: Adds user to disk or group.
--change-passphrase: Changes passphrase of specified user or group.
--change-userdomain: Changes authentication domain of specified
user or group.
--list-user: Lists authorized users on an encrypted disk.
--offload: Offloads passphrase user information onto specified device.
--remove-user: Removes user from specified disk or group.
--verify-user: Verifies passphrase of user or group.
PGP Whole Disk Encryption Command Line User Management Commands
Where:
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
--username specifies a username for an operation.
<user> is the username of the user being added.
--domain-name specifies the name of the domain to which the user
authenticates. The default is the login domain.
<domain> is the domain to which the user authenticates.
--sso specifies to create the user as a single sign-on (SSO) user, which
means that the Windows passphrase for logging in to the disk will also be
automatically used to authenticate to the encrypted disk.
--passphrase specifies the passphrase for an operation.
<pass> is the passphrase the user being added will use to authenticate.
--username specifies a username for an operation.
<user> is the username of the user being added.
--admin-authorization specifies that the command is being
performed by a member of the WDE-ADMIN Active Directory group.
--admin-passphrase specifies that the passphrase of an authorized
user on the encrypted disk will be used to authenticate the adding of the
new user account.
<phrase> is the passphrase of an authorized user on the disk.
--recovery-token specifies that the disk's recovery token (WDRT) will
This example shows a new passphrase user, Alice Cameron, being added
to a boot disk with a passphrase of Frodo@Baggins22. The passphrase
(Sam&Gamgee44) of an existing user on the disk is used to authenticate.
The --auth command lets you authenticate to an encrypted disk.
In most cases, if a disk needs authentication, the user will be prompted to
authenticate to the disk by pgptray. If pgptray is not running, you can use
This example shows a user on an encrypted disk authenticating to the boot
disk, disk 0.
31
PGP Whole Disk Encryption Command Line Disk Management
--instrument
The --instrument command replaces the Windows or Mac OS X MBR with
the PGPMBR.
Instrumenting the disk or partition is the first step in the process of securing a
disk; it is followed by adding a passphrase user and then encrypting the disk.
These three actions can be done individually, in that order, or all at once using
--secure command.
the
The usage format is:
pgpwde --instrument --disk <number>
Where:
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
Example:
--uninstrument
pgpwde --instrument --disk 0
This example shows a boot disk being instrumented.
The --uninstrument command replaces the PGPMBR with the original
(saved) Windows or Mac OS X MBR. The removes the requirement to
authenticate at the PGP BootGuard screen when starting the system.
Uninstrumenting a disk is normally done as part of the decryption process, so
this command is not normally used on its own.
Caution: You can only uninstrument a disk that has been instrumented but
nothing else. You cannot uninstrument an encrypted disk.
The usage format is:
pgpwde --uninstrument --disk <number>
Where:
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
Example:
pgpwde --uninstrument --disk 0
This example shows a boot disk being uninstrumented.
32
PGP Whole Disk Encryption Command Line Disk Management
33
8
Disk Operation
The disk operation commands are:
--decrypt: Decrypts the specified disk.
--encrypt: Encrypts the specified disk.
--resume: Resumes a halted encrypt or decrypt process.
--secure: Encrypts a disk to a specified user and passphrase.
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
--passphrase specifies the passphrase for an operation.
<phrase> is the passphrase of an authorized user on the disk.
--keyid specifies a user by key ID for an operation.
36
PGP Whole Disk Encryption Command Line Disk Operation
<keyid> is the key ID of an authorized user on the disk.
--all specifies that all partitions should be decrypted.
--partition specifies that only the listed partition should be encrypted.
<partnumber> is the partition to be encrypted.
--dedicated-mode specifies that dedicated mode (uses maximum
computer power to encrypt faster) be used in the encryption process.
--fast-mode specifies that fast mode (skipping unused sectors) be used
in the encryption process.
--safe-mode specifies that safe mode (encryption can be resumed
without loss of data if power is lost) be used in the encryption process.
Example:
pgpwde --encrypt --disk 0 --passphrase
'Frodo*1*Baggins22' --fast-mode --all
This example shows encryption of a boot disk being started using fast
mode. Authentication is provided by a authorized passphrase user; all
partitions are to be encrypted.
--resume
The --resume command resumes a stopped process, either encrypting or
decrypting a disk.
This example shows encryption being resumed on a boot disk.
37
PGP Whole Disk Encryption Command Line Disk Operation
--secure
The --secure command encrypts a disk to a specified user and passphrase. In
essence, it does three things that can also be done separately: it instruments
the disk, adds a passphrase user, and encrypts the disk.
This example shows a boot disk being secured (instrumented and
encrypted, with a new passphrase user).
38
PGP Whole Disk Encryption Command Line Disk Operation
--stop
The --stop command stops the current process, either encrypting or
decrypting a disk.
The usage format is:
pgpwde --stop --disk <number>
Where:
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
Example:
pgpwde --stop --disk 0
This example shows the encryption or decryption process on disk 0 being
stopped.
39
9
Boot Bypass Commands
The boot bypass feature lets you reboot a system one or more times without
having to authenticate at the PGP BootGuard screen.
Caution: Using the boot bypass feature weakens the protection provided by
PGP Whole Disk Encryption. Pay extra attention to the physical security of
systems when a bypass restart count exists. Use the --remove-bypass
command to remove any unnecessary remaining bypass restarts.
Boot bypass is generally used for remote deployment or upgrade scenarios
when one or more reboots is required; patch management, for example.
By default, boot bypass is disabled for a system. You must use the
bypass
Note: All three boot bypass commands apply to the boot disk only, even if
you specify another disk on the command line.
The boot bypass commands are:
--check-bypass: Checks to see if the specified disk is enabled for boot
command to enable bypass restarts.
--add-bypass: Enables the specified disk for boot bypass.
bypass.
--remove-bypass: Removes boot bypass from a disk where it is
enabled.
The --add-bypass command lets you enable one or more bypass restarts for
a system.
41
PGP Whole Disk Encryption Command Line Boot Bypass Commands
You can set the number of bypass restarts for a system to any value from 0 to
4,294,967,295. Setting the count to 0 (zero) disables bypass restarts. Setting
the count from 1 to 4,294,967,295 allows that many bypass restarts, as long as
the count is not higher than the preference set on the PGP Universal Server.
In a PGP Universal-managed environment, the PGP administrator can establish
a preference on the PGP Universal Server that limits the number of bypass
restarts that can be established using
--add-bypass.
The preference is called
wdeMaximumBypassRestarts. Setting the
preference to 0 (zero) disables boot bypass. Setting the preference to a value
from 1 to 4,294,967,295 allows that many bypass restarts. If the preference
does not exist on the PGP Universal Server, the value is set to 1, allowing one
bypass restart for each system.
If you enter a number on the command line that is greater than the preference
on the PGP Universal Server, an error will be returned. The error message does
not display the value configured for the preference.
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
--count specifies that bypass restarts are being configured the boot disk
on the system.
<bypassrestarts> is the desired number of bypass restarts.
--admin-authorization specifies that the command is being
performed by a member of the WDE-ADMIN Active Directory group.
--admin-passphrase specifies that the passphrase of an authorized
user on the encrypted disk will be used to authenticate.
<phrase> is the passphrase of an authorized user on the disk.
Example:
pgpwde --add-bypass --disk 0 --count 4 --admin-
passphrase 'bilbo@baggins42'
This example shows that four bypass restarts was added to the boot disk
on the system using the passphrase of an authorized user on the disk.
42
PGP Whole Disk Encryption Command Line Boot Bypass Commands
--check-bypass
The --check-bypass command tells you if boot bypass is configured for the
specified boot disk. If configured, it will also display the original and remaining
bypass restart counts.
This example shows the removal of boot bypass from a disk.
44
Recovery Token
10
Commands
In PGP Universal-managed environments with the appropriate policy, Whole
Disk Recovery Tokens (WDRTs) are created automatically when a disk, partition,
or removable disk is whole disk encrypted. They are sent to the PGP Universal
Server managing security for the disk or partition when they are created.
WDRTs can be used to access the disk or partition in case the passphrase or
authentication token is lost.
Once a WDRT is used, it cannot be used again. A new WDRT must be
generated for the system. All new WDRTs are also automatically sent to the
PGP Universal Server managing the disk when the new WDRT is created.
Because the first WDRT for a system is created automatically, the only
command related to WDRTs is to create a new WDRT.
--new-wdrt specifies the creation of a new WDRT.
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
45
PGP Whole Disk Encryption Command Line Recovery Token Commands
--admin-authorization specifies that the command is being
performed by a member of the WDE-ADMIN Active Directory group.
--admin-passphrase specifies that the passphrase of an authorized
user on the encrypted disk will be used to authenticate the adding of the
new user account.
<phrase> is the passphrase of an authorized user on the disk.
--recovery-token specifies that a recovery token (WDRT) will be
The --set-background command lets you specify a custom background
image for the PGP BootGuard authentication screen.
Custom background images must be created according to the following
specifications:
XPM files only.
Image size of 640 by 480.
47
PGP Whole Disk Encryption Command Line PGP BootGuard Customization Commands
Palette of 15 colors only, including black (one color is reserved for fonts).
You do not have to use all 15 colors in the image.
8-bit RGB only (cannot be 16-bit RGB). You can verify you are using 8 bit by
looking at the XPM header using a text editor: 8-bit values appear as
#285A83 (one hex triplet), 16-bit values appears as #28285A5A8383 (two
hex triplets).
Note: If you specify an image that does not meet these requirements, a
default text-only screen will be used.
Graphics applications that support the XPM file format include Graphic
Converter on Mac OS X, GIMP on Mac OS X/FreeBSD and UNIX/LINUX, and
the Convert command on Linux.
The new background image will display when the PGP BootGuard
authentication screen next appears.
This example shows an image file, corplogo.xpm, being set as the
background image for the PGP BootGuard authentication screen.
The --set-language command lets you specify the languages that will be
used by PGP BootGuard for display and for the keyboard.
You can specify one language and one display from the list of supported
languages. You are not required to use the same language for both.
Options not specified are not changed. So if you specify a new language for
text, the existing keyboard setting is not changed. The response to the --setlanguage command shows both the previous settings and the new settings, for
both display and keyboard.
Changes will take effect on the next system startup.
48
PGP Whole Disk Encryption Command Line PGP BootGuard Customization Commands
This example shows Japanese being specified for both display and
keyboard in PGP BootGuard.
The --set-sound command lets you enable or disable the use of audio clues
for actions that occur during the PGP Bootguard authentication process. Audio
clues are disabled by default.
Audio clues can help vision-impaired users more easily navigate the PGP
BootGuard authentication process.
When enabled, the system will play audible tone combinations during the PGP
BootGuard authentication process. Each tone combination begins with a middle
sound and is followed by either a higher tone, another middle tone, or a lower
tone.
The three combinations are:
Ready for passphrase/pin entry: When the system is first ready for
passphrase/pin entry, the middle-middle tone combination plays.
Successful authentication: If the authentication attempt was successful,
the middle-high tone combination plays. The system then continues
booting.
49
PGP Whole Disk Encryption Command Line PGP BootGuard Customization Commands
Unsuccessful authentication: If the authentication attempt was
unsuccessful, the middle-low tone combination plays. The PGP BootGuard
authentication screen displays and the passphrase field is cleared for
another authentication attempt.
The tone combinations cannot be customized; you can only decide whether to
enable audio clues or disable them.
Changes will take effect on the next system startup.
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
--beep enables audio clues.
--no-beep disables audio clues.
Example:
--set-start
pgpwde --set-sound --disk 0 --beep
Accessibility Sounds set to [ON]
This example shows audio clues being enabled.
The --set-start command lets you display a custom startup image for PGP
BootGuard that appears
before the authentication screen. Press any key to
make the startup screen disappear.
Custom startup images must be created according to the following
specifications:
XPM files only.
Image size of 640 by 480.
Palette of 15 colors only, including black (one color is reserved for fonts).
You do not have to use all 15 colors in the image.
8-bit RGB only (cannot be 16-bit RGB). You can verify you are using 8 bit by
looking at the XPM header using a text editor: 8-bit values appear as
#285A83 (one hex triplet), 16-bit values appears as #28285A5A8383 (two
hex triplets).
Graphics applications that support the XPM file format include Graphic
Converter on Mac OS X, GIMP on Mac OS X/FreeBSD and UNIX/LINUX, and
the Convert command on Linux.
50
PGP Whole Disk Encryption Command Line PGP BootGuard Customization Commands
The new startup image will display on the next system startup (unless Boot
Bypass is used).
The usage format is:
pgpwde --set-start --disk <number> --image <file>
Where:
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
--image specifies the image file to use as the startup screen.
This example shows an image file, corpsplash.xpm, being set as the PGP
BootGuard startup image.
--set-text
The --set-text command lets you specify text that will display when the
PGP BootGuard screen appears.
You can disable the display of text by entering no text where the message
would go.
You can enter one line of text, up to 80 characters (including spaces). The
default text is: "Forgot your passphrase? Please contact your IT department or
Security Administrator."
Note: Text must go in quotation marks or only the text up to the first space
will display. The quotation marks do not display.
Changes will take effect on the next system startup.
--disk specifies the disk to which the operation applies.
<number> is the disk number on the system.
--message specifies new text for the PGP BootGuard screen.
<text> is the text you want to display. If left empty, no text will display.
51
PGP Whole Disk Encryption Command Line PGP BootGuard Customization Commands
Examples:
pgpwde --set-text --disk 0 --message "You must change
your login passphrase monthly."
Custom message Updated
Set custom authentication screen text completed
This example shows a new text message for the PGP BootGuard screen.
pgpwde --set-text --disk 0 --message
Custom message Updated
Set custom authentication screen text completed
This example shows the display of text for the PGP BootGuard screen
being disabled.
52
12
Local Self Recovery
Local self recovery lets you authenticate to PGP BootGuard even if you have
forgotten your passphrase.
Note: Local self recovery only works if you configure it before you lose your
passphrase; PGP Corporation recommends configuring it immediately after
licensing PGP Whole Disk Encryption Command Line if you plan on using it.
When you configure local self recovery, you create five security questions;
three must be answered correctly to authenticate to PGP BootGuard.
Note: If you are using PGP Whole Disk Encryption Command Line in a PGP
Universal Server-managed environment, your PGP Universal Server
administrator may have disabled the option for local self recovery. Your
administrator may also have specified that local self recovery be configured
during enrollment. In this case, you are prompted to enter the security
questions as as you set up PGP Whole Disk Encryption Command Line.
The local self recovery commands are:
--recovery-configure: Configures the local self recovery feature.
--recovery-questions: Displays local self recovery questions.
--recovery-verify: Verifies existing local self recovery questions and
answers.
--recovery-remove: Removes existing local self recovery questions and
answers.
--recovery-change-passphrase: Changes a forgotten passphrase.
How to authenticate to PGP BootGuard if you have forgotten your passphrase,
but you configured local self recovery, is described in Authenticating if you have
Forgotten Your Passphrase.
Authenticating if you Have Forgotten Your Passphrase.......................... 58
53
PGP Whole Disk Encryption Command Line Local Self Recovery
--recovery-configure
The --recovery-configure command configures local self recovery.
You can configure the required five questions and answers in either of two
ways:
text files: you create two text files; one text file with five questions, each
on separate lines, and a second text file with five answers to those
questions, again each on a separate line.
interactively (--interactive): You will be prompted for five questions
and their corresponding answers.
You can also use
Command Line interactively prompt for a passphrase. To do this, use
interactive
--interactive to have PGP Whole Disk Encryption
--
on the command line instead of --passphrase and the
passphrase.
Note: Text files and --interactive are mutually exclusive. Use one
method or the other.
You will need to be able to correctly answer three of the five questions if you
forget your passphrase and need to authenticate to PGP BootGuard using
This example shows local self recovery being configured for user Alice
Cameron with the five questions and answers in the specified text files on
a Windows system.
--recovery-questions
The --recovery-questions command displays configured local self
recovery questions.
Note: --recovery-questions only shows existing questions. You cannot
This example displays the configured local self recovery questions for user
Alice Cameron.
--recovery-verify
The --recovery-verify command lets you verify the configured local self
recovery questions and answers. You can answer the five questions either
using a text file or interactively.
Note: You cannot modify the local self recovery questions using
--recovery-verify.
To authenticate to PGP BootGuard using the configured local self recovery
questions and answers, see Recovering a Lost Passphrase.
--recovery-remove specifies that you are removing configured local
self recovery questions and answers.
--user specifies which user account is being used.
<username> is the name of the user account.
--passphrase specifies the passphrase for an operation.
<phrase> is the passphrase for specified user account.
--disk specifies disk on the system for which local self recovery is being
removed.
<disknumber> is the disk number on the system. Disk 0, the boot disk,
is the default.
Example:
pgpwde --recovery-remove --user "Alice Cameron"
--passphrase 'bilbo#baggins+Frodo' --disk 0
This example removes configured local self recovery questions and answers for
user Alice Cameron.
--recovery-change-passphrase
The --recovery-change-passphrase command lets you create a new
passphrase when you have forgotten your existing passphrase and
authenticated to PGP BootGuard using local self recovery.
Note: PGP Corporation recommends creating a new passphrase as soon as
you authenticate to PGP BootGuard after forgetting your passphrase and
authenticating using local self recovery.
This example shows user Alice Cameron authenticating to PGP BootGuard
using the answers in the file answers.txt.
Authenticating if you Have Forgotten Your Passphrase
If you have forgotten your passphrase and cannot authenticate to the PGP
BootGuard screen, you can authenticate using local self recovery if you have
previously configured it.
Note: Local self recovery must be configured in advance.
To authenticate at the PGP BootGuard screen using local self recovery
1 On the PGP BootGuard screen, use the arrow keys to select
Passphrase
in the lower right corner, then press Enter. A new screen
appears, showing the first local self recovery question.
Forgot
2 Enter the answer to the first question, then press
Enter. The second
question appears.
3Enter the answer to the second question, then press
question appears.
58
Enter. The third
PGP Whole Disk Encryption Command Line Local Self Recovery
4 Enter the answer to the third question, then press Enter. The fourth
questions appears.
5 Enter the answer to the fourth question, then press
Enter. The fifth and
last question appears.
6 Enter the answer to the fifth question, then press
Enter.
If you entered three or more of the questions correctly, the PGP BootGuard
screen goes away and the system boots normally.
If you did not enter three or more questions correctly, you are given
another chance.
If you subsequently remember your original passphrase, you can continue using
it. Using local self recovery does not remove your passphrase.
If you do not believe you will ever remember your original passphrase, you can
change your passphrase after authenticating to PGP BootGuard using the
--recovery-change-passphrase command. This means that you do not
have to continue using the local self recovery questions to authenticate to PGP
BootGuard. Using this command does remove your original passphrase, so it
will not work if you remember it later.
59
13
Options
The PGP Whole Disk Encryption Command Line options are:
--admin-authorization: Specifies that the command is authorized by
member of the WDE-ADMIN Active Directory group.
--admin-passphrase: Specifies the passphrase of an existing PGP WDE
user.
--all: Specifies the use of partition mode encryption on all partitions.
--answers-file: Specifies the path to a text file with five answers.
--auto-start: Starts encryption immediately.
--base-disk: Specifies the disk number of the original group.
--beep: Enables beep when PGP BootGuard screen appears.
--dedicated-mode: Specifies that dedicated mode be used.
--disk (-d): Specifies the number of the target disk. Zero (0) is boot
disk.
--display: Specifies the PGP BootGuard display language.
--domain-name: Specifies the user authentication domain.
--fast-mode: Specifies that fast mode be used.
--image: Specifies an image file to be used.
--interactive: Specifies passphrases and questions/answers be asked
interactively.
--keyboard: Specifies the PGP BootGuard keyboard language.
--keyid: Specifies the key ID of a PGP key.
--license-email: Specifies an email address for the license holder.
--license-name: Specifies the person who whom PGP Whole Disk
Encryption Command Line is licensed.
--license-number: Specifies a valid license number for PGP Whole
Disk Encryption Command Line.
--license-organization: Specifies an organization for the license
holder.
--message: Specifies custom message for PGP BootGuard screen.
--new-domain: Specifies a new domain for a user.
--new-passphrase: Specifies a new passphrase for an existing user.
61
PGP Whole Disk Encryption Command Line Options
--no-beep: Disables beep when PGP BootGuard screen appears.
--partition: Specifies a partition for an operation.
--passphrase (-p): Specifies a passphrase for an operation.
--proxy-passphrase: Specifies the passphrase of the specified user
on the proxy server.
--proxy-server: Specifies a proxy server to go through to license PGP
Whole Disk Encryption Command Line.
--proxy-username: Specifies a user on the proxy server.
--questions-file: Specifies the path to a text file with five questions.
--recovery-token: Specifies a whole disk recovery token.
--safe-mode: Specifies that safe mode be used.
--username (-u): Specifies a username for an operation.
The descriptions of some options in PGP Whole Disk Encryption Command Line
mention that they are "secure," as in "This option is not secure". In this context,
"secure" means that the option’s argument is saved in non-pageable memory
(when that option is available to applications). Options that are not "secure" are
saved in normal system memory.
--admin-authorization
Specifies that the operation is authorized by a member of the WDE-ADMIN
Active Directory group. In other words, by an administrator of PGP WDE clients
in a PGP Universal-managed environment.
No passphrase is required on the command line when using this option.
Instead, the administrator will be authenticated against the WDE-ADMIN group
when the option is used.
This example shows local self recovery being configured for user Alice Cameron
with the five questions and answers in the specified text files on a Windows
system.
Specifies whether or not encryption should begin immediately. Options are Yes
This example shows disk 1 on the system being added to the encrypted
disk group. Encryption will begin immediately.
--beep
Specifies that audio clues for actions that occur during the PGP Bootguard
authentication process should be enabled.
65
PGP Whole Disk Encryption Command Line Options
The default is audio clues are disabled.
Example:
pgpwde --set-sound --disk 0 --beep
Accessibility Sounds set to [ON]
--count
Specifies the number of bypass restarts being configured for the boot disk on a
system.
Only works with the
Valid values for
Setting --count to 0 disables the boot bypass feature on the system.
In a PGP Universal-managed environment, a preference constrains what values
are valid for
command line that is higher than the value set in the preference.
--dedicated-mode
Specifies that Dedicated Mode should be used for the encryption process.
Dedicated Mode uses maximum computer power to encrypt faster; your
system is less responsive during encryption.
This example shows audio clues being enabled.
--add-bypass command.
--count are 0 through 4,294,967,295.
--count on the command line; you cannot set a value on the
--disk (-d)
Example:
pgpwde --encrypt --disk 0 --passphrase
'Frodo*1*Baggins22'
--dedicated-mode
This example shows encryption of a boot disk being started using
Dedicated Mode.
Specifies the disk to which the operation applies.
Example:
pgpwde --info --disk 0
Disk information for disk 0.
Model Number: ST910021AS
66
PGP Whole Disk Encryption Command Line Options
Total number of sectors on disk: 192426569
Display disk information completed
--display
--domain-name
This example shows general information being provided for disk 0.
This example shows an image file, corplogo.xpm, being set as the
background image for the PGP BootGuard authentication screen.
--interactive
Specifies that passphrases or questions and answers should be provided
interactively, as opposed to coming from text files in the case of questions and
answers.
--keyboard
Examples:
pgpwde --auth --disk 0 --interactive
This example shows a user authenticating to a boot disk by providing the
required passphrase interactively (being prompted for it) instead of entering
it on the command line.
This example shows Japanese being specified for both display and
keyboard in PGP BootGuard.
68
PGP Whole Disk Encryption Command Line Options
--keyid
Specifies the key ID of a PGP key.
Example:
pgpwde --verify-user --disk 0 --passphrase
'Frodo@Baggins44'
--keyid 0x12345678
Successfully verified user Alice Cameron
This example shows PGP key user Alice Cameron's passphrase being
verified via the key ID of her PGP key.
--license-email
Specifies the email address of the person for whom the software is licensed.
--license-name
This number is used to send license recovery emails and it cannot be changed
once the license is authorized: if you do not specify an email during licensing,
license recovery will not be possible.
This example shows a new passphrase user being added to a boot disk
with a passphrase of Frodo@Baggins22. In this example,
is being used to specify the passphrase that the new user of the encrypted
disk will use to access it.
This example shows local self recovery being configured for user Alice Cameron
with the five questions and answers in the specified text files on a Windows
system.
73
PGP Whole Disk Encryption Command Line Options
--recovery-token
Specifies that a recovery token (WDRT) be created.
--set-text Sets PGP BootGuard authentication screen text message.
Local Self Recovery
--recovery-configure Configures the local self recovery feature.
--recovery-questions Displays local self recovery questions.
--recovery-verify Verifies existing local self recovery questions and answers.
--recovery-remove Removes existing local self recovery questions and answers.
--recovery-change-passphrase Changes a forgotten passphrase.
78
PGP Whole Disk Encryption Command Line Quick Reference
Options
--admin-authorization (--aa) Command authorized by member of WDE-ADMIN AD group.
--admin-passphrase (--ap) Specifies the passphrase of an existing WDE user.
--all Specifies the use of partition mode encryption on all partitions.
--answers-file Specifies the path to a text file with five answers.
--auto-start Specifies whether or not encryption should begin immediately.
--beep Enables beep when PGP BootGuard screen appears.
--count Specifies the number of bypass restarts being configured.
--dedicated-mode Encrypts faster; system is less responsive.
--disk (-d) Specifies the number of the target disk. Zero (0) is boot disk.
--display Specifies the PGP BootGuard display language.
--domain-name Specifies the user authentication domain.
--fast-mode Skips unused sectors, so encryption is faster.
--image Specifies an image file for an operation.
--interactive Specifies passphrases or questions/answers should be prompted for.
--keyboard Specifies the PGP BootGuard keyboard language.
--keyid Specifies the key ID of a PGP key.
--license-email Specifies the email address of the licensee.
--license-name Specifies the name of the licensee.
--license-number Specifies a valid license number
--license-organization Specifies the organization of the licensee.
--message Specifies a custom message for the PGP BootGuard screen.
--new-domain Specifies a new domain for a user.
--new-passphrase Specifies a new passphrase for an existing user.
--no-beep Disables been when PGP BootGuard screen appears.
--partition Specifies a partition for an operation.
--passphrase (-p) Specifies a passphrase for an operation.
--proxy-passphrase Specifies the passphrase of the user on the proxy server.
--proxy-server Specifies the proxy server to use for licensing.
--proxy-username Specifies a username on the proxy server being for licensing.
--questions-file Specifies the path to a text file with five questions.
79
PGP Whole Disk Encryption Command Line Quick Reference
--recovery-token Specifies a whole disk recovery token for authentication.
--safe-mode Encryption can be resumed safely if power is lost during encryption.
--sso Creates user as single sign-on user.
--username (-u) Specifies a username for an operation.
--xml Displays returned information in XML format.
80
B
Troubleshooting
This section describes how PGP Whole Disk Encryption Command Line can be
used to troubleshoot problems you might encounter when whole disk
encrypting drives.
Note: These troubleshooting procedures can be used whether you are using
the graphical user interface or the command-line interface of PGP Whole Disk
Encryption.
Encryption Does Not Begin ..................................................................... 82
Encryption Does Not Finish..................................................................... 83
Problems at PGP BootGuard ................................................................... 85
Overview
The troubleshooting tips in this appendix assume:
PGP Desktop or PGP WDE is correctly installed on the system.
The PGP software is licensed to support PGP WDE.
Refer to the section called "Licensing PGP Whole Disk Encryption" in the
"Protecting Disks with PGP Whole Disk Encryption" chapter of the
Desktop User's Guide
You have the PGP Desktop or PGP WDE user documentation available.
PGP Desktop documentation is installed onto your computer during the
installation process. To view it, select
Documentation
Document Format (PDF) files. You can view and print these files with
Adobe Acrobat Reader, available on the
http://www.adobe.com).
(
Before using PGP Whole Disk Encryption Command Line to troubleshoot
problems with PGP Whole Disk Encryption, PGP Corporation recommends
checking existing resources for information about the issue you are
experiencing:
for more information.
Start > Programs > PGP >
. All documents are saved as Adobe Acrobat Portable
Adobe Web site
81
PGP
PGP Whole Disk Encryption Command Line Troubleshooting
The PGP Desktop Release Notes include the latest information available
about PGP WDE, including system requirements and known
incompatibilities.
The
PGP Desktop User's Guide describes how to prepare a drive for
encryption, how to encrypt it, and how to use it after encryption.
Encryption Does Not Begin
While the vast majority of drives can be encrypted without a problem, on some
occasions you may find a drive where the encryption process does not start.
Perform the following steps:
1Review the
encryption.
Potential issues include unsupported operating systems and software
incompatibilities. For example, to encrypt a boot disk on a Mac OS X
system, you must be using an Intel-based Macintosh. If any issues are
found, make the appropriate changes and then attempt encryption again.
2If the first attempt at encryption was made using the graphical user
interface, attempt to encrypt using PGP Whole Disk Encryption Command
Line.
Refer to the
PGP Desktop Release Notes for issues that could be blocking
--encrypt command for more information.
If encryption still will not begin, you can use PGP Whole Disk Encryption
Command Line to learn more information.
1First, determine the boot drive on the system using the --enum command.
pgpwde --enum
The response will be something like:
Total number of installed fixed/removable storage
device (excluding floppy and CDROM): 1
Disk 0 has 1 online volumes:
volume C is on partition 2 with offset 80325
Enumerate disks completed
This example shows that the system has one disk, Disk 0, which is drive
letter C and is the boot disk. You now know:
The boot drive can be whole disk encrypted, as it is Disk 0. Only boot
disks that are Disk 0 can be whole disk encrypted.
That Disk 0 is the boot disk (which you need to know for subsequent
commands).
2 Next, check the status of the boot drive using the --status command.
82
PGP Whole Disk Encryption Command Line Troubleshooting
pgpwde --status --disk 0
Disk disk 0 is not instrumented by bootguard.
Disk status completed
This example shows the response for a disk that is not whole disk
encrypted; that is, the disk is not instrumented by PGP BootGuard.
If a disk is encrypted or even partially encrypted, the response would be
something like:
pgpwde --status --disk 0
Disk disk0 is instrumented by bootguard.
Current key is valid.
Whole disk encrypted
Total sectors: 192426569 highwatermark: 192426569
Disk status completed
This response or something similar would mean that the encryption
process started but then stopped again. For information on dealing with a
drive where encryption does not finish, refer to
Encryption Does Not Finish.
If the problem continues, you will need to get further assistance.
The PGP Support forums are user community forums hosted by PGP
Corporation and monitored by PGP Corporation personnel. Check the PGP
Whole Disk Encryption forums for more information.
To access the PGP Support forums, please visit
http://forum.pgp.com).
(
The PGP Support Knowledge Base and PGP Technical Support may also be
able to assist you with your issue.
To access the PGP Support Knowledge Base or request PGP Technical
Support, please visit
https://support.pgp.com). Note that you may access portions of the
(
PGP Support Knowledge Base without a support agreement;
however, you must have a valid support agreement to request PGP
Technical Support.
Encryption Does Not Finish
Once encryption has started, most drives finish encryption normally. On some
occasions, however, the encryption process may stop on its own. The cause is
generally a problem with the drive being encrypted.
PGP Support
PGP Support Portal Web Site
If the system being encrypted loses power during the process, encryption will
automatically stop. Depending on whether or not you were using the Safe
Mode option (
--safe-mode), you have two options:
83
PGP Whole Disk Encryption Command Line Troubleshooting
If you were using Safe Mode, simply get the system back up and restart
encryption. It should resume near the point where power was lost.
If you were not using Safe Mode, get the system back up, decrypt the
portion of the drive that was encrypted, and then restart encryption.
The best practice for a drive where encryption stopped automatically is to
decrypt the partially encrypted drive, check it for problems, then start encryption
again. Be sure to
fully decrypt any drive on which encryption was started before
checking it for problems.
Note: Refer to the PGP Desktop User's Guide for extensive information
about preparing a drive for encryption.
If encryption stops before finishing (without losing power), perform the
following steps:
1Decrypt the portion of the drive that was encrypted.
You can use the PGP WDE user interface or PGP WDE command line to
decrypt.
2When the drive is fully decrypted, check the status of the boot drive using
--status command.
the
pgpwde --status --disk 0
Disk disk 0 is not instrumented by bootguard.
Disk status completed
This example shows the response for a disk that has been fully decrypted.
If the response to the
--status command shows the drive still partially
encrypted, make sure the drive is fully decrypted.
1Next, check the health of the drive.
Check the "Ensure Disk Health Before Encryption" section of the
"Protecting Disks with PGP Whole Disk Encryption" chapter of the
Desktop User's Guide
for more information.
PGP
2 Make the changes necessary to ensure the health of the drive.
3 Review the
PGP Desktop Release Notes for issues that could be affecting
encryption. If any issues are found, make the appropriate changes.
4 When all changes have been made, reboot the system.
5 Begin the encryption process again.
If the problem continues, you will need to get further assistance:
The PGP Support forums are user community forums hosted by PGP
Corporation and monitored by PGP Corporation personnel. Check the PGP
Whole Disk Encryption forums for more information.
To access the PGP Support forums, please visit
http://forum.pgp.com).
(
84
PGP Support
PGP Whole Disk Encryption Command Line Troubleshooting
The PGP Support Knowledge Base and PGP Technical Support may also be
able to assist you with your issue.
To access the PGP Support Knowledge Base or request PGP Technical
Support, please visit
https://support.pgp.com). Note that you may access portions of the
(
PGP Support Portal Web Site
PGP Support Knowledge Base without a support agreement;
however, you must have a valid support agreement to request PGP
Technical Support.
Problems at PGP BootGuard
On rare occasions, a drive may successfully encrypt but PGP BootGuard may
prevent access to the system.
Most cases involving problems at the PGP BootGuard screen involve entering
the passphrase correctly.
It's easy to spot a problem involving entering your passphrase: you enter what
you believe is the correct passphrase and press
BootGuard displays the message "Incorrect authentication, please try again"
instead of giving you access to your system.
Enter or return; PGP
If you cannot successfully enter your passphrase at the PGP BootGuard screen,
perform the following steps:
1Carefully re-enter your passphrase. You may have typed it incorrectly.
To see the characters you are typing, press
Tab then enter your
passphrase.
2 Make sure
Caps Lock is off, unless your passphrase is all capital letters.
3 Make sure you are using the correct keyboard layout. If the wrong
keyboard layout is selected, you may inadvertently be typing the wrong
characters.
Select
Keyboard on the main PGP BootGuard screen and press Enter or
return. Available keyboard layouts are displayed; the selected keyboard
layout is shown under the list. Select
Go Back and press Enter or return
to return to the main PGP BootGuard screen.
Refer to the PGP Desktop Release Notes and the PGP Desktop User's
for more information about supported keyboard layouts.
Guide
4If there are other configured users for the drive, try the passphrases of
these users.
5If you have configured local self recovery, try using it to authenticate at
PGP BootGuard. See Local Self Recovery for more information.
6If you are in an enterprise environment, contact your PGP administrator for
the PGP Whole Disk Recovery Token for the system.
If the problem continues, you will need to get further assistance.
85
PGP Whole Disk Encryption Command Line Troubleshooting
The PGP Support forums are user community forums hosted by PGP
Corporation and monitored by PGP Corporation personnel. Check the PGP
Whole Disk Encryption forums for more information.
To access the PGP Support forums, please visit
http://forum.pgp.com).
(
PGP Support
The PGP Support Knowledge Base and PGP Technical Support may also be
able to assist you with your issue.
To access the PGP Support Knowledge Base or request PGP Technical
Support, please visit
https://support.pgp.com). Note that you may access portions of the
(
PGP Support Portal Web Site
PGP Support Knowledge Base without a support agreement;
however, you must have a valid support agreement to request PGP
Technical Support.
If you are still unable to successfully access the system, you can use the
recovery CD or diskette you created before you encrypted the drive. The
recovery software will allow you to decrypt the drive. Refer to the
User's Guide
If you did
for complete information.
not create a recovery CD or diskette before you encrypted the drive,
PGP Desktop
go to the PGP Support Knowledge Base and search for article 470. This article
includes a pointer to a Web location from which you can download a recovery
CD or diskette.
86
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.