GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SYMCRYPTRUN (1)

NAME

symcryptrun - Call a simple symmetric encryption tool

CONTENTS

Synopsis
Description
See Also

SYNOPSIS

symcryptrun --class class --program program --keyfile keyfile [--decrypt|--encrypt] [inputfile]

DESCRIPTION

Sometimes simple encryption tools are already in use for a long time and there might be a desire to integrate them into the GnuPG framework. The protocols and encryption methods might be non-standard or not even properly documented, so that a full-fledged encryption tool with an interface like gpg is not doable. symcryptrun provides a solution: It operates by calling the external encryption/decryption module and provides a passphrase for a key using the standard pinentry based mechanism through gpg-agent.

Note, that symcryptrun is only available if GnuPG has been configured with \(aq--enable-symcryptrun\(aq at build time.

For encryption, the plain text must be provided on STDIN or as the argument inputfile, and the ciphertext will be output to STDOUT. For decryption vice versa.

CLASS describes the calling conventions of the external tool. Currently it must be given as \(aqconfucius\(aq. PROGRAM is the full filename of that external tool.

For the class \(aqconfucius\(aq the option --keyfile is required; keyfile is the name of a file containing the secret key, which may be protected by a passphrase. For detailed calling conventions, see the source code.

Note, that gpg-agent must be running before starting symcryptrun.

The following additional options may be used:

-v
--verbose
Output additional information while running.

-q
--quiet
Try to be as quiet as possible.

--homedir dir
  Set the name of the home directory to dir. If this option is not used, the home directory defaults to \(oq~/.gnupg\(cq. It is only recognized when given on the command line. It also overrides any home directory stated through the environment variable \(oqGNUPGHOME\(cq or (on W32 systems) by means of the Registry entry HKCU\Software\GNU\GnuPG:HomeDir.

--log-file file
  Append all logging output to file. Default is to write logging information to STDERR.

The possible exit status codes of symcryptrun are:

0 Success.
1 Some error occured.
2 No valid passphrase was provided.
3 The operation was canceled by the user.

SEE ALSO

gpg(1), gpgsm(1), gpg-agent(1),

The full documentation for this tool is maintained as a Texinfo manual. If GnuPG and the info program are properly installed at your site, the command

info gnupg

should give you access to the complete manual including a menu structure and an index.

Search for    or go to Top of page |  Section 1 |  Main Index


GnuPG 2.0.29 SYMCRYPTRUN (1) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.