Merge pull request #29 from spiegel-im-spiegel/add-hkp-mode

Add hkp mode

Author: spiegel-im-spiegel

.gitignore

@@ -25,5 +25,3 @@ _cgo_gotypes.go
 _cgo_export.*
 
 _testmain.go
-
-go.sum

README.md

@@ -69,21 +69,30 @@ See [latest release](https://github.com/spiegel-im-spiegel/gpgpdump/releases/lat
 ```
 $ gpgpdump -h
 Usage:
-  gpgpdump [flags] [OpenPGP file]
+  gpgpdump [flags]
+  gpgpdump [command]
+
+Available Commands:
+  help        Help about any command
+  hkp         Dumps from OpenPGP key server
+  version     Print the version number
 
 Flags:
-  -a, --armor        accepts ASCII input only
-      --debug        for debug
-  -h, --help         help for gpgpdump
-      --indent int   indent size for output string
-  -i, --int          dumps multi-precision integers
-  -j, --json         output with JSON format
-  -l, --literal      dumps literal packets (tag 11)
-  -m, --marker       dumps marker packets (tag 10)
-  -p, --private      dumps private packets (tag 60-63)
-  -t, --toml         output with TOML format
-  -u, --utc          output with UTC time
-  -v, --version      output version of gpgpdump
+  -a, --armor         accepts ASCII input only
+      --debug         for debug
+  -f, --file string   path of OpenPGP file
+  -h, --help          help for gpgpdump
+      --indent int    indent size for output string
+  -i, --int           dumps multi-precision integers
+  -j, --json          output with JSON format
+  -l, --literal       dumps literal packets (tag 11)
+  -m, --marker        dumps marker packets (tag 10)
+  -p, --private       dumps private packets (tag 60-63)
+  -t, --toml          output with TOML format
+  -u, --utc           output with UTC time
+  -v, --version       output version of gpgpdump
+
+Use "gpgpdump [command] --help" for more information about a command.
 
 $ cat sig
 -----BEGIN PGP SIGNATURE-----
@@ -221,6 +230,104 @@ $ cat sig | gpgpdump -j -u --indent 2
 }
 ```
 
+### HKP Access Mode
+
+```
+$ gpgpdump hkp -h
+Dumps from OpenPGP key server
+
+Usage:
+  gpgpdump hkp [flags] <user id>
+
+Flags:
+  -h, --help               help for hkp
+      --keyserver string   OpenPGP key server (default "keys.gnupg.net")
+      --port int           port number of OpenPGP key server (default 11371)
+      --proxy string       URL of proxy server
+      --raw                output raw text from OpenPGP key server
+      --secure             enable HKP over HTTPS
+
+Global Flags:
+  -a, --armor        accepts ASCII input only
+      --debug        for debug
+      --indent int   indent size for output string
+  -i, --int          dumps multi-precision integers
+  -j, --json         output with JSON format
+  -l, --literal      dumps literal packets (tag 11)
+  -m, --marker       dumps marker packets (tag 10)
+  -p, --private      dumps private packets (tag 60-63)
+  -t, --toml         output with TOML format
+  -u, --utc          output with UTC time
+
+$ gpgpdump hkp -u --indent 2 0x44ce6900e2b307a4
+Public-Key Packet (tag 6) (269 bytes)
+  Version: 4 (current)
+  Public key creation time: 2009-11-08T15:20:55Z
+    4a f6 e1 d7
+  Public-key Algorithm: RSA (Encrypt or Sign) (pub 1)
+  RSA public modulus n (2048 bits)
+  RSA public encryption exponent e (17 bits)
+User ID Packet (tag 13) (25 bytes)
+  User ID: Alice <[email protected]>
+Signature Packet (tag 2) (312 bytes)
+  Version: 4 (current)
+  Signiture Type: Positive certification of a User ID and Public-Key packet (0x13)
+  Public-key Algorithm: RSA (Encrypt or Sign) (pub 1)
+  Hash Algorithm: SHA-1 (hash 2)
+  Hashed Subpacket (34 bytes)
+    Signature Creation Time (sub 2): 2009-11-08T15:20:55Z
+    Key Flags (sub 27) (1 bytes)
+      Flag: This key may be used to certify other keys.
+      Flag: This key may be used to sign data.
+    Preferred Symmetric Algorithms (sub 11) (5 bytes)
+      Symmetric Algorithm: AES with 256-bit key (sym 9)
+      Symmetric Algorithm: AES with 192-bit key (sym 8)
+      Symmetric Algorithm: AES with 128-bit key (sym 7)
+      Symmetric Algorithm: CAST5 (128 bit key, as per) (sym 3)
+      Symmetric Algorithm: TripleDES (168 bit key derived from 192) (sym 2)
+    Preferred Hash Algorithms (sub 21) (5 bytes)
+      Hash Algorithm: SHA2-256 (hash 8)
+      Hash Algorithm: SHA-1 (hash 2)
+      Hash Algorithm: SHA2-384 (hash 9)
+      Hash Algorithm: SHA2-512 (hash 10)
+      Hash Algorithm: SHA2-224 (hash 11)
+    Preferred Compression Algorithms (sub 22) (3 bytes)
+      Compression Algorithm: ZLIB <RFC1950> (comp 2)
+      Compression Algorithm: BZip2 (comp 3)
+      Compression Algorithm: ZIP <RFC1951> (comp 1)
+    Features (sub 30) (1 bytes)
+      Flag: Modification Detection (packets 18 and 19)
+    Key Server Preferences (sub 23) (1 bytes)
+      Flag: No-modify
+  Unhashed Subpacket (10 bytes)
+    Issuer (sub 16): 0x44ce6900e2b307a4
+  Hash left 2 bytes
+    93 62
+  RSA signature value m^d mod n (2045 bits)
+Public-Subkey Packet (tag 14) (269 bytes)
+  Version: 4 (current)
+  Public key creation time: 2009-11-08T15:20:55Z
+    4a f6 e1 d7
+  Public-key Algorithm: RSA (Encrypt or Sign) (pub 1)
+  RSA public modulus n (2048 bits)
+  RSA public encryption exponent e (17 bits)
+Signature Packet (tag 2) (287 bytes)
+  Version: 4 (current)
+  Signiture Type: Subkey Binding Signature (0x18)
+  Public-key Algorithm: RSA (Encrypt or Sign) (pub 1)
+  Hash Algorithm: SHA-1 (hash 2)
+  Hashed Subpacket (9 bytes)
+    Signature Creation Time (sub 2): 2009-11-08T15:20:55Z
+    Key Flags (sub 27) (1 bytes)
+      Flag: This key may be used to encrypt communications.
+      Flag: This key may be used to encrypt storage.
+  Unhashed Subpacket (10 bytes)
+    Issuer (sub 16): 0x44ce6900e2b307a4
+  Hash left 2 bytes
+    66 f3
+  RSA signature value m^d mod n (2048 bits)
+```
+
 [gpgpdump]: https://github.com/spiegel-im-spiegel/gpgpdump "spiegel-im-spiegel/gpgpdump: gpgpdump - OpenPGP packet visualizer"
 [RFC 4880]: https://tools.ietf.org/html/rfc4880
 [RFC 4880bis]: https://datatracker.ietf.org/doc/draft-ietf-openpgp-rfc4880bis/

cli/gpgpdump/facade/armor_test.go

@@ -35,14 +35,27 @@ func TestArmorErr(t *testing.T) {
 	outBuf := new(bytes.Buffer)
 	outErrBuf := new(bytes.Buffer)
 	ui := rwi.New(rwi.WithReader(inData), rwi.WithWriter(outBuf), rwi.WithErrorWriter(outErrBuf))
-	args := []string{"-a", "--debug"}
+	args := []string{"-a"}
 
 	exit := Execute(ui, args)
 	if exit != exitcode.Abnormal {
 		t.Errorf("Execute(armor) = \"%v\", want \"%v\".", exit, exitcode.Abnormal)
-	} else {
-		fmt.Printf("Info: %+v", outErrBuf.String())
 	}
+	fmt.Printf("Info: %+v", outErrBuf.String())
+}
+
+func TestArmorErrDebug(t *testing.T) {
+	inData := bytes.NewReader(bindata1)
+	outBuf := new(bytes.Buffer)
+	outErrBuf := new(bytes.Buffer)
+	ui := rwi.New(rwi.WithReader(inData), rwi.WithWriter(outBuf), rwi.WithErrorWriter(outErrBuf))
+	args := []string{"-a", "--debug"}
+
+	exit := Execute(ui, args)
+	if exit != exitcode.Normal {
+		t.Errorf("Execute(armor) = \"%v\", want \"%v\".", exit, exitcode.Normal)
+	}
+	fmt.Printf("Info: %+v", outErrBuf.String())
 }
 
 /* Copyright 2017-2019 Spiegel

cli/gpgpdump/facade/facade.go

@@ -11,6 +11,8 @@ import (
 	"github.com/spiegel-im-spiegel/gocli/exitcode"
 	"github.com/spiegel-im-spiegel/gocli/rwi"
 	"github.com/spiegel-im-spiegel/gpgpdump"
+	"github.com/spiegel-im-spiegel/gpgpdump/errs"
+	"github.com/spiegel-im-spiegel/gpgpdump/info"
 	"github.com/spiegel-im-spiegel/gpgpdump/options"
 )
 
@@ -30,13 +32,15 @@ var (
 	versionFlag bool //version flag
 	jsonFlag    bool //output with JSON format
 	tomlFlag    bool //output with TOML format
+	debugFlag   bool //debug flag
 	indentSize  int
+	filePath    string
 )
 
 //newRootCmd returns cobra.Command instance for root command
 func newRootCmd(ui *rwi.RWI, args []string) *cobra.Command {
 	rootCmd := &cobra.Command{
-		Use: Name + " [flags] [OpenPGP file]",
+		Use: Name,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			//parse options
 			if versionFlag {
@@ -46,65 +50,72 @@ func newRootCmd(ui *rwi.RWI, args []string) *cobra.Command {
 
 			//open PGP file
 			reader := ui.Reader()
-			if len(args) > 0 {
-				file, err := os.Open(args[0]) //args[0] is maybe file path
+			if len(filePath) > 0 {
+				file, err := os.Open(filePath)
 				if err != nil {
-					return err
+					return debugPrint(ui, err)
 				}
 				defer file.Close()
 				reader = file
 			}
 
 			//parse OpenPGP packets
-			info, err := gpgpdump.Parse(reader, opts)
+			r, err := marshalPacketInfo(gpgpdump.Parse(reader, opts))
 			if err != nil {
-				if opts.Debug() {
-					_ = ui.OutputErrln(fmt.Sprintf("%+v", err))
-				}
-				return err
-			}
-
-			//marshal packet info
-			var result io.Reader
-			if jsonFlag {
-				result, err = info.JSON(indentSize)
-			} else if tomlFlag {
-				result, err = info.TOML(indentSize)
-			} else if indentSize > 0 {
-				result = info.ToString(strings.Repeat(" ", indentSize))
-				err = nil
-			} else {
-				result = info.ToString("\t")
-				err = nil
+				return debugPrint(ui, err)
 			}
-			if err != nil {
-				if opts.Debug() {
-					_ = ui.OutputErrln(fmt.Sprintf("%+v", err))
-				}
-				return err
-			}
-			return ui.WriteFrom(result)
+			return debugPrint(ui, ui.WriteFrom(r))
 		},
 	}
 	rootCmd.Flags().BoolVarP(&versionFlag, "version", "v", false, "output version of "+Name)
-	rootCmd.Flags().BoolVarP(&jsonFlag, "json", "j", false, "output with JSON format")
-	rootCmd.Flags().BoolVarP(&tomlFlag, "toml", "t", false, "output with TOML format")
-	rootCmd.Flags().IntVarP(&indentSize, "indent", "", 0, "indent size for output string")
-	rootCmd.Flags().BoolP(options.ARMOR.String(), "a", false, "accepts ASCII input only")
-	rootCmd.Flags().BoolP(options.DEBUG.String(), "", false, "for debug") //not use
-	//rootCmd.Flags().BoolP(options.GDUMP.String(), "g", false, "selects alternate (GnuPG type) dump format") //not use
-	rootCmd.Flags().BoolP(options.INTEGER.String(), "i", false, "dumps multi-precision integers")
-	rootCmd.Flags().BoolP(options.LITERAL.String(), "l", false, "dumps literal packets (tag 11)")
-	rootCmd.Flags().BoolP(options.MARKER.String(), "m", false, "dumps marker packets (tag 10)")
-	rootCmd.Flags().BoolP(options.PRIVATE.String(), "p", false, "dumps private packets (tag 60-63)")
-	rootCmd.Flags().BoolP(options.UTC.String(), "u", false, "output with UTC time")
+	rootCmd.Flags().StringVarP(&filePath, "file", "f", "", "path of OpenPGP file")
+	rootCmd.PersistentFlags().BoolVarP(&jsonFlag, "json", "j", false, "output with JSON format")
+	rootCmd.PersistentFlags().BoolVarP(&tomlFlag, "toml", "t", false, "output with TOML format")
+	rootCmd.PersistentFlags().IntVarP(&indentSize, "indent", "", 0, "indent size for output string")
+	rootCmd.PersistentFlags().BoolP(options.ARMOR.String(), "a", false, "accepts ASCII input only")
+	rootCmd.PersistentFlags().BoolP(options.DEBUG.String(), "", false, "for debug") //not use
+	//rootCmd.PersistentFlags().BoolP(options.GDUMP.String(), "g", false, "selects alternate (GnuPG type) dump format") //not use
+	rootCmd.PersistentFlags().BoolP(options.INTEGER.String(), "i", false, "dumps multi-precision integers")
+	rootCmd.PersistentFlags().BoolP(options.LITERAL.String(), "l", false, "dumps literal packets (tag 11)")
+	rootCmd.PersistentFlags().BoolP(options.MARKER.String(), "m", false, "dumps marker packets (tag 10)")
+	rootCmd.PersistentFlags().BoolP(options.PRIVATE.String(), "p", false, "dumps private packets (tag 60-63)")
+	rootCmd.PersistentFlags().BoolP(options.UTC.String(), "u", false, "output with UTC time")
 
 	rootCmd.SetArgs(args)
 	rootCmd.SetOutput(ui.ErrorWriter())
+	rootCmd.AddCommand(newVersionCmd(ui))
+	rootCmd.AddCommand(newHkpCmd(ui))
 
 	return rootCmd
 }
 
+func debugPrint(ui *rwi.RWI, err error) error {
+	if debugFlag && err != nil {
+		fmt.Fprintf(ui.ErrorWriter(), "error: %+v\n", err)
+		return nil
+	}
+	return errs.Cause(err)
+}
+
+func marshalPacketInfo(i *info.Info, e error) (r io.Reader, err error) {
+	if e != nil {
+		err = e
+		return
+	}
+	if jsonFlag {
+		r, err = i.JSON(indentSize)
+	} else if tomlFlag {
+		r, err = i.TOML(indentSize)
+	} else if indentSize > 0 {
+		r = i.ToString(strings.Repeat(" ", indentSize))
+		err = nil
+	} else {
+		r = i.ToString("\t")
+		err = nil
+	}
+	return
+}
+
 func getBool(cmd *cobra.Command, code options.OptCode) (options.OptCode, bool) {
 	name := code.String()
 	f, err := cmd.Flags().GetBool(name)
@@ -115,7 +126,7 @@ func getBool(cmd *cobra.Command, code options.OptCode) (options.OptCode, bool) {
 }
 
 func parseOpt(cmd *cobra.Command) options.Options {
-	return options.New(
+	opts := options.New(
 		options.Set(getBool(cmd, options.ARMOR)),
 		options.Set(getBool(cmd, options.DEBUG)), //for debug
 		//options.Set(getBool(cmd, options.GDUMP)), //not use
@@ -125,6 +136,8 @@ func parseOpt(cmd *cobra.Command) options.Options {
 		options.Set(getBool(cmd, options.PRIVATE)),
 		options.Set(getBool(cmd, options.UTC)),
 	)
+	debugFlag = opts.Debug()
+	return opts
 }
 
 //Execute is called from main function

cli/gpgpdump/facade/facade_test.go

@@ -95,7 +95,7 @@ func TestLoadByFile(t *testing.T) {
 	outBuf := new(bytes.Buffer)
 	outErrBuf := new(bytes.Buffer)
 	ui := rwi.New(rwi.WithWriter(outBuf), rwi.WithErrorWriter(outErrBuf))
-	args := []string{"testdata/bindata1"}
+	args := []string{"-f", "testdata/bindata1"}
 
 	exit := Execute(ui, args)
 	if exit != exitcode.Normal {