blob: 68852c6c73ff7d2126f7ded531a48297fbfe567c [file] [log] [blame]
/*
*
* 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.qpid.server.security;
import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.GeneralSecurityException;
import java.security.cert.Certificate;
import java.security.cert.X509Certificate;
import java.util.ArrayList;
import java.util.Collection;
import java.util.EnumMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.naming.InvalidNameException;
import javax.naming.ldap.LdapName;
import javax.naming.ldap.Rdn;
import javax.net.ssl.TrustManager;
import javax.net.ssl.TrustManagerFactory;
import javax.security.auth.x500.X500Principal;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import org.apache.qpid.server.logging.EventLogger;
import org.apache.qpid.server.logging.messages.TrustStoreMessages;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.qpid.server.configuration.IllegalConfigurationException;
import org.apache.qpid.server.model.AbstractConfiguredObject;
import org.apache.qpid.server.model.AuthenticationProvider;
import org.apache.qpid.server.model.Broker;
import org.apache.qpid.server.model.ConfiguredObject;
import org.apache.qpid.server.model.IntegrityViolationException;
import org.apache.qpid.server.model.ManagedAttributeField;
import org.apache.qpid.server.model.ManagedObject;
import org.apache.qpid.server.model.ManagedObjectFactoryConstructor;
import org.apache.qpid.server.model.Port;
import org.apache.qpid.server.model.State;
import org.apache.qpid.server.model.StateTransition;
import org.apache.qpid.server.model.TrustStore;
import org.apache.qpid.server.model.VirtualHostNode;
import org.apache.qpid.server.security.auth.manager.SimpleLDAPAuthenticationManager;
import org.apache.qpid.server.util.urlstreamhandler.data.Handler;
import org.apache.qpid.transport.network.security.ssl.SSLUtil;
@ManagedObject( category = false )
public class NonJavaTrustStoreImpl
extends AbstractConfiguredObject<NonJavaTrustStoreImpl> implements NonJavaTrustStore<NonJavaTrustStoreImpl>
{
private static final Logger LOGGER = LoggerFactory.getLogger(NonJavaTrustStoreImpl.class);
private final Broker<?> _broker;
private final EventLogger _eventLogger;
@ManagedAttributeField( afterSet = "updateTrustManagers" )
private String _certificatesUrl;
@ManagedAttributeField
private boolean _exposedAsMessageSource;
@ManagedAttributeField
private List<VirtualHostNode<?>> _includedVirtualHostNodeMessageSources;
@ManagedAttributeField
private List<VirtualHostNode<?>> _excludedVirtualHostNodeMessageSources;
private volatile TrustManager[] _trustManagers = new TrustManager[0];
static
{
Handler.register();
}
private X509Certificate[] _certificates;
@ManagedObjectFactoryConstructor
public NonJavaTrustStoreImpl(final Map<String, Object> attributes, Broker<?> broker)
{
super(parentsMap(broker), attributes);
_broker = broker;
_eventLogger = _broker.getEventLogger();
_eventLogger.message(TrustStoreMessages.CREATE(getName()));
}
@Override
public String getCertificatesUrl()
{
return _certificatesUrl;
}
@Override
public List<Map<CertificateDetails,Object>> getCertificateDetails()
{
List<Map<CertificateDetails,Object>> certificateDetails = new ArrayList<>();
if(_certificates != null)
{
for (X509Certificate certificate : _certificates)
{
Map<CertificateDetails, Object> details = new EnumMap<>(CertificateDetails.class);
details.put(CertificateDetails.SUBJECT_NAME, getNameFromCertificate(certificate));
details.put(CertificateDetails.ISSUER_NAME, certificate.getIssuerX500Principal().getName());
details.put(CertificateDetails.VALID_START, certificate.getNotBefore());
details.put(CertificateDetails.VALID_END, certificate.getNotAfter());
certificateDetails.add(details);
}
}
return certificateDetails;
}
private String getNameFromCertificate(final X509Certificate certificate)
{
String name;
X500Principal subjectX500Principal = certificate.getSubjectX500Principal();
name = getCommonNameFromPrincipal(subjectX500Principal);
return name;
}
private String getCommonNameFromPrincipal(final X500Principal subjectX500Principal)
{
String name;
String dn = subjectX500Principal.getName();
try
{
LdapName ldapDN = new LdapName(dn);
name = dn;
for (Rdn rdn : ldapDN.getRdns())
{
if (rdn.getType().equalsIgnoreCase("CN"))
{
name = String.valueOf(rdn.getValue());
break;
}
}
}
catch (InvalidNameException e)
{
LOGGER.error("Error getting subject name from certificate");
name = null;
}
return name;
}
@Override
public TrustManager[] getTrustManagers() throws GeneralSecurityException
{
if (_trustManagers == null || _trustManagers.length == 0)
{
throw new IllegalStateException("Truststore " + this + " defines no trust managers");
}
return _trustManagers;
}
@Override
public Certificate[] getCertificates() throws GeneralSecurityException
{
try
{
return SSLUtil.readCertificates(getUrlFromString(getCertificatesUrl()));
}
catch (IOException e)
{
throw new GeneralSecurityException(e);
}
}
@Override
public void onValidate()
{
super.onValidate();
validateTrustStoreAttributes(this);
}
@StateTransition(currentState = {State.ACTIVE, State.ERRORED}, desiredState = State.DELETED)
protected ListenableFuture<Void> doDelete()
{
// verify that it is not in use
String storeName = getName();
Collection<Port<?>> ports = new ArrayList<Port<?>>(_broker.getPorts());
for (Port port : ports)
{
Collection<TrustStore> trustStores = port.getTrustStores();
if(trustStores != null)
{
for (TrustStore store : trustStores)
{
if(storeName.equals(store.getAttribute(TrustStore.NAME)))
{
throw new IntegrityViolationException("Trust store '"
+ storeName
+ "' can't be deleted as it is in use by a port: "
+ port.getName());
}
}
}
}
Collection<AuthenticationProvider> authenticationProviders = new ArrayList<AuthenticationProvider>(_broker.getAuthenticationProviders());
for (AuthenticationProvider authProvider : authenticationProviders)
{
if(authProvider.getAttributeNames().contains(SimpleLDAPAuthenticationManager.TRUST_STORE))
{
Object attributeType = authProvider.getAttribute(AuthenticationProvider.TYPE);
Object attributeValue = authProvider.getAttribute(SimpleLDAPAuthenticationManager.TRUST_STORE);
if (SimpleLDAPAuthenticationManager.PROVIDER_TYPE.equals(attributeType)
&& storeName.equals(attributeValue))
{
throw new IntegrityViolationException("Trust store '"
+ storeName
+ "' can't be deleted as it is in use by an authentication manager: "
+ authProvider.getName());
}
}
}
deleted();
setState(State.DELETED);
_eventLogger.message(TrustStoreMessages.DELETE(getName()));
return Futures.immediateFuture(null);
}
@StateTransition(currentState = {State.UNINITIALIZED, State.ERRORED}, desiredState = State.ACTIVE)
protected ListenableFuture<Void> doActivate()
{
setState(State.ACTIVE);
return Futures.immediateFuture(null);
}
@Override
protected void validateChange(final ConfiguredObject<?> proxyForValidation, final Set<String> changedAttributes)
{
super.validateChange(proxyForValidation, changedAttributes);
NonJavaTrustStore changedStore = (NonJavaTrustStore) proxyForValidation;
if (changedAttributes.contains(NAME) && !getName().equals(changedStore.getName()))
{
throw new IllegalConfigurationException("Changing the key store name is not allowed");
}
validateTrustStoreAttributes(changedStore);
}
private void validateTrustStoreAttributes(NonJavaTrustStore<?> keyStore)
{
try
{
SSLUtil.readCertificates(getUrlFromString(keyStore.getCertificatesUrl()));
}
catch (IOException | GeneralSecurityException e)
{
throw new IllegalArgumentException("Cannot validate certificate(s):" + e, e);
}
}
@SuppressWarnings("unused")
private void updateTrustManagers()
{
try
{
if (_certificatesUrl != null)
{
X509Certificate[] certs = SSLUtil.readCertificates(getUrlFromString(_certificatesUrl));
java.security.KeyStore inMemoryKeyStore = java.security.KeyStore.getInstance(java.security.KeyStore.getDefaultType());
inMemoryKeyStore.load(null, null);
int i = 1;
for(Certificate cert : certs)
{
inMemoryKeyStore.setCertificateEntry(String.valueOf(i++), cert);
}
TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
tmf.init(inMemoryKeyStore);
_trustManagers = tmf.getTrustManagers();
_certificates = certs;
}
}
catch (IOException | GeneralSecurityException e)
{
throw new IllegalConfigurationException("Cannot load certificate(s) :" + e, e);
}
}
private URL getUrlFromString(String urlString) throws MalformedURLException
{
URL url;
try
{
url = new URL(urlString);
}
catch (MalformedURLException e)
{
File file = new File(urlString);
url = file.toURI().toURL();
}
return url;
}
@Override
public boolean isExposedAsMessageSource()
{
return _exposedAsMessageSource;
}
@Override
public List<VirtualHostNode<?>> getIncludedVirtualHostNodeMessageSources()
{
return _includedVirtualHostNodeMessageSources;
}
@Override
public List<VirtualHostNode<?>> getExcludedVirtualHostNodeMessageSources()
{
return _excludedVirtualHostNodeMessageSources;
}
}