cf-uaac 4.3.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ec28aaefed5216eceb8c2665fd861167475f4b02202c0f7a432ded556374b02
-  data.tar.gz: aa68a4e5bdced51b1a049f8cad96237eec7784c596dfc51f77de0c5dd0a3fdc8
+  metadata.gz: 9b0ccc68333fba77918370b92678e803a339d2efd0bf80415f06a469015f69ca
+  data.tar.gz: 15fd888cb1d7beeb64df62f9393a6d148daa76377e8af02eb9b531b43b39afe5
 SHA512:
-  metadata.gz: f5e0299e7af1702bd5ec78da39eb6d731a1eda5d1458c5ff564f6a0b141877ee9e84351fa107984719c77be3e49ca4323967222ddff7dc08f8e24daa74f725dc
-  data.tar.gz: 19999aa17a59d217da5e01cdef536834d4b10529a4bc860b5ddbdac07637336ebf594b5d18e18dd93256b2cdb3607067ea283c8f687d679c75c627391721f545
+  metadata.gz: 6f37d4c1122288ebad48fdc0612c1263a8eebcedca8a12e467ca2b625bddf0cf5136fe11511e085a8f8f0ca6a03bc4283a2b580e30a79b626c13779d4888355b
+  data.tar.gz: f22f6149a3b769a9b3428def9568091a2f9cac5a99042c9c9a9bce76e9fc5984849fa1393ca3966f9e81952abac84c4b35f66b70f9a8c89a599de371cad6049e

data/.github/workflows/ruby.yml

@@ -0,0 +1,26 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.5', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake cov

data/README.md

@@ -1,8 +1,13 @@
 # CloudFoundry UAA Command Line Client
 
-[![Build Status](https://travis-ci.org/cloudfoundry/cf-uaac.svg?branch=master)](https://travis-ci.org/cloudfoundry/cf-uaac)
+![Build status](https://github.com/cloudfoundry/cf-uaac/actions/workflows/ruby.yml/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/cf-uaac.png)](https://rubygems.org/gems/cf-uaac)
 
+## Operating system compatibility 
+
+The `uaac` CLI is tested on Linux and Mac OS, and is supported on these systems.
+It is not tested or supported on Windows, though it has been known to work at some point.
+
 ## Installation
 
 From Rubygems:
@@ -17,6 +22,24 @@ gem build cf-uaac.gemspec
 gem install cf-uaac*.gem
 ```
 
+### Troubleshooting possible installation issues
+
+You may encounter some errors when building native extentions of the required
+Gems. We redirect you to the documentation of those Gem dependencies, as many
+different compilation/linking issue may occur.
+
+Typical issues with x86 Darwin systems (i.e. macOS) may involve the following
+`cflags` and `ldflags` options, for the `bundler` Gem to properly build the
+required Gems native extensions. You should not use them blindly without
+knowing what you're doing. If you don't want persistent workarounds in your
+Bundler config, those settings can also be passed to one-off `gem install`
+invocations. Please refer to `gem help install` and `man bundle-config`.
+
+```
+bundle config build.eventmachine --with-cflags="-fms-extensions"
+bundle config build.mysql2 --with-ldflags="-L/usr/local/opt/openssl@1.1/lib"
+bundle config build.thin --with-cflags="-fms-extensions -Wno-error=implicit-function-declaration"
+```
 
 ## Concepts
 
@@ -35,6 +58,11 @@ Now that UAAC has your token, you're able to run commands and hit the endpoints
 
 To use the APIs, see: https://github.com/cloudfoundry/cf-uaa-lib
 
+### Caveats in connecting
+
+When necessary, the `--skip-ssl-validation` flag should be used once only,
+along with the `uaac target` invocation. See `uaac target -h`.
+
 
 ## Creating clients
 
@@ -67,4 +95,4 @@ export UAA_CLIENT_ID="admin"
 export UAA_CLIENT_SECRET="adminsecret"
 export UAA_CLIENT_TARGET="http://localhost:8080/uaa"
 bundle exec rake test
-```
+```

data/cf-uaac.gemspec

@@ -24,8 +24,6 @@ Gem::Specification.new do |s|
   s.summary     = %q{Command line interface for CloudFoundry UAA}
   s.description = %q{Client command line tools for interacting with the CloudFoundry User Account and Authorization (UAA) server.  The UAA is an OAuth2 Authorization Server so it can be used by webapps and command line apps to obtain access tokens to act on behalf of users.  The tokens can then be used to access protected resources in a Resource Server.  This library can be used by clients (as a convenient wrapper for mainstream oauth gems) or by resource servers.}
 
-  s.rubyforge_project = 'cf-uaac'
-
   s.license       = 'Apache-2.0'
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -33,13 +31,14 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   # dependencies
-  s.add_runtime_dependency 'cf-uaa-lib', '~> 3.11'
+  s.add_runtime_dependency 'cf-uaa-lib', '~> 4.0'
   s.add_development_dependency 'rake', '>= 10.3.1', '~> 13.0'
   s.add_development_dependency 'rspec', '>= 2.14.1', '~> 3.9'
   s.add_development_dependency 'simplecov', '~> 0.21.2'
-  s.add_development_dependency 'simplecov-rcov', '~> 0.2.3'
-  s.add_development_dependency 'ci_reporter', '~> 1.9', '>= 1.9.2'
-  s.add_runtime_dependency 'highline', '~> 1.6', '>= 1.6.21'
+  s.add_development_dependency 'simplecov-rcov', '~> 0.3.0'
+  s.add_development_dependency 'ci_reporter', '>= 1.9.2', '~> 2.0'
+  s.add_development_dependency 'ci_reporter_rspec', '~> 1.0'
+  s.add_runtime_dependency 'highline', '~> 2.0'
   s.add_runtime_dependency 'eventmachine', '~> 1.0', '>= 1.0.3'
   s.add_runtime_dependency 'launchy', '~> 2.4', '>= 2.4.2'
   s.add_runtime_dependency 'em-http-request', '~> 1.1', '>= 1.1.2'

data/lib/uaa/cli/base.rb

@@ -14,6 +14,7 @@
 require 'highline'
 require 'optparse'
 require 'json/pure'
+require 'io/console'
 
 module CF; module UAA end end
 
@@ -65,7 +66,7 @@ class Topic
 
   def terminal_columns
     return @terminal_columns ||= 0 if @terminal_columns || !@output.tty?
-    cols = HighLine::SystemExtensions.terminal_size.first rescue 0
+    cols = IO.console.winsize.last rescue 0 if $stdin.tty?
     @terminal_columns = !cols || cols < 40 ? 0 : cols
   end
 

data/lib/uaa/cli/client_reg.rb

@@ -28,6 +28,8 @@ class ClientCli < CommonCli
       :refresh_token_validity => 'seconds',
       :redirect_uri => 'list',
       :autoapprove => 'list',
+      :allowpublic => 'list',
+      :allowedproviders => 'list',
       :'signup_redirect_url' => 'url'
   }
   CLIENT_SCHEMA.each { |k, v| define_option(k, "--#{k} <#{v}>") }
@@ -45,12 +47,15 @@ class ClientCli < CommonCli
         info[k] = opts[:interact] ?
           info[k] = askd("#{k.to_s.gsub('_', ' ')} (#{p})", default): default
       end
-      if k == :autoapprove && (info[k] == 'true' || info[k] == 'false')
+      if (k == :autoapprove || k == :allowpublic) && (info[k] == 'true' || info[k] == 'false')
         info[k] = !!(info[k] == 'true')
       else
         info[k] = Util.arglist(info[k]) if p == 'list'
         info.delete(k) unless info[k]
       end
+      if opts.key?(k) && k == :allowedproviders && (info[k].join('') == 'all' || info[k].join('') == 'null' || info[k].join('') == 'nil')
+        info[:allowedproviders] = nil
+      end
     end
   end
 

data/lib/uaa/cli/common.rb

@@ -31,7 +31,7 @@ class CommonCli < Topic
 
   def username(name); name || ask("User name") end
   def userpwd(pwd = opts[:password]); pwd || ask_pwd("Password") end
-  def passcode(passcode = opts[:passcode]); passcode || ask("Passcode (from #{Config.target}/passcode)") end
+  def passcode(passcode = opts[:passcode]); passcode || ask("Passcode ( from #{Config.target}/passcode )") end
   def clientid(id = opts[:client]); id || ask("Client ID") end
   def clientsecret(secret = opts[:secret]); secret || ask_pwd("Client secret") end
   def clientname(name = opts[:name]); name end
@@ -186,7 +186,8 @@ class MiscCli < CommonCli
   define_option :ca_cert, "--ca-cert [file]", "use the given CA certificate to validate the target's SSL certificate"
   define_option :skip_ssl_validation, "--skip-ssl-validation", "do not attempt to validate ssl certificate"
   define_option :force, "--[no-]force", "-f", "set even if target does not respond"
-  desc "target [uaa_url]", "Display current or set new target", :force, :ca_cert, :skip_ssl_validation do |uaa_url|
+  define_option :basic_auth, "--[no-]basic_auth", "set if you need basic or oauth2 (url encoded) client authentication"
+  desc "target [uaa_url]", "Display current or set new target", :force, :ca_cert, :skip_ssl_validation, :basic_auth do |uaa_url|
     msg, info = nil, {}
     if uaa_url
       if uaa_url.to_i.to_s == uaa_url
@@ -204,6 +205,8 @@ class MiscCli < CommonCli
       Config.target = url # we now have a canonical url set to https if possible
       Config.target_opts(skip_ssl_validation: true) if opts[:skip_ssl_validation]
       Config.target_opts(ca_cert: opts[:ca_cert])
+      Config.target_opts(basic_auth: true) if opts[:basic_auth] == true
+      Config.target_opts(basic_auth: false) if opts[:basic_auth] == false
       update_target_info(info) if info[:prompts]
     end
     return say "no target set" unless Config.target

data/lib/uaa/cli/info.rb

@@ -47,10 +47,6 @@ class InfoCli < CommonCli
     pp info
   end
 
-  desc "stats", "Show UAA's current usage statistics", :client, :secret do
-    pp misc_request { @cli_class.uaa_info_client.varz(clientid, clientsecret) }
-  end
-
   desc "password strength [password]", "calculate strength score of a password" do |pwd|
     pp misc_request { @cli_class.uaa_info_client.password_strength(userpwd(pwd)) }
   end

data/lib/uaa/cli/token.rb

@@ -25,6 +25,7 @@ class TokenCatcher < Stub::Base
     secret = server.info.delete(:client_secret)
     ti = TokenIssuer.new(Config.target, server.info.delete(:client_id), secret,
         { token_target: Config.target_value(:token_target),
+          basic_auth: Config.target_value(:basic_auth),
           skip_ssl_validation: Config.target_value(:skip_ssl_validation)})
     tkn = secret ? ti.authcode_grant(server.info.delete(:uri), data) :
         ti.implicit_grant(server.info.delete(:uri), data)
@@ -88,8 +89,9 @@ class TokenCli < CommonCli
 
   def issuer_request(client_id, secret = nil)
     update_target_info
-    yield TokenIssuer.new(Config.target.to_s, CGI.escape(client_id), CGI.escape(secret),
+    yield TokenIssuer.new(Config.target.to_s, client_id, secret,
         { token_target: Config.target_value(:token_endpoint),
+          basic_auth: Config.target_value(:basic_auth),
           skip_ssl_validation: Config.target_value(:skip_ssl_validation),
           ssl_ca_file: Config.target_value(:ca_cert) })
   rescue Exception => e

data/lib/uaa/cli/user.rb

@@ -19,12 +19,12 @@ class UserCli < CommonCli
 
   topic 'User Accounts', 'account'
 
+  define_option :origin, '--origin <name>, select user to update by identity provider origin. Defaults to UAA'
   define_option :givenName, '--given_name <name>'
   define_option :familyName, '--family_name <name>'
   define_option :emails, '--emails <addresses>'
   define_option :phoneNumbers, '--phones <phone_numbers>'
-  define_option :origin, '--origin <identity provider origin, defaults to UAA>'
-  USER_INFO_OPTS = [:givenName, :familyName, :emails, :phoneNumbers, :origin]
+  USER_INFO_OPTS = [:origin, :givenName, :familyName, :emails, :phoneNumbers]
 
   def user_opts(info = {})
     [:emails, :phoneNumbers].each do |o|

data/lib/uaa/stub/scim.rb

@@ -65,7 +65,7 @@ class StubScim
         :authorizations, :groups].to_set,
       client: [*COMMON_ATTRS, :client_id, :name, :client_secret, :authorities,
         :authorized_grant_types, :scope, :autoapprove,
-        :access_token_validity, :refresh_token_validity, :redirect_uri,
+        :access_token_validity, :refresh_token_validity, :redirect_uri, :allowedproviders,
         :'signup_redirect_url'].to_set,
       group: [*COMMON_ATTRS, :displayname, :members, :writers, :readers, :external_groups].to_set }
   VISIBLE_ATTRS = {user: Set.new(LEGAL_ATTRS[:user] - HIDDEN_ATTRS),

data/spec/client_reg_spec.rb

@@ -58,8 +58,8 @@ describe ClientCli do
     end
 
     it 'does not wrap the output of the access token in the terminal' do
-      @output.stub(:tty?) { true }
-      HighLine::SystemExtensions.stub(:terminal_size) { [80] }
+      allow(@output).to receive(:tty?).and_return(true)
+      allow(IO.console).to receive(:winsize).and_return([40, 80])
       Cli.run('context').should be
       Cli.output.string.should match /access_token: \S+?\s+token_type/m
     end

data/spec/common_spec.rb

@@ -44,7 +44,7 @@ describe CommonCli do
 
   it "displays user help with -h has --origin option" do
     Cli.run("user -h")
-    Cli.output.string.should include("--origin <identity provider origin, defaults to UAA>")
+    Cli.output.string.should include("--origin <name>, select user to update by identity provider origin. Defaults to UAA")
   end
 
   it "displays group help with -h has --origin option" do

data/spec/info_spec.rb

@@ -53,11 +53,6 @@ describe InfoCli do
     Cli.output.string.should include "score", "requiredScore"
   end
 
-  it "gets the server stats" do
-    pending "no UAA_VARZ_SECRET environment variable set" unless @varz_secret
-    Cli.run("stats -c varz -s #{@varz_secret}").should be
-    Cli.output.string.should include 'type: UAA', 'mem:', 'version:'
-  end
 
   it "sets multiple targets to be fully qualified in config and targets output" do
     Config.load("")

data/spec/spec_helper.rb

@@ -26,6 +26,12 @@ require 'rspec'
 require 'eventmachine'
 require 'uaa/stub/uaa'
 
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = [:expect, :should]
+  end
+end
+
 module CF::UAA
 
 module SpecHelper

data/spec/user_spec.rb

@@ -69,7 +69,7 @@ describe UserCli do
     Cli.input = StringIO.new("password") # selecting first origin through stdin
     Cli.run("user add #{user_with_origin} " +
                 '--emails sam@example.com --given_name SamueL ' +
-                "--phones 801-555-1212 --family_name jonES --origin uaa").should be
+                "--phones 801-555-1212 --family_name jonES --origin uaa")
 
     expect(Cli.output.string).to match 'Password:'
     Cli.run("user delete #{user_with_origin}")
@@ -80,7 +80,7 @@ describe UserCli do
     Cli.input = StringIO.new("password") # selecting first origin through stdin
     Cli.run("user add #{user_with_origin} " +
                 '--emails sam@example.com --given_name SamueL ' +
-                "--phones 801-555-1212 --family_name jonES").should be
+                "--phones 801-555-1212 --family_name jonES")
 
     expect(Cli.output.string).to match 'Password:'
     Cli.run("user delete #{user_with_origin}")

data/version.txt

@@ -1 +1 @@
-4.3.0
+4.6.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cf-uaac
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Dave Syer
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cf-uaa-lib
@@ -20,14 +20,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -88,54 +88,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: ci_reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.2
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter_rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.21
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.21
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
@@ -257,8 +265,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - LICENSE

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-
-before_install:
-  - gem update
-  - gem install bundler
-
-rvm:
-  - 2.7
-  - 2.6
-  - 2.5