content: // Licensed to the Apache Software Foundation (ASF) under one
  // or more contributor license agreements.  See the NOTICE file
  // distributed with this work for additional information
  // regarding copyright ownership.  The ASF licenses this file
  // to you under the Apache License, Version 2.0 (the
  // "License"); you may not use this file except in compliance
  // with the License.  You may obtain a copy of the License at
  //
  //   http://www.apache.org/licenses/LICENSE-2.0
  //
  // Unless required by applicable law or agreed to in writing,
  // software distributed under the License is distributed on an
  // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  // KIND, either express or implied.  See the License for the
  // specific language governing permissions and limitations
  // under the License.
  package org.apache.cloudstack.ldap;
  
  import java.io.FileInputStream;
  import java.io.IOException;
  import java.util.Hashtable;
  
  import javax.inject.Inject;
  import javax.naming.Context;
  import javax.naming.NamingException;
  import javax.naming.ldap.InitialLdapContext;
  import javax.naming.ldap.LdapContext;
  import java.security.KeyStore;
  
  import org.apache.commons.lang3.StringUtils;
  import org.apache.logging.log4j.Logger;
  import org.apache.logging.log4j.LogManager;
  
  public class LdapContextFactory {
      protected Logger logger = LogManager.getLogger(getClass());
  
      @Inject
      private LdapConfiguration _ldapConfiguration;
  
      public LdapContextFactory() {
      }
  
      public LdapContextFactory(final LdapConfiguration ldapConfiguration) {
          _ldapConfiguration = ldapConfiguration;
      }
  
      public LdapContext createBindContext(Long domainId) throws NamingException, IOException {
          return createBindContext(null, domainId);
      }
  
      public LdapContext createBindContext(final String providerUrl, Long domainId) throws NamingException, IOException {
          final String bindPrincipal = _ldapConfiguration.getBindPrincipal(domainId);
          final String bindPassword = _ldapConfiguration.getBindPassword(domainId);
          return createInitialDirContext(bindPrincipal, bindPassword, providerUrl, true, domainId);
      }
  
      private LdapContext createInitialDirContext(final String principal, final String password, final boolean isSystemContext, Long domainId) throws NamingException {
          return createInitialDirContext(principal, password, null, isSystemContext, domainId);
      }
  
      private LdapContext createInitialDirContext(final String principal, final String password, final String providerUrl, final boolean isSystemContext, Long domainId)
          throws NamingException {
          Hashtable<String, String> environment = getEnvironment(principal, password, providerUrl, isSystemContext, domainId);
          logger.debug("initializing ldap with provider url: {}", environment.get(Context.PROVIDER_URL));
          return new InitialLdapContext(environment, null);
      }
  
      public LdapContext createUserContext(final String principal, final String password, Long domainId) throws NamingException, IOException {
          return createInitialDirContext(principal, password, false, domainId);
      }
  
      private void enableSSL(final Hashtable<String, String> environment, Long domainId) {
          final boolean sslStatus = _ldapConfiguration.getSSLStatus(domainId);
  
          if (sslStatus) {
              logger.info("LDAP SSL enabled.");
              environment.put(Context.SECURITY_PROTOCOL, "ssl");
              String trustStore = _ldapConfiguration.getTrustStore(domainId);
              String trustStorePassword = _ldapConfiguration.getTrustStorePassword(domainId);
  
              if (!validateTrustStore(trustStore, trustStorePassword)) {
                  throw new RuntimeException("Invalid truststore or truststore password");
              }
  
              System.setProperty("javax.net.ssl.trustStore", trustStore);
              System.setProperty("javax.net.ssl.trustStorePassword", trustStorePassword);
          }
      }
  
      private boolean validateTrustStore(String trustStore, String trustStorePassword) {
          if (trustStore == null) {
              return true;
          }
  
          if (trustStorePassword == null) {
              return false;
          }
  
          try {
              KeyStore.getInstance("JKS").load(
                  new FileInputStream(trustStore),
                  trustStorePassword.toCharArray()
              );
              return true;
          } catch (Exception e) {
              logger.warn("Failed to validate truststore: {}", e.getMessage());
              return false;
          }
      }
  
      private Hashtable<String, String> getEnvironment(final String principal, final String password, final String providerUrl, final boolean isSystemContext, Long domainId) {
          final String factory = _ldapConfiguration.getFactory();
          String url = providerUrl == null ? _ldapConfiguration.getProviderUrl(domainId) : providerUrl;
          if (StringUtils.isEmpty(url) && domainId != null) {
              //try a default ldap implementation
              url = _ldapConfiguration.getProviderUrl(null);
          }
  
          final Hashtable<String, String> environment = new Hashtable<>();
  
          environment.put(Context.INITIAL_CONTEXT_FACTORY, factory);
          environment.put(Context.PROVIDER_URL, url);
          environment.put("com.sun.jndi.ldap.read.timeout", _ldapConfiguration.getReadTimeout(domainId).toString());
          environment.put("com.sun.jndi.ldap.connect.pool", "true");
  
          enableSSL(environment, domainId);
          setAuthentication(environment, isSystemContext, domainId);
  
          if (principal != null) {
              environment.put(Context.SECURITY_PRINCIPAL, principal);
          }
  
          if (password != null) {
              environment.put(Context.SECURITY_CREDENTIALS, password);
          }
  
          return environment;
      }
  
      private void setAuthentication(final Hashtable<String, String> environment, final boolean isSystemContext, final Long domainId) {
          final String authentication = _ldapConfiguration.getAuthentication(domainId);
  
          if ("none".equals(authentication) && !isSystemContext) {
              environment.put(Context.SECURITY_AUTHENTICATION, "simple");
          } else {
              environment.put(Context.SECURITY_AUTHENTICATION, authentication);
          }
      }
  
  }
  