pe_rbac 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 003e9ccdbe211c50b4025335831bcaab7c77d4cf
+  data.tar.gz: 40d72b46ffd84a8b9976d81eba7bf93f23e92e65
+SHA512:
+  metadata.gz: 5c05146edfa1e4d4eb2392f774699c834388d836d546b34d1aebef2e638f2375b6e3799e317013de34d9dd511b372c95b5730bc12061ba225bee42c26712ed1c
+  data.tar.gz: fec01c7aae9f104627bc7bd02ba77fa87544a2d53b6d44306adb96010d1060046d40071d96cdf3a7fe927e0d6c431daa3ed07e621b469fac48a7e5fbf0bf162f

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pe_rbac.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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.

data/README.md

@@ -0,0 +1,58 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pe_rbac'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pe_rbac
+
+## Usage
+
+### Setting up code manager on the command line
+```
+pe_rbac  code_manager --password t0ps3cret
+```
+Right now, the command line just provides a means to setup code manager.  If you
+want to do more then this, you must use the Ruby API
+
+### 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!
+
+## Development
+
+### Debugging
+```
+RESTCLIENT_LOG=stdout bundle exec pe_rbac
+```
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pe_rbac.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pe_rbac"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example.rb

@@ -0,0 +1,57 @@
+require 'pe_rbac'
+begin
+  # get all users
+  resp = PeRbac::get_users
+  puts resp
+
+  # get user by ID
+  resp = PeRbac::get_user('4765c077-3675-4a2d-85c0-0c76b82d15cb')
+  puts resp
+
+  # Lookup the ID for a user
+  resp = PeRbac::get_user_id('admin')
+  puts "FOUND: " + resp
+
+  # get all roles
+  resp = PeRbac::get_roles
+  puts resp
+
+  # get role by ID
+  resp = PeRbac::get_role(1)
+  puts resp
+
+  # create user (works - commented out to preven conflict error)
+  #resp = PeRbac::create_user('test','test@test.com', 'mr test test')
+  #puts resp
+
+  # update user
+  resp = PeRbac::update_user('test','test@test.com.au', 'mrs test test')
+  puts resp.code
+
+  # change password
+  resp = PeRbac::change_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')
+  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::login('psquared', 'changeme', '10y')
+
+  # what permissions are there?
+  resp = PeRbac::get_permissions
+  puts resp.body
+
+rescue Exception => e
+  puts e.message
+  puts e.backtrace
+end

data/exe/pe_rbac

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+require 'pe_rbac'
+require 'escort'
+
+Escort::App.create do |app|
+  app.version "0.0.1"
+  app.summary "pe_rbac"
+  app.description "create RBAC users and install tokens"
+
+  app.command :code_manager do |command|
+    command.summary "Setup a code manager"
+    command.description "Create a deploy user for use with code manager and install token"
+    command.action do |options, arguments|
+      role      = 'Code Deployers'
+      cmd       = :code_manager # FIXME obtain this automatically
+      lifetime  = options[:global][:commands][cmd][:options][:lifetime]
+      username  = options[:global][:commands][cmd][:options][:username]
+      password  = options[:global][:commands][cmd][:options][:password]
+      email     = options[:global][:commands][cmd][:options][:email]
+      role_ids = PeRbac::get_role_ids(role)
+
+      perms = {
+        "objectType" => "tokens",
+        "action"     => "override_lifetime",
+        "instance"   => nil,
+      }
+      PeRbac::update_role(role, permissions=perms)
+      PeRbac::ensure_user(username, email, username, password, role_ids)
+      PeRbac::login(username, password, lifetime)     
+    end
+    command.options do |opts|
+      opts.opt(:username,
+        'Username for deploy user',
+        :long    => '--username',
+        :default => 'deploy'
+      )
+      opts.opt(:password,
+        'Initial password for deploy user',
+        :long    => '--password',
+        :default => 'changeme'
+      )
+      opts.opt(:email,
+        'Email address',
+        :long    => '--email',
+        :default => 'root@localhost'
+      )
+      opts.opt(:lifetime,
+        'Token validity length',
+        :long    => '--lifetime',
+        :default => '10y'
+      )
+    end
+  end
+
+end

data/lib/pe_rbac.rb

@@ -0,0 +1,240 @@
+require "pe_rbac/version"
+require 'restclient'
+require 'socket'
+require 'json'
+
+module PeRbac
+  ssldir = '/etc/puppetlabs/puppet/ssl'
+  CONF = {
+    host: Socket.gethostname,
+    port: 4433,
+    cert: ssldir + '/certs/pe-internal-orchestrator.pem',
+    key: ssldir + '/private_keys/pe-internal-orchestrator.pem',
+    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
+      ids.push(found)
+    }
+    ids
+  end
+
+  # CREATE
+  def self.ensure_role(display_name, description, permissions=[], users=[])
+    if get_role_id(display_name)
+      update_role(display_name, description, permissions, users)
+    else
+      create_role(display_name, description, permissions, users)
+    end
+  end
+  
+  def self.create_role(display_name, description, permissions=[], users=[])
+    role = {
+      "display_name"  => display_name,
+      "description"   => description,
+      "permissions"   => permissions,
+      "user_ids"      => users,
+      "group_ids"     => [], # doesn't seem to be used yet
+    }
+    _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 ? display_name : role['permissions']
+      role['user_ids'] = user_ids ? display_name : role['user_ids']
+      role['group_ids'] = group_ids ? display_name : 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
+
+  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
+    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,
+    )
+  end
+
+end

data/lib/pe_rbac/version.rb

@@ -0,0 +1,3 @@
+module PeRbac
+  VERSION = "0.1.0"
+end

data/pe_rbac.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pe_rbac/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pe_rbac"
+  spec.version       = PeRbac::VERSION
+  spec.authors       = ["Geoff Williams"]
+  spec.email         = ["geoff@geoffwilliams.me.uk"]
+
+  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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "rest-client", "2.0.0"
+  spec.add_runtime_dependency "escort", "0.4.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: pe_rbac
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoff Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: escort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: Programatically do stuff with Puppet Enterprise RBAC
+email:
+- geoff@geoffwilliams.me.uk
+executables:
+- pe_rbac
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example.rb
+- exe/pe_rbac
+- lib/pe_rbac.rb
+- lib/pe_rbac/version.rb
+- pe_rbac.gemspec
+homepage: https://github.com/geoffwilliams/pe_rbac
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby API for Puppet Enterprise RBAC
+test_files: []
+has_rdoc: