saml-handler/src/main/java/org/apache/sling/auth/saml2/AuthenticationHandlerSAML2Config.java

/*
 * 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.sling.auth.saml2;

import org.apache.sling.auth.saml2.impl.AuthenticationHandlerSAML2Impl;
import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.AttributeType;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;


/**
 * The configuration for <code>SAML2</code> in Apache Sling
 *
 * @see AuthenticationHandlerSAML2Impl
 */

@ObjectClassDefinition(name="SAML2 Service Provider (SP) Configuration",
        description = "Configure SAML SSO by configuring details about your Identify Provider (IdP)"+
                "and related Service Provider metadata")
public @interface AuthenticationHandlerSAML2Config {

    @AttributeDefinition(name = "Path",
        description="Path under which this AuthenticationHandler should be used")
    String path() default "";

    @AttributeDefinition(name = "Service Ranking",
        description="Integer value used to select with handler when multiple handlers have path")
    int service_ranking() default 42;

    @AttributeDefinition(name = "Service Provider Entity ID",
        description="The Entity ID for the SP")
    String entityID() default "http://localhost:8080/";

    @AttributeDefinition(name = "ACS Path",
        description="Service Provider's Assertion Consumer Service Path")
    String acsPath() default "/sp/consumer";

    @AttributeDefinition(name = "User ID (uid) Attribute Name",
        description="Name of the attribute holding the users unique id")
    String saml2userIDAttr() default "username";

    @AttributeDefinition(name = "Path for SAML2 Users",
        description="Home path for SAML2 Users")
    String saml2userHome() default "/home/users/saml";

    @AttributeDefinition(name = "groupMembership Attribute Name",
        description="Name of the attribute holding the users' group memberships")
    String saml2groupMembershipAttr() default "";

    @AttributeDefinition(name = "Synchronize User Attributes",
            description="Map of attributes from SAML Response to Synchronize. For example, urn:oid:1.2.840.113549.1.9.1=./profile/email saves this attribute if it exists under the users profile node with the property name 'email' ")
    String[] syncAttrs() default {};

    @AttributeDefinition(name = "SAML2 Session Attribute",
        description="Name used to save the users security context within a HTTP SESSION")
    String saml2SessionAttr() default "saml2AuthInfo";

    @AttributeDefinition(name = "SAML2 IDP Destination",
        description="")
    String saml2IDPDestination() default "http://localhost:8080/idp/profile/SAML2/Redirect/SSO";

    @AttributeDefinition(name = "Logout URL",
            description="Redirect User to this URL when they logout")
    String saml2LogoutURL() default "https://sling.apache.org/";

    @AttributeDefinition(
        name = "Service Provider Enabled",
        description = "SAML2 Web Profile Service Provider Authentication Handler Enabled",
        type = AttributeType.BOOLEAN )
    boolean saml2SPEnabled() default false;

    @AttributeDefinition(
            name = "Sign and Encrypt Assertions",
            description = "Highly Recommended for security",
            type = AttributeType.BOOLEAN )
    boolean saml2SPEncryptAndSign() default false;

    @AttributeDefinition(name = "Java Keystore (.jks) file location",
        description="File location of the Java Keystore JKS")
    String jksFileLocation() default "";

    @AttributeDefinition(name = "JKS Password (storepass)",
        description="Password needed for accessing the JKS",
        type = AttributeType.PASSWORD)
    String jksStorePassword() default "";

    @AttributeDefinition(name = "IDP Signing Certificate Alias",
        description="Alias of certificate to be used when verifying Identity Provider signature")
    String idpCertAlias() default "";

    @AttributeDefinition(name = "SP Keystore Alias",
        description="Alias identifying the Service Provider (SP) Encryption Key-pair (keystore alias)")
    String spKeysAlias() default "";

    @AttributeDefinition(name = "SP Keystore Password (keystore)",
        description="Password needed for accessing the Service Provider (SP) Key Pair identified by the SP Keystore Alias",
        type = AttributeType.PASSWORD)
    String spKeysPassword() default "";

}