graphql-authorization 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f41e83bd1407914b99c2d161cab351389bc2662
+  data.tar.gz: 5327b6bcf0740340a54d0302c3411e37aba13d04
+SHA512:
+  metadata.gz: d5c08d15ef43326785b8d84c132f5427aa68de7dcaf8a8bf55232958ab6afd12e6d8d0c22c968dcdf9cfc58139353bc3deac9fcdc974ad990d361946acce94d0
+  data.tar.gz: 432554dfd539e37283dfa0f120113895e188637de6ecc518406e4b8b46a527b1463f6749a50bc96b3dc6adb901db6b509c573fe86cc7b2d3200a3edb5d58b224

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Matthew Chang
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GraphqlAuthorization'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/graphql/authorization.rb

@@ -0,0 +1,11 @@
+module GraphQL
+  module Authorization
+  end
+end
+
+require 'graphql/authorization/version'
+require 'graphql/authorization/instrumentation'
+require 'graphql/authorization/unauthorized'
+require 'graphql/authorization/ability'
+require 'graphql/authorization/all'
+require 'graphql/authorization/ability_type'

data/lib/graphql/authorization/ability.rb

@@ -0,0 +1,75 @@
+class GraphQL::Authorization::Ability
+  def initialize(user)
+    @user = user
+    @ability = {}
+
+    #default white list builtin scalars
+    permit GraphQL::STRING_TYPE, execute: true, only: []
+    permit GraphQL::INT_TYPE, execute: true, only: []
+    permit GraphQL::FLOAT_TYPE, execute: true, only: []
+    permit GraphQL::ID_TYPE, execute: true, only: []
+    permit GraphQL::BOOLEAN_TYPE, execute: true, only: []
+
+    ability(user)
+  end
+
+  #permits execution, all access by default
+  def permit(type,options={})
+    raise NameError.new("duplicate ability definition") if @ability.key? type
+    ability_object = GraphQL::Authorization::AbilityType.new(type,nil,{})
+    if options.key?(:except) && options.key?(:only)
+      raise ArgumentError.new("you cannot specify white list and black list")
+    end
+    if options[:except]
+      ability_object.access(type.fields.keys.map(&:to_sym) - options[:except])
+    elsif options[:only]
+      ability_object.access(options[:only])
+    end
+    ability_object.execute options[:execute]
+    if block_given?
+      #note Proc.new creates a proc with the block given to the method
+      ability_object.instance_eval(&Proc.new)
+    end
+    @ability[type] = ability_object
+  end
+
+  #calls a proc-like object with args comensorate with it's arity
+  def callSetArgs(object,*args)
+    arity = object&.arity || object.method(:call).arity
+    if arity > 0
+      object.call(*args[0..arity-1])
+    elsif arity == 0
+      object.call()
+    else
+      object.call(*args)
+    end
+  end
+
+  #returns true if the user can execute queries of type, "type"
+  def canExecute(type,args={})
+    return false unless @ability[type]
+    execute = @ability[type].execute_permission
+    return callSetArgs(execute,args) if execute.respond_to? :call
+    execute
+  end
+
+  #returns true if the user can access "field" on "type"
+  def canAccess(type,field,object=nil,args={})
+    return false unless @ability[type]
+    access = @ability[type].access_permission[field]
+    return callSetArgs(access,object,args) if access.respond_to? :call
+    access
+  end
+
+  def allowed type
+    if type.class == GraphQL::UnionType
+      permit type, execute: true
+    else
+      permit type, execute: true, only: GraphQL::Authorization::All
+    end
+  end
+
+  def ability(user)
+    raise NotImplementedError.new("must implmenet ability funciton")
+  end
+end

data/lib/graphql/authorization/ability_type.rb

@@ -0,0 +1,19 @@
+GraphQL::Authorization::AbilityType = Struct.new("AbilityType", :type, :execute_permission, :access_permission) do
+  def execute value
+    self.execute_permission = value
+  end
+  def access value, evaluator = true
+    if self.type.class == GraphQL::UnionType
+      raise ArgumentError.new "Specifying access on a union type which cannot be accessed"
+    end
+    if value == GraphQL::Authorization::All
+      self.access type.all_fields.map {|e| e.name.to_sym}, evaluator
+    elsif value.class == Array
+      self.access value.map {|e| [e,evaluator]}.to_h
+    elsif value.class != Hash
+      self.access({value => evaluator})
+    else
+      self.access_permission = self.access_permission.merge(value)
+    end
+  end
+end

data/lib/graphql/authorization/all.rb

@@ -0,0 +1,2 @@
+#Simply definining a unique symbol to represent "all fields" for authorization
+GraphQL::Authorization::All = Object.new

data/lib/graphql/authorization/instrumentation.rb

@@ -0,0 +1,40 @@
+# Wrapps fields in authorization checks
+module GraphQL
+  module Authorization
+    class Instrumentation
+      def initialize(always_allow_execute: false)
+        @always_allow_execute = always_allow_execute
+      end
+
+      # returns the essential type of a potentially wrapped type (i.e., list or non-null)
+      def baseTypeOf(type)
+        if type.class == GraphQL::NonNullType || type.class == GraphQL::ListType
+          baseTypeOf(type.of_type)
+        else
+          type
+        end
+      end
+
+      def toSymKeys(hash)
+        hash.map { |key, value| [key.to_sym, value] }.to_h
+      end
+
+      def instrument(type, field)
+        fieldType = baseTypeOf(field.type)
+        old_resolve_proc = field.resolve_proc
+        new_resolve_proc = lambda do |obj, args, ctx|
+          unless ctx[:ability] == :root
+            raise GraphQL::Authorization::Unauthorized, "not authorized to execute #{fieldType.name}" unless ctx[:ability].canExecute(fieldType, toSymKeys(args.to_h)) || @always_allow_execute
+            raise GraphQL::Authorization::Unauthorized, "not authorized to access #{field.name} on #{type.name}" unless ctx[:ability].canAccess(type, field.name.to_sym, obj, toSymKeys(args.to_h))
+          end
+          old_resolve_proc.call(obj, args, ctx)
+        end
+
+        # Return a copy of `field`, with a new resolve proc
+        field.redefine do
+          resolve(new_resolve_proc)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/authorization/unauthorized.rb

@@ -0,0 +1,9 @@
+module GraphQL
+  module Authorization
+    class Unauthorized < StandardError
+      def initialize(msg="Unauthorized")
+        super
+      end
+    end
+  end
+end

data/lib/graphql/authorization/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  module Authorization
+    VERSION = "0.0.2"
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: graphql-authorization
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matthew Chang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- matthew@callnine.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/graphql/authorization.rb
+- lib/graphql/authorization/ability.rb
+- lib/graphql/authorization/ability_type.rb
+- lib/graphql/authorization/all.rb
+- lib/graphql/authorization/instrumentation.rb
+- lib/graphql/authorization/unauthorized.rb
+- lib/graphql/authorization/version.rb
+homepage: https://github.com/Call9/graphql-authorization
+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.5.1
+signing_key: 
+specification_version: 4
+summary: An authorization framework for graphql-ruby
+test_files: []