man/pgg.texi

   1 \input texinfo                  @c -*-texinfo-*-
   2
   3 @setfilename ../info/pgg
   4
   5 @set VERSION 0.1
   6
   7
   8 @copying
   9 This file describes PGG, an Emacs interface to various PGP implementations.
  10
  11 Copyright @copyright{} 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
  12 Copyright @copyright{} 2001 Daiki Ueno.
  13
  14 @quotation
  15 Permission is granted to copy, distribute and/or modify this document
  16 under the terms of the GNU Free Documentation License, Version 1.2 or
  17 any later version published by the Free Software Foundation; with no
  18 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  19 Texts.  A copy of the license is included in the section entitled ``GNU
  20 Free Documentation License.''
  21 @end quotation
  22 @end copying
  23
  24 @dircategory Emacs
  25 @direntry
  26 * PGG: (pgg).   Emacs interface to various PGP implementations.
  27 @end direntry
  28
  29 @settitle PGG @value{VERSION}
  30
  31
  32 @titlepage
  33 @title PGG
  34
  35 @author by Daiki Ueno
  36 @page
  37
  38 @vskip 0pt plus 1filll
  39 @insertcopying
  40 @end titlepage
  41 @page
  42
  43 @node Top
  44 @top PGG
  45 This manual describes PGG.  PGG is an interface library between Emacs
  46 and various tools for secure communication.  PGG also provides a simple
  47 user interface to encrypt, decrypt, sign, and verify MIME messages.
  48
  49 @menu
  50 * Overview::                    What PGG is.
  51 * Prerequisites::               Complicated stuff you may have to do.
  52 * How to use::                  Getting started quickly.
  53 * Architecture::
  54 * Parsing OpenPGP packets::
  55 * Function Index::
  56 * Variable Index::
  57 @end menu
  58
  59 @node Overview
  60 @chapter Overview
  61
  62 PGG is an interface library between Emacs and various tools for secure
  63 communication.  Even though Mailcrypt has similar feature, it does not
  64 deal with detached PGP messages, normally used in PGP/MIME
  65 infrastructure.  This was the main reason why I wrote the new library.
  66
  67 PGP/MIME is an application of MIME Object Security Services (RFC1848).
  68 The standard is documented in RFC2015.
  69
  70 @node Prerequisites
  71 @chapter Prerequisites
  72
  73 PGG requires at least one implementation of privacy guard system.
  74 This document assumes that you have already obtained and installed them
  75 and that you are familiar with its basic functions.
  76
  77 By default, PGG uses GnuPG.  If you are new to such a system, I
  78 recommend that you should look over the GNU Privacy Handbook (GPH)
  79 which is available at @uref{http://www.gnupg.org/documentation/}.
  80
  81 When using GnuPG, we recommend the use of the @code{gpg-agent}
  82 program, which is distributed with versions 2.0 and later of GnuPG.
  83 This is a daemon to manage private keys independently from any
  84 protocol, and provides the most secure way to input and cache your
  85 passphrases (@pxref{Caching passphrase}).  By default, PGG will
  86 attempt to use @code{gpg-agent} if it is running.  @xref{Invoking
  87 GPG-AGENT,,,gnupg,Using the GNU Privacy Guard}.
  88
  89 PGG also supports Pretty Good Privacy version 2 or version 5.
  90
  91 @node How to use
  92 @chapter How to use
  93
  94 The toplevel interface of this library is quite simple, and only
  95 intended to use with public-key cryptographic operation.
  96
  97 To use PGG, evaluate following expression at the beginning of your
  98 application program.
  99
 100 @lisp
 101 (require 'pgg)
 102 @end lisp
 103
 104 If you want to check existence of pgg.el at runtime, instead you can
 105 list autoload setting for desired functions as follows.
 106
 107 @lisp
 108 (autoload 'pgg-encrypt-region "pgg"
 109   "Encrypt the current region." t)
 110 (autoload 'pgg-encrypt-symmetric-region "pgg"
 111   "Encrypt the current region with symmetric algorithm." t)
 112 (autoload 'pgg-decrypt-region "pgg"
 113   "Decrypt the current region." t)
 114 (autoload 'pgg-sign-region "pgg"
 115   "Sign the current region." t)
 116 (autoload 'pgg-verify-region "pgg"
 117   "Verify the current region." t)
 118 (autoload 'pgg-insert-key "pgg"
 119   "Insert the ASCII armored public key." t)
 120 (autoload 'pgg-snarf-keys-region "pgg"
 121   "Import public keys in the current region." t)
 122 @end lisp
 123
 124 @menu
 125 * User Commands::
 126 * Selecting an implementation::
 127 * Caching passphrase::
 128 * Default user identity::
 129 @end menu
 130
 131 @node User Commands
 132 @section User Commands
 133
 134 At this time you can use some cryptographic commands.  The behavior of
 135 these commands relies on a fashion of invocation because they are also
 136 intended to be used as library functions.  In case you don't have the
 137 signer's public key, for example, the function @code{pgg-verify-region}
 138 fails immediately, but if the function had been called interactively, it
 139 would ask you to retrieve the signer's public key from the server.
 140
 141 @deffn Command pgg-encrypt-region start end recipients &optional sign passphrase
 142 Encrypt the current region between @var{start} and @var{end} for
 143 @var{recipients}.  When the function were called interactively, you
 144 would be asked about the recipients.
 145
 146 If encryption is successful, it replaces the current region contents (in
 147 the accessible portion) with the resulting data.
 148
 149 If optional argument @var{sign} is non-@code{nil}, the function is
 150 request to do a combined sign and encrypt.  This currently is
 151 confirmed to work with GnuPG, but might not work with PGP or PGP5.
 152
 153 If optional @var{passphrase} is @code{nil}, the passphrase will be
 154 obtained from the passphrase cache or user.
 155 @end deffn
 156
 157 @deffn Command pgg-encrypt-symmetric-region &optional start end passphrase
 158 Encrypt the current region between @var{start} and @var{end} using a
 159 symmetric cipher.  After invocation you are asked for a passphrase.
 160
 161 If optional @var{passphrase} is @code{nil}, the passphrase will be
 162 obtained from the passphrase cache or user.
 163
 164 symmetric-cipher encryption is currently only implemented for GnuPG.
 165 @end deffn
 166
 167 @deffn Command pgg-decrypt-region start end &optional passphrase
 168 Decrypt the current region between @var{start} and @var{end}.  If
 169 decryption is successful, it replaces the current region contents (in
 170 the accessible portion) with the resulting data.
 171
 172 If optional @var{passphrase} is @code{nil}, the passphrase will be
 173 obtained from the passphrase cache or user.
 174 @end deffn
 175
 176 @deffn Command pgg-sign-region start end &optional cleartext passphrase
 177 Make the signature from text between @var{start} and @var{end}.  If the
 178 optional third argument @var{cleartext} is non-@code{nil}, or the
 179 function is called interactively, it does not create a detached
 180 signature.  In such a case, it replaces the current region contents (in
 181 the accessible portion) with the resulting data.
 182
 183 If optional @var{passphrase} is @code{nil}, the passphrase will be
 184 obtained from the passphrase cache or user.
 185 @end deffn
 186
 187 @deffn Command pgg-verify-region start end &optional signature fetch
 188 Verify the current region between @var{start} and @var{end}.  If the
 189 optional third argument @var{signature} is non-@code{nil}, it is treated
 190 as the detached signature file of the current region.
 191
 192 If the optional 4th argument @var{fetch} is non-@code{nil}, or the
 193 function is called interactively, we attempt to fetch the signer's
 194 public key from the key server.
 195 @end deffn
 196
 197 @deffn Command pgg-insert-key
 198 Retrieve the user's public key and insert it as ASCII-armored format.
 199 @end deffn
 200
 201 @deffn Command pgg-snarf-keys-region start end
 202 Collect public keys in the current region between @var{start} and
 203 @var{end}, and add them into the user's keyring.
 204 @end deffn
 205
 206 @node Selecting an implementation
 207 @section Selecting an implementation
 208
 209 Since PGP has a long history and there are a number of PGP
 210 implementations available today, the function which each one has differs
 211 considerably.  For example, if you are using GnuPG, you know you can
 212 select cipher algorithm from 3DES, CAST5, BLOWFISH, and so on, but on
 213 the other hand the version 2 of PGP only supports IDEA.
 214
 215 Which implementation is used is controlled by the @code{pgg-scheme}
 216 variable.  If it is @code{nil} (the default), the value of the
 217 @code{pgg-default-scheme} variable will be used instead.
 218
 219 @defvar pgg-scheme
 220 Force specify the scheme of PGP implementation.  The value can be set to
 221 @code{gpg}, @code{pgp}, and @code{pgp5}.  The default is @code{nil}.
 222 @end defvar
 223
 224 @defvar pgg-default-scheme
 225 The default scheme of PGP implementation.  The value should be one of
 226 @code{gpg}, @code{pgp}, and @code{pgp5}.  The default is @code{gpg}.
 227 @end defvar
 228
 229 @node Caching passphrase
 230 @section Caching passphrase
 231
 232 PGG provides a simple passphrase caching mechanism.  If you want to
 233 arrange the interaction, set the variable @code{pgg-read-passphrase}.
 234
 235 @defvar pgg-cache-passphrase
 236 If non-@code{nil}, store passphrases.  The default value of this
 237 variable is @code{t}.  If you are worried about security issues,
 238 however, you could stop the caching of passphrases by setting this
 239 variable to @code{nil}.
 240 @end defvar
 241
 242 @defvar pgg-passphrase-cache-expiry
 243 Elapsed time for expiration in seconds.
 244 @end defvar
 245
 246 @defvar pgg-gpg-use-agent
 247 When using GnuPG (gpg) as PGP scheme you can use @code{gpg-agent} for
 248 caching@footnote{Actually @code{gpg-agent} does not cache passphrases
 249 but private keys.  On the other hand, from a users point of view this
 250 technical difference isn't visible.}.  It defaults to @code{t}.
 251 Setting this to @code{nil} is not recommended.
 252 @end defvar
 253
 254 @node Default user identity
 255 @section Default user identity
 256
 257 The PGP implementation is usually able to select the proper key to use
 258 for signing and decryption, but if you have more than one key, you may
 259 need to specify the key id to use.
 260
 261 @defvar pgg-default-user-id
 262 User ID of your default identity.  It defaults to the value returned
 263 by @samp{(user-login-name)}.  You can customize this variable.
 264 @end defvar
 265
 266 @defvar pgg-gpg-user-id
 267 User ID of the GnuPG default identity.  It defaults to @samp{nil}.
 268 This overrides @samp{pgg-default-user-id}.  You can customize this
 269 variable.
 270 @end defvar
 271
 272 @defvar pgg-pgp-user-id
 273 User ID of the PGP 2.x/6.x default identity.  It defaults to
 274 @samp{nil}.  This overrides @samp{pgg-default-user-id}.  You can
 275 customize this variable.
 276 @end defvar
 277
 278 @defvar pgg-pgp5-user-id
 279 User ID of the PGP 5.x default identity.  It defaults to @samp{nil}.
 280 This overrides @samp{pgg-default-user-id}.  You can customize this
 281 variable.
 282 @end defvar
 283
 284 @node Architecture
 285 @chapter Architecture
 286
 287 PGG introduces the notion of a "scheme of PGP implementation" (used
 288 interchangeably with "scheme" in this document).  This term refers to a
 289 singleton object wrapped with the luna object system.
 290
 291 Since PGG was designed for accessing and developing PGP functionality,
 292 the architecture had to be designed not just for interoperability but
 293 also for extensiblity.  In this chapter we explore the architecture
 294 while finding out how to write the PGG backend.
 295
 296 @menu
 297 * Initializing::
 298 * Backend methods::
 299 * Getting output::
 300 @end menu
 301
 302 @node Initializing
 303 @section Initializing
 304
 305 A scheme must be initialized before it is used.
 306 It had better guarantee to keep only one instance of a scheme.
 307
 308 The following code is snipped out of @file{pgg-gpg.el}.  Once an
 309 instance of @code{pgg-gpg} scheme is initialized, it's stored to the
 310 variable @code{pgg-scheme-gpg-instance} and will be reused from now on.
 311
 312 @lisp
 313 (defvar pgg-scheme-gpg-instance nil)
 314
 315 (defun pgg-make-scheme-gpg ()
 316   (or pgg-scheme-gpg-instance
 317       (setq pgg-scheme-gpg-instance
 318             (luna-make-entity 'pgg-scheme-gpg))))
 319 @end lisp
 320
 321 The name of the function must follow the
 322 regulation---@code{pgg-make-scheme-} follows the backend name.
 323
 324 @node Backend methods
 325 @section Backend methods
 326
 327 In each backend, these methods must be present.  The output of these
 328 methods is stored in special buffers (@ref{Getting output}), so that
 329 these methods must tell the status of the execution.
 330
 331 @deffn Method pgg-scheme-lookup-key scheme string &optional type
 332 Return keys associated with @var{string}.  If the optional third
 333 argument @var{type} is non-@code{nil}, it searches from the secret
 334 keyrings.
 335 @end deffn
 336
 337 @deffn Method pgg-scheme-encrypt-region scheme start end recipients &optional sign passphrase
 338 Encrypt the current region between @var{start} and @var{end} for
 339 @var{recipients}.  If @var{sign} is non-@code{nil}, do a combined sign
 340 and encrypt.  If encryption is successful, it returns @code{t},
 341 otherwise @code{nil}.
 342 @end deffn
 343
 344 @deffn Method pgg-scheme-encrypt-symmetric-region scheme start end &optional passphrase
 345 Encrypt the current region between @var{start} and @var{end} using a
 346 symmetric cipher and a passphrases.  If encryption is successful, it
 347 returns @code{t}, otherwise @code{nil}.  This function is currently only
 348 implemented for GnuPG.
 349 @end deffn
 350
 351 @deffn Method pgg-scheme-decrypt-region scheme start end &optional passphrase
 352 Decrypt the current region between @var{start} and @var{end}.  If
 353 decryption is successful, it returns @code{t}, otherwise @code{nil}.
 354 @end deffn
 355
 356 @deffn Method pgg-scheme-sign-region scheme start end &optional cleartext passphrase
 357 Make the signature from text between @var{start} and @var{end}.  If the
 358 optional third argument @var{cleartext} is non-@code{nil}, it does not
 359 create a detached signature.  If signing is successful, it returns
 360 @code{t}, otherwise @code{nil}.
 361 @end deffn
 362
 363 @deffn Method pgg-scheme-verify-region scheme start end &optional signature
 364 Verify the current region between @var{start} and @var{end}.  If the
 365 optional third argument @var{signature} is non-@code{nil}, it is treated
 366 as the detached signature of the current region.  If the signature is
 367 successfully verified, it returns @code{t}, otherwise @code{nil}.
 368 @end deffn
 369
 370 @deffn Method pgg-scheme-insert-key scheme
 371 Retrieve the user's public key and insert it as ASCII-armored format.
 372 On success, it returns @code{t}, otherwise @code{nil}.
 373 @end deffn
 374
 375 @deffn Method pgg-scheme-snarf-keys-region scheme start end
 376 Collect public keys in the current region between @var{start} and
 377 @var{end}, and add them into the user's keyring.
 378 On success, it returns @code{t}, otherwise @code{nil}.
 379 @end deffn
 380
 381 @node Getting output
 382 @section Getting output
 383
 384 The output of the backend methods (@ref{Backend methods}) is stored in
 385 special buffers, so that these methods must tell the status of the
 386 execution.
 387
 388 @defvar pgg-errors-buffer
 389 The standard error output of the execution of the PGP command is stored
 390 here.
 391 @end defvar
 392
 393 @defvar pgg-output-buffer
 394 The standard output of the execution of the PGP command is stored here.
 395 @end defvar
 396
 397 @defvar pgg-status-buffer
 398 The rest of status information of the execution of the PGP command is
 399 stored here.
 400 @end defvar
 401
 402 @node Parsing OpenPGP packets
 403 @chapter Parsing OpenPGP packets
 404
 405 The format of OpenPGP messages is maintained in order to publish all
 406 necessary information needed to develop interoperable applications.
 407 The standard is documented in RFC 2440.
 408
 409 PGG has its own parser for the OpenPGP packets.
 410
 411 @defun pgg-parse-armor string
 412 List the sequence of packets in @var{string}.
 413 @end defun
 414
 415 @defun pgg-parse-armor-region start end
 416 List the sequence of packets in the current region between @var{start}
 417 and @var{end}.
 418 @end defun
 419
 420 @defvar pgg-ignore-packet-checksum
 421 If non-@code{nil}, don't check the checksum of the packets.
 422 @end defvar
 423
 424 @node Function Index
 425 @chapter Function Index
 426 @printindex fn
 427
 428 @node Variable Index
 429 @chapter Variable Index
 430 @printindex vr
 431
 432 @summarycontents
 433 @contents
 434 @bye
 435
 436 @c End:
 437
 438 @ignore
 439    arch-tag: 0c205838-34b9-41a5-b9d7-49ae57ccac85
 440 @end ignore