pe_rbac 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b68ee5976cd98508a5b2c2c05c3812f84079c838
-  data.tar.gz: ddb64bdd13aeea1f9ae5f6c248a6b657e1711821
+  metadata.gz: 3014fbdf37cd61996d946ca5ffc913381c487f43
+  data.tar.gz: e7843fbae2230eaa7cbdc54c7713a986f5fce735
 SHA512:
-  metadata.gz: 6bb111f203b9d472937fdec79ed90cdaf4f9cdcd43b1ebe42e8afb8020128c4e5eb45fa75d11b4e3bde3ee6373bd65dd991cdb4c99ef304e2f14a9ec706b6623
-  data.tar.gz: 101a4b969b827edd2fa07f1efde04648e81bb98a1e4e2fc3d8d67167021d6821b569d01b14ab87cb83f7e6066d5b9c7980729f78d83e6b3e05208d8fd4149264
+  metadata.gz: 274adf65e4a1070b83a6d7eaa5b488dccfc6ce75beb1017390eb11dcd6ca75708c4f537f2232fcbf7a6ff683c462ec6b9ec83c956ee95a2716c4438c20e416f5
+  data.tar.gz: 76167510d42307e88eea42dcdd1e3e16d4908ba33373a5579a9068c30a67a37e756f1b51b9db71861e88112e408d8dffd23a791112e2636cd209442bb211c85a

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5
+

data/LICENSE.txt

@@ -1,21 +1,201 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Geoff Williams
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,8 +1,18 @@
+[![Build Status](https://travis-ci.org/GeoffWilliams/pe_rbac.svg?branch=master)](https://travis-ci.org/GeoffWilliams/pe_rbac)
 # PeRbac
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pe_rbac`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem lets you drive the Puppet Enterprise RBAC API from the command line or ruby.  While you can of-course do the same thing using the [pltraining/rbac](https://forge.puppet.com/pltraining/rbac) forge module, this requires that you have:
+* Write-access to Puppet's git repository
+* Code Manager setup to read from git
+* A desire to continually enforce your RBAC changes
 
-TODO: Delete this and the text above, and describe your gem
+Since this is often not the case, this gem provides a command line to do things like reset passwords or setup Code Manager with a single command.
+
+## Features/Commands
+* Setup Code Manager
+* Setup Read-only PuppetDB access
+* Reset passwords
+* Ruby API
 
 ## Installation
 
@@ -55,11 +65,8 @@ pe_rbac reset_password --username foo --password 12345678
 Reset the password for the `foo` user to `12345678`
 
 ### Ruby API
-An *IN FLUX* Ruby API exists, see code for more info.  This WILL change (well it
-will if I do any more development work on this...) - expect module names,
-functions, etc. to change.  In particular, I'm planning:
-* Sub-modules/file reorgs
-* tests!
+A Ruby API exists, see code for more info.  For the moment this code does what I want, but may extend to cover new features as requred.
+
 
 ## Development
 
@@ -74,7 +81,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pe_rbac.
+Bug reports and pull requests are welcome on GitHub at https://github.com/GeoffWilliams/pe_rbac.
 
 
 ## License

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
 task :default => :spec

data/example.rb

@@ -28,23 +28,23 @@ begin
   resp = PeRbac::update_user('test','test@test.com.au', 'mrs test test')
   puts resp.code
 
-  # change password
-  resp = PeRbac::change_password('test','12345678')
+  # reset/change password
+  resp = PeRbac::reset_password('test','12345678')
   puts resp.code
 
   # get an API token
   resp = PeRbac::token('test', '12345678')
   puts resp
-  
+
   # create or update a user with role access and write a token
-  role_ids = PeRbac::get_role_ids('Code Deployers')
+  role_id = PeRbac::get_role_id('Code Deployers')
   perms = {
     "objectType" => "tokens",
     "action"     => "override_lifetime",
     "instance"   => nil,
   }
   PeRbac::update_role('Code Deployers', permissions=perms)
-  PeRbac::ensure_user('psquared', 'root@localhost', 'psquared', 'changeme', role_ids)
+  PeRbac::ensure_user('psquared', 'root@localhost', 'psquared', 'changeme', role_id)
   PeRbac::login('psquared', 'changeme', '10y')
 
   # what permissions are there?

data/exe/pe_rbac

@@ -1,7 +1,29 @@
 #!/usr/bin/env ruby
+#
+# Copyright 2016 Geoff Williams for Puppet Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'pe_rbac'
+require 'pe_rbac/action'
+require 'pe_rbac/core'
+require 'pe_rbac/role'
+require 'pe_rbac/user'
 require 'escort'
 
+# display help if nothing specified
+ARGV.push('-h') if ARGV.empty?
+
 Escort::App.create do |app|
   app.version PeRbac::VERSION
   app.summary "pe_rbac"
@@ -19,9 +41,8 @@ Escort::App.create do |app|
       password  = options[:global][:commands][cmd][:options][:password]
       email     = options[:global][:commands][cmd][:options][:email]
 
-      role_ids = PeRbac::get_role_ids(role)
-      # always returns an array even though there should only be one match
-      role_data = PeRbac::get_role(role_ids.first)
+      role_id = PeRbac::Role::get_role_id(role)
+      role_data = PeRbac::Role::get_role(role_id)
 
       perms = [{
         "object_type" => "tokens",
@@ -30,14 +51,14 @@ Escort::App.create do |app|
       }]
 
       # only need to update the role since its built-in
-      PeRbac::update_role(
+      PeRbac::Role::update_role(
         role,
         nil,
-        PeRbac::merge_permissions(role_data['permissions'], perms)
+        PeRbac::Core::merge_permissions(role_data['permissions'], perms)
       )
 
-      PeRbac::ensure_user(username, email, username, password, role_ids)
-      PeRbac::login(username, password, lifetime)
+      PeRbac::User::ensure_user(username, email, username, password, role_id)
+      PeRbac::Action::login(username, password, lifetime)
     end
     command.options do |opts|
       opts.opt(:username,
@@ -96,20 +117,20 @@ Escort::App.create do |app|
       end
 
       # create/update the role
-      PeRbac::ensure_role(
+      PeRbac::Role::ensure_role(
         role,
         description,
         perms
       )
 
       # get the ID of the newly created role
-      role_ids    = PeRbac::get_role_ids(role)
+      role_id = PeRbac::Role::get_role_id(role)
 
       # join a user to the role
-      PeRbac::ensure_user(username, email, username, password, role_ids)
+      PeRbac::User::ensure_user(username, email, username, password, role_id)
 
       # Generate and output the token
-      token = PeRbac::token(username, password, lifetime)
+      token = PeRbac::Action::token(username, password, lifetime)
       Escort::Logger.output.puts token
     end
     command.options do |opts|
@@ -156,7 +177,7 @@ Escort::App.create do |app|
       username    = options[:global][:commands][cmd][:options][:username]
       password    = options[:global][:commands][cmd][:options][:password]
 
-      PeRbac::reset_password(username, password)
+      PeRbac::Action::reset_password(username, password)
     end
     command.options do |opts|
       opts.opt(:username,

data/lib/pe_rbac/action.rb

@@ -0,0 +1,68 @@
+#
+# Copyright 2016 Geoff Williams for Puppet Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'pe_rbac/core'
+require 'pe_rbac/user'
+module PeRbac
+  module Action
+
+    #
+    # Token
+    #
+    def self.token(login, password, lifetime=false)
+      payload = {
+        "login"     => login,
+        "password"  => password,
+      }
+
+      # see https://docs.puppet.com/pe/latest/rbac_token_auth.html#setting-a-token-specific-lifetime
+      if lifetime
+        payload["lifetime"] = lifetime
+      end
+      resp = PeRbac::Core::request(:post, '/auth/token', payload)
+      resp ? JSON.parse(resp.body)['token'] : false
+    end
+
+    def self.login(login, password, lifetime=false)
+      dirname = Dir.home + '/.puppetlabs'
+      tokenfile = dirname + '/token'
+      if ! Dir.exist?(dirname)
+        Dir.mkdir(dirname, 0700)
+      end
+      File.write(tokenfile, token(login, password, lifetime))
+      File.chmod(0600, tokenfile)
+    end
+
+    def self.reset_password(login, password)
+      # lookup user id
+      user_id = User::get_user_id(login)
+      status = false
+      if user_id
+        # get password reset token
+        reset_token = PeRbac::Core::request(:post, "/users/#{user_id}/password/reset")
+
+        # reset password
+        PeRbac::Core::request(:post, '/auth/reset', {
+          'token'     => reset_token,
+          'password'  => password,
+        })
+        status = true
+      end
+      status
+    end
+
+
+  end
+end

data/lib/pe_rbac/core.rb

@@ -0,0 +1,122 @@
+#
+# Copyright 2016 Geoff Williams for Puppet Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'escort'
+module PeRbac
+  module Core
+    @@ssldir = '/etc/puppetlabs/puppet/ssl'
+    @@fqdn = %x(facter fqdn).strip.downcase
+
+    def self.set_ssldir(ssldir)
+      @@ssldir = ssldir
+    end
+
+    def self.get_ssldir
+      @@ssldir
+    end
+
+    def self.set_fqdn(fqdn)
+      @@fqdn = fqdn
+    end
+
+    def self.get_fqdn
+      @@fqdn
+    end
+
+    def self.get_conf
+      pe_old_pk   = "#{@@ssldir}/private_keys/pe-internal-orchestrator.pem"
+      pe_old_cert = "#{@@ssldir}/certs/pe-internal-orchestrator.pem"
+      pe_new_pk   = "#{@@ssldir}/private_keys/#{@@fqdn}.pem"
+      pe_new_cert = "#{@@ssldir}/certs/#{@@fqdn}.pem"
+
+      # pe 2016.4.0 removes the pe-internal-orchestrator.pem file but old systems
+      # will still have the client cert (which won't work), so pick based on
+      # using pe-internal-orchestrator.pem if its available
+      if File.exist?(pe_old_pk)
+        pk    = pe_old_pk
+        cert  = pe_old_cert
+      else
+        pk    = pe_new_pk
+        cert  = pe_new_cert
+      end
+
+      conf = {
+        host: @@fqdn,
+        port: 4433,
+        cert: cert,
+        key: pk,
+        cacert: @@ssldir + '/certs/ca.pem'
+      }
+    end
+
+    def self.request(method, path, payload=nil, raw=false)
+      conf = get_conf()
+      url = "https://#{conf[:host]}:#{conf[:port]}#{PeRbac::BASE_URI}#{path}"
+      if payload
+        if raw
+          _payload=payload
+        else
+          _payload=payload.to_json
+        end
+      else
+        _payload=nil
+      end
+      begin
+        result = RestClient::Request.execute(
+          method: method,
+          url: url,
+          ssl_ca_file: conf[:cacert],
+          ssl_client_cert: OpenSSL::X509::Certificate.new(File.read(conf[:cert])),
+          ssl_client_key: OpenSSL::PKey::RSA.new(File.read(conf[:key])),
+          ssl_version: :TLSv1_2,
+          headers: {:content_type => :json, :accept => :json},
+          payload: _payload,
+        )
+      rescue RestClient::ExceptionWithResponse => e
+        Escort::Logger.error.error url
+        Escort::Logger.error.error _payload
+        Escort::Logger.error.error e.response
+        result = false
+      end
+
+      result
+    end
+
+
+    # return a new array of permissions, adding the permission `ensure` to the
+    # existing permissions if required
+    def self.merge_permissions(existing, ensure_perms)
+      # duplicate existing array of hash
+      permissions = existing.map do |e| e.dup end
+
+      ensure_perms.each { |ensure_perm|
+        ensure_perm_exists = false
+        existing.each { |existing_perm|
+          if  existing_perm['object_type']  == ensure_perm['object_type'] and
+              existing_perm['action']       == ensure_perm['action'] and
+              existing_perm['instance']     == ensure_perm['instance']
+            ensure_perm_exists = true
+          end
+        }
+        if ! ensure_perm_exists
+          permissions.push(ensure_perm)
+        end
+      }
+
+      permissions
+    end
+  end
+
+end

data/lib/pe_rbac/permission.rb

@@ -0,0 +1,28 @@
+#
+# Copyright 2016 Geoff Williams for Puppet Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'pe_rbac/core'
+
+module PeRbac
+  module Permission
+    #
+    # Permissions
+    #
+    def self.get_permissions()
+      resp = PeRbac::Core::request(:get, "/types")
+      resp ? JSON.parse(resp.body) : false
+    end
+  end
+end

data/lib/pe_rbac/role.rb

@@ -0,0 +1,83 @@
+#
+# Copyright 2016 Geoff Williams for Puppet Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'pe_rbac/core'
+
+module PeRbac
+  module Role
+    #
+    # role
+    #
+    def self.get_roles
+      JSON.parse(PeRbac::Core::request(:get, "/roles").body)
+    end
+
+    def self.get_role(id)
+      resp = PeRbac::Core::request(:get, "/roles/#{id}")
+      resp ? JSON.parse(resp.body) : false
+    end
+
+    def self.get_role_id(display_name)
+      i=0
+      found=false
+      roles = get_roles()
+      while !found and i < roles.length do
+        if roles[i]['display_name'] == display_name
+          found = roles[i]['id']
+        end
+        i+=1
+      end
+      found
+    end
+
+    # CREATE
+    def self.ensure_role(display_name, description, permissions=[], user_ids=[])
+      if get_role_id(display_name)
+        update_role(display_name, description, permissions, user_ids)
+      else
+        create_role(display_name, description, permissions, user_ids)
+      end
+    end
+
+    # https://docs.puppet.com/pe/latest/rbac_roles_v1.html#post-roles
+    def self.create_role(display_name, description=display_name, permissions=[], user_ids=[], group_ids=[])
+      role = {
+        "permissions"   => permissions,
+        "user_ids"      => Array(user_ids),
+        "group_ids"     => Array(group_ids),
+        "display_name"  => display_name,
+        "description"   => description,
+      }
+      PeRbac::Core::request(:post, '/roles', role) ? true : false
+    end
+
+    def self.update_role(display_name, description=nil, permissions=nil, user_ids=nil, group_ids=nil)
+      role_id = get_role_id(display_name)
+      status = false
+      if role_id
+        role = get_role(role_id)
+        role['display_name']  = display_name ? display_name : role['display_name']
+        role['description']   = description ? display_name : role['description']
+        role['permissions']   = permissions ? permissions : role['permissions']
+        role['user_ids']      = user_ids ? Array(user_ids) : role['user_ids']
+        role['group_ids']     = group_ids ? Array(group_ids) : role['group_ids']
+
+        PeRbac::Core::request(:put, "/roles/#{role_id}", role)
+        status = true
+      end
+      status
+    end
+  end
+end

data/lib/pe_rbac/user.rb

@@ -0,0 +1,94 @@
+#
+# Copyright 2016 Geoff Williams for Puppet Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'pe_rbac/core'
+require 'pe_rbac/action'
+
+module PeRbac
+  module User
+    def self.get_users
+      JSON.parse(PeRbac::Core::request(:get, '/users').body)
+    end
+
+    # get the user id for a login or false if missing
+    # eg 'admin' => '42bf351c-f9ec-40af-84ad-e976fec7f4bd'
+    def self.get_user_id(login)
+      users = get_users
+      id = false
+      i = 0
+      while !id and i < users.length do
+        if users[i]['login'] == login
+          id = users[i]['id']
+        end
+        i += 1
+      end
+      id
+    end
+
+    def self.get_user(id)
+      resp = PeRbac::Core::request(:get, "/users/#{id}")
+      resp ? JSON.parse(resp.body) : false
+    end
+
+    def self.ensure_user(login, email, display_name, password=nil, role_ids=[])
+      if get_user_id(login)
+        # existing user
+        update_user(login, email, display_name, role_ids)
+        if password
+          PeRbac::Action::reset_password(login, password)
+        end
+      else
+        # new user
+        create_user(login, email, display_name, password, role_ids)
+      end
+
+    end
+
+    def self.create_user(login, email, display_name, password=nil, role_ids=[])
+      # completely different to what the PE console sends... :/
+      # Elegantly convert role_ids to an array if it isn't one already
+      user={
+        "login"         => login,
+        "email"         => email,
+        "display_name"  => display_name,
+        "role_ids"      => Array(role_ids),
+      }
+
+      if password
+        user["password"] = password
+      end
+
+      PeRbac::Core::request(:post, '/users', user) ? true : false
+    end
+
+    def self.update_user(login, email=nil, display_name=nil, role_ids=nil, is_revoked=nil)
+      user = get_user(get_user_id(login))
+      status = false
+      if user
+        if ! user['remote']
+          # trade-off for auto id lookup is that you cant change logins...
+          user['login'] = login ? login : user['login']
+          user['email'] = email ? email : user['email']
+          user['display_name'] = display_name ? display_name : user['display_name']
+        end
+        user['role_ids'] = role_ids ? Array(role_ids) : user['role_ids']
+        user['is_revoked'] = (! is_revoked.nil?) ? is_revoked : user['is_revoked']
+
+        status = PeRbac::Core::request(:put, "/users/#{user['id']}", user) ? true : false
+      end
+      status
+    end
+  end
+end

data/lib/pe_rbac/version.rb

@@ -1,3 +1,18 @@
+#
+# Copyright 2016 Geoff Williams for Puppet Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module PeRbac
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/pe_rbac.rb

@@ -1,307 +1,24 @@
+#
+# Copyright 2016 Geoff Williams for Puppet Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require "pe_rbac/version"
 require 'restclient'
 require 'socket'
 require 'json'
 
 module PeRbac
-  ssldir = '/etc/puppetlabs/puppet/ssl'
-  fqdn = %x(facter fqdn).strip.downcase
-  pe_old_pk   = "#{ssldir}/private_keys/pe-internal-orchestrator.pem"
-  pe_old_cert = "#{ssldir}/certs/pe-internal-orchestrator.pem"
-  pe_new_pk   = "#{ssldir}/private_keys/#{fqdn}.pem"
-  pe_new_cert = "#{ssldir}/certs/#{fqdn}.pem"
-
-  # pe 2016.4.0 removes the pe-internal-orchestrator.pem file but old systems
-  # will still have the client cert (which won't work), so pick based on
-  # using pe-internal-orchestrator.pem if its available
-  if File.exist?(pe_old_pk)
-    pk    = pe_old_pk
-    cert  = pe_old_cert
-  else
-    pk    = pe_new_pk
-    cert  = pe_new_cert
-  end
-
-  CONF = {
-    host: Socket.gethostname.downcase,
-    port: 4433,
-    cert: cert,
-    key: pk,
-    cacert: ssldir + '/certs/ca.pem'
-  }
-
   BASE_URI = '/rbac-api/v1'
 
-  #
-  # user
-  #
-
-  def self.get_users
-    JSON.parse(_request(:get, '/users').body)
-  end
-
-  # get the user id for a login or false if missing
-  # eg 'admin' => '42bf351c-f9ec-40af-84ad-e976fec7f4bd'
-  def self.get_user_id(login)
-    users = get_users
-    id = false
-    i = 0
-    while !id and i < users.length do
-      if users[i]['login'] == login
-        id = users[i]['id']
-      end
-      i += 1
-    end
-    id
-  end
-
-  def self.get_user(id)
-    JSON.parse(_request(:get, "/users/#{id}").body)
-  end
-
-  def self.ensure_user(login, email, display_name, password=nil, role_ids=[])
-    if get_user_id(login)
-      # existing user
-      update_user(login, email, display_name, role_ids)
-      if password
-        change_password(login, password)
-      end
-    else
-      # new user
-      create_user(login, email, display_name, password, role_ids)
-    end
-
-  end
-
-  def self.create_user(login, email, display_name, password=nil, role_ids=[])
-    # completely different to what the PE console sends... :/
-    user={
-      "login"         => login,
-      "email"         => email,
-      "display_name"  => display_name,
-      "role_ids"      => role_ids,
-    }
-
-    if password
-      user["password"] = password
-    end
-
-    _request(:post, '/users', user)
-  end
-
-  def self.update_user(login, email=nil, display_name=nil, role_ids=nil, is_revoked=nil)
-    user = get_user(get_user_id(login))
-    if ! user['remote']
-      # trade-off for auto id lookup is that you cant change logins...
-      user['login'] = login ? login : user['login']
-      user['email'] = email ? email : user['email']
-      user['display_name'] = display_name ? display_name : user['display_name']
-    end
-    user['role_ids'] = role_ids ? role_ids : user['role_ids']
-    user['is_revoked'] = (! is_revoked.nil?) ? is_revoked : user['is_revoked']
-
-    _request(:put, "/users/#{user['id']}", user)
-  end
-
-  def self.change_password(login, new_password)
-    token = _request(:post, "/users/#{get_user_id(login)}/password/reset").body
-
-    reset = {
-      "token"     => token,
-      "password"  => new_password,
-    }
-
-    _request(:post, '/auth/reset', reset)
-  end
-
-  #
-  # role
-  #
-  def self.get_roles
-    JSON.parse(_request(:get, "/roles").body)
-  end
-
-  def self.get_role(id)
-    JSON.parse(_request(:get, "/roles/#{id}").body)
-  end
-
-  def self.get_role_id(display_name)
-    i=0
-    found=false
-    roles = get_roles()
-    while !found and i < roles.length do
-      if roles[i]['display_name'] == display_name
-        found = roles[i]['id']
-      end
-      i+=1
-    end
-    found
-  end
-
-
-  # get the role id for a display name
-  # eg ['Code Deployers', 'blah'] => [4,8]
-  def self.get_role_ids(display_names)
-    if ! display_names.is_a? Array
-      display_names = [display_names]
-    end
-    roles = get_roles
-    ids = []
-    display_names.each { |display_name|
-      found=get_role_id(display_name)
-      #if !found
-      #  raise("RBAC role '#{display_name}' not found")
-      #end
-      if found
-        ids.push(found)
-      end
-    }
-    ids
-  end
-
-  # CREATE
-  def self.ensure_role(display_name, description, permissions=[], user_ids=[])
-    if get_role_id(display_name)
-      update_role(display_name, description, permissions, user_ids)
-    else
-      create_role(display_name, description, permissions, user_ids)
-    end
-  end
-
-  # https://docs.puppet.com/pe/latest/rbac_roles_v1.html#post-roles
-  def self.create_role(display_name, description=display_name, permissions=[], user_ids=[], group_ids=[])
-    role = {
-      "permissions"   => permissions,
-      "user_ids"      => user_ids,
-      "group_ids"     => group_ids,
-      "display_name"  => display_name,
-      "description"   => description,
-    }
-    _request(:post, '/roles', role)
-  end
-
-  def self.update_role(display_name, description=nil, permissions=nil, user_ids=nil, group_ids=nil)
-    role_id = get_role_id(display_name)
-    if role_id
-      role = get_role(role_id)
-      role['display_name']  = display_name ? display_name : role['display_name']
-      role['description']   = description ? display_name : role['description']
-      role['permissions']   = permissions ? permissions : role['permissions']
-      role['user_ids']      = user_ids ? user_ids : role['user_ids']
-      role['group_ids']     = group_ids ? group_ids : role['group_ids']
-
-      _request(:put, "/roles/#{role_id}", role)
-    else
-      raise("No such role exists: #{display_name} create it first or use ensure_role")
-    end
-  end
-
-
-  #
-  # Permissions
-  #
-  def self.get_permissions()
-    _request(:get, "/types")
-  end
-
-
-  #
-  # Token
-  #
-  def self.token(login, password, lifetime=false)
-    payload = {
-      "login"     => login,
-      "password"  => password,
-    }
-
-    # see https://docs.puppet.com/pe/latest/rbac_token_auth.html#setting-a-token-specific-lifetime
-    if lifetime
-      payload["lifetime"] = lifetime
-    end
-
-    JSON.parse(_request(:post, '/auth/token', payload))['token']
-  end
-
-  def self.login(login, password, lifetime=false)
-    dirname = Dir.home + '/.puppetlabs'
-    tokenfile = dirname + '/token'
-    if ! Dir.exist?(dirname)
-      Dir.mkdir(dirname, 0700)
-    end
-    File.write(tokenfile, token(login, password, lifetime))
-    File.chmod(0600, tokenfile)
-  end
-
-  def self.reset_password(login, password)
-    # lookup user id
-    user_id = self.get_user_id(login)
-    if user_id
-      # get password reset token
-      reset_token = _request(:post, "/users/#{user_id}/password/reset")
-
-      # reset password
-      _request(:post, '/auth/reset', {
-        'token'     => reset_token,
-        'password'  => password,
-      })
-    else
-      Escort::Logger.error.error "No such user: #{login}"
-    end
-  end
-
-  # return a new array of permissions, adding the permission `ensure` to the
-  # existing permissions if required
-  def self.merge_permissions(existing, ensure_perms)
-    # duplicate existing array of hash
-    permissions = existing.map do |e| e.dup end
-
-    ensure_perms.each { |ensure_perm|
-      ensure_perm_exists = false
-      existing.each { |existing_perm|
-        if  existing_perm['object_type']  == ensure_perm['object_type'] and
-            existing_perm['action']       == ensure_perm['action'] and
-            existing_perm['instance']     == ensure_perm['instance']
-          ensure_perm_exists = true
-        end
-      }
-      if ! ensure_perm_exists
-        permissions.push(ensure_perm)
-      end
-    }
-
-    permissions
-  end
-
-  private
-
-  def self._request(method, path, payload=nil, raw=false)
-    url = "https://#{CONF[:host]}:#{CONF[:port]}#{BASE_URI}#{path}"
-    if payload
-      if raw
-        _payload=payload
-      else
-        _payload=payload.to_json
-      end
-    else
-      _payload=nil
-    end
-    begin
-      RestClient::Request.execute(
-        method: method,
-        url: url,
-        ssl_ca_file: CONF[:cacert],
-        ssl_client_cert: OpenSSL::X509::Certificate.new(File.read(CONF[:cert])),
-        ssl_client_key: OpenSSL::PKey::RSA.new(File.read(CONF[:key])),
-        ssl_version: :TLSv1,
-        headers: {:content_type => :json, :accept => :json},
-        payload: _payload,
-      )
-    rescue RestClient::ExceptionWithResponse => e
-      Escort::Logger.error.error url
-      Escort::Logger.error.error _payload
-      Escort::Logger.error.error e.response
-      raise "API Error"
-    end
-  end
-
 end

data/pe_rbac.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Ruby API for Puppet Enterprise RBAC}
   spec.description   = %q{Programatically do stuff with Puppet Enterprise RBAC}
   spec.homepage      = "https://github.com/geoffwilliams/pe_rbac"
-  spec.license       = "MIT"
+  spec.license       = "Apache 2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
@@ -21,6 +21,16 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sinatra", "1.4.7"
+  spec.add_development_dependency "webrick", "1.3.1"
+  spec.add_development_dependency "rack", "1.6.5"
+  spec.add_development_dependency "fakefs", "0.10.1"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency  'simplecov', "0.12.0"
+
+  # required at runtime but provided by PE
+  spec.add_development_dependency "facter", "2.4.6"
+
 
   spec.add_runtime_dependency "rest-client", "2.0.0"
   spec.add_runtime_dependency "escort", "0.4.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pe_rbac
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Geoff Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,104 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: facter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.6
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +173,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,11 +184,16 @@ files:
 - example.rb
 - exe/pe_rbac
 - lib/pe_rbac.rb
+- lib/pe_rbac/action.rb
+- lib/pe_rbac/core.rb
+- lib/pe_rbac/permission.rb
+- lib/pe_rbac/role.rb
+- lib/pe_rbac/user.rb
 - lib/pe_rbac/version.rb
 - pe_rbac.gemspec
 homepage: https://github.com/geoffwilliams/pe_rbac
 licenses:
-- MIT
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []