hashes - D - Tcl 9 compatibility warnings.

Author: andreas-kupries

embedded/md/tcllib/files/modules/md4/md4.md

@@ -68,6 +68,23 @@ Alternatively if __cryptkit__ is available this will be used\. If no
 accelerator package can be found then the pure\-tcl implementation is used\. The
 programming interface remains the same in all cases\.
 
+*BEWARE* The commands in this package expect binary data as their input\. When
+a __\-file__ is provided then this is ensured by the commands themselves, as
+they open the referenced file in binary mode\. When literal data, or a
+__\-channel__ are provided instead, then the command's *caller is
+responsible* for ensuring this fact\. The necessary conversion command is
+__encoding convertto utf\-8 $string__\.
+
+*ATTENTION*, there is a *Tcl 9 COMPATIBILITY ISSUE* here\.
+
+*Tcl 8\.x silently mishandles* non\-binary input by cutting it internally to
+size\. I\.e\. by only using the low byte of a higher unicode point\. No error is
+thrown, the *result is simply wrong*\.
+
+*Tcl 9 throws an error* instead, i\.e\.
+
+    expected byte sequence but character <location> was ...
+
 # <a name='section2'></a>COMMANDS
 
   - <a name='1'></a>__::md4::md4__ ?*\-hex*? \[ *\-channel channel* &#124; *\-file filename* &#124; *string* \]

embedded/md/tcllib/files/modules/md5/md5.md

@@ -67,23 +67,40 @@ applications\.
 If you have __critcl__ and have built the __tcllibc__ package then the
 implementation of the hashing function will be performed by compiled code\.
 Alternatively if you have either __cryptkit__ or __Trf__ then either of
-these can be used to accelerate the digest computation\. If no suitable compiled
-package is available then the pure\-Tcl implementation wil be used\. The
-programming interface remains the same in all cases\.
+these is used to accelerate the digest computation\. If no suitable compiled
+package is available then the pure\-Tcl implementation is used\. The programming
+interface remains the same in all cases\.
 
 *Note* the previous version of this package always returned a hex encoded
 string\. This has been changed to simplify the programming interface and to make
 this version more compatible with other implementations\. To obtain the previous
 usage, either explicitly specify package version 1 or use the *\-hex* option to
 the __md5__ command\.
 
+*BEWARE* The commands in this package expect binary data as their input\. When
+a __\-file__ is provided then this is ensured by the commands themselves, as
+they open the referenced file in binary mode\. When literal data, or a
+__\-channel__ are provided instead, then the command's *caller is
+responsible* for ensuring this fact\. The necessary conversion command is
+__encoding convertto utf\-8 $string__\.
+
+*ATTENTION*, there is a *Tcl 9 COMPATIBILITY ISSUE* here\.
+
+*Tcl 8\.x silently mishandles* non\-binary input by cutting it internally to
+size\. I\.e\. by only using the low byte of a higher unicode point\. No error is
+thrown, the *result is simply wrong*\.
+
+*Tcl 9 throws an error* instead, i\.e\.
+
+    expected byte sequence but character <location> was ...
+
 # <a name='section2'></a>COMMANDS
 
   - <a name='1'></a>__::md5::md5__ ?*\-hex*? \[ *\-channel channel* &#124; *\-file filename* &#124; *string* \]
 
-    Calculate the MD5 digest of the data given in string\. This is returned as a
-    binary string by default\. Giving the *\-hex* option will return a
-    hexadecimal encoded version of the digest\.
+    Calculate the MD5 digest of the binary data given in string\. This is
+    returned as a binary string by default\. Giving the *\-hex* option will
+    return a hexadecimal encoded version of the digest\.
 
     The data to be hashed can be specified either as a string argument to the
     __md5__ command, or as a filename or a pre\-opened channel\. If the

embedded/md/tcllib/files/modules/ripemd/ripemd128.md

@@ -69,6 +69,23 @@ This package will use __Trf__ to accelerate the digest computation if
 available\. In the absence of an accelerator package the pure\-Tcl implementation
 will be used\.
 
+*BEWARE* The commands in this package expect binary data as their input\. When
+a __\-file__ is provided then this is ensured by the commands themselves, as
+they open the referenced file in binary mode\. When literal data, or a
+__\-channel__ are provided instead, then the command's *caller is
+responsible* for ensuring this fact\. The necessary conversion command is
+__encoding convertto utf\-8 $string__\.
+
+*ATTENTION*, there is a *Tcl 9 COMPATIBILITY ISSUE* here\.
+
+*Tcl 8\.x silently mishandles* non\-binary input by cutting it internally to
+size\. I\.e\. by only using the low byte of a higher unicode point\. No error is
+thrown, the *result is simply wrong*\.
+
+*Tcl 9 throws an error* instead, i\.e\.
+
+    expected byte sequence but character <location> was ...
+
 # <a name='section2'></a>COMMANDS
 
   - <a name='1'></a>__::ripemd::ripemd128__ ?*\-hex*? \[ *\-channel channel* &#124; *\-file filename* &#124; *string* \]

embedded/md/tcllib/files/modules/ripemd/ripemd160.md

@@ -67,6 +67,23 @@ This package will use __cryptkit__ or __Trf__ to accelerate the digest
 computation if either package is available\. In the absence of an accelerator
 package the pure\-Tcl implementation will be used\.
 
+*BEWARE* The commands in this package expect binary data as their input\. When
+a __\-file__ is provided then this is ensured by the commands themselves, as
+they open the referenced file in binary mode\. When literal data, or a
+__\-channel__ are provided instead, then the command's *caller is
+responsible* for ensuring this fact\. The necessary conversion command is
+__encoding convertto utf\-8 $string__\.
+
+*ATTENTION*, there is a *Tcl 9 COMPATIBILITY ISSUE* here\.
+
+*Tcl 8\.x silently mishandles* non\-binary input by cutting it internally to
+size\. I\.e\. by only using the low byte of a higher unicode point\. No error is
+thrown, the *result is simply wrong*\.
+
+*Tcl 9 throws an error* instead, i\.e\.
+
+    expected byte sequence but character <location> was ...
+
 # <a name='section2'></a>COMMANDS
 
   - <a name='1'></a>__::ripemd::ripemd160__ ?*\-hex*? \[ *\-channel channel* &#124; *\-file filename* &#124; *string* \]

embedded/md/tcllib/files/modules/sha1/sha1.md

@@ -68,6 +68,23 @@ applications\.
 This package also includes support for creating keyed message\-digests using the
 HMAC algorithm from RFC 2104 \(3\) with SHA1 as the message\-digest\.
 
+*BEWARE* The commands in this package expect binary data as their input\. When
+a __\-file__ is provided then this is ensured by the commands themselves, as
+they open the referenced file in binary mode\. When literal data, or a
+__\-channel__ are provided instead, then the command's *caller is
+responsible* for ensuring this fact\. The necessary conversion command is
+__encoding convertto utf\-8 $string__\.
+
+*ATTENTION*, there is a *Tcl 9 COMPATIBILITY ISSUE* here\.
+
+*Tcl 8\.x silently mishandles* non\-binary input by cutting it internally to
+size\. I\.e\. by only using the low byte of a higher unicode point\. No error is
+thrown, the *result is simply wrong*\.
+
+*Tcl 9 throws an error* instead, i\.e\.
+
+    expected byte sequence but character <location> was ...
+
 # <a name='section2'></a>COMMANDS
 
   - <a name='1'></a>__::sha1::sha1__ ?__\-hex&#124;\-bin__? \[ __\-channel channel__ &#124; __\-file filename__ &#124; ?__\-\-__? *string* \]

embedded/md/tcllib/files/modules/sha1/sha256.md

@@ -69,6 +69,23 @@ algorithms are related to the SHA1 algorithm\.
 This package also includes support for creating keyed message\-digests using the
 HMAC algorithm from RFC 2104 \(3\) with SHA256 as the message\-digest\.
 
+*BEWARE* The commands in this package expect binary data as their input\. When
+a __\-file__ is provided then this is ensured by the commands themselves, as
+they open the referenced file in binary mode\. When literal data, or a
+__\-channel__ are provided instead, then the command's *caller is
+responsible* for ensuring this fact\. The necessary conversion command is
+__encoding convertto utf\-8 $string__\.
+
+*ATTENTION*, there is a *Tcl 9 COMPATIBILITY ISSUE* here\.
+
+*Tcl 8\.x silently mishandles* non\-binary input by cutting it internally to
+size\. I\.e\. by only using the low byte of a higher unicode point\. No error is
+thrown, the *result is simply wrong*\.
+
+*Tcl 9 throws an error* instead, i\.e\.
+
+    expected byte sequence but character <location> was ...
+
 # <a name='section2'></a>COMMANDS
 
   - <a name='1'></a>__::sha2::sha256__ ?__\-hex&#124;\-bin__? \[ __\-channel channel__ &#124; __\-file filename__ &#124; ?__\-\-__? *string* \]

idoc/man/files/modules/md4/md4.n

@@ -309,6 +309,26 @@ code\&. Alternatively if \fBcryptkit\fR is available this will be
 used\&. If no accelerator package can be found then the pure-tcl
 implementation is used\&. The programming interface remains the same in
 all cases\&.
+.PP
+\fIBEWARE\fR
+The commands in this package expect binary data as their input\&.
+When a \fB-file\fR is provided then this is ensured by the commands
+themselves, as they open the referenced file in binary mode\&.
+When literal data, or a \fB-channel\fR are provided instead, then the
+command's \fIcaller is responsible\fR for ensuring this fact\&.
+The necessary conversion command is \fBencoding convertto utf-8 $string\fR\&.
+.PP
+\fIATTENTION\fR, there is a \fITcl 9 COMPATIBILITY ISSUE\fR here\&.
+.PP
+\fITcl 8\&.x silently mishandles\fR non-binary input by cutting it
+internally to size\&. I\&.e\&. by only using the low byte of a higher unicode point\&.
+No error is thrown, the \fIresult is simply wrong\fR\&.
+.PP
+\fITcl 9 throws an error\fR instead, i\&.e\&.
+.CS
+
+expected byte sequence but character <location> was \&.\&.\&.
+.CE
 .SH COMMANDS
 .TP
 \fB::md4::md4\fR ?\fI-hex\fR? [ \fI-channel channel\fR | \fI-file filename\fR | \fIstring\fR ]

idoc/man/files/modules/md5/md5.n

@@ -307,9 +307,9 @@ attack\&. MD5 should be used in preference to MD4 for new applications\&.
 If you have \fBcritcl\fR and have built the \fBtcllibc\fR
 package then the implementation of the hashing function will be
 performed by compiled code\&. Alternatively if you have either
-\fBcryptkit\fR or \fBTrf\fR then either of these can be used to
+\fBcryptkit\fR or \fBTrf\fR then either of these is used to
 accelerate the digest computation\&. If no suitable compiled package is
-available then the pure-Tcl implementation wil be used\&. The
+available then the pure-Tcl implementation is used\&. The
 programming interface remains the same in all cases\&.
 .PP
 \fINote\fR the previous version of this package always returned a
@@ -318,10 +318,30 @@ interface and to make this version more compatible with other
 implementations\&. To obtain the previous usage, either explicitly
 specify package version 1 or use the \fI-hex\fR option to the
 \fBmd5\fR command\&.
+.PP
+\fIBEWARE\fR
+The commands in this package expect binary data as their input\&.
+When a \fB-file\fR is provided then this is ensured by the commands
+themselves, as they open the referenced file in binary mode\&.
+When literal data, or a \fB-channel\fR are provided instead, then the
+command's \fIcaller is responsible\fR for ensuring this fact\&.
+The necessary conversion command is \fBencoding convertto utf-8 $string\fR\&.
+.PP
+\fIATTENTION\fR, there is a \fITcl 9 COMPATIBILITY ISSUE\fR here\&.
+.PP
+\fITcl 8\&.x silently mishandles\fR non-binary input by cutting it
+internally to size\&. I\&.e\&. by only using the low byte of a higher unicode point\&.
+No error is thrown, the \fIresult is simply wrong\fR\&.
+.PP
+\fITcl 9 throws an error\fR instead, i\&.e\&.
+.CS
+
+expected byte sequence but character <location> was \&.\&.\&.
+.CE
 .SH COMMANDS
 .TP
 \fB::md5::md5\fR ?\fI-hex\fR? [ \fI-channel channel\fR | \fI-file filename\fR | \fIstring\fR ]
-Calculate the MD5 digest of the data given in string\&. This is returned
+Calculate the MD5 digest of the binary data given in string\&. This is returned
 as a binary string by default\&. Giving the \fI-hex\fR option will
 return a hexadecimal encoded version of the digest\&.
 .sp

idoc/man/files/modules/ripemd/ripemd128.n

@@ -310,6 +310,26 @@ This package will use \fBTrf\fR to
 accelerate the digest computation if available\&. In
 the absence of an accelerator package the pure-Tcl implementation will
 be used\&.
+.PP
+\fIBEWARE\fR
+The commands in this package expect binary data as their input\&.
+When a \fB-file\fR is provided then this is ensured by the commands
+themselves, as they open the referenced file in binary mode\&.
+When literal data, or a \fB-channel\fR are provided instead, then the
+command's \fIcaller is responsible\fR for ensuring this fact\&.
+The necessary conversion command is \fBencoding convertto utf-8 $string\fR\&.
+.PP
+\fIATTENTION\fR, there is a \fITcl 9 COMPATIBILITY ISSUE\fR here\&.
+.PP
+\fITcl 8\&.x silently mishandles\fR non-binary input by cutting it
+internally to size\&. I\&.e\&. by only using the low byte of a higher unicode point\&.
+No error is thrown, the \fIresult is simply wrong\fR\&.
+.PP
+\fITcl 9 throws an error\fR instead, i\&.e\&.
+.CS
+
+expected byte sequence but character <location> was \&.\&.\&.
+.CE
 .SH COMMANDS
 .TP
 \fB::ripemd::ripemd128\fR ?\fI-hex\fR? [ \fI-channel channel\fR | \fI-file filename\fR | \fIstring\fR ]

idoc/man/files/modules/ripemd/ripemd160.n

@@ -308,6 +308,26 @@ This package will use \fBcryptkit\fR or \fBTrf\fR to
 accelerate the digest computation if either package is available\&. In
 the absence of an accelerator package the pure-Tcl implementation will
 be used\&.
+.PP
+\fIBEWARE\fR
+The commands in this package expect binary data as their input\&.
+When a \fB-file\fR is provided then this is ensured by the commands
+themselves, as they open the referenced file in binary mode\&.
+When literal data, or a \fB-channel\fR are provided instead, then the
+command's \fIcaller is responsible\fR for ensuring this fact\&.
+The necessary conversion command is \fBencoding convertto utf-8 $string\fR\&.
+.PP
+\fIATTENTION\fR, there is a \fITcl 9 COMPATIBILITY ISSUE\fR here\&.
+.PP
+\fITcl 8\&.x silently mishandles\fR non-binary input by cutting it
+internally to size\&. I\&.e\&. by only using the low byte of a higher unicode point\&.
+No error is thrown, the \fIresult is simply wrong\fR\&.
+.PP
+\fITcl 9 throws an error\fR instead, i\&.e\&.
+.CS
+
+expected byte sequence but character <location> was \&.\&.\&.
+.CE
 .SH COMMANDS
 .TP
 \fB::ripemd::ripemd160\fR ?\fI-hex\fR? [ \fI-channel channel\fR | \fI-file filename\fR | \fIstring\fR ]