kubeclient 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad5e0d0d632be2585068c14cf2eb218e20788c83
-  data.tar.gz: f7b002dcb8a7a49381b3bdbe8e6eaf2abdbe1f4d
+  metadata.gz: f7a3f5bd1265e7901b0107badc19f6519919674d
+  data.tar.gz: 89a0f99ce7194c998a3a0f18888fcc0496adf2b8
 SHA512:
-  metadata.gz: 0bec0e053d54fa34c6b058c071b55e681d0c97497808ba7e23703dcfde1dff5e86be185a2b3cf0c1c834b50857b11298ff524f14ed42c2145d18d859b85924c5
-  data.tar.gz: 5f2d7cb7770b4e7d3414b468704db641929eafde9452c60a863ab7d542cb3ea9fc1e35f8d2cddb3f85ccf02eb8a1dd078503748822e2ba7db3b9383210788cfe
+  metadata.gz: 0ea1aec07c2dd2e121b9648fb1e18a3c23993af2bf9efd460992ec8a983c5d1ee38102c1b013a20e09c766d1f7e1474561494bd77e28be190f3a85ec23ec5fd6
+  data.tar.gz: b002550b4e4144802f20e21262f082ce228bc196e643e0f9c4446f1cbe49f0710584d5cdab865a544cc557b4e27a6661ce9350423075a34a700fbc01b18ebdb2

data/CHANGELOG.md

@@ -4,6 +4,15 @@ Notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 Kubeclient release versioning follows [SemVer](https://semver.org/).
 
+## 3.1.1 - 2018-06-01
+
+### Security
+- Fixed `Kubeclient::Config.read` to use `YAML.safe_load` (#334).
+
+  Previously, could deserialize arbitrary ruby classes.  The risk depends on ruby classes available in the application; sometimes a class may have side effects - up to arbitrary code execution - when instantiated and/or built up with `x[key] = value` during YAML parsing.
+
+  Despite this fix, using config from untrusted sources is not recommended.
+
 ## 3.1.0 - 2018-05-27
 
 ### Fixed

data/README.md

@@ -262,30 +262,44 @@ end
 
 ### Kubeclient::Config
 
-If you've been using `kubectl` and have a `.kube/config` file, you can auto-populate a config object using `Kubeclient::Config`:
+If you've been using `kubectl` and have a `.kube/config` file (possibly referencing other files in fields such as `client-certificate`), you can auto-populate a config object using `Kubeclient::Config`:
 
 ```ruby
-config = Kubeclient::Config.read('/path/to/.kube/config')
+# assuming $KUBECONFIG is one file, won't merge multiple like kubectl
+config = Kubeclient::Config.read(ENV['KUBECONFIG'] || '/path/to/.kube/config')
 ```
 
-...and then pass that object to `Kubeclient::Client`:
+You can also construct `Config` directly from nested data. For example if you have JSON or YAML config data in a variable:
 
+```ruby
+config = Kubeclient::Config.new(YAML.safe_load(yaml_text), nil)
+# or
+config = Kubeclient::Config.new(JSON.parse(json_text), nil)
 ```
+
+The 2nd argument is a base directory for finding external files, if config refers to them with relative path.
+Setting it to `nil` disables file lookups.  (A config can be self-contained by using inline fields such as `client-certificate-data`.)
+
+To create a client based on a Config object:
+
+```ruby
+# default context according to `current-context` field:
+context = config.context
+# or to use a specific context, by name:
+context = config.context('default/192-168-99-100:8443/system:admin')
+
 Kubeclient::Client.new(
-  config.context.api_endpoint,
-    config.context.api_version,
-    {
-      ssl_options: config.context.ssl_options,
-      auth_options: config.context.auth_options
-    }
+  context.api_endpoint,
+  context.api_version,
+  ssl_options: context.ssl_options,
+  auth_options: context.auth_options
 )
 ```
 
-You can also load your JSONified config in from an ENV variable (e.g. `KUBE_CONFIG`) like so:
+#### Security: Don't use config from untrusted sources
 
-```ruby
-Kubeclient::Config.new(JSON.parse(ENV['KUBE_CONFIG']), nil)
-```
+Kubeclient was never reviewed for behaving safely with malicious / malformed config.
+It might crash / misbehave in unexpected ways...
 
 #### namespace
 

data/lib/kubeclient/config.rb

@@ -25,7 +25,7 @@ module Kubeclient
     end
 
     def self.read(filename)
-      Config.new(YAML.load_file(filename), File.dirname(filename))
+      Config.new(YAML.safe_load(File.read(filename)), File.dirname(filename))
     end
 
     def contexts

data/lib/kubeclient/version.rb

@@ -1,4 +1,4 @@
 # Kubernetes REST-API Client
 module Kubeclient
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.1.1'.freeze
 end

data/test/test_config.rb

@@ -1,4 +1,5 @@
 require_relative 'test_helper'
+require 'yaml'
 
 # Testing Kubernetes client configuration
 class KubeclientConfigTest < MiniTest::Test
@@ -14,6 +15,34 @@ class KubeclientConfigTest < MiniTest::Test
     check_context(config.context, ssl: true)
   end
 
+  def test_allinone_nopath
+    yaml = File.read(config_file('allinone.kubeconfig'))
+    # A self-contained config shouldn't depend on kcfg_path.
+    config = Kubeclient::Config.new(YAML.safe_load(yaml), nil)
+    assert_equal(['default/localhost:8443/system:admin'], config.contexts)
+    check_context(config.context, ssl: true)
+  end
+
+  def test_external_nopath
+    yaml = File.read(config_file('external.kubeconfig'))
+    # kcfg_path = nil should prevent file access
+    config = Kubeclient::Config.new(YAML.safe_load(yaml), nil)
+    assert_raises(StandardError) do
+      config.context.ssl_options
+    end
+  end
+
+  def test_external_nopath_absolute
+    yaml = File.read(config_file('external.kubeconfig'))
+    # kcfg_path = nil should prevent file access, even if absolute path specified
+    ca_absolute_path = File.absolute_path(config_file('external.kubeconfig').path)
+    yaml = yaml.gsub('external-ca.pem', ca_absolute_path)
+    config = Kubeclient::Config.new(YAML.safe_load(yaml), nil)
+    assert_raises(StandardError) do
+      config.context.ssl_options
+    end
+  end
+
   def test_nouser
     config = Kubeclient::Config.read(config_file('nouser.kubeconfig'))
     assert_equal(['default/localhost:8443/nouser'], config.contexts)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubeclient
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Alissa Bonas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-27 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -297,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A client for Kubernetes REST api