Changed to Apache 2.0 license

Author: martin-lindstrom

LICENSE

@@ -1,15 +1,90 @@
-![Logo](https://github.com/litsec/eidas-opensaml/blob/master/docs/img/litsec-small.png)
+![Logo](https://github.com/litsec/opensaml-ext/blob/master/docs/img/litsec-small.png)
 
 ------
 
 # opensaml-ext
 
-Utility extensions for OpenSAML 2.X and 3.X.
+Utility extensions for OpenSAML 3.X.
 
-This open source package is an extension to OpenSAML that offers easy to use support for handling object creation, attributes, metadata, request and response handling and much more.
+This open source package is an extension to OpenSAML 3.X that offers utility classes and interfaces such as:
 
-See the [opensaml-ext Wiki](https://github.com/litsec/opensaml-ext/wiki) for detailed descriptions of the features.
+* Easier initialization of the OpenSAML libraries.
+* Utility methods for creating OpenSAML objects that does not require using the builder classes directly.
+* Utility methods for marshalling and unmarshalling.
+* Simplified support for signing XML objects.
+* An abstraction for metadata handling making it easier to download and use SAML metadata.
+* Spring Framework factory beans for easier integration in a Spring environment.
+* A builder pattern for some commonly used objects, such as creating SAML attribute objects, entity descriptors (metadata) or authentication requests.
 
-Copyright © 2017, [Litsec AB](http://www.litsec.se). Licensed under the GNU General Public License 3, for details see [LICENSE](LICENSE).
+Java API documentation of the opensaml-ext library is found at [https://litsec.github.io/opensaml-ext/javadoc](https://litsec.github.io/opensaml-ext/javadoc/).
+
+*Limited support for OpenSAML 2.X is also part of the project. This library will not be updated and its purpose is to support older libraries built using OpenSAML 2.*
+
+> Note: Some features of this library is still experimental.
+
+### Maven and opensaml-ext
+
+The opensaml-ext project artifacts are published to Maven central.
+
+Include the following snippet in your Maven POM to add opensaml-ext as a dependency for your project.
+
+```
+<dependency>
+  <groupId>se.litsec.opensaml</groupId>
+  <artifactId>opensaml3-ext</artifactId>
+  <version>${opensaml-ext.version}</version>
+</dependency>
+```
+
+If you are making use of the Spring features in opensaml-ext you need to explicitly add those dependencies. For example:
+
+```
+<dependency>
+  <groupId>org.springframework</groupId>
+  <artifactId>spring-beans</artifactId>
+  <version>${spring.version}</version>
+</dependency>
+
+<dependency>
+  <groupId>org.springframework</groupId>
+  <artifactId>spring-context</artifactId>
+  <version>${spring.version}</version>
+</dependency>
+```
+
+Currently, opensaml-ext uses version `4.3.7.RELEASE` of Spring.
+
+If you are using the OpenSAML 2.X version of the library (with limited features) use:
+
+```
+<dependency>
+  <groupId>se.litsec.opensaml</groupId>
+  <artifactId>opensaml2-ext</artifactId>
+  <version>${opensaml-ext.version}</version>
+</dependency>
+```
+### Initializing the OpenSAML library
+
+The OpenSAML library needs to be initialized before it can be used. The opensaml-ext library offers a simple default way of doing this.
+
+In order to initialize the OpenSAML library, include the following code somewhere in your application. It must be exectuted before any other code that is dependent on OpenSAML runs.
+
+```
+OpenSAMLInitializer.getInstance().initialize();
+```
+
+The OpenSAMLInitializer may also be supplied a customized parser pool. If none is assigned, a default parser pool is used.
+
+If you are using opensaml-ext in a Spring environment you may use the `OpenSAMLInitializerBean` to initialize OpenSAML. Include the following bean declaration in your Spring XML context:
+
+```
+<bean id="openSamlInitializer" 
+      class="se.litsec.opensaml.config.spring.OpenSAMLInitializerBean" 
+      scope="singleton" 
+      lazy-init="false" />
+```
+
+
+Copyright &copy; 2016-2018, [Litsec AB](http://www.litsec.se). Licensed under version 2.0 of the [Apache License](http://www.apache.org/licenses/LICENSE-2.0).
 
 

README.md

@@ -6,21 +6,20 @@
   <groupId>se.litsec.opensaml</groupId>
   <artifactId>opensaml2-ext</artifactId>
   <packaging>jar</packaging>
-  <version>0.9.2</version>
+  <version>0.9.3-SNAPSHOT</version>
 
   <name>Litsec :: OpenSAML 2.X utility extensions</name>
   <description>OpenSAML 2.X utility extension library</description>
   <url>https://github.com/litsec/opensaml-ext</url>
 
   <licenses>
     <license>
-      <name>GNU General Public License, Version 3</name>
-      <url>http://www.gnu.org/licenses/gpl-3.0.html</url>
+      <name>The Apache Software License, Version 2.0</name>
+      <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
       <distribution>repo</distribution>
-      <comments>A free, copyleft license for software and other kinds of works</comments>
     </license>
   </licenses>
-
+  
   <scm>
     <connection>scm:https://github.com/litsec/opensaml-ext.git</connection>
     <developerConnection>scm:https://github.com/litsec/opensaml-ext.git</developerConnection>
@@ -36,6 +35,11 @@
     </developer>
   </developers>
 
+  <organization>
+    <name>Litsec AB</name>
+    <url>http://www.litsec.se</url>
+  </organization>
+
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <java.version>1.8</java.version>
@@ -180,6 +184,12 @@
           </filesets>
         </configuration>
       </plugin>
+      
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-project-info-reports-plugin</artifactId>
+        <version>2.9</version>      
+      </plugin>      
 
     </plugins>
 

docs/img/litsec-small.png

@@ -1,22 +1,17 @@
 /*
- * The opensaml-ext project is an open-source package that extends OpenSAML
- * with useful extensions and utilities.
+ * Copyright 2016-2018 Litsec AB
  *
- * More details on <https://github.com/litsec/opensaml-ext>
- * Copyright (C) 2017 Litsec AB
+ * 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
  *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ *     http://www.apache.org/licenses/LICENSE-2.0
  *
- * 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 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 se.litsec.opensaml.core;
 

opensaml2/pom.xml

@@ -1,22 +1,17 @@
 /*
- * The opensaml-ext project is an open-source package that extends OpenSAML
- * with useful extensions and utilities.
+ * Copyright 2016-2018 Litsec AB
  *
- * More details on <https://github.com/litsec/opensaml-ext>
- * Copyright (C) 2017 Litsec AB
+ * 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
  *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ *     http://www.apache.org/licenses/LICENSE-2.0
  *
- * 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 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 se.litsec.opensaml.core;
 

opensaml2/src/main/java/se/litsec/opensaml/core/AbstractSAMLObjectBuilder.java

@@ -1,22 +1,17 @@
 /*
- * The opensaml-ext project is an open-source package that extends OpenSAML
- * with useful extensions and utilities.
+ * Copyright 2016-2018 Litsec AB
  *
- * More details on <https://github.com/litsec/opensaml-ext>
- * Copyright (C) 2017 Litsec AB
+ * 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
  *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ *     http://www.apache.org/licenses/LICENSE-2.0
  *
- * 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 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 se.litsec.opensaml.core;
 

opensaml2/src/main/java/se/litsec/opensaml/core/LocalizedString.java

@@ -1,22 +1,17 @@
 /*
- * The opensaml-ext project is an open-source package that extends OpenSAML
- * with useful extensions and utilities.
+ * Copyright 2016-2018 Litsec AB
  *
- * More details on <https://github.com/litsec/opensaml-ext>
- * Copyright (C) 2017 Litsec AB
+ * 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
  *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ *     http://www.apache.org/licenses/LICENSE-2.0
  *
- * 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 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 se.litsec.opensaml.saml2.attribute;
 

opensaml2/src/main/java/se/litsec/opensaml/core/SAMLObjectBuilder.java

@@ -0,0 +1,112 @@
+/*
+ * Copyright 2016-2018 Litsec AB
+ *
+ * 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 se.litsec.opensaml.saml2.attribute;
+
+import org.opensaml.saml2.core.Attribute;
+
+/**
+ * An attribute template is a template of a SAML attribute, i.e., it represents the name, friendly name and name format
+ * but not the value of the attribute.
+ * <p>
+ * A template may be useful when defining attribute sets and/or attribute release policies.
+ * </p>
+ * 
+ * @author Martin Lindström ([email protected])
+ */
+public class AttributeTemplate {
+
+  /** The attribute name. */
+  private String name;
+
+  /** The attribute friendly name. */
+  private String friendlyName;
+
+  /**
+   * The name format of this attribute. The default is {@code urn:oasis:names:tc:SAML:2.0:attrname-format:uri} (
+   * {@link Attribute#URI_REFERENCE}).
+   */
+  private String nameFormat = Attribute.URI_REFERENCE;
+
+  /**
+   * Creates an attribute template with the given name and friendly name, the default name format
+   * {@code urn:oasis:names:tc:SAML:2.0:attrname-format:uri} ({@link Attribute#URI_REFERENCE}) and not multi-valued.
+   * 
+   * @param name
+   *          the attribute name
+   * @param friendlyName
+   *          the attribute friendly name (optional)
+   */
+  public AttributeTemplate(String name, String friendlyName) {
+    this(name, friendlyName, Attribute.URI_REFERENCE);
+  }
+
+  /**
+   * Creates an attribute template with the given name, friendly name and name format.
+   * 
+   * @param name
+   *          the attribute name
+   * @param friendlyName
+   *          the attribute friendly name
+   * @param nameFormat
+   *          the name format
+   */
+  public AttributeTemplate(String name, String friendlyName, String nameFormat) {
+    if (name == null) {
+      throw new NullPointerException("'name' must not be null");
+    }
+    this.name = name;
+    this.friendlyName = friendlyName;
+    this.nameFormat = nameFormat != null ? nameFormat : Attribute.URI_REFERENCE;
+  }
+
+  /**
+   * Get the name of this attribute template.
+   * 
+   * @return the name of this attribute template
+   */
+  public String getName() {
+    return this.name;
+  }
+
+  /**
+   * Get the friendly name of this attribute template.
+   * 
+   * @return the friendly name of this attribute template
+   */
+  public String getFriendlyName() {
+    return this.friendlyName;
+  }
+
+  /**
+   * Get the name format of this attribute template.
+   * 
+   * @return the name format of this attribute template
+   */
+  public String getNameFormat() {
+    return this.nameFormat;
+  }
+
+  /**
+   * Based on the attribute template an {@link AttributeBuilder} object is created.
+   * 
+   * @return a builder
+   */
+  public AttributeBuilder createBuilder() {
+    AttributeBuilder builder = new AttributeBuilder(this.name);
+    return builder.friendlyName(this.friendlyName).nameFormat(this.nameFormat);
+  }
+
+}