Different behaviour and output when piping in CMD and PowerShell

by

tl;dr:

Up to at least PowerShell 7.2.x, if you need raw byte handling and/or need to prevent PowerShell from situationally adding a trailing newline to your text data, avoid the PowerShell pipeline altogether.

  • Future support for passing raw byte data between external programs and to-file redirections is the subject of GitHub issue #1908.

For raw byte handling, shell out to cmd with /c (on Windows; on Unix-like platforms / Unix-like Windows subsystems, use sh or bash with -c):

cmd /c 'type .\test.txt | .\Crypt.exe --encrypt | .\Crypt.exe --decrypt'

Use a similar technique to save raw byte output in a file – do not use PowerShell‘s > operator:

cmd /c 'someexe > file.bin'

Note that if you want to capture an external program’s text output in a PowerShell variable or process it further in a PowerShell pipeline, you need to make sure that [Console]::OutputEncoding matches your program’s output character encoding (the active OEM code page, typically), which should be true by default in this case; see the next section for details.

Generally, however, byte manipulation of text data is best avoided.

There are two separate problems, only one of which has a simple solution:

Problem 1: There is indeed a character encoding problem, as you suspected:

PowerShell invisibly inserts itself as an intermediary in pipelines, even when sending data to and receiving data from external programs: It converts data from and to .NET strings (System.String), which are sequences of UTF-16 code units.

  • As an aside: Even when using only PowerShell-native commands, this means that reading input from files and saving them again can result in a different character encoding, because the information about the original character encoding is not preserved once (string) data has been read into memory, and on saving it is the cmdlets’ default character encoding that is used; while this default encoding is consistently BOM-less UTF-8 in PowerShell (Core) 6+, it varies by cmdlet in Windows PowerShell – see this answer.

In order to send to and receive data from external programs (such as Crypt.exe in your case), you need to match their character encoding; in your case, with a Windows console application that uses raw byte handling, the implied encoding is the system’s active OEM code page.

  • On sending data, PowerShell uses the encoding of the $OutputEncoding preference variable to encode (what is invariably treated as text) data, which defaults to ASCII(!) in Windows PowerShell, and (BOM-less) UTF-8 in PowerShell (Core).

  • The receiving end is covered by default: PowerShell uses [Console]::OutputEncoding (which itself reflects the code page reported by chcp) for decoding data received, and on Windows this by default reflects the active OEM code page, both in Windows PowerShell and PowerShell [Core][1].

To fix your primary problem, you therefore need to set $OutputEncoding to the active OEM code page:

# Make sure that PowerShell uses the OEM code page when sending
# data to `.\Crypt.exe`
$OutputEncoding = [Console]::OutputEncoding

Problem 2: PowerShell invariably appends a trailing newline to data that doesn’t already have one when piping data to external programs:

That is, "foo" | .\Crypt.exe doesn’t send (the $OutputEncoding-encoded bytes representing) "foo" to .\Crypt.exe‘s stdin, it sends "foo`r`n" on Windows; i.e., a (platform-appropriate) newline sequence (CRLF on Windows) is automatically and invariably appended (unless the string already happens to have a trailing newline).

This problematic behavior is discussed in GitHub issue #5974 and also in this answer.

In your specific case, the implicitly appended "`r`n" is also subject to the byte-value-shifting, which means that the 1st Crypt.exe calls transforms it to -*, causing another "`r`n" to be appended when the data is sent to the 2nd Crypt.exe call.

The net result is an extra newline that is round-tripped (the intermediate -*), plus an encrypted newline that results in φΩ).

In short: If your input data had no trailing newline, you’ll have to cut off the last 4 characters from the result (representing the round-tripped and the inadvertently encrypted newline sequences):

# Ensure that .\Crypt.exe output is correctly decoded.
$OutputEncoding = [Console]::OutputEncoding

# Invoke the command and capture its output in variable $result.
# Note the use of the `Get-Content` cmdlet; in PowerShell, `type`
# is simply a built-in *alias* for it.
$result = Get-Content .\test.txt | .\Crypt.exe --decrypt | .\Crypt.exe --encrypt

# Remove the last 4 chars. and print the result.
$result.Substring(0, $result.Length - 4)

Given that calling cmd /c as shown at the top of the answer works too, that hardly seems worth it.

How PowerShell handles pipeline data with external programs:

Unlike cmd (or POSIX-like shells such as bash):

  • PowerShell doesn’t support raw byte data in pipelines.[2]
  • When talking to external programs, it only knows text (whereas it passes .NET objects when talking to PowerShell’s own commands, which is where much of its power comes from).

Specifically, this works as follows:

  • When you send data to an external program via the pipeline (to its stdin stream):

    • It is converted to text (strings) using the character encoding specified in the $OutputEncoding preference variable, which defaults to ASCII(!) in Windows PowerShell, and (BOM-less) UTF-8 in PowerShell (Core).

      • Caveat: If you assign an encoding with a BOM to $OutputEncoding, PowerShell (as of v7.0) will emit the BOM as part of the first line of output sent to an external program; therefore, for instance, do not use [System.Text.Encoding]::Utf8 (which emits a BOM) in Windows PowerShell, and use [System.Text.Utf8Encoding]::new($false) (which doesn’t) instead.

      • If the data is not captured or redirected by PowerShell, encoding problems may not always become apparent, namely if an external program is implemented in a way that uses the Windows Unicode console API to print to the display.

    • Something that isn’t already text (a string) is stringified using PowerShell’s default output formatting (the same format you see when you print to the console), with an important caveat:

      • If the (last) input object already is a string that doesn’t itself have a trailing newline, one is invariably appended (and even an existing trailing newline is replaced with the platform-native one, if different).

  • When you capture / redirect data from an external program (from its stdout stream), it is invariably decoded as lines of text (strings), based on the encoding specified in [Console]::OutputEncoding, which defaults to the active OEM code page on Windows (surprisingly, in both PowerShell editions, as of v7.0-preview6[1]).

  • PowerShell-internally text is represented using the .NET System.String type, which is based on UTF-16 code units (often loosely, but incorrectly called “Unicode”[3]).

The above also applies:

  • when piping data between external programs,

  • when data is redirected to a file; that is, irrespective of the source of the data and its original character encoding, PowerShell uses its default encoding(s) when sending data to files; in Windows PowerShell, > produces UTF-16LE-encoded files (with BOM), whereas PowerShell (Core) sensibly defaults to BOM-less UTF-8 (consistently, across file-writing cmdlets).

[1] In PowerShell (Core), given that $OutputEncoding commendably already defaults to UTF-8, it would make sense to have [Console]::OutputEncoding be the same – i.e., for the active code page to be effectively 65001 on Windows, as suggested in GitHub issue #7233.

[2] With input from a file, the closest you can get to raw byte handling is to read the file as a .NET System.Byte array with Get-Content -AsByteStream (PowerShell (Core)) / Get-Content -Encoding Byte (Windows PowerShell), but the only way you can further process such as an array is to pipe to a PowerShell command that is designed to handle a byte array, or by passing it to a .NET type’s method that expects a byte array. If you tried to send such an array to an external program via the pipeline, each byte would be sent as its decimal string representation on its own line.

[3] Unicode is the name of the abstract standard describing a “global alphabet”. In concrete use, it has various standard encodings, UTF-8 and UTF-16 being the most widely used.

More Related Contents:

  1. CMD pipe different form Powershell pipe?
  2. Watch file for changes and run command with powershell
  3. Escaping the and (&) sign in Powershell
  4. UTF-8 output from PowerShell
  5. How to run an application as “run as administrator” from the command prompt? [closed]
  6. How can I run a PowerShell script with white spaces in the path from the command line?
  7. How to run an installation in /silent mode with adjusted settings
  8. Running CMD command in PowerShell
  9. CMD or Powershell command to combine (merge) corresponding lines from two files [duplicate]
  10. PowerShell The term is not recognized as cmdlet function script file or operable program
  11. Git Shell in Windows: patch’s default character encoding is UCS-2 Little Endian – how to change this to ANSI or UTF-8 without BOM?
  12. String handling from Powershell script
  13. How to create a zip archive with PowerShell?
  14. How do I pass named parameters with Invoke-Command?
  15. What’s the difference between “Write-Host”, “Write-Output”, or “[console]::WriteLine”?
  16. How to redirect Windows cmd stdout and stderr to a single file?
  17. How do you run a SQL Server query from PowerShell?
  18. Combine `Get-Disk` info and `LogicalDisk` info in PowerShell?
  19. Powershell remoting with ip-address as target
  20. Merging multiple CSV files into one using PowerShell
  21. Obtaining ExitCode using Start-Process and WaitForExit instead of -Wait
  22. Why and how are these two $null values different?
  23. A better way to check if a path exists or not in PowerShell [closed]
  24. Create directory if it does not exist
  25. Delete all files and folders but exclude a subfolder
  26. Start-Process with PowerShell.exe exhibits different behavior with embedded single quotes and double quotes
  27. Why is $false -eq “” true?
  28. Jenkins powershell plugin is running 32 bit Powershell and I need 64bit
  29. Powershell – Output Color for certain results
  30. Pass function as a parameter

Leave a Comment