1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.Auth.LDAPAuthenticator do
10 @behaviour Pleroma.Web.Auth.Authenticator
12 @connection_timeout 10_000
13 @search_timeout 10_000
15 def get_user(%Plug.Conn{} = conn, params) do
16 if Pleroma.Config.get([:ldap, :enabled]) do
19 %{"authorization" => %{"name" => name, "password" => password}} ->
22 %{"grant_type" => "password", "username" => name, "password" => password} ->
26 case ldap_user(name, password) do
30 {:error, {:ldap_connection_error, _}} ->
31 # When LDAP is unavailable, try default authenticator
32 Pleroma.Web.Auth.PleromaAuthenticator.get_user(conn, params)
38 # Fall back to default authenticator
39 Pleroma.Web.Auth.PleromaAuthenticator.get_user(conn, params)
43 def get_by_external_registration(conn, params), do: get_user(conn, params)
45 def handle_error(%Plug.Conn{} = _conn, error) do
49 def auth_template, do: nil
51 defp ldap_user(name, password) do
52 ldap = Pleroma.Config.get(:ldap, [])
53 host = Keyword.get(ldap, :host, "localhost")
54 port = Keyword.get(ldap, :port, 389)
55 ssl = Keyword.get(ldap, :ssl, false)
56 sslopts = Keyword.get(ldap, :sslopts, [])
59 [{:port, port}, {:ssl, ssl}, {:timeout, @connection_timeout}] ++
60 if sslopts != [], do: [{:sslopts, sslopts}], else: []
62 case :eldap.open([to_charlist(host)], options) do
65 if Keyword.get(ldap, :tls, false) do
66 :application.ensure_all_started(:ssl)
68 case :eldap.start_tls(
70 Keyword.get(ldap, :tlsopts, []),
77 Logger.error("Could not start TLS: #{inspect(error)}")
81 bind_user(connection, ldap, name, password)
83 :eldap.close(connection)
87 Logger.error("Could not open LDAP connection: #{inspect(error)}")
88 {:error, {:ldap_connection_error, error}}
92 defp bind_user(connection, ldap, name, password) do
93 uid = Keyword.get(ldap, :uid, "cn")
94 base = Keyword.get(ldap, :base)
96 case :eldap.simple_bind(connection, "#{uid}=#{name},#{base}", password) do
98 case User.get_by_nickname_or_email(name) do
103 register_user(connection, base, uid, name, password)
111 defp register_user(connection, base, uid, name, password) do
112 case :eldap.search(connection, [
113 {:base, to_charlist(base)},
114 {:filter, :eldap.equalityMatch(to_charlist(uid), to_charlist(name))},
115 {:scope, :eldap.wholeSubtree()},
116 {:attributes, ['mail', 'email']},
117 {:timeout, @search_timeout}
119 {:ok, {:eldap_search_result, [{:eldap_entry, _, attributes}], _}} ->
120 with {_, [mail]} <- List.keyfind(attributes, 'mail', 0) do
122 email: :erlang.list_to_binary(mail),
126 password_confirmation: password
129 changeset = User.register_changeset(%User{}, params)
131 case User.register(changeset) do
137 Logger.error("Could not find LDAP attribute mail: #{inspect(attributes)}")
138 {:error, :ldap_registration_missing_attributes}