org.apache.activemq.artemis.utils.PasswordMaskingUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of artemis-commons Show documentation
There is a newer version: 2.39.0
/*
 * 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.activemq.artemis.utils;

import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.HashMap;
import java.util.Map;

import org.apache.activemq.artemis.api.core.ActiveMQException;
import org.apache.activemq.artemis.api.core.ActiveMQExceptionType;
import org.apache.activemq.artemis.logs.ActiveMQUtilBundle;

public class PasswordMaskingUtil {

   private static final String PLAINTEXT_PROCESSOR = "plaintext";
   private static final String SECURE_PROCESSOR = "secure";

   private static final Map processors = new HashMap<>();

   //stored password takes 2 forms, ENC() or plain text
   public static HashProcessor getHashProcessor(String storedPassword) throws Exception {

      if (!isEncoded(storedPassword)) {
         return getPlaintextProcessor();
      }
      return getSecureProcessor();
   }

   private static boolean isEncoded(String storedPassword) {
      if (storedPassword == null) {
         return true;
      }

      if (storedPassword.startsWith("ENC(") && storedPassword.endsWith(")")) {
         return true;
      }
      return false;
   }

   public static HashProcessor getHashProcessor() {
      HashProcessor processor = null;
      try {
         processor = getSecureProcessor();
      } catch (Exception e) {
         processor = getPlaintextProcessor();
      }
      return processor;
   }

   public static HashProcessor getPlaintextProcessor() {
      synchronized (processors) {
         HashProcessor plain = processors.get(PLAINTEXT_PROCESSOR);
         if (plain == null) {
            plain = new NoHashProcessor();
            processors.put(PLAINTEXT_PROCESSOR, plain);
         }
         return plain;
      }
   }

   public static HashProcessor getSecureProcessor() throws Exception {
      synchronized (processors) {
         HashProcessor processor = processors.get(SECURE_PROCESSOR);
         if (processor == null) {
            DefaultSensitiveStringCodec codec = (DefaultSensitiveStringCodec) getCodec("org.apache.activemq.artemis.utils.DefaultSensitiveStringCodec;algorithm=one-way");
            processor = new SecureHashProcessor(codec);
            processors.put(SECURE_PROCESSOR, processor);
         }
         return processor;
      }
   }

   /*
    * Loading the codec class.
    *
    * @param codecDesc This parameter must have the following format:
    *
    * ;key=value;key1=value1;...
    *
    * Where only  is required. key/value pairs are optional
    */
   public static SensitiveDataCodec getCodec(String codecDesc) throws ActiveMQException {
      SensitiveDataCodec codecInstance;

      // semi colons
      String[] parts = codecDesc.split(";");

      if (parts.length < 1)
         throw new ActiveMQException(ActiveMQExceptionType.ILLEGAL_STATE, "Invalid PasswordCodec value: " + codecDesc);

      final String codecClassName = parts[0];

      // load class
      codecInstance = AccessController.doPrivileged(new PrivilegedAction>() {
         @Override
         public SensitiveDataCodec run() {
            ClassLoader loader = Thread.currentThread().getContextClassLoader();
            try {
               Class clazz = loader.loadClass(codecClassName);
               return (SensitiveDataCodec) clazz.newInstance();
            } catch (Exception e) {
               throw ActiveMQUtilBundle.BUNDLE.errorCreatingCodec(e, codecClassName);
            }
         }
      });

      if (parts.length > 1) {
         Map props = new HashMap<>();

         for (int i = 1; i < parts.length; i++) {
            String[] keyVal = parts[i].split("=");
            if (keyVal.length != 2)
               throw ActiveMQUtilBundle.BUNDLE.invalidProperty(parts[i]);
            props.put(keyVal[0], keyVal[1]);
         }
         try {
            codecInstance.init(props);
         } catch (Exception e) {
            throw new ActiveMQException("Fail to init codec", e, ActiveMQExceptionType.SECURITY_EXCEPTION);
         }
      }

      return codecInstance;
   }

   public static DefaultSensitiveStringCodec getDefaultCodec() {
      return new DefaultSensitiveStringCodec();
   }


}