app/models/client_application.rb

   1 # == Schema Information
   2 #
   3 # Table name: client_applications
   4 #
   5 #  id                :integer          not null, primary key
   6 #  name              :string
   7 #  url               :string
   8 #  support_url       :string
   9 #  callback_url      :string
  10 #  key               :string(50)
  11 #  secret            :string(50)
  12 #  user_id           :integer
  13 #  created_at        :datetime
  14 #  updated_at        :datetime
  15 #  allow_read_prefs  :boolean          default(FALSE), not null
  16 #  allow_write_prefs :boolean          default(FALSE), not null
  17 #  allow_write_diary :boolean          default(FALSE), not null
  18 #  allow_write_api   :boolean          default(FALSE), not null
  19 #  allow_read_gpx    :boolean          default(FALSE), not null
  20 #  allow_write_gpx   :boolean          default(FALSE), not null
  21 #  allow_write_notes :boolean          default(FALSE), not null
  22 #
  23 # Indexes
  24 #
  25 #  index_client_applications_on_key      (key) UNIQUE
  26 #  index_client_applications_on_user_id  (user_id)
  27 #
  28 # Foreign Keys
  29 #
  30 #  client_applications_user_id_fkey  (user_id => users.id)
  31 #
  32
  33 class ClientApplication < ApplicationRecord
  34   belongs_to :user
  35   has_many :tokens, :class_name => "OauthToken", :dependent => :delete_all
  36   has_many :access_tokens
  37   has_many :oauth2_verifiers
  38   has_many :oauth_tokens
  39
  40   validates :key, :presence => true, :uniqueness => true
  41   validates :name, :url, :secret, :presence => true
  42   validates :url, :format => %r{\Ahttp(s?)://(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(/|/([\w#!:.?+=&%@!\-/]))?}i
  43   validates :support_url, :allow_blank => true, :format => %r{\Ahttp(s?)://(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(/|/([\w#!:.?+=&%@!\-/]))?}i
  44   validates :callback_url, :allow_blank => true, :format => %r{\A[a-z][a-z0-9.+-]*://(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(/|/([\w#!:.?+=&%@!\-/]))?}i
  45
  46   before_validation :generate_keys, :on => :create
  47
  48   attr_accessor :token_callback_url
  49
  50   def self.find_token(token_key)
  51     token = OauthToken.includes(:client_application).find_by(:token => token_key)
  52     token if token&.authorized?
  53   end
  54
  55   def self.verify_request(request, options = {}, &block)
  56     signature = OAuth::Signature.build(request, options, &block)
  57     return false unless OauthNonce.remember(signature.request.nonce, signature.request.timestamp)
  58
  59     value = signature.verify
  60     value
  61   rescue OAuth::Signature::UnknownSignatureMethod
  62     false
  63   end
  64
  65   def self.all_permissions
  66     PERMISSIONS
  67   end
  68
  69   def oauth_server
  70     @oauth_server ||= OAuth::Server.new("https://" + Settings.server_url)
  71   end
  72
  73   def credentials
  74     @credentials ||= OAuth::Consumer.new(key, secret)
  75   end
  76
  77   def create_request_token(_params = {})
  78     params = { :client_application => self, :callback_url => token_callback_url }
  79     permissions.each do |p|
  80       params[p] = true
  81     end
  82     RequestToken.create(params)
  83   end
  84
  85   def access_token_for_user(user)
  86     unless token = access_tokens.valid.find_by(:user_id => user)
  87       params = { :user => user }
  88
  89       permissions.each do |p|
  90         params[p] = true
  91       end
  92
  93       token = access_tokens.create(params)
  94     end
  95
  96     token
  97   end
  98
  99   # the permissions that this client would like from the user
 100   def permissions
 101     ClientApplication.all_permissions.select { |p| self[p] }
 102   end
 103
 104   protected
 105
 106   # this is the set of permissions that the client can ask for. clients
 107   # have to say up-front what permissions they want and when users sign up they
 108   # can agree or not agree to each of them.
 109   PERMISSIONS = [:allow_read_prefs, :allow_write_prefs, :allow_write_diary, :allow_write_api, :allow_read_gpx, :allow_write_gpx, :allow_write_notes].freeze
 110
 111   def generate_keys
 112     self.key = OAuth::Helper.generate_key(40)[0, 40]
 113     self.secret = OAuth::Helper.generate_key(40)[0, 40]
 114   end
 115 end