aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJohn Thacker <johnthacker@gmail.com>2022-02-03 08:28:11 -0500
committerA Wireshark GitLab Utility <gerald+gitlab-utility@wireshark.org>2022-02-06 00:32:13 +0000
commit25d0c88251b7649cd58ae791252ec74d6ab6e3de (patch)
tree18319432dcff185e9ce8325336267799067276c5 /doc
parentebe22f7b7b6238d2cbe35889c89ffc3c485ea696 (diff)
epan: Add BASE_SHOW_UTF_8_PRINTABLE
Add BASE_SHOW_UTF_8_PRINTABLE and related function tvb_utf_8_isprint for supporting fields of bytes that are "maybe UTF-8" (default or SHOULD be UTF-8 but could be something else, with no encoding indicator), such as SSID fields in IEEE 802.11 (See #16208), certain OctetString fields in Diameter or PFCP, and other places where BASE_SHOW_ASCII_PRINTABLE is currently used. Fix #5307
Diffstat (limited to 'doc')
-rw-r--r--doc/README.dissector12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/README.dissector b/doc/README.dissector
index 98113942fd..8232b28dd5 100644
--- a/doc/README.dissector
+++ b/doc/README.dissector
@@ -132,7 +132,8 @@ FIELDDISPLAY --For FT_UINT{8,16,24,32,40,48,56,64} and
BASE_CUSTOM, or BASE_NONE, possibly ORed with
BASE_RANGE_STRING, BASE_EXT_STRING, BASE_VAL64_STRING,
BASE_ALLOW_ZERO, BASE_UNIT_STRING, BASE_SPECIAL_VALS,
- BASE_NO_DISPLAY_VALUE, or BASE_SHOW_ASCII_PRINTABLE
+ BASE_NO_DISPLAY_VALUE, BASE_SHOW_ASCII_PRINTABLE, or
+ BASE_SHOW_UTF_8_PRINTABLE
BASE_NONE may be used with a non-NULL FIELDCONVERT when the
numeric value of the field itself is not of significance to
@@ -182,8 +183,8 @@ FIELDDISPLAY --For FT_UINT{8,16,24,32,40,48,56,64} and
SEP_DOT, SEP_DASH, SEP_COLON, or SEP_SPACE to provide
a separator between bytes; BASE_NONE has no separator
- between bytes. These can be ORed with BASE_ALLOW_ZERO
- and BASE_SHOW_ASCII_PRINTABLE.
+ between bytes. These can be ORed with BASE_ALLOW_ZERO,
+ BASE_SHOW_ASCII_PRINTABLE, or BASE_SHOW_UTF_8_PRINTABLE.
BASE_ALLOW_ZERO displays <none> instead of <MISSING>
for a zero-sized byte array.
@@ -192,6 +193,11 @@ FIELDDISPLAY --For FT_UINT{8,16,24,32,40,48,56,64} and
characters and, if so, will display the field's value
as a string, in quotes. The value will still be
filterable as a byte value.
+ BASE_SHOW_UTF_8_PRINTABLE will check whether the
+ field's value is valid UTF-8 consisting entirely of
+ printable characters and, if so, will display the field's
+ value as a string, in quotes. The value will still be
+ filterable as a byte value.
--For FT_IPv4: