/* * mxisd - Matrix Identity Server Daemon * Copyright (C) 2017 Kamax Sarl * * https://www.kamax.io/ * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program 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 Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ package io.kamax.mxisd.config.ldap; import io.kamax.matrix.ThreePidMedium; import io.kamax.matrix.json.GsonUtil; import io.kamax.mxisd.backend.ldap.LdapBackend; import io.kamax.mxisd.exception.ConfigurationException; import org.apache.commons.lang.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.util.*; public abstract class LdapConfig { public static class UID { private String type; private String value; public String getType() { return type; } public void setType(String type) { this.type = type; } public String getValue() { return value; } public void setValue(String value) { this.value = value; } } public static class Attribute { private UID uid = new UID(); private String name = "displayName"; private Map> threepid = new HashMap<>(); public Attribute() { uid.setType("uid"); uid.setValue("saMAccountName"); threepid.put("email", Arrays.asList( "mailPrimaryAddress", "mail", "otherMailbox" )); threepid.put("msisdn", Arrays.asList( "telephoneNumber", "mobile", "homePhone", "otherTelephone", "otherMobile", "otherHomePhone" )); } public UID getUid() { return uid; } public void setUid(UID uid) { this.uid = uid; } public String getName() { return name; } public void setName(String name) { this.name = name; } public Map> getThreepid() { return threepid; } public void setThreepid(Map> threepid) { this.threepid = threepid; } } public static class Auth { private String filter; public String getFilter() { return filter; } public void setFilter(String filter) { this.filter = filter; } } public static class Connection { private boolean tls = false; private String host; private int port = 389; private String bindDn; private String bindPassword; private String baseDn; private List baseDNs = new ArrayList<>(); public boolean isTls() { return tls; } public void setTls(boolean tls) { this.tls = tls; } public String getHost() { return host; } public void setHost(String host) { this.host = host; } public int getPort() { return port; } public void setPort(int port) { this.port = port; } public String getBindDn() { return bindDn; } public void setBindDn(String bindDn) { this.bindDn = bindDn; } public String getBindPassword() { return bindPassword; } public void setBindPassword(String bindPassword) { this.bindPassword = bindPassword; } @Deprecated public String getBaseDn() { return baseDn; } @Deprecated public void setBaseDn(String baseDn) { this.baseDn = baseDn; } public List getBaseDNs() { return baseDNs; } public void setBaseDNs(List baseDNs) { this.baseDNs = baseDNs; } } public static class Directory { public static class Attribute { private List other = new ArrayList<>(); public List getOther() { return other; } public void setOther(List other) { this.other = other; } } private Attribute attribute = new Attribute(); private String filter; public Attribute getAttribute() { return attribute; } public void setAttribute(Attribute attribute) { this.attribute = attribute; } public String getFilter() { return filter; } public void setFilter(String filter) { this.filter = filter; } } public static class Identity { private String filter; private String token = "%3pid"; private Map medium = new HashMap<>(); private boolean lookup = false; public String getFilter() { return filter; } public void setFilter(String filter) { this.filter = filter; } public String getToken() { return token; } public void setToken(String token) { this.token = token; } public Map getMedium() { return medium; } public Optional getQuery(String key) { return Optional.ofNullable(medium.get(key)); } public void setMedium(Map medium) { this.medium = medium; } public boolean isLookup() { return lookup; } public void setLookup(boolean lookup) { this.lookup = lookup; } } public static class Profile { private String filter; public String getFilter() { return filter; } public void setFilter(String filter) { this.filter = filter; } } private transient final Logger log = LoggerFactory.getLogger(LdapConfig.class); private boolean enabled; private String filter; private boolean activeDirectory; private String defaultDomain; private Connection connection = new Connection(); private Attribute attribute = new Attribute(); private Auth auth = new Auth(); private Directory directory = new Directory(); private Identity identity = new Identity(); private Profile profile = new Profile(); protected abstract String getConfigName(); public boolean isEnabled() { return enabled; } public void setEnabled(boolean enabled) { this.enabled = enabled; } public String getFilter() { return filter; } public void setFilter(String filter) { this.filter = filter; } public boolean isActiveDirectory() { return activeDirectory; } public void setActiveDirectory(boolean activeDirectory) { this.activeDirectory = activeDirectory; } public String getDefaultDomain() { return defaultDomain; } public void setDefaultDomain(String defaultDomain) { this.defaultDomain = defaultDomain; } public Connection getConnection() { return connection; } public void setConnection(Connection conn) { this.connection = conn; } public Attribute getAttribute() { return attribute; } public void setAttribute(Attribute attribute) { this.attribute = attribute; } public Auth getAuth() { return auth; } public void setAuth(Auth auth) { this.auth = auth; } public Directory getDirectory() { return directory; } public void setDirectory(Directory directory) { this.directory = directory; } public Identity getIdentity() { return identity; } public void setIdentity(Identity identity) { this.identity = identity; } public Profile getProfile() { return profile; } public void setProfile(Profile profile) { this.profile = profile; } public void build() { log.info("--- " + getConfigName() + " Config ---"); log.info("Enabled: {}", isEnabled()); if (!isEnabled()) { return; } if (StringUtils.isBlank(connection.getHost())) { throw new IllegalStateException("LDAP Host must be configured!"); } if (connection.getPort() < 1 || connection.getPort() > 65535) { throw new IllegalStateException("LDAP port is not valid"); } // Backward compatibility with the old option if (!StringUtils.isBlank(connection.baseDn)) { connection.getBaseDNs().add(connection.baseDn); } if (connection.getBaseDNs().isEmpty()) { throw new ConfigurationException("ldap.connection.baseDNs", "You must specify at least one Base DN via the singular or plural config option"); } if (StringUtils.isBlank(attribute.getUid().getType())) { throw new IllegalStateException("Attribute UID Type cannot be empty"); } if (StringUtils.isBlank(attribute.getUid().getValue())) { throw new IllegalStateException("Attribute UID value cannot be empty"); } String uidType = attribute.getUid().getType(); if (!StringUtils.equals(LdapBackend.UID, uidType) && !StringUtils.equals(LdapBackend.MATRIX_ID, uidType)) { throw new IllegalArgumentException("Unsupported LDAP UID type: " + uidType); } if (StringUtils.isBlank(identity.getToken())) { throw new ConfigurationException("ldap.identity.token"); } if(isActiveDirectory()) { if(!StringUtils.equals(LdapBackend.UID, uidType)) { throw new IllegalArgumentException(String.format( "Attribute UID type should be set to %s in Active Directory mode", LdapBackend.UID )); } } // Build queries attribute.getThreepid().forEach((k, v) -> { if (StringUtils.isBlank(identity.getMedium().get(k))) { if (ThreePidMedium.PhoneNumber.is(k)) { identity.getMedium().put(k, LdapBackend.buildOrQuery("+" + getIdentity().getToken(), v)); } else { identity.getMedium().put(k, LdapBackend.buildOrQuery(getIdentity().getToken(), v)); } } }); getAuth().setFilter(StringUtils.defaultIfBlank(getAuth().getFilter(), getFilter())); getDirectory().setFilter(StringUtils.defaultIfBlank(getDirectory().getFilter(), getFilter())); getIdentity().setFilter(StringUtils.defaultIfBlank(getIdentity().getFilter(), getFilter())); if (StringUtils.isBlank(getProfile().getFilter())) { getProfile().setFilter(getFilter()); } log.info("Host: {}", connection.getHost()); log.info("Port: {}", connection.getPort()); log.info("TLS: {}", connection.isTls()); log.info("Bind DN: {}", connection.getBindDn()); log.info("Base DNs:"); for (String baseDN : connection.getBaseDNs()) { log.info(" - {}", baseDN); } log.info("Attribute: {}", GsonUtil.get().toJson(attribute)); log.info("Auth: {}", GsonUtil.get().toJson(auth)); log.info("Directory: {}", GsonUtil.get().toJson(directory)); log.info("Identity: {}", GsonUtil.get().toJson(identity)); log.info("Profile: {}", GsonUtil.get().toJson(profile)); } }