2019-05-02 18:17:27 -04:00
# frozen_string_literal: true
2014-02-24 22:30:49 -05:00
class DiscourseSingleSignOn < SingleSignOn
2014-06-02 03:32:39 -04:00
2019-06-10 20:04:26 -04:00
class BlankExternalId < StandardError ; end
class BannedExternalId < StandardError ; end
2014-02-24 22:30:49 -05:00
def self . sso_url
2021-02-08 05:04:33 -05:00
SiteSetting . discourse_connect_url
2014-02-24 22:30:49 -05:00
end
def self . sso_secret
2021-02-08 05:04:33 -05:00
SiteSetting . discourse_connect_secret
2014-02-24 22:30:49 -05:00
end
2021-02-18 05:35:10 -05:00
def self . generate_sso ( return_path = " / " , secure_session : )
sso = new ( secure_session : secure_session )
2014-02-24 22:30:49 -05:00
sso . nonce = SecureRandom . hex
2014-02-25 17:58:30 -05:00
sso . register_nonce ( return_path )
2014-11-26 01:25:54 -05:00
sso . return_sso_url = Discourse . base_url + " /session/sso_login "
2016-04-07 21:20:01 -04:00
sso
end
2021-02-18 05:35:10 -05:00
def self . generate_url ( return_path = " / " , secure_session : )
generate_sso ( return_path , secure_session : secure_session ) . to_url
end
def initialize ( secure_session : )
@secure_session = secure_session
2014-02-24 22:30:49 -05:00
end
2014-02-25 17:58:30 -05:00
def register_nonce ( return_path )
2014-02-24 22:30:49 -05:00
if nonce
2021-03-11 05:38:34 -05:00
if SiteSetting . discourse_connect_csrf_protection
@secure_session . set ( nonce_key , return_path , expires : SingleSignOn . nonce_expiry_time )
else
Discourse . cache . write ( nonce_key , return_path , expires_in : SingleSignOn . nonce_expiry_time )
end
2014-02-24 22:30:49 -05:00
end
end
def nonce_valid?
2021-03-11 05:38:34 -05:00
if SiteSetting . discourse_connect_csrf_protection
nonce && @secure_session [ nonce_key ] . present?
else
nonce && Discourse . cache . read ( nonce_key ) . present?
end
2014-02-24 22:30:49 -05:00
end
2021-08-18 09:14:12 -04:00
def nonce_error
if Discourse . cache . read ( used_nonce_key ) . present?
" Nonce has already been used "
else
" Nonce has expired "
end
end
2014-02-25 17:58:30 -05:00
def return_path
2021-03-11 05:38:34 -05:00
if SiteSetting . discourse_connect_csrf_protection
@secure_session [ nonce_key ] || " / "
else
Discourse . cache . read ( nonce_key ) || " / "
end
2014-02-25 17:58:30 -05:00
end
2014-02-24 22:30:49 -05:00
def expire_nonce!
if nonce
2021-03-11 05:38:34 -05:00
if SiteSetting . discourse_connect_csrf_protection
@secure_session [ nonce_key ] = nil
else
Discourse . cache . delete nonce_key
end
2021-08-18 09:14:12 -04:00
Discourse . cache . write ( used_nonce_key , return_path , expires_in : SingleSignOn . used_nonce_expiry_time )
2014-02-24 22:30:49 -05:00
end
end
def nonce_key
" SSO_NONCE_ #{ nonce } "
end
2021-08-18 09:14:12 -04:00
def used_nonce_key
" USED_SSO_NONCE_ #{ nonce } "
end
2019-06-10 20:04:26 -04:00
BANNED_EXTERNAL_IDS = %w{ none nil blank null }
2015-02-25 14:40:55 -05:00
def lookup_or_create_user ( ip_address = nil )
2019-06-10 20:04:26 -04:00
# we don't want to ban 0 from being an external id
external_id = self . external_id . to_s
if external_id . blank?
raise BlankExternalId
end
if BANNED_EXTERNAL_IDS . include? ( external_id . downcase )
raise BannedExternalId , external_id
end
2020-11-10 05:40:41 -05:00
# we protect here to ensure there is no situation where the same external id
# concurrently attempts to create or update sso records
#
# we can get duplicate HTTP requests quite easily (client rapid refresh) and this path does stuff such
# as updating groups for a users and so on that can happen even after the sso record and user is there
DistributedMutex . synchronize ( " sso_lookup_or_create_user_ #{ external_id } " ) do
lookup_or_create_user_unsafe ( ip_address )
end
end
private
def lookup_or_create_user_unsafe ( ip_address )
2014-05-06 09:41:59 -04:00
sso_record = SingleSignOnRecord . find_by ( external_id : external_id )
2014-04-15 01:53:48 -04:00
2016-09-01 22:04:22 -04:00
if sso_record && ( user = sso_record . user )
2014-02-24 22:30:49 -05:00
sso_record . last_payload = unsigned_payload
else
2015-02-23 15:58:45 -05:00
user = match_email_or_create_user ( ip_address )
2014-02-27 19:48:46 -05:00
sso_record = user . single_sign_on_record
end
2014-04-15 01:53:48 -04:00
2016-06-21 05:28:58 -04:00
# ensure it's not staged anymore
2020-03-17 11:48:24 -04:00
user . unstage!
2016-06-21 05:28:58 -04:00
2018-08-29 19:57:53 -04:00
change_external_attributes_and_override ( sso_record , user )
2014-02-24 22:30:49 -05:00
2015-05-19 12:16:02 -04:00
if sso_record && ( user = sso_record . user ) && ! user . active && ! require_activation
2014-02-25 18:28:03 -05:00
user . active = true
2014-06-02 03:32:39 -04:00
user . save!
2015-03-20 13:03:24 -04:00
user . enqueue_welcome_message ( 'welcome_user' ) unless suppress_welcome_message
2017-06-14 13:20:18 -04:00
user . set_automatic_groups
2014-02-25 18:28:03 -05:00
end
2014-04-15 01:53:48 -04:00
2014-04-21 23:52:13 -04:00
custom_fields . each do | k , v |
user . custom_fields [ k ] = v
end
2015-02-23 15:58:45 -05:00
user . ip_address = ip_address
2016-05-17 03:31:34 -04:00
2014-11-26 20:39:00 -05:00
user . admin = admin unless admin . nil?
user . moderator = moderator unless moderator . nil?
2017-01-31 19:42:27 -05:00
user . title = title unless title . nil?
2014-02-27 19:48:46 -05:00
# optionally save the user and sso_record if they have changed
2016-08-28 21:28:19 -04:00
user . user_avatar . save! if user . user_avatar
2014-02-27 19:48:46 -05:00
user . save!
2016-05-17 03:31:34 -04:00
2020-04-08 02:33:50 -04:00
if @email_changed && user . active
user . set_automatic_groups
end
2019-04-10 12:53:30 -04:00
# The user might require approval
user . create_reviewable
2021-02-08 05:04:33 -05:00
if bio && ( user . user_profile . bio_raw . blank? || SiteSetting . discourse_connect_overrides_bio )
2016-08-01 01:29:28 -04:00
user . user_profile . bio_raw = bio
user . user_profile . save!
end
2018-06-19 20:30:23 -04:00
if website
user . user_profile . website = website
user . user_profile . save!
end
2020-04-28 02:06:35 -04:00
if location
user . user_profile . location = location
user . user_profile . save!
end
2016-05-17 03:31:34 -04:00
unless admin . nil? && moderator . nil?
Group . refresh_automatic_groups! ( :admins , :moderators , :staff )
end
2014-02-27 19:48:46 -05:00
sso_record . save!
2014-02-25 18:28:03 -05:00
2016-11-11 00:57:31 -05:00
if sso_record . user
apply_group_rules ( sso_record . user )
end
2014-02-24 22:30:49 -05:00
sso_record && sso_record . user
end
2014-04-15 01:53:48 -04:00
2018-04-09 23:17:23 -04:00
def synchronize_groups ( user )
names = ( groups || " " ) . split ( " , " ) . map ( & :downcase )
ids = Group . where ( 'LOWER(NAME) in (?) AND NOT automatic' , names ) . pluck ( :id )
group_users = GroupUser
. where ( 'group_id IN (SELECT id FROM groups WHERE NOT automatic)' )
. where ( user_id : user . id )
2018-04-10 01:30:18 -04:00
delete_group_users = group_users
if ids . length > 0
delete_group_users = group_users . where ( 'group_id NOT IN (?)' , ids )
end
delete_group_users . destroy_all
2018-04-09 23:17:23 -04:00
ids -= group_users . where ( 'group_id IN (?)' , ids ) . pluck ( :group_id )
ids . each do | group_id |
GroupUser . create ( group_id : group_id , user_id : user . id )
end
end
2016-11-11 00:57:31 -05:00
def apply_group_rules ( user )
2021-02-08 05:04:33 -05:00
if SiteSetting . discourse_connect_overrides_groups
2018-04-09 23:17:23 -04:00
synchronize_groups ( user )
return
end
2016-11-11 00:57:31 -05:00
if add_groups
2017-08-02 11:30:23 -04:00
split = add_groups . split ( " , " ) . map ( & :downcase )
2016-11-11 00:57:31 -05:00
if split . length > 0
2017-08-11 18:09:22 -04:00
Group . where ( 'LOWER(name) in (?) AND NOT automatic' , split ) . pluck ( :id ) . each do | id |
2016-11-11 00:57:31 -05:00
unless GroupUser . where ( group_id : id , user_id : user . id ) . exists?
GroupUser . create ( group_id : id , user_id : user . id )
end
end
end
end
if remove_groups
2017-08-11 18:09:22 -04:00
split = remove_groups . split ( " , " ) . map ( & :downcase )
2016-11-11 00:57:31 -05:00
if split . length > 0
GroupUser
. where ( user_id : user . id )
2017-08-11 18:09:22 -04:00
. where ( 'group_id IN (SELECT id FROM groups WHERE LOWER(name) in (?))' , split )
2016-11-11 00:57:31 -05:00
. destroy_all
end
end
end
2015-02-23 15:58:45 -05:00
def match_email_or_create_user ( ip_address )
2020-11-10 05:40:41 -05:00
# Use a mutex here to counter SSO requests that are sent at the same time with
2018-04-12 04:18:49 -04:00
# the same email payload
DistributedMutex . synchronize ( " discourse_single_sign_on_ #{ email } " ) do
2018-09-10 18:24:02 -04:00
user = User . find_by_email ( email ) if ! require_activation
if ! user
2018-04-12 04:18:49 -04:00
try_name = name . presence
try_username = username . presence
user_params = {
primary_email : UserEmail . new ( email : email , primary : true ) ,
2021-10-12 09:25:54 -04:00
name : try_name || User . suggest_name ( try_username ) ,
username : UserNameSuggester . suggest ( try_username || try_name ) ,
2018-04-12 04:18:49 -04:00
ip_address : ip_address
}
2018-08-29 19:57:53 -04:00
if SiteSetting . allow_user_locale && locale && LocaleSiteSetting . valid_value? ( locale )
user_params [ :locale ] = locale
end
2018-04-12 04:18:49 -04:00
user = User . create! ( user_params )
2021-02-08 05:04:33 -05:00
if SiteSetting . verbose_discourse_connect_logging
2018-04-12 04:18:49 -04:00
Rails . logger . warn ( " Verbose SSO log: New User (user_id: #{ user . id } ) Params: #{ user_params } User Params: #{ user . attributes } User Errors: #{ user . errors . full_messages } Email: #{ user . primary_email . attributes } Email Error: #{ user . primary_email . errors . full_messages } " )
end
2017-11-07 06:38:36 -05:00
end
2014-02-24 22:30:49 -05:00
2018-04-12 04:18:49 -04:00
if user
if sso_record = user . single_sign_on_record
sso_record . last_payload = unsigned_payload
sso_record . external_id = external_id
else
if avatar_url . present?
Jobs . enqueue ( :download_avatar_from_url ,
url : avatar_url ,
user_id : user . id ,
2021-02-08 05:04:33 -05:00
override_gravatar : SiteSetting . discourse_connect_overrides_avatar
2018-04-12 04:18:49 -04:00
)
end
2018-05-07 04:03:26 -04:00
if profile_background_url . present?
Jobs . enqueue ( :download_profile_background_from_url ,
url : profile_background_url ,
user_id : user . id ,
is_card_background : false
)
end
if card_background_url . present?
Jobs . enqueue ( :download_profile_background_from_url ,
url : card_background_url ,
user_id : user . id ,
is_card_background : true
)
end
2018-04-12 04:18:49 -04:00
user . create_single_sign_on_record! (
last_payload : unsigned_payload ,
external_id : external_id ,
external_username : username ,
external_email : email ,
external_name : name ,
2018-05-07 04:03:26 -04:00
external_avatar_url : avatar_url ,
external_profile_background_url : profile_background_url ,
external_card_background_url : card_background_url
2017-11-07 05:38:38 -05:00
)
end
2014-02-27 19:48:46 -05:00
end
2014-04-15 01:53:48 -04:00
2018-04-12 04:18:49 -04:00
user
end
2014-02-27 19:48:46 -05:00
end
2014-04-15 01:53:48 -04:00
2014-02-27 19:48:46 -05:00
def change_external_attributes_and_override ( sso_record , user )
2020-04-08 02:33:50 -04:00
@email_changed = false
2021-02-08 05:04:33 -05:00
if SiteSetting . auth_overrides_email && user . email != Email . downcase ( email )
2014-02-27 19:48:46 -05:00
user . email = email
2017-05-16 16:18:18 -04:00
user . active = false if require_activation
2020-04-08 02:33:50 -04:00
@email_changed = true
2014-02-27 19:48:46 -05:00
end
2014-04-15 01:53:48 -04:00
2021-02-08 05:04:33 -05:00
if SiteSetting . auth_overrides_username? && username . present?
2018-03-09 16:06:55 -05:00
if user . username . downcase == username . downcase
user . username = username # there may be a change of case
2018-03-13 18:29:11 -04:00
elsif user . username != username
2018-03-09 16:06:55 -05:00
user . username = UserNameSuggester . suggest ( username || name || email , user . username )
end
2014-02-27 19:48:46 -05:00
end
2014-04-15 01:53:48 -04:00
2021-02-08 05:04:33 -05:00
if SiteSetting . auth_overrides_name && user . name != name && name . present?
2015-05-06 23:52:26 -04:00
user . name = name || User . suggest_name ( username . blank? ? email : username )
2014-02-27 19:48:46 -05:00
end
2014-04-15 01:53:48 -04:00
2018-08-29 19:57:53 -04:00
if locale_force_update && SiteSetting . allow_user_locale && locale && LocaleSiteSetting . valid_value? ( locale )
user . locale = locale
end
2016-09-15 19:44:45 -04:00
avatar_missing = user . uploaded_avatar_id . nil? || ! Upload . exists? ( user . uploaded_avatar_id )
2015-01-28 10:47:59 -05:00
2021-02-08 05:04:33 -05:00
if ( avatar_missing || avatar_force_update || SiteSetting . discourse_connect_overrides_avatar ) && avatar_url . present?
2016-10-24 13:55:30 -04:00
avatar_changed = sso_record . external_avatar_url != avatar_url
2016-09-15 19:44:45 -04:00
2016-10-24 13:55:30 -04:00
if avatar_force_update || avatar_changed || avatar_missing
2021-02-08 05:04:33 -05:00
Jobs . enqueue ( :download_avatar_from_url , url : avatar_url , user_id : user . id , override_gravatar : SiteSetting . discourse_connect_overrides_avatar )
2016-10-24 13:55:30 -04:00
end
2014-08-19 03:49:14 -04:00
end
2020-11-24 18:53:44 -05:00
if profile_background_url . present?
profile_background_missing = user . user_profile . profile_background_upload . blank? || Upload . get_from_url ( user . user_profile . profile_background_upload . url ) . blank?
2021-02-08 05:04:33 -05:00
if profile_background_missing || SiteSetting . discourse_connect_overrides_profile_background
2020-11-24 18:53:44 -05:00
profile_background_changed = sso_record . external_profile_background_url != profile_background_url
if profile_background_changed || profile_background_missing
Jobs . enqueue ( :download_profile_background_from_url ,
url : profile_background_url ,
user_id : user . id ,
is_card_background : false
)
end
2018-05-07 04:03:26 -04:00
end
end
2020-11-24 18:53:44 -05:00
if card_background_url . present?
card_background_missing = user . user_profile . card_background_upload . blank? || Upload . get_from_url ( user . user_profile . card_background_upload . url ) . blank?
2021-07-16 10:16:30 -04:00
if card_background_missing || SiteSetting . discourse_connect_overrides_card_background
2020-11-24 18:53:44 -05:00
card_background_changed = sso_record . external_card_background_url != card_background_url
if card_background_changed || card_background_missing
Jobs . enqueue ( :download_profile_background_from_url ,
url : card_background_url ,
user_id : user . id ,
is_card_background : true
)
end
2018-05-07 04:03:26 -04:00
end
end
2014-02-27 19:48:46 -05:00
# change external attributes for sso record
sso_record . external_username = username
sso_record . external_email = email
sso_record . external_name = name
2014-08-19 03:49:14 -04:00
sso_record . external_avatar_url = avatar_url
2018-05-07 04:03:26 -04:00
sso_record . external_profile_background_url = profile_background_url
sso_record . external_card_background_url = card_background_url
2014-02-27 19:48:46 -05:00
end
2014-04-15 01:53:48 -04:00
end