Stateless OpenPGP Command Line Interface
draft-dkg-openpgp-stateless-cli-02

Document Type Active Internet-Draft (individual)
Last updated 2020-03-06
Stream (None)
Intended RFC status (None)
Formats plain text html xml pdf htmlized (tools) htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
openpgp                                                     D.K. Gillmor
Internet-Draft                                                      ACLU
Intended status: Informational                              6 March 2020
Expires: 7 September 2020

                Stateless OpenPGP Command Line Interface
                   draft-dkg-openpgp-stateless-cli-02

Abstract

   This document defines a generic stateless command-line interface for
   dealing with OpenPGP messages, known as "sop".  It aims for a
   minimal, well-structured API covering OpenPGP object security.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on 7 September 2020.

Copyright Notice

   Copyright (c) 2020 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents (https://trustee.ietf.org/
   license-info) in effect on the date of publication of this document.
   Please review these documents carefully, as they describe your rights
   and restrictions with respect to this document.  Code Components
   extracted from this document must include Simplified BSD License text
   as described in Section 4.e of the Trust Legal Provisions and are
   provided without warranty as described in the Simplified BSD License.

Gillmor                 Expires 7 September 2020                [Page 1]
Internet-Draft  Stateless OpenPGP Command Line Interface      March 2020

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Requirements Language . . . . . . . . . . . . . . . . . .   4
     1.2.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   4
     1.3.  Using sop in a Test Suite . . . . . . . . . . . . . . . .   4
   2.  Examples  . . . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Subcommands . . . . . . . . . . . . . . . . . . . . . . . . .   5
     3.1.  version: Version Information  . . . . . . . . . . . . . .   5
     3.2.  generate-key: Generate a Secret Key . . . . . . . . . . .   6
     3.3.  extract-cert: Extract a Certificate from a Secret Key . .   6
     3.4.  sign: Create Detached Signatures  . . . . . . . . . . . .   7
     3.5.  verify: Verify Detached Signatures  . . . . . . . . . . .   7
     3.6.  encrypt: Encrypt a Message  . . . . . . . . . . . . . . .   8
     3.7.  decrypt: Decrypt a Message  . . . . . . . . . . . . . . .  10
     3.8.  armor: Convert binary to ASCII  . . . . . . . . . . . . .  12
     3.9.  dearmor: Convert ASCII to binary  . . . . . . . . . . . .  13
     3.10. detach-inband-signature-and-message: split a clearsigned
            message  . . . . . . . . . . . . . . . . . . . . . . . .  13
   4.  Input String Types  . . . . . . . . . . . . . . . . . . . . .  14
     4.1.  DATE  . . . . . . . . . . . . . . . . . . . . . . . . . .  15
     4.2.  USERID  . . . . . . . . . . . . . . . . . . . . . . . . .  15
   5.  Input/Output Indirect Types . . . . . . . . . . . . . . . . .  15
     5.1.  Special Designators for Indirect Types  . . . . . . . . .  16
     5.2.  CERTS . . . . . . . . . . . . . . . . . . . . . . . . . .  16
     5.3.  KEY . . . . . . . . . . . . . . . . . . . . . . . . . . .  16
     5.4.  CIPHERTEXT  . . . . . . . . . . . . . . . . . . . . . . .  16
     5.5.  SIGNATURES  . . . . . . . . . . . . . . . . . . . . . . .  17
     5.6.  SESSIONKEY  . . . . . . . . . . . . . . . . . . . . . . .  17
     5.7.  PASSWORD  . . . . . . . . . . . . . . . . . . . . . . . .  18
     5.8.  VERIFICATIONS . . . . . . . . . . . . . . . . . . . . . .  18
     5.9.  DATA  . . . . . . . . . . . . . . . . . . . . . . . . . .  18
   6.  Failure Modes . . . . . . . . . . . . . . . . . . . . . . . .  19
   7.  Guidance for Implementers . . . . . . . . . . . . . . . . . .  20
     7.1.  One OpenPGP Message at a Time . . . . . . . . . . . . . .  21
     7.2.  Simplified Subset of OpenPGP Message  . . . . . . . . . .  21
     7.3.  Validate Signatures Only from Known Signers . . . . . . .  21
     7.4.  OpenPGP inputs can be either Binary or ASCII-armored  . .  21
     7.5.  Detached Signatures . . . . . . . . . . . . . . . . . . .  22
     7.6.  Reliance on Supplied Certs and Keys . . . . . . . . . . .  23
     7.7.  Text is always UTF-8  . . . . . . . . . . . . . . . . . .  23
Show full document text