Sanitizing invalid literal text string

- modified tag11 and tag13 packets
- modified sub06, sub20, sub24, sub26, and sub28 sub-packets

Author: spiegel-im-spiegel

packet/parser_test.go

@@ -285,7 +285,7 @@ const (
 		Literal Data Packet (tag 11) (19 bytes)
 			62 00 5a 19 0d e4 48 65 6c 6c 6f 20 77 6f 72 6c 64 0d 0a
 			Literal data format: b (binary)
-			File name: <null>
+			File name (0 byte)
 			Modification time of a file: 2017-11-25T06:29:56Z
 				5a 19 0d e4
 			Literal data (13 bytes)

packet/tags/sub06.go

@@ -19,9 +19,7 @@ func newSub06(cxt *context.Context, subID values.SuboacketID, body []byte) Subs
 
 // Parse parsing Regular Expression Sub-packet
 func (s *sub06) Parse() (*info.Item, error) {
-	rootInfo := s.ToItem()
-	rootInfo.Value = string(s.reader.GetBody())
-	return rootInfo, nil
+	return values.NewText(s.reader.GetBody(), s.ToItem().Name).ToItem(s.cxt.Debug()), nil
 }
 
 /* Copyright 2016-2019 Spiegel

packet/tags/sub20.go

@@ -47,24 +47,21 @@ func (s *sub20) Parse() (*info.Item, error) {
 	if err != nil {
 		return rootInfo, errs.Wrapf(err, "illegal name in parsing sub packet %d (length: %d bytes)", int(s.subID), nameLength)
 	}
-	rootInfo.Add(info.NewItem(
-		info.Name("Name"),
-		info.Value(string(name)),
-	))
+	rootInfo.Add(values.NewText(name, "Name").ToItem(s.cxt.Debug()))
 	value, err := s.reader.ReadBytes(int64(binary.BigEndian.Uint16(valueLength)))
 	if err != nil {
 		return rootInfo, errs.Wrapf(err, "illegal value in parsing sub packet %d (length: %d bytes)", int(s.subID), valueLength)
 	}
-	itm := info.NewItem(
-		info.Name("Value"),
-	)
 	if human != 0x00 {
-		itm.Value = string(value)
+		//human readable data (text)
+		rootInfo.Add(values.NewText(value, "Value").ToItem(s.cxt.Debug()))
 	} else {
-		itm.Dump = values.DumpBytes(value, true).String()
+		//binary data
+		rootInfo.Add(info.NewItem(
+			info.Name("Value"),
+			info.DumpStr(values.DumpBytes(value, true).String()),
+		))
 	}
-	rootInfo.Add(itm)
-
 	return rootInfo, nil
 }
 

packet/tags/sub24.go

@@ -19,9 +19,7 @@ func newSub24(cxt *context.Context, subID values.SuboacketID, body []byte) Subs
 
 // Parse parsing Preferred Key Server Sub-packet
 func (s *sub24) Parse() (*info.Item, error) {
-	rootInfo := s.ToItem()
-	rootInfo.Value = string(s.reader.GetBody())
-	return rootInfo, nil
+	return values.NewText(s.reader.GetBody(), s.ToItem().Name).ToItem(s.cxt.Debug()), nil
 }
 
 /* Copyright 2016-2019 Spiegel

packet/tags/sub26.go

@@ -19,9 +19,7 @@ func newSub26(cxt *context.Context, subID values.SuboacketID, body []byte) Subs
 
 // Parse parsing Policy URI Sub-packet
 func (s *sub26) Parse() (*info.Item, error) {
-	rootInfo := s.ToItem()
-	rootInfo.Value = string(s.reader.GetBody())
-	return rootInfo, nil
+	return values.NewText(s.reader.GetBody(), s.ToItem().Name).ToItem(s.cxt.Debug()), nil
 }
 
 /* Copyright 2016-2019 Spiegel

packet/tags/sub28.go

@@ -19,9 +19,7 @@ func newSub28(cxt *context.Context, subID values.SuboacketID, body []byte) Subs
 
 // Parse parsing Signer's User ID Sub-packet
 func (s *sub28) Parse() (*info.Item, error) {
-	rootInfo := s.ToItem()
-	rootInfo.Value = string(s.reader.GetBody())
-	return rootInfo, nil
+	return values.NewText(s.reader.GetBody(), s.ToItem().Name).ToItem(s.cxt.Debug()), nil
 }
 
 /* Copyright 2016-2019 Spiegel

packet/tags/tag11.go

@@ -34,7 +34,7 @@ func (t *tag11) Parse() (*info.Item, error) {
 	if err != nil {
 		return rootInfo, errs.Wrapf(err, "illegal length of file name in parsing tag %d (length: %d bytes)", int(t.tag), int64(flen))
 	}
-	rootInfo.Add(fname.ToItem(t.cxt.Debug()))
+	rootInfo.Add(fname.ToItem(t.cxt.Literal()))
 	ftime, err := values.NewDateTime(t.reader, t.cxt.UTC())
 	if err != nil {
 		return rootInfo, errs.Wrapf(err, "illegal timestump of file in parsing tag %d", int(t.tag))

packet/tags/tag11_test.go

@@ -20,7 +20,7 @@ const (
 	tag11Result1 = `Literal Data Packet (tag 11) (19 bytes)
 	62 00 5a 19 0d e4 48 65 6c 6c 6f 20 77 6f 72 6c 64 0d 0a
 	Literal data format: b (binary)
-	File name: <null>
+	File name (0 byte)
 	Modification time of a file: 2017-11-25T06:29:56Z
 		5a 19 0d e4
 	Literal data (13 bytes)
@@ -79,7 +79,7 @@ func TestTag11(t *testing.T) {
 	}
 }
 
-/* Copyright 2017 Spiegel
+/* Copyright 2017-2019 Spiegel
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packet/tags/tag13.go

@@ -20,12 +20,7 @@ func newTag13(cxt *context.Context, tag values.TagID, body []byte) Tags {
 // Parse parsing User ID Packet
 func (t *tag13) Parse() (*info.Item, error) {
 	rootInfo := t.ToItem()
-	body := t.reader.GetBody()
-	rootInfo.Add(info.NewItem(
-		info.Name("User ID"),
-		info.Value(string(body)),
-		info.DumpStr(values.DumpBytes(body, t.cxt.Debug()).String()),
-	))
+	rootInfo.Add(values.NewText(t.reader.GetBody(), "User ID").ToItem(t.cxt.Debug()))
 	return rootInfo, nil
 }
 

packet/values/literal.go

@@ -34,67 +34,66 @@ func (l LiteralFormat) String() string {
 	return string(l)
 }
 
-//LiteralFname is file name of literal data
-type LiteralFname struct {
-	name []byte
+//Text is literal text
+type Text struct {
+	name string
+	body []byte
 }
 
-//NewLiteralFname returns new LiteralFname instance
-func NewLiteralFname(r *reader.Reader, l int64) (*LiteralFname, error) {
+//NewText returns new Text instance
+func NewText(body []byte, name string) *Text {
+	return &Text{name: name, body: body}
+}
+
+//NewLiteralFname returns new Text instance for file name of literal data
+func NewLiteralFname(r *reader.Reader, l int64) (*Text, error) {
+	name := "File name"
 	if r == nil {
-		return &LiteralFname{name: nil}, nil
+		return NewText(nil, name), nil
 	}
 	if l < 1 {
-		return &LiteralFname{name: nil}, nil
+		return NewText(nil, name), nil
 	}
 	data, err := r.ReadBytes(l)
 	if err != nil {
 		return nil, errs.Wrapf(err, "illegal file name of literal packet (length: %d bytes)", l)
 	}
-	return &LiteralFname{name: data}, err
+	return NewText(data, name), nil
 }
 
-//ToItem returns Item instance
-func (l *LiteralFname) ToItem(dumpFlag bool) *info.Item {
-	if l == nil {
-		return nil
-	}
-	name := "File name"
-	if l.name == nil {
+func (t *Text) ToItem(dumpFlag bool) *info.Item {
+	if t == nil {
 		return info.NewItem(
-			info.Name(name),
-			info.Value("<null>"),
+			info.Note("null"),
 		)
 	}
-	fname := stripString(l.name)
-	if len(fname) == 0 {
+	if t.body == nil || len(t.body) == 0 {
 		return info.NewItem(
-			info.Name(name),
-			info.Value("<invalid text string>"),
-			info.DumpStr(DumpBytes(l.name, dumpFlag).String()),
+			info.Name(t.name),
+			info.Note("0 byte"),
 		)
 	}
-	return info.NewItem(
-		info.Name(name),
-		info.Value(fname),
-		info.DumpStr(DumpBytes(l.name, dumpFlag).String()),
-	)
-}
-
-func stripString(b []byte) string {
-	if !utf8.Valid(b) {
-		return ""
+	if !utf8.Valid(t.body) {
+		return info.NewItem(
+			info.Name(t.name),
+			info.Note("invalid text string"),
+			info.DumpStr(DumpBytes(t.body, true).String()),
+		)
 	}
 	rs := []rune{}
-	for _, r := range string(b) {
+	for _, r := range string(t.body) {
 		if unicode.IsControl(r) {
 			c := fmt.Sprintf("(%U)", r)
 			rs = append(rs, []rune(c)...)
 		} else {
 			rs = append(rs, r)
 		}
 	}
-	return string(rs)
+	return info.NewItem(
+		info.Name(t.name),
+		info.Value(string(rs)),
+		info.DumpStr(DumpBytes(t.body, dumpFlag).String()),
+	)
 }
 
 //RawData returns info.Item instance for raw data