Cleared environment variables still visible via PTY.spawn #2888

rampion · 2015-04-29T13:04:17Z

I've found a bug with JRuby's ENV constant's #[]= and #delete methods.
Environment variables cleared via ENV["FOO"] = nil or ENV.delete("FOO"),
are still set to their pre-cleared value under certain conditions.

In particular, you can still see the pre-cleared value in a PTY terminal
spawned after the environment variable was cleared. This is in contrast
to subshells started via backtick, system, or exec, where the cleared
value does not seem to be visible.

Using the example.rb code defined at the end:

$ jruby example.rb
originally : {:pty=>nil, :backtick=>nil, :env=>nil}
clearing via ENV["FOO"] = nil
        after set   : {:pty=>"something", :backtick=>"something", :env=>"something"}
        after clear : {:pty=>"something", :backtick=>nil, :env=>nil}
clearing via ENV["FOO"] = ""
        after set   : {:pty=>"something else", :backtick=>"something else", :env=>"something else"}
        after clear : {:pty=>"", :backtick=>"", :env=>""}
clearing via ENV.delete("FOO")
        after set   : {:pty=>"yet something else", :backtick=>"yet something else", :env=>"yet something else"}
        after clear : {:pty=>"yet something else", :backtick=>nil, :env=>nil}

Note how the environment made available to the pty still has the old value of $FOO.

In contrast, MRI ruby does not leak the old environment variable to the PTY terminal:

$ mriruby example.rb
originally : {:pty=>nil, :backtick=>nil, :env=>nil}
clearing via ENV["FOO"] = nil
        after set   : {:pty=>"something", :backtick=>"something", :env=>"something"}
        after clear : {:pty=>nil, :backtick=>nil, :env=>nil}
clearing via ENV["FOO"] = ""
        after set   : {:pty=>"something else", :backtick=>"something else", :env=>"something else"}
        after clear : {:pty=>"", :backtick=>"", :env=>""}
clearing via ENV.delete("FOO")
        after set   : {:pty=>"yet something else", :backtick=>"yet something else", :env=>"yet something else"}
        after clear : {:pty=>nil, :backtick=>nil, :env=>nil}

Example code follows:

# example.rb
require 'tempfile'
require 'pty'

COMMAND = %!ruby -e "p ENV['FOO']"!

def test
  tf = Tempfile.new 'output'
  output = begin
             stdout, stdin, pid = PTY.spawn "#{COMMAND} | tee #{tf.path}"
             stdout.read
           rescue Errno::EIO, IOError
             tf.read
           ensure
             tf.close
             Process.wait pid
           end
  { :pty => eval(output), :backtick => eval(`#{COMMAND}`), :env => ENV["FOO"] }
end

original = ENV["FOO"]
puts "originally : #{test.inspect}"

puts 'clearing via ENV["FOO"] = nil'
ENV["FOO"] = "something"
puts "\tafter set   : #{test.inspect}"
ENV["FOO"] = nil
puts "\tafter clear : #{test.inspect}"

puts 'clearing via ENV["FOO"] = ""'
ENV["FOO"] = "something else"
puts "\tafter set   : #{test.inspect}"
ENV["FOO"] = ""
puts "\tafter clear : #{test.inspect}"

puts 'clearing via ENV.delete("FOO")'
ENV["FOO"] = "yet something else"
puts "\tafter set   : #{test.inspect}"
ENV.delete "FOO"
puts "\tafter clear : #{test.inspect}"

The text was updated successfully, but these errors were encountered:

byteit101 self-assigned this Jan 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Sponsors

Cleared environment variables still visible via PTY.spawn #2888

Cleared environment variables still visible via PTY.spawn #2888

rampion commented Apr 29, 2015

Cleared environment variables still visible via PTY.spawn #2888

Cleared environment variables still visible via PTY.spawn #2888

Comments

rampion commented Apr 29, 2015