Redmine

Toshi MARUYAMA wrote:

Try this patch.
[...]

This patch is not work, the item is a Hash, without 'force_encoding' method.

I think AuthSourceLdap.get_attr is a good place.

def self.get_attr(entry, attr_name)
  if !attr_name.blank?
    value = entry[attr_name].is_a?(Array) ? entry[attr_name].first : entry[attr_name]
    value.force_encoding('UTF-8')
  end
end

Toshi MARUYAMA wrote:

Try this patch.

I was patched. But i got an other error.

[root@redmine32 models]# diff auth_source_ldap.rb auth_source_ldap.rb.org
94c94
<     results.collect {|item| item.force_encoding('UTF-8')}
---
>     results

BEFORE

[2015-12-09 01:01:44.417073][15262] Started GET "/redmine/auth_sources/autocomplete_for_new_user?term=**********" for 192.168.16.253 at 2015-12-09 01:01:44 +0900
[2015-12-09 01:01:44.417846][15262] Processing by AuthSourcesController#autocomplete_for_new_user as JSON
[2015-12-09 01:01:44.417899][15262]   Parameters: {"term"=>"**********"}
[2015-12-09 01:01:44.422393][15262]   Current user: admin (id=1)
[2015-12-09 01:01:44.479656][15262] Completed 500 Internal Server Error in 62ms (ActiveRecord: 2.6ms)

[2015-12-09 01:01:44.480361][15262] Encoding::UndefinedConversionError ("\xE7" from ASCII-8BIT to UTF-8):
[2015-12-09 01:01:44.480361][15262]   app/controllers/auth_sources_controller.rb:79:in `autocomplete_for_new_user'
[2015-12-09 01:01:44.480361][15262]   lib/redmine/sudo_mode.rb:63:in `sudo_mode'

AFTER

[2015-12-09 00:56:35.824736][14847] Started GET "/redmine/auth_sources/autocomplete_for_new_user?term=**********" for 192.168.16.253 at 2015-12-09 00:56:35 +0900
[2015-12-09 00:56:35.825657][14847] Processing by AuthSourcesController#autocomplete_for_new_user as JSON
[2015-12-09 00:56:35.825702][14847]   Parameters: {"term"=>"**********"}
[2015-12-09 00:56:35.830259][14847]   Current user: admin (id=1)
[2015-12-09 00:56:35.879744][14847] Completed 500 Internal Server Error in 54ms (ActiveRecord: 2.7ms)

[2015-12-09 00:56:35.880394][14847] NoMethodError (undefined method `force_encoding' for #<Hash:0x007f2fdb8dd4e0>):
[2015-12-09 00:56:35.880394][14847]   app/models/auth_source_ldap.rb:94:in `block in search'
[2015-12-09 00:56:35.880394][14847]   app/models/auth_source_ldap.rb:94:in `collect'
[2015-12-09 00:56:35.880394][14847]   app/models/auth_source_ldap.rb:94:in `search'
[2015-12-09 00:56:35.880394][14847]   app/models/auth_source.rb:61:in `block in search'
[2015-12-09 00:56:35.880394][14847]   app/models/auth_source.rb:58:in `search'
[2015-12-09 00:56:35.880394][14847]   app/controllers/auth_sources_controller.rb:77:in `autocomplete_for_new_user'
[2015-12-09 00:56:35.880394][14847]   lib/redmine/sudo_mode.rb:63:in `sudo_mode'

Haihan Ji wrote:

This patch is not work, the item is a Hash, without 'force_encoding' method.
I think AuthSourceLdap.get_attr is a good place.

I fixed, Thanks.

I confirm this bug, redmine 3.2.0 with net-ldap-0.12.1. If I rollback on net-ldap-0.3.1 - all is ok.
The LDAP server response is identical in both cases.
Haihan Ji wrote:

I think AuthSourceLdap.get_attr is a good place.

Yes, this works, thank you!
UPD:
Maybe more general solution exists? Maybe we need to use other version of net-ldap gem, or fix this gem?
I see the same error in Redmine Ldap Sync plugin:

ActionView::Template::Error (incompatible character encodings: UTF-8 and ASCII-8BIT):
    1: <% @test.users_at_ldap.each do |(login, data)| -%>
    2: <%= "#{l(:label_user)} \"#{login}\"" %>: <%= data == :not_found ?
    3:     "#{l(:label_not_found)}\n" :
    4:     "\n#{user_fields_list data[:fields], data[:groups]}" %>
    5: <% end -%>
    6: <% @test.groups_at_ldap.each do |(name, data)| -%>
    7: <%= "#{l(:label_group)} \"#{name}\"" %>: <%= data == :not_found ?
  lib/redmine/sudo_mode.rb:63:in `sudo_mode'

https://github.com/ruby-ldap/ruby-net-ldap/issues/4

It will be good, if someone can help to fix this net-ldap bug?

Haihan Ji wrote:

I think AuthSourceLdap.get_attr is a good place.
[...]

This Fix don't work to me until i convert result to a string.

value.to_s.force_encoding('UTF-8')

Edit after comment 15: Oops, I missed r15025 somehow... Sorry for taking up your time.

I needed national chars in the Firs/Last Name fields from LDAP, so I cherry picked the changed in r15024 (which is the change that Haihan Ji suggested above).

However this does not play nice with cases when a field is unavailable from the LDAP server.

We don't have the email property set for all LDAP accounts in the AD, but it is set for some of the users so I wanted to use the property when available.

Before this patch: if the email property was set accounts are auto-created without any further questions, and without the email set the user is asked for it when auto-creating his account.

Now, after the patch, if the email property is not set I get the following error message in the log during account auto-creation:

Error during authentication: undefined method `force_encoding' for nil:NilClass

I changed the code to only call the force_encoding method if value is non-nil:

  def self.get_attr(entry, attr_name)
    if !attr_name.blank?
      value = entry[attr_name].is_a?(Array) ? entry[attr_name].first : entry[attr_name]
      value.force_encoding('UTF-8') unless value.nil?
    end
  end

(This is the first line of Ruby I've written and I am not sure I did it right... But i think it solves the problem by not calling force_encoding if value is nil.)