1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
#
# Sonar, entreprise quality control tool.
# Copyright (C) 2008-2013 SonarSource
# mailto:contact AT sonarsource DOT com
#
# SonarQube is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3 of the License, or (at your option) any later version.
#
# SonarQube is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
#
# Use Sonar database (table USERS) to authenticate users.
#
class DefaultRealm
def authenticate?(username, password, servlet_request)
result=nil
if !username.blank? && !password.blank?
user=User.find_active_by_login(username)
result=user if user && user.authenticated?(password)
end
result
end
def editable_password?
true
end
end
#
# Use an external security system with fallback to Sonar database.
# See the Java extension point org.sonar.api.security.SecurityRealm
#
class PluginRealm
def initialize(java_realm)
@java_authenticator = java_realm.doGetAuthenticator()
@java_users_provider = java_realm.getUsersProvider()
@java_groups_provider = java_realm.getGroupsProvider()
@save_password = Api::Utils.java_facade.getSettings().getBoolean('sonar.security.savePassword')
end
def authenticate?(username, password, servlet_request)
details=nil
if @java_users_provider
begin
provider_context = org.sonar.api.security.ExternalUsersProvider::Context.new(username, servlet_request)
details = @java_users_provider.doGetUserDetails(provider_context)
rescue Exception => e
Rails.logger.error("Error from external users provider: #{e.message}")
@save_password ? fallback(username, password) : false
else
if details
# User exist in external system
auth(username, password, servlet_request, details)
else
# No such user in external system
fallback(username, password)
end
end
else
# Legacy authenticator
auth(username, password, servlet_request, nil)
end
end
#
# Fallback to password from Sonar Database
#
def fallback(username, password)
result=nil
if !username.blank? && !password.blank?
user=User.find_active_by_login(username)
result = user if user && user.authenticated?(password)
end
result
end
#
# Authenticate user using external system. Return the user.
#
def auth(username, password, servlet_request, user_details)
if @java_authenticator
begin
authenticator_context=org.sonar.api.security.Authenticator::Context.new(username, password, servlet_request)
status = @java_authenticator.doAuthenticate(authenticator_context)
rescue Exception => e
Rails.logger.error("Error from external authenticator: #{e.message}")
fallback(username, password)
else
status ? synchronize(username, password, user_details) : nil
end
else
# No authenticator
nil
end
end
#
# Authentication in external system was successful - replicate password, details and groups into Sonar
# Return the user.
#
def synchronize(username, password, details)
username=details.getName() if username.blank? && details
user = User.find_by_login(username)
if !user
# No such user in Sonar database
return nil if !Api::Utils.java_facade.getSettings().getBoolean('sonar.authenticator.createUsers')
# Automatically create a user in the sonar db if authentication has been successfully done
user = User.new(:login => username, :name => username, :email => '')
if details
user.name = details.getName()
user.email = details.getEmail()
end
default_group_name = Api::Utils.java_facade.getSettings().getString('sonar.defaultGroup')
default_group = Group.find_by_name(default_group_name)
if default_group
user.groups << default_group
else
Rails.logger.error("The default user group does not exist: #{default_group_name}. Please check the parameter 'Default user group' in general settings.")
end
else
# Existing user
if details && Api::Utils.java_facade.getSettings().getBoolean('sonar.security.updateUserAttributes')
user.name = details.getName()
user.email = details.getEmail()
end
end
if @save_password
user.password = password
user.password_confirmation = password
end
synchronize_groups(user)
# A user that is synchronized with an external system is always set to 'active' (see SONAR-3258 for the deactivation concept)
user.active=true
# Note that validation disabled
user.save(false)
user
end
def synchronize_groups(user)
if @java_groups_provider
begin
groups = @java_groups_provider.doGetGroups(user.login)
rescue Exception => e
Rails.logger.error("Error from external groups provider: #{e.message}")
else
if groups
user.groups = []
for group_name in groups
group = Group.find_by_name(group_name)
if group
user.groups << group
end
end
end
end
end
end
def editable_password?
false
end
end
#
# Load the realm to use. The server must be restarted when configuration is changed.
#
class RealmFactory
@@realm = nil
def self.realm
if @@realm.nil?
realm_factory = Api::Utils.java_facade.getCoreComponentByClassname('org.sonar.server.ui.SecurityRealmFactory')
component = realm_factory.getRealm()
@@realm = component ? PluginRealm.new(component) : DefaultRealm.new
end
@@realm
end
end
module NeedAuthentication
# ForUser module is included by the class User. It redirects authentication to the selected Authenticator.
module ForUser
# Stuff directives into including module
def self.included(recipient)
recipient.extend(ModelClassMethods)
end
module ModelClassMethods
# Authenticates a user by their login name and unencrypted password. Returns the user or nil.
#
# uff. this is really an authorization, not authentication routine.
# We really need a Dispatch Chain here or something.
# This will also let us return a human error message.
#
def authenticate(login, password, servlet_request)
# Downcase login (typically for Active Directory)
# Note that login in Sonar DB is case-sensitive, however in this case authentication and automatic user creation will always happen with downcase login
downcase = Api::Utils.java_facade.getSettings().getBoolean('sonar.authenticator.downcase')
if login && downcase
login = login.downcase
end
RealmFactory.realm.authenticate?(login, password, servlet_request)
end
def editable_password?
RealmFactory.realm.editable_password?
end
end
end
end
|
