Java tutorial
/** * Copyright (c) Istituto Nazionale di Fisica Nucleare (INFN). 2006-2016 * * Licensed 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.glite.security.voms.admin.configuration; import static org.glite.security.voms.admin.util.SysconfigUtil.SYSCONFIG_CONF_DIR; import static org.glite.security.voms.admin.util.SysconfigUtil.SYSCONFIG_DEFAULT_FILE_PATH; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.IOException; import java.io.InputStream; import java.io.PrintStream; import java.math.BigDecimal; import java.math.BigInteger; import java.security.PrivateKey; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.Arrays; import java.util.Iterator; import java.util.List; import java.util.Properties; import javax.servlet.ServletContext; import org.apache.commons.configuration.CompositeConfiguration; import org.apache.commons.configuration.Configuration; import org.apache.commons.configuration.ConfigurationException; import org.apache.commons.configuration.ConfigurationUtils; import org.apache.commons.configuration.PropertiesConfiguration; import org.apache.commons.configuration.SystemConfiguration; import org.apache.commons.io.FileUtils; import org.apache.commons.lang.Validate; import org.glite.security.voms.admin.error.VOMSException; import org.glite.security.voms.admin.operations.VOMSPermission; import org.glite.security.voms.admin.util.DNUtil; import org.glite.security.voms.admin.util.SysconfigUtil; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import eu.emi.security.authn.x509.impl.PEMCredential; public final class VOMSConfiguration { private static volatile VOMSConfiguration instance = null; public synchronized static VOMSConfiguration load(ServletContext context) { if (instance != null) throw new VOMSConfigurationException("VOMS configuration already loaded!"); instance = new VOMSConfiguration(context); return instance; } public synchronized static void dispose() { if (instance != null) { instance.clear(); instance = null; } } public static VOMSConfiguration instance() { if (instance == null) throw new VOMSConfigurationException("VOMS configuration not loaded! Use the load method to load it."); return instance; } private CompositeConfiguration config; private ServletContext context; Logger log = LoggerFactory.getLogger(VOMSConfiguration.class); private PEMCredential serviceCredential; private void loadConfDir() { loadSysconfig(); if (config.getString(SYSCONFIG_CONF_DIR) == null) { log.warn("{} undefined in VOMS Admin sysconfig.", SYSCONFIG_CONF_DIR); log.warn("Setting default value assuming EMI packaging: {}", "/etc/voms-admin"); config.setProperty(SYSCONFIG_CONF_DIR, "/etc/voms-admin"); } if (context != null && context.getInitParameter(SYSCONFIG_CONF_DIR) != null) { log.info("Setting {} from context: {}", SYSCONFIG_CONF_DIR, context.getInitParameter(SYSCONFIG_CONF_DIR)); config.setProperty(SYSCONFIG_CONF_DIR, context.getInitParameter(SYSCONFIG_CONF_DIR)); } } private VOMSConfiguration(ServletContext ctxt) { this.context = ctxt; config = new CompositeConfiguration(); loadVersionProperties(); loadConfDir(); loadHostAndPort(); if (context != null) { context = ctxt; loadVOName(); loadServiceProperties(); loadServiceCredentials(); } else { config.addConfiguration(new SystemConfiguration()); } log.debug("VOMS-Admin configuration loaded!"); } private void loadHostAndPort() { if (context != null) { config.setProperty(VOMSConfigurationConstants.VOMS_SERVICE_PORT, context.getInitParameter("PORT")); config.setProperty(VOMSConfigurationConstants.VOMS_SERVICE_HOSTNAME, context.getInitParameter("HOST")); } } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#addProperty(java.lang. * String, java.lang.Object) */ public void addProperty(String arg0, Object arg1) { config.addProperty(arg0, arg1); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#clear() */ public void clear() { config.clear(); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#clearProperty(java.lang * .String) */ public void clearProperty(String arg0) { config.clearProperty(arg0); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#containsKey(java.lang. * String) */ public boolean containsKey(String arg0) { return config.containsKey(arg0); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#getBigDecimal(java.lang * .String) */ public BigDecimal getBigDecimal(String arg0) { return config.getBigDecimal(arg0); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#getBigDecimal(java.lang * .String, java.math.BigDecimal) */ public BigDecimal getBigDecimal(String arg0, BigDecimal arg1) { return config.getBigDecimal(arg0, arg1); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#getBigInteger(java.lang * .String) */ public BigInteger getBigInteger(String arg0) { return config.getBigInteger(arg0); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#getBigInteger(java.lang * .String, java.math.BigInteger) */ public BigInteger getBigInteger(String arg0, BigInteger arg1) { return config.getBigInteger(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getBoolean(java.lang.String * ) */ public boolean getBoolean(String arg0) { return config.getBoolean(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getBoolean(java.lang.String * , boolean) */ public boolean getBoolean(String arg0, boolean arg1) { return config.getBoolean(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getBoolean(java.lang.String * , java.lang.Boolean) */ public Boolean getBoolean(String arg0, Boolean arg1) { return config.getBoolean(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getByte(java.lang.String) */ public byte getByte(String arg0) { return config.getByte(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getByte(java.lang.String, * byte) */ public byte getByte(String arg0, byte arg1) { return config.getByte(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getByte(java.lang.String, * java.lang.Byte) */ public Byte getByte(String arg0, Byte arg1) { return config.getByte(arg0, arg1); } public String getCustomizationPageAbsolutePath(String pageName) { String basePath = getCustomizedContentPath() + "/" + pageName; File f = new File(basePath); if (f.exists() && f.canRead()) return f.getAbsolutePath(); return null; } public String getConfigurationDirectoryPath() { String path = config.getString(SYSCONFIG_CONF_DIR) + "/" + getVOName(); return path; } private String getCustomizedContentPath() { String pathName = getConfigurationDirectoryPath() + "/customized-content/"; return pathName; } public Properties getDatabaseProperties() { String propFileName = getConfigurationDirectoryPath() + "/database.properties"; Properties props = new Properties(); try { props.load(new FileInputStream(propFileName)); } catch (IOException e) { log.error("Error loading database properties: " + e.getMessage(), e); throw new VOMSException("Error loading database properties: " + e.getMessage(), e); } return props; } public String getDefaultVOAUPURL() { return String.format("file://%s/vo-aup.txt", getConfigurationDirectoryPath()); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getDouble(java.lang.String ) */ public double getDouble(String arg0) { return config.getDouble(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getDouble(java.lang.String , * double) */ public double getDouble(String arg0, double arg1) { return config.getDouble(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getDouble(java.lang.String , * java.lang.Double) */ public Double getDouble(String arg0, Double arg1) { return config.getDouble(arg0, arg1); } private InputStream getExternalLogbackConfiguration() throws FileNotFoundException { String path = getConfigurationDirectoryPath() + "/logback.runtime.xml"; File f = new File(path); if (!f.exists()) log.warn("External logging configuration not found at path '" + path + "'... "); if (!f.canRead()) log.warn("External logging configuration is not readable: '" + path + "'... "); return new FileInputStream(f); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getFloat(java.lang.String) */ public float getFloat(String arg0) { return config.getFloat(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getFloat(java.lang.String, * float) */ public float getFloat(String arg0, float arg1) { return config.getFloat(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getFloat(java.lang.String, * java.lang.Float) */ public Float getFloat(String arg0, Float arg1) { return config.getFloat(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getInt(java.lang.String) */ public int getInt(String arg0) { return config.getInt(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getInt(java.lang.String, * int) */ public int getInt(String arg0, int arg1) { return config.getInt(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getInteger(java.lang.String * , java.lang.Integer) */ public Integer getInteger(String arg0, Integer arg1) { return config.getInteger(arg0, arg1); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#getKeys() */ public Iterator getKeys() { return config.getKeys(); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getKeys(java.lang.String) */ public Iterator getKeys(String arg0) { return config.getKeys(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getList(java.lang.String) */ public List getList(String arg0) { return config.getList(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getList(java.lang.String, * java.util.List) */ public List getList(String arg0, List arg1) { return config.getList(arg0, arg1); } public List getLocallyConfiguredVOs() { String configDirPath = getString(SYSCONFIG_CONF_DIR); if (configDirPath == null) throw new VOMSConfigurationException("No value found for " + SYSCONFIG_CONF_DIR + "!"); List voList = new ArrayList(); File configDir = new File(configDirPath); if (!configDir.exists()) throw new VOMSConfigurationException("Voms configuration directory does not exist"); File[] filez = configDir.listFiles(); if (filez != null) for (int i = 0; i < filez.length; i++) { if (filez[i].isDirectory()) { log.debug("Found vo: " + filez[i].getName()); voList.add(filez[i].getName()); } } return voList; } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getLong(java.lang.String) */ public long getLong(String arg0) { return config.getLong(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getLong(java.lang.String, * long) */ public long getLong(String arg0, long arg1) { return config.getLong(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getLong(java.lang.String, * java.lang.Long) */ public Long getLong(String arg0, Long arg1) { return config.getLong(arg0, arg1); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#getProperties(java.lang * .String) */ public Properties getProperties(String arg0) { return config.getProperties(arg0); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#getProperty(java.lang. * String) */ public Object getProperty(String arg0) { return config.getProperty(arg0); } public X509Certificate getServiceCertificate() { if (serviceCredential == null) return null; return serviceCredential.getCertificate(); } public PrivateKey getServicePrivateKey() { if (serviceCredential == null) return null; return serviceCredential.getKey(); } public ServletContext getServletContext() { return context; } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getShort(java.lang.String) */ public short getShort(String arg0) { return config.getShort(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getShort(java.lang.String, * short) */ public short getShort(String arg0, short arg1) { return config.getShort(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getShort(java.lang.String, * java.lang.Short) */ public Short getShort(String arg0, Short arg1) { return config.getShort(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getString(java.lang.String ) */ public String getString(String arg0) { return config.getString(arg0); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getString(java.lang.String , * java.lang.String) */ public String getString(String arg0, String arg1) { return config.getString(arg0, arg1); } /* * (non-Javadoc) * * @see * org.apache.commons.configuration.Configuration#getStringArray(java.lang * .String) */ public String[] getStringArray(String arg0) { return config.getStringArray(arg0); } public String getVomsesConfigurationString() { if (getString("vomses.configuration") == null) { String vomsesConfString = loadVomsesConfigurationString(); setProperty("vomses.configuration", vomsesConfString); } return getString("vomses.configuration"); } private String getVomsServicePropertiesFileName() { String fileName = getConfigurationDirectoryPath() + "/service.properties"; return fileName; } public String getVOName() { return getString(VOMSConfigurationConstants.VO_NAME); } /* * (non-Javadoc) * * @see org.apache.commons.configuration.Configuration#isEmpty() */ public boolean isEmpty() { return config.isEmpty(); } private void loadServiceCredentials() { String certificateFileName = getString(VOMSConfigurationConstants.VOMS_SERVICE_CERT_FILE, "/etc/grid-security/hostcert.pem"); String privateKeyFileName = getString(VOMSConfigurationConstants.VOMS_SERVICE_KEY_FILE, "/etc/grid-security/hostkey.pem"); /* load certificate */ log.info("Loading credentials for VOMS Attribute authority from:" + certificateFileName + "," + privateKeyFileName); try { serviceCredential = new PEMCredential(new FileInputStream(privateKeyFileName), new FileInputStream(certificateFileName), (char[]) null); } catch (Throwable t) { log.error("Error loading service credentials: {}", t.getMessage(), t); throw new VOMSException(t.getMessage(), t); } log.info("VOMS AA service credential's DN: " + DNUtil.getOpenSSLSubject(serviceCredential.getCertificate().getSubjectX500Principal())); } public void loadServiceProperties() { String fileName = getVomsServicePropertiesFileName(); try { PropertiesConfiguration vomsServiceProperties = new PropertiesConfiguration( getVomsServicePropertiesFileName()); config.addConfiguration(vomsServiceProperties); } catch (ConfigurationException e) { log.error("Error loading service properties from " + fileName); if (log.isDebugEnabled()) log.error(e.getMessage(), e); throw new VOMSConfigurationException("Error loading service properties from " + fileName, e); } log.debug("VOMS Admin service properties loaded!"); } private void loadSysconfig() { String sysconfigFilePath = SYSCONFIG_DEFAULT_FILE_PATH; try { sysconfigFilePath = SysconfigUtil.getSysconfigFilePath(); PropertiesConfiguration sysconf = new PropertiesConfiguration(sysconfigFilePath); config.addConfiguration(sysconf); log.debug("Loaded sysconfig from: {}", sysconfigFilePath); } catch (ConfigurationException e) { log.error("Error parsing VOMS Admin system configuration file " + sysconfigFilePath); throw new VOMSConfigurationException( "Error parsing VOMS Admin system configuration file " + SYSCONFIG_DEFAULT_FILE_PATH, e); } } private void loadVersionProperties() { InputStream versionPropStream = this.getClass().getClassLoader().getResourceAsStream("version.properties"); PropertiesConfiguration versionProperties = new PropertiesConfiguration(); try { versionProperties.load(versionPropStream); config.addConfiguration(versionProperties); } catch (ConfigurationException e) { log.error("Error configuring version properties:" + e.getMessage(), e); throw new VOMSConfigurationException("Error configuring version properties!", e); } } private String loadLSCConfigurationString() { String lscConfFileName = getConfigurationDirectoryPath() + "/lsc"; try { String lscConf = FileUtils.readFileToString(new File(lscConfFileName)); return lscConf; } catch (IOException e) { log.error("Error loading LSC configuration file:" + e.getMessage(), e); throw new VOMSException(e.getMessage(), e); } } private List<Integer> stringListToIntegerList(List<String> list) { Validate.notNull(list); List<Integer> timeList = new ArrayList<Integer>(); for (String i : list) { try { int ii = Integer.parseInt(i.trim()); timeList.add(ii); } catch (NumberFormatException nfe) { throw new VOMSException("Error while parsing list '" + list + "': " + nfe.getMessage(), nfe); } } return timeList; } public List<Integer> getAUPReminderIntervals() { int signAUPTaskLifetime = config.getInteger(VOMSConfigurationConstants.SIGN_AUP_TASK_LIFETIME, VOMSConfigurationConstants.SIGN_AUP_TASK_LIFETIME_DEFAULT_VALUE); @SuppressWarnings("unchecked") List<String> reminderTimes = config.getList(VOMSConfigurationConstants.SIGN_AUP_TASK_REMINDERS, Arrays.asList(VOMSConfigurationConstants.SIGN_AUP_TASK_REMINDERS_DEFAULT_VALUE)); List<Integer> intervals = stringListToIntegerList(reminderTimes); Iterator<Integer> iter = intervals.iterator(); while (iter.hasNext()) { int i = iter.next(); if (i >= signAUPTaskLifetime || i <= 0) { log.warn("Ignoring invalid reminder value: {}", i); iter.remove(); continue; } } return intervals; } private String loadVomsesConfigurationString() { String vomsesConfFileName = getConfigurationDirectoryPath() + "/vomses"; try { String vomsesConf = FileUtils.readFileToString(new File(vomsesConfFileName)); return vomsesConf; } catch (IOException e) { log.error("Error loading vomses configuration file:" + e.getMessage(), e); throw new VOMSException(e.getMessage(), e); } } private void loadVOName() { SystemConfiguration systemConfig = new SystemConfiguration(); if (!config.containsKey("VO_NAME")) { if (context.getInitParameter("VO_NAME") != null) { log.debug("Setting VO name from init parameter: {}", context.getInitParameter("VO_NAME")); config.setProperty(VOMSConfigurationConstants.VO_NAME, context.getInitParameter("VO_NAME")); } if (!config.containsKey(VOMSConfigurationConstants.VO_NAME)) { throw new VOMSConfigurationException("VO_NAME property not found!"); } } else { config.setProperty(VOMSConfigurationConstants.VO_NAME, config.getProperty("VO_NAME")); } } public boolean pageHasCustomization(String pageName) { String basePath = getCustomizedContentPath() + "/" + pageName; File f = new File(basePath); return (f.exists() && f.canRead()); } public void setProperty(String arg0, Object arg1) { config.setProperty(arg0, arg1); } public Configuration subset(String arg0) { return config.subset(arg0); } @SuppressWarnings("unchecked") public List<String> getExternalValidators() { return config.getList(VOMSConfigurationConstants.VOMS_EXTERNAL_VALIDATOR_LIST); } public String getExternalValidatorConfigClass(String pluginName) { String configClassPropertyName = String.format("%s.%s.%s", VOMSConfigurationConstants.VOMS_EXTERNAL_VALIDATOR_PREFIX, pluginName, VOMSConfigurationConstants.VOMS_EXTERNAL_VALIDATOR_CONFIG_SUFFIX); return config.getString(configClassPropertyName); } public String getExternalValidatorProperty(String pluginName, String pluginPropertyName, String defaultValue) { String propertyName = String.format("%s.%s.%s", VOMSConfigurationConstants.VOMS_EXTERNAL_VALIDATOR_PREFIX, pluginName, pluginPropertyName); return config.getString(propertyName, defaultValue); } public String getExternalValidatorProperty(String pluginName, String pluginPropertyName) { String propertyName = String.format("%s.%s.%s", VOMSConfigurationConstants.VOMS_EXTERNAL_VALIDATOR_PREFIX, pluginName, pluginPropertyName); return config.getString(propertyName); } public void setRegistrationType(String registrationType) { config.setProperty(VOMSConfigurationConstants.VOMS_INTERNAL_REGISTRATION_TYPE, registrationType); } public String getRegistrationType() { return config.getString(VOMSConfigurationConstants.VOMS_INTERNAL_REGISTRATION_TYPE, "default"); } public VOMSPermission getUnauthenticatedClientPermissionMask() { String unauthenticatedClientPermMask = getString( VOMSConfigurationConstants.VOMS_UNAUTHENTICATED_CLIENT_PERMISSION_MASK, "CONTAINER_READ|MEMBERSHIP_READ"); VOMSPermission permMask = null; try { permMask = VOMSPermission.fromString(unauthenticatedClientPermMask); } catch (IllegalArgumentException e) { // Parse error on user set permission mask log.error("Error parsing user set permission mask for unauthenticated client: '" + unauthenticatedClientPermMask + "'"); log.error(e.getMessage()); permMask = VOMSPermission.getContainerReadPermission().setMembershipReadPermission(); } return permMask; } public String getServiceHostname() { return config.getString(VOMSConfigurationConstants.VOMS_SERVICE_HOSTNAME, "localhost"); } public String getGroupManagerRoleName() { return config.getString(VOMSConfigurationConstants.GROUP_MANAGER_ROLE_NAME, "Group-Manager"); } public int getExpiringUsersWarningInterval() { String warningPeriodInDays = VOMSConfiguration.instance().getString( VOMSConfigurationConstants.MEMBERSHIP_EXPIRATION_WARNING_PERIOD, VOMSConfigurationConstants.MEMBERSHIP_EXPIRATION_WARNING_PERIOD_DEFAULT_VALUE); Integer i; try { i = Integer.parseInt(warningPeriodInDays); } catch (NumberFormatException e) { log.error( "Error converting {} to an integer. The {} property should contain a positive integer! Using the default value instead.", warningPeriodInDays); return Integer.parseInt(VOMSConfigurationConstants.MEMBERSHIP_EXPIRATION_WARNING_PERIOD_DEFAULT_VALUE); } if (i <= 0) { log.warn("Negative warning period set for the property {}. Using the default value instead.", VOMSConfigurationConstants.MEMBERSHIP_EXPIRATION_WARNING_PERIOD); return Integer.parseInt(VOMSConfigurationConstants.MEMBERSHIP_EXPIRATION_WARNING_PERIOD_DEFAULT_VALUE); } return i; } public String getLSCConfiguration() { return loadLSCConfigurationString(); } public String getHostname() { return config.getString("voms.hostname"); } public PEMCredential getServiceCredential() { return serviceCredential; } public void dump(PrintStream stream) { for (int i = 0; i < config.getNumberOfConfigurations(); i++) ConfigurationUtils.dump(config.getConfiguration(i), stream); } }