PGP NetShare Command Line 10.1 Operating instructions

Type
Operating instructions
PGP NetShare Command Line
User's Guide
Version Information
PGP NetShare Command Line User's Guide. 10.1. Released September 2010.
Copyright Information
Copyright © 1991-2010 by PGP Corporation. All Rights Reserved. No part of this document can be reproduced or transmitted in any form or by any
means, electronic or mechanical, for any purpose, without the express written permission of PGP Corporation.
Trademark Information
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
PGP Support (https://support.pgp.com). PGP Corporation
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.
Acknowledgments
This product includes or may include:
-- The Zip and ZLib compression code, created by Mark Adler and Jean-Loup Gailly, is used with permission from the free Info-ZIP implementation,
developed by zlib (
http://www.zlib.net). -- Libxml2, the XML C parser and toolkit developed for the Gnome project and distributed and copyrighted
under the MIT License found at
http://www.opensource.org/licenses/mit-license.html. Copyright © 2007 by the Open Source Initiative. -- bzip2 1.0, a
freely available high-quality data compressor, is copyrighted by Julian Seward, © 1996-2005. -- Application server (
http://jakarta.apache.org/), web
server (
http://www.apache.org/), Jakarta Commons (http://jakarta.apache.org/commons/license.html) and log4j, a Java-based library used to parse
HTML, developed by the Apache Software Foundation. The license is at
www.apache.org/licenses/LICENSE-2.0.txt. -- Castor, an open-source, data-
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
http://www.castor.org/license.html. -- Xalan, an open-source software library from the Apache Software
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
http://xml.apache.org/xalan-j/#license1.1. -- Apache Axis is an implementation of the SOAP ("Simple Object Access
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
under an Apache-style license, available at
http://mx4j.sourceforge.net/docs/ch01s06.html. -- jpeglib version 6a is based in part on the work of the
Independent JPEG Group. (
http://www.ijg.org/) -- libxslt the XSLT C library developed for the GNOME project and used for XML transformations is
distributed under the MIT License
http://www.opensource.org/licenses/mit-license.html. -- PCRE Perl regular expression compiler, copyrighted and
distributed by University of Cambridge. ©1997-2006. The license agreement is at
http://www.pcre.org/license.txt. -- BIND Balanced Binary Tree Library
and Domain Name System (DNS) protocols developed and copyrighted by Internet Systems Consortium, Inc. (
http://www.isc.org) -- Free BSD
implementation of daemon developed by The FreeBSD Project, © 1994-2006. -- Simple Network Management Protocol Library developed and
copyrighted by Carnegie Mellon University © 1989, 1991, 1992, Networks Associates Technology, Inc, © 2001- 2003, Cambridge Broadband Ltd. ©
2001- 2003, Sun Microsystems, Inc., © 2003, Sparta, Inc, © 2003-2006, Cisco, Inc and Information Network Center of Beijing University of Posts and
Telecommunications, © 2004. The license agreement for these is at
http://net-snmp.sourceforge.net/about/license.html. -- NTP version 4.2 developed
by Network Time Protocol and copyrighted to various contributors. -- Lightweight Directory Access Protocol developed and copyrighted by OpenLDAP
Foundation. OpenLDAP is an open-source implementation of the Lightweight Directory Access Protocol (LDAP). Copyright © 1999-2003, The
OpenLDAP Foundation. The license agreement is at
http://www.openldap.org/software/release/license.html. Secure shell OpenSSH developed by
OpenBSD project is released by the OpenBSD Project under a BSD-style license, available at
http://www.openbsd.org/cgi-
bin/cvsweb/src/usr.bin/ssh/LICENCE?rev=HEAD. -- PC/SC Lite is a free implementation of PC/SC, a specification for SmartCard integration is released
under the BSD license. -- Postfix, an open source mail transfer agent (MTA), is released under the IBM Public License 1.0, available at
http://www.opensource.org/licenses/ibmpl.php. -- PostgreSQL, a free software object-relational database management system, is released under a
BSD-style license, available at
http://www.postgresql.org/about/licence. -- PostgreSQL JDBC driver, a free Java program used to connect to a
PostgreSQL database using standard, database independent Java code, (c) 1997-2005, PostgreSQL Global Development Group, is released under a
BSD-style license, available at
http://jdbc.postgresql.org/license.html. -- PostgreSQL Regular Expression Library, a free software object-relational
database management system, is released under a BSD-style license, available at
http://www.postgresql.org/about/licence. -- 21.vixie-cron is the Vixie
version of cron, a standard UNIX daemon that runs specified programs at scheduled times. Copyright © 1993, 1994 by Paul Vixie; used by permission. -
- 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
http://www.jacorb.org/lgpl.html. Copyright © 2006 The JacORB Project. -- TAO (The ACE ORB)
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
http://www.cs.wustl.edu/~schmidt/ACE-copying.html. -- libcURL, a library for
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
http://thunk.org/hg/e2fsprogs/?file/fe55db3e508c/lib/uuid/COPYING. Copyright (C) 1996, 1997 Theodore Ts'o. --
libpopt, a library that parses command line options, is released under the terms of the GNU Free Documentation License available at
http://directory.fsf.org/libs/COPYING.DOC. Copyright © 2000-2003 Free Software Foundation, Inc. -- gSOAP, a development tool for Windows clients
to communicate with the Intel Corporation AMT chipset on a motherboard, is distributed under the gSOAP Public License version 1.3b, available at
4
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
http://opensource.org/licenses/cpl1.0.php. -- The Perl Kit provides several independent utilities used to
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
http://www.gnu.org/licenses/lgpl.html. -- Yahoo! User Interface (YUI) library version 2.5.2, a Web UI interface library for AJAX.
Copyright (c) 2009, Yahoo! Inc. All rights reserved. Released under a BSD-style license, available at
http://developer.yahoo.com/yui/license.html. --
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
http://json-lib.sourceforge.net/license.html. -- EZMorph, used by JSON-lib, is distributed under the Apache 2.0 license,
available at
http://ezmorph.sourceforge.net/license.html. -- Apache Commons Lang, used by JSON-lib, is distributed under the Apache 2.0 license,
available at
http://commons.apache.org/license.html. -- Apache Commons BeanUtils, used by JSON-lib, is distributed under the Apache 2.0 license,
available at
http://commons.apache.org/license.html. -- SimpleIni is an .ini format file parser and provides the ability to read and write .ini files, a
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
http://www.opensource.org/licenses/mit-
license.html. Copyright (c) 2005-2009 by Mike Sharov <[email protected]ceforge.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
http://www.opensource.org/licenses/bsd-
license.php. Copyright 2008 Google Inc. All rights reserved.
Additional acknowledgements and legal notices are included as part of the PGP Universal Server.
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.
i
Contents
Introduction 3
About PGP NetShare 3
About PGP NetShare Command Line 4
Audience 4
System Requirements 4
Installing and Uninstalling 4
Upgrading to Version 10.1 5
The Command-Line Interface 7
Overview 7
Scripting 8
Editing the Path on a System 8
Configuration File 9
Environment Variables 10
Creating Environment Variables 11
Passphrases 12
XML Output 12
Searching for Keys on Remote Servers 13
Commands 15
--version 16
--help (-h) 17
--encrypt (-e) 17
--decrypt 20
--reencrypt (-r) 21
--reencrypt-full 23
--reencrypt-delta 25
--reencrypt-clone 27
--list (-l) 28
--list-xml 29
--verify (-v) 29
--lock-all 30
--unlock 30
--set-driver 31
--get-driver 32
Options 33
--recipient (-r) 35
--recipient-owner 35
--recipient-operator 35
ii
PGP NetShare Command Line Contents
--recipient-remove 35
--recipient-xml 36
--group (-g) 36
--group-operator 37
--signer (s) 37
--signer-passphrase 37
--signer-passphrase-fd 37
--passphrase (-p) 38
--passphrase-fd 38
--adk 39
--public-keyring 39
--private-keyring 39
--universal-server 40
--auth-username 40
--auth-passphrase 40
--auth-passphrase-fd 41
--input (-i) 41
--output (-o) 41
--output-file 41
--home-dir 42
Flags 43
--verbose 43
--remote 44
--force 44
--halt-on-error 44
--local-mode 44
--preserve 45
--quiet 45
Quick Reference 47
Commands 47
Options 48
Flags 48
3
1
Introduction
This User's Guide tells you how to use the PGP NetShare Command Line
application.
In This Chapter
About PGP NetShare ................................................................................. 3
About PGP NetShare Command Line ....................................................... 4
Audience.................................................................................................... 4
System Requirements............................................................................... 4
Installing and Uninstalling .......................................................................... 4
Upgrading to Version 10.1 ......................................................................... 5
About PGP NetShare
PGP NetShare is a software product that lets a defined set of users access files
in a shared, protected space (such as on a corporate file server, in a shared
folder, or even removable media such as a thumb drive).
The files are protected by encryption, but continue to appear (to the users who
have access rights) as normal application files. Anyone without access rights to
the files, but who can access the shared space, can see the files but does not
have access to the content.
PGP NetShare can be purchased as a standalone product, as one product
among several products for example, PGP Desktop Email or PGP Whole Disk
Encryption), or as part of PGP Desktop.
For more information about PGP NetShare, see the:
PGP Desktop User's Guide
PGP NetShare Quick Start Guide
PGP NetShare Data Sheet
4
PGP NetShare Command Line Introduction
About PGP NetShare Command Line
PGP NetShare Command Line gives you access to PGP NetShare functionality
using a command-line interface.
Accessing PGP NetShare Command Line functions from the command line is
useful for scripting PGP NetShare functions, troubleshooting problems, or if the
graphical user interface is not available.
Note: Not all PGP NetShare functions are available via the command line.
PGP NetShare Command Line is always in one of two operation modes:
desktop. PGP Desktop is also installed on the system.
standalone. PGP Desktop is not installed on the same system.
Run the
--version command to see what operation mode PGP NetShare
Command Line is in.
When you run the
--help command, only those commands, options, and flags
that are available in the current operation mode are displayed.
Audience
This User's Guide is for anyone who is going to be using PGP NetShare
Command Line to perform PGP NetShare functions from the command line.
It assumes you are familiar with using PGP NetShare via the graphical user
interface in the standalone product or as part of PGP Desktop.
System Requirements
The system requirements for PGP NetShare Command Line are the same as for
PGP NetShare itself; if PGP NetShare (standalone or as part of PGP Desktop)
installs on a system, PGP NetShare Command Line (pgpnetshare.exe) will also
install and be usable.
Installing and Uninstalling
PGP NetShare Command Line (pgpnetshare.exe) is installed automatically when
PGP NetShare is installed on a system.
5
PGP NetShare Command Line Introduction
The default location for either installation is: C:\Program Files\PGP
Corporation\PGP Desktop\pgpnetshare.exe
.
To uninstall PGP NetShare Command Line, simply uninstall PGP NetShare or
PGP Desktop.
Upgrading to Version 10.1
Changes were made to PGP NetShare Command Line in Version 10.1, resulting
in some commands, options, and flags from previous versions being removed.
If you scripted previous versions of PGP NetShare Command Line, make sure
to check your scripts to ensure that they do not reference commands, options,
or flags that are no longer in the product.
7
2
The Command-Line
Interface
This section describes the command-line interface of PGP NetShare Command
Line.
In This Chapter
Overview ................................................................................................... 7
Scripting..................................................................................................... 8
Editing the Path on a System .................................................................... 8
Configuration File....................................................................................... 9
Environment Variables............................................................................. 10
Passphrases............................................................................................. 12
XML Output............................................................................................. 12
Searching for Keys on Remote Servers .................................................. 13
Overview
PGP NetShare Command Line uses a command-line interface. You enter a valid
command at the command prompt and press
Enter. PGP NetShare Command
Line responds appropriately based on what you entered (if you entered a valid
command) or with an error message (if you entered an invalid or incorrectly
structured command).
All PGP NetShare Command Line commands have a
long form: the text
"pgpnetshare", a space, two hyphens "
--", and then the command name.
For example:
C:\>pgpnetshare --help [Enter]
is the command to display the built-in help information.
(The command prompt, C:\>, and [Enter] will no longer be shown in examples.)
A few commands also have a
short form: one hyphen and then a single letter
that substitutes for the command name. For example:
pgpnetshare -h
is the short form of the command to access help.
8
PGP NetShare Command Line The Command-Line Interface
Short forms of commands are noted where appropriate.
Scripting
PGP NetShare Command Line commands can easily be inserted into scripts for
automating common tasks, such as creating a Protected Folder, re-encrypting a
Protected Folder, or verifying files and folders in a Protected Folder.
PGP NetShare Command Line commands can easily be added to scripts written
with scripting languages such as Perl or Python.
Editing the Path on a System
By default, the PGP NetShare Command Line application, pgpnetshare.exe, is
installed in C:\Program Files\PGP Corporation\PGP Desktop\.
To use PGP NetShare Command Line using the Windows Command Prompt
application, you need to navigate to the PGP NetShare Command Line directory
to execute commands (or the commands will fail).
If you wish to be able to execute PGP NetShare 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 NetShare Command
Line application.
To add the PGP NetShare 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 System Properties screen, click Environment
Variables
.
5 In the
System Variables section at the bottom of the Environment
Variables
screen, select Path, then click Edit.
6 At the end of the existing
Variable value line, enter a semicolon (;), then
add the path to the PGP NetShare Command Line application
7 Click OK to save the change, then close the windows you opened.
9
PGP NetShare Command Line The Command-Line Interface
To add the PGP NetShare Command Line application to your path on a
Windows XP or 2000 system:
1 On the Windows desktop, right click the
My Computer icon, then select
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
System Variables section at the bottom of the Environment
Variables
screen, select Path, then click Edit.
5 At the end of the existing Variable value line, enter a semicolon (;), then
add the path to the PGP NetShare Command Line application.
6 Click
OK to save the change, then close the windows you opened.
Configuration File
The PGP NetShare Command Line configuration file holds settings that affect
how PGP NetShare Command Line works.
The PGP NetShare Command Line configuration file (PGPprefs.xml) cannot be
changed by PGP NetShare Command Line itself: any changes need to be edited
manually.
The PGP NetShare Command Line configuration file is located:
Windows XP:
C:\Documents and Settings\[Local User]\Application
Data\PGP Corporation\PGP\
.
Windows 7 and Vista: C:\Users\[Local User]\AppData\Roaming\PGP
Corporation\PGP\
.
Note: Configuration file settings in PGPprefs.xml are shared among all PGP
Corporation applications on the system.
Configuration file settings you can use with PGP NetShare Command Line are:
Output File (CLoutputFile). Specifies the output file (default is not set in
the configuration file; defaults to stdout). The output file is used for output
messages. See
--output-file for more information.
Private keyring file (privateKeyringFile). The filename or path and
filename to the private keyring file. The default is
secring.skr, located in
the default PGP NetShare Command Line home directory. See
--private-
keyring
for more information.
Public keyring file (publicKeyringFile). The filename or path and
filename to the public keyring file. The default is
pubring.pkr, located in
the default PGP NetShare Command Line home directory. See
--public-
keyring
for more information.
10
PGP NetShare Command Line The Command-Line Interface
Keyservers (keyservers). Specifies the keyserver(s) to be searched for
keys.
Always encrypt to keys (alwaysEncryptToKeys). Specifies keys that
should always be added implicitly when encrypting and re-encrypting.
Configured Universal Server (adminGroupServer). Specifies the PGP
Universal Server used for activity logging, key and Active Directory group
queries. Only available in configured installs with PGP Desktop.
Enrollment Cookie (adminConfigCookie). Authenticates the user
against a PGP Universal Server for an operation. Only available in
configured installs with PGP Desktop.
Location Blacklist (blackListContent, enableBlackList). Entries
in the Blacklist specify those locations that should never be encrypted by
PGP NetShare Command Line.
Organization ADK (ADKKeyID, useADK). Specifies the centralized
organization ADK (Additional Decryption Key). Usually only available in
configured installs with PGP Desktop.
Policy ADK (policyADK, usePolicyADK). Specifies a policy-specific
ADK. Usually only available in configured installs with PGP Desktop.
Manage Individual Files (allowAdvancedUserMode). Controls whether
the user is allowed to manage (encrypt, decrypt, or re-encrypt) single files,
as opposed to folders that might contain files.
Environment Variables
PGP NetShare Command Line behavior can be changed using environment
variables.
Environment variables have the lowest priority compared to the command line
and the configuration file. Settings for either will override environment variables.
However, if a value for an item is not specified on the command line or in the
configuration file, the environment variable will be used. Environment variables
cannot be disabled; if they are present, they are implemented. To disable an
environment variable, remove it. Setting a Boolean environment variable will
activate it, regardless of the value to which it is set.
Environment variables that can be implemented for PGP NetShare Command
Line are:
PGP_LOCAL_MODE. This is a Boolean environment variable that forces
PGP NetShare Command Line to run in local mode. The default is unset.
See
--local-mode for more information.
Usage:
PGP_LOCAL_MODE=1
11
PGP NetShare Command Line The Command-Line Interface
PGP_HOME_DIR. This is a string environment variable that overrides the
default home directory, pointing it to the path supplied in the variable. The
default is unset. See
--home-dir for more information.
Usage:
PGP_HOME_DIR=C:\Documents and Settings\<current
user>\Application Data\PGP Corporation\PGP\
PGP_PASSPHRASE. This is a string environment variable that lets you set
your passphrase. The default is unset. See
--passphrase for more
information.
Usage:
PGP_PASSPHRASE="1Killer*Whale"
Creating Environment Variables
PGP NetShare Command Line lets you create environment variables to control
certain behaviors.
To create
an environment variable on a Windows 7 system:
1 Right click the
Computer icon on your desktop and choose Properties.
2 On the System window, click on Advanced system settings in the left
pane.
3 On the
System Properties window, select the Advanced tab and then
click on
Environment Variables near the bottom of the window.
4 In the
User Variables section of the Environment Variables screen, click
New.
5 In the Variable name field, enter a name for the variable you are creating.
For example, if you were setting the PGP_HOME_DIR environment
variable, you would enter:
PGP_HOME_DIR
6 In the Variable value field, enter a value appropriate for the variable you
are creating.
For example, if you were setting the PGP_HOME_DIR environment
variable, you could enter:
C:\PGP\PGPhomedir\
7 Click OK.
The Environment Variables screen reappears. The environment variable
you created displays in the
User variables list.
8 Click OK.
9 On the System Properties window, click Apply then click OK.
10 Close the
System window.
12
PGP NetShare Command Line The Command-Line Interface
Passphrases
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 when
entered on the command line.
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.
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 on the
command line. 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.
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.
XML Output
PGP NetShare Command Line gives you the option to save some output in XML
format.
If you desire properly formatted XML output, do not copy the XML output from
the console window and then paste it; this could introduce extraneous newline
characters into the output.
Instead, use either of these two methods:
Use the
--output-file option.
pgpnetshare --list-xml <XMLcontent> output-file
'c:\acllist-xml'
Pipe the output directly to a file: pgpnetshare --list-xml
<XMLcontent> > 'c:\acllist-xml'
13
PGP NetShare Command Line The Command-Line Interface
Searching for Keys on Remote Servers
By default, PGP NetShare Command Line searches for keys on the local
system.
If you want PGP NetShare Command Line to search for keys on a remote
keyserver, a PGP Universal Server for example, you must explicitly tell it to
search there.
There are two commands to search for keys on a remote keyserver:
--universal-server searches for keys on the specified PGP Universal
Server.
--remote searches for keys on the specified keyserver.
15
3
Commands
This section describes PGP NetShare Command Line commands:
--version, which displays PGP NetShare Command Line version
information.
--help, which provides a brief description of the commands and options
available in PGP NetShare Command Line.
--encrypt, which creates a Protected Folder and specifies who can
access the files.
--decrypt, which decrypts an existing Protected Folder and the files in it.
--reencrypt, which modifies who can access files in a Protected Folder.
--reencrypt-full, which modifies who can access files in a Protected
Folder and reencrypts the files.
--reencrypt-delta, which reencrypts files and folders in delta mode.
--reencrypt-clone, which reencrypts files and folders in clone mode.
--list, which lists the file or folder access control list (ACL).
--list-xml, which lists the file or folder ACL in XML format.
--verify, which displays information about the specified protected file or
directory.
--lock-all, which clears symmetric keys cached by PGP NetShare
Command Line
--unlock, which unlocks a file or folder.
--set-driver, which sets the state of the PGP NetShare Command Line
driver, active or passive.
--get-driver, which displays the current state of the PGP NetShare
Command Line driver, active or passive.
16
PGP NetShare Command Line Commands
In This Chapter
--version ................................................................................................... 16
--help (-h) .................................................................................................. 17
--encrypt (-e)............................................................................................. 17
--decrypt................................................................................................... 20
--reencrypt (-r) .......................................................................................... 21
--reencrypt-full.......................................................................................... 23
--reencrypt-delta....................................................................................... 25
--reencrypt-clone...................................................................................... 27
--list (-l) ..................................................................................................... 28
--list-xml ................................................................................................... 29
--verify (-v) ................................................................................................ 29
--lock-all.................................................................................................... 30
--unlock .................................................................................................... 30
--set-driver................................................................................................ 31
--get-driver................................................................................................ 32
--version
The --version command displays information about the version of PGP
NetShare Command Line you are using, including the current operation mode:
desktop or standalone.
The usage format is:
pgpnetshare --version [options]
Where:
[options] let you modify the command. Options are:
--verbose, which displays additional information about the operation.
Examples:
pgpnetshare --version
PGP NetShare Command Line responds with version information in the
format:
PGP NetShare Command Line version 10.1.0 (Build 999),
mode(desktop)
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28
  • Page 29 29
  • Page 30 30
  • Page 31 31
  • Page 32 32
  • Page 33 33
  • Page 34 34
  • Page 35 35
  • Page 36 36
  • Page 37 37
  • Page 38 38
  • Page 39 39
  • Page 40 40
  • Page 41 41
  • Page 42 42
  • Page 43 43
  • Page 44 44
  • Page 45 45
  • Page 46 46
  • Page 47 47
  • Page 48 48
  • Page 49 49
  • Page 50 50
  • Page 51 51
  • Page 52 52
  • Page 53 53

PGP NetShare Command Line 10.1 Operating instructions

Type
Operating instructions

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI