Class: DiscourseApi::SingleSignOn

Inherits:
Object
  • Object
show all
Defined in:
lib/discourse_api/single_sign_on.rb

Constant Summary collapse

ACCESSORS = 
[:nonce, :name, :username, :email, :avatar_url, :avatar_force_update,
:about_me, :external_id, :return_sso_url, :admin, :moderator]
FIXNUMS = 
[]
BOOLS = 
[:avatar_force_update, :admin, :moderator]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#sso_secret ⇒ Object

Returns the value of attribute sso_secret.



13
14
15
 
# File 'lib/discourse_api/single_sign_on.rb', line 13

def sso_secret
  @sso_secret
end

#sso_url ⇒ Object

Returns the value of attribute sso_url.



13
14
15
 
# File 'lib/discourse_api/single_sign_on.rb', line 13

def sso_url
  @sso_url
end

Class Method Details

.parse(payload, sso_secret = nil) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/discourse_api/single_sign_on.rb', line 23

def self.parse(payload, sso_secret = nil)
  sso = new
  sso.sso_secret = sso_secret if sso_secret

  parsed = Rack::Utils.parse_query(payload)
  if sso.sign(parsed["sso"]) != parsed["sig"]
    raise RuntimeError, "Bad signature for payload"
  end

  decoded = Base64.decode64(parsed["sso"])
  decoded_hash = Rack::Utils.parse_query(decoded)

  ACCESSORS.each do |k|
    val = decoded_hash[k.to_s]
    val = val.to_i if FIXNUMS.include? k
    if BOOLS.include? k
      val = ["true", "false"].include?(val) ? val == "true" : nil
    end
    sso.send("#{k}=", val)
  end

  decoded_hash.each do |k,v|
    # 1234567
    # custom.
    #
    if k[0..6] == "custom."
      field = k[7..-1]
      sso.custom_fields[field] = v
    end
  end

  sso
end

.sso_secret ⇒ Object

Raises:

  • (RuntimeError) 


15
16
17
 
# File 'lib/discourse_api/single_sign_on.rb', line 15

def self.sso_secret
  raise RuntimeError, "sso_secret not implemented on class, be sure to set it on instance"
end

.sso_url ⇒ Object

Raises:

  • (RuntimeError) 


19
20
21
 
# File 'lib/discourse_api/single_sign_on.rb', line 19

def self.sso_url
  raise RuntimeError, "sso_url not implemented on class, be sure to set it on instance"
end

Instance Method Details

#custom_fields ⇒ Object 



65
66
67
 
# File 'lib/discourse_api/single_sign_on.rb', line 65

def custom_fields
  @custom_fields ||= {}
end

#payload ⇒ Object 



80
81
82
83
 
# File 'lib/discourse_api/single_sign_on.rb', line 80

def payload
  payload = Base64.encode64(unsigned_payload)
  "sso=#{CGI::escape(payload)}&sig=#{sign(payload)}"
end

#sign(payload) ⇒ Object 



70
71
72
 
# File 'lib/discourse_api/single_sign_on.rb', line 70

def sign(payload)
  OpenSSL::HMAC.hexdigest("sha256", sso_secret, payload)
end

#to_url(base_url = nil) ⇒ Object 



75
76
77
78
 
# File 'lib/discourse_api/single_sign_on.rb', line 75

def to_url(base_url=nil)
  base = "#{base_url || sso_url}"
  "#{base}#{base.include?('?') ? '&' : '?'}#{payload}"
end

#unsigned_payload ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/discourse_api/single_sign_on.rb', line 85

def unsigned_payload
  payload = {}
  ACCESSORS.each do |k|
   next if (val = send k) == nil

   payload[k] = val
  end

  if @custom_fields
    @custom_fields.each do |k,v|
      payload["custom.#{k}"] = v.to_s
    end
  end

  Rack::Utils.build_query(payload)
end