faction 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a931eff98f4c85176316bb01e874a499ff64119e
+  data.tar.gz: 33ad1322fefac0622f9043cca4eece16092eb8ab
+SHA512:
+  metadata.gz: 104284e288f39af5d3f9e2d4ce787c2834914de352b92cfa91b0ceaffafc2c35f88c90274c07a3a6056d11523ef942545ac9d8acf4b86fa89b7685801122ee25
+  data.tar.gz: 6d08fdedba41b27d5273a693ffebbaad304fbeee69a283180a4edcdbbf6a3ccee6571a64764faf0e389c4a927ba60d6aa07b69b299c10707c23873810dfa17a4

data/.gitignore

@@ -0,0 +1,4 @@
+*~
+*.gem
+doc/
+.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Olli Helenius
+
+MIT License
+
+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,41 @@
+# Faction
+
+Faction is a client for Atlassian Crowd's SOAP API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faction', github: 'onesto/faction'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faction
+
+## Usage
+
+### User authentication
+
+```ruby
+token = begin
+  crowd = Faction::Client.new('http://localhost:8050/crowd/services/SecurityServer', 'myapp', 'secret')
+  validation_factors = {:user_agent     => "Some web browser",
+                        :remote_address => "127.0.0.1"}
+  crowd.authenticate_principal('test-user', 'secret-password', validation_factors)
+rescue Faction::AuthenticationException => e
+  puts "Authentication failed: #{e}"
+end
+# .. do something with token ..
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/log_in_and_out.rb

@@ -0,0 +1,13 @@
+require 'faction'
+
+CROWD_URL     = 'http://localhost:8085/crowd/services/SecurityServer'
+APP_NAME      = 'application'
+APP_PASSWORD  = 'password'
+
+TEST_USERNAME = 'test'
+TEST_PASSWORD = 'test'
+
+crowd = Faction::Client.new(CROWD_URL, APP_NAME, APP_PASSWORD, :verify_cert => false)
+token = crowd.authenticate_principal(TEST_USERNAME, TEST_PASSWORD)
+puts("#{TEST_USERNAME} logged in, token = #{token}")
+crowd.invalidate_principal_token(token)

data/faction.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faction/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faction"
+  spec.version       = Faction::VERSION
+  spec.authors       = ["Olli Helenius"]
+  spec.email         = ["olli.helenius@onesto.fi"]
+  spec.description   = %q{A simple Savon-based client for Atlassian Crowd SOAP API}
+  spec.summary       = %q{A simple Savon-based client for Atlassian Crowd SOAP API}
+  spec.homepage      = "https://github.com/onesto/faction"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'savon', '< 0.8'
+end

data/lib/faction.rb

@@ -0,0 +1,289 @@
+require 'openssl'
+require 'savon'
+require "faction/version"
+
+
+module Faction #:nodoc:
+
+  # Exception base for Faction
+  class Exception < ::Exception; end
+  # Any sort of Exception from Crowd
+  class AuthenticationException < Exception; end
+
+  # See http://docs.atlassian.com/crowd/current/com/atlassian/crowd/integration/service/soap/server/SecurityServer.html
+  # for Crowd SOAP API documentation.
+  #
+  # The <tt>validation_factors</tt> parameter is a <tt>Hash</tt> that can contain the following keys:
+  # * <tt>:user_agent</tt> - <tt>ValidationFactor.USER_AGENT</tt>
+  # * <tt>:remote_address</tt> - <tt>ValidationFactor.REMOTE_ADDRESS</tt>
+  # * <tt>:remote_host</tt> - <tt>ValidationFactor.REMOTE_HOST</tt>
+  # * <tt>:forwarded_for</tt> - <tt>ValidationFactor.X_FORWARDED_FOR</tt>
+  # * <tt>:random_number</tt> - <tt>ValidationFactor.RANDOM_NUMBER</tt>
+  # * <tt>:name</tt> - <tt>ValidationFactor.NAME</tt>
+  class Client
+    @@debug = false
+
+    # Sets the global debugging for Client
+    def self.debug=(value)
+      @@debug = value
+    end
+
+    # True if Faction is in debug mode
+    def self.debug?
+      @@debug
+    end
+
+    # Url of the Crowd SecurityServer
+    attr_reader :crowd_url
+    # Application name
+    attr_reader :app_name
+    # Application password
+    attr_reader :app_password
+
+    # Instantiates a new client using a "standard" <tt>crowd.properties</tt> file.
+    def self.from_properties(properties_file)
+      props = Hash[*open(properties_file).readlines.map {|line|
+                     line.split(/=/, 2).map(&:strip)}.flatten]
+      self.new(props['crowd.server.url'] + '/SecurityServer',
+               props['application.name'],
+               props['application.password'],
+               :verify_cert => ['yes', 'true'].include?(props['ssl.verify']))
+    end
+
+    # Creates a new Crowd client.
+    #
+    # Parameters:
+    # * <tt>crowd_url</tt> - The URL to Crowd SecurityServer.
+    # * <tt>app_name</tt> - Application name.
+    # * <tt>app_password</tt> - Application password.
+    # * <tt>options</tt> - A Hash of options (described below).
+    #
+    # Options
+    # * <tt>:verify_cert</tt> - If <tt>false</tt> the peer SSL certificate is not verified.
+    #
+    # Example:
+    #   Faction::Client.new('http://localhost:8085/crowd/services/SecurityServer', 'application', 'password')
+    #
+    def initialize(crowd_url, app_name, app_password, options = {})
+      @crowd_url = crowd_url
+      @crowd = Savon::Client.new(@crowd_url + (Client.debug? ? '?wsdl' : ''))
+      if options[:verify_cert] == false
+        @crowd.request.http.ssl_client_auth(:verify_mode => OpenSSL::SSL::VERIFY_NONE)
+      end
+      @app_name = app_name
+      @app_password = app_password
+      @app_token = nil
+    end
+
+    # See <tt>SecurityServerClient.authenticatePrincipal</tt>
+    def authenticate_principal(name, password, validation_factors = nil)
+      authenticated_crowd_call(:authenticate_principal,
+                                { 'auth:application' => app_name,
+                                  'auth:name' => name,
+                                  'auth:credential' => {'auth:credential' => password},
+                                  'auth:validationFactors' => convert_validation_factors(validation_factors)})
+    end
+
+    # See <tt>SecurityServerClient.createPrincipalToken</tt>
+    def create_principal_token(name, validation_factors = nil)
+      authenticated_crowd_call(:create_principal_token,
+                                { 'auth:application' => app_name,
+                                  'auth:name' => name,
+                                  'auth:validationFactors' => convert_validation_factors(validation_factors)})
+    end
+
+    # See <tt>SecurityServerClient.invalidatePrincipalToken</tt>
+    def invalidate_principal_token(token)
+      authenticated_crowd_call(:invalidate_principal_token, token) && nil
+    end
+
+    # See <tt>SecurityServerClient.getCookieInfo</tt>
+    # Returns a <tt>Hash</tt> containing the cookie info fields.
+    def cookie_info
+      authenticated_crowd_call(:get_cookie_info)
+    end
+
+    def get_cookie_info
+      $stderr.puts('faction: get_cookie_info deprecated, use cookie_info instead')
+      cookie_info
+    end
+
+    # See <tt>SecurityServerClient.isValidPrincipalToken</tt>
+    def valid_principal_token?(token, validation_factors = nil)
+      authenticated_crowd_call(:is_valid_principal_token,
+                               token,
+                               {'auth:validationFactors' => convert_validation_factors(validation_factors)})
+    end
+
+    # See <tt>SecurityServer.updatePrincipalCredential</tt>
+    def update_principal_credential(name, new_password)
+      authenticated_crowd_call(:update_principal_credential,
+                               name,
+                               {'auth:credential' => new_password, 'auth:encryptedCredential' => false})
+    end
+
+    # See <tt>SecurityServer.findPrincipalByToken</tt>
+    # Returns the principal information as a <tt>Hash</tt>.
+    def find_principal_by_token(token)
+      simplify_soap_attributes(authenticated_crowd_call(:find_principal_by_token, token))
+    end
+
+    def find_principal_by_name(name)
+      simplify_soap_attributes(authenticated_crowd_call(:find_principal_by_name, name))
+    end
+
+    def find_principal_with_attributes_by_name(name)
+      simplify_soap_attributes(authenticated_crowd_call(:find_principal_with_attributes_by_name, name))
+    end
+
+    def find_group_by_name(name)
+      simplify_soap_group(authenticated_crowd_call(:find_group_by_name, name))
+    end
+
+    def find_group_memberships(name)
+      arrayify(authenticated_crowd_call(:find_group_memberships, name)[:string])
+    end
+
+    def group_names
+      authenticated_crowd_call(:find_all_group_names)[:string]
+    end
+
+    def principal_names
+      authenticated_crowd_call(:find_all_principal_names)[:string]
+    end
+
+    def granted_authorities
+      authenticated_crowd_call(:get_granted_authorities)[:string]
+    end
+
+    def cache_enabled?
+      authenticated_crowd_call(:is_cache_enabled)
+    end
+
+    def cache_time
+      authenticated_crowd_call(:get_cache_time)
+    end
+
+    def add_principal_to_group(principal, group)
+      authenticated_crowd_call(:add_principal_to_group, principal, group) && nil
+    end
+
+    private
+
+    CROWD_NAMESPACES = {
+      'xmlns:wsdl' => 'urn:SecurityServer',
+      'xmlns:auth' => 'http://authentication.integration.crowd.atlassian.com',
+      'xmlns:xsd'  => 'http://www.w3.org/2001/XMLSchema',
+      'xmlns:xsi'  => 'http://www.w3.org/2001/XMLSchema-instance'
+    }
+
+    USER_AGENT      = "User-Agent" #:nodoc:
+    REMOTE_ADDRESS  = "remote_address" #:nodoc:
+    REMOTE_HOST     = "remote_host" #:nodoc:
+    X_FORWARDED_FOR = "X-Forwarded-For" #:nodoc:
+    RANDOM_NUMBER   = "Random-Number" #:nodoc:
+    NAME            = "NAME" #:nodoc:
+
+    VALIDATION_FACTOR_MAPPING = {
+      :user_agent     => USER_AGENT,
+      :remote_address => REMOTE_ADDRESS,
+      :remote_host    => REMOTE_HOST,
+      :forwarded_for  => X_FORWARDED_FOR,
+      :random_number  => RANDOM_NUMBER,
+      :name           => NAME
+    }
+
+    def convert_validation_factors(in_validation_factors)
+      return nil if in_validation_factors.nil?
+      result = in_validation_factors.map do |name, value|
+        raise Faction::Exception, "Invalid validation factor #{name}" if !VALIDATION_FACTOR_MAPPING.include?(name)
+        {'auth:name'  => VALIDATION_FACTOR_MAPPING[name], 'auth:value' => value}
+      end
+      {'auth:ValidationFactor' => result}
+    end
+
+    def simplify_soap_attributes(soap_object)
+      attributes = soap_object[:attributes][:soap_attribute].inject({}) do |hash, item|
+        hash[item[:name].to_sym] = item[:values][:string]
+        hash
+      end
+      soap_object.merge(:attributes => attributes)
+    end
+
+    def simplify_soap_group(soap_group)
+      soap_group.merge(:members => soap_group[:members][:string])
+    end
+
+    def arrayify(soap_object)
+      if soap_object.nil?
+        []
+      elsif soap_object.is_a? Array
+        soap_object
+      else
+        [soap_object]
+      end
+    end
+
+    def app_authentication
+      Hash['auth:name'  => app_name,
+           'auth:token' => app_token]
+    end
+
+    def ensure_app_token!
+      app_token
+    end
+
+    def app_token
+      @app_token ||= authenticate_application
+    end
+
+    def authenticate_application
+      response = crowd_call(:authenticate_application) do |soap|
+        soap.body.merge!('wsdl:in0' => {
+                           'auth:name' => app_name,
+                           'auth:credential' => {
+                             'auth:credential' => app_password,
+                             'auth:encryptedCredential' => false,
+                           }})
+      end
+      response[:token]
+    end
+
+    def crowd_call(name, &block)
+      method = (Client.debug? ? name : "#{name}!").to_sym
+      response = @crowd.call(method) do |soap|
+        soap.namespaces.merge!(CROWD_NAMESPACES)
+        soap.body = {}
+        yield soap if block_given?
+      end
+      response.to_hash[:"#{name}_response"][:out]
+    end
+
+    def real_authenticated_crowd_call(name, *args)
+      ensure_app_token!
+      crowd_call(name) do |soap|
+        soap.body = {'wsdl:in0' => app_authentication}
+        order = ['wsdl:in0']
+        args.each_with_index do |arg, index|
+          soap.body["wsdl:in#{index + 1}"] = arg
+          order << "wsdl:in#{index + 1}"
+        end
+        soap.body[:order!] = order
+      end
+    end
+
+    def authenticated_crowd_call(name, *args)
+      begin
+        real_authenticated_crowd_call(name, *args)
+      rescue Savon::SOAPFault => f
+        # retry once
+        @app_token = nil
+        begin
+          real_authenticated_crowd_call(name, *args)
+        rescue Savon::SOAPFault => f
+          raise AuthenticationException, f.message
+        end
+      end
+    end
+  end
+end

data/lib/faction/version.rb

@@ -0,0 +1,3 @@
+module Faction
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: faction
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Olli Helenius
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A simple Savon-based client for Atlassian Crowd SOAP API
+email:
+- olli.helenius@onesto.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/log_in_and_out.rb
+- faction.gemspec
+- lib/faction.rb
+- lib/faction/version.rb
+homepage: https://github.com/onesto/faction
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A simple Savon-based client for Atlassian Crowd SOAP API
+test_files: []