se.swedenconnect.opensaml.eidas.xmlsec.EidasSecurityConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-eidas Show documentation
OpenSAML 5.X extension library for the eIDAS Framework
The newest version!
/*
 * Copyright 2016-2024 Sweden Connect
 *
 * 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.swedenconnect.opensaml.eidas.xmlsec;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.opensaml.xmlsec.AlgorithmPolicyConfiguration.Precedence;
import org.opensaml.xmlsec.DecryptionConfiguration;
import org.opensaml.xmlsec.EncryptionConfiguration;
import org.opensaml.xmlsec.SignatureSigningConfiguration;
import org.opensaml.xmlsec.SignatureValidationConfiguration;
import org.opensaml.xmlsec.config.impl.DefaultSecurityConfigurationBootstrap;
import org.opensaml.xmlsec.encryption.support.EncryptionConstants;
import org.opensaml.xmlsec.encryption.support.RSAOAEPParameters;
import org.opensaml.xmlsec.impl.BasicDecryptionConfiguration;
import org.opensaml.xmlsec.impl.BasicEncryptionConfiguration;
import org.opensaml.xmlsec.impl.BasicSignatureSigningConfiguration;
import org.opensaml.xmlsec.impl.BasicSignatureValidationConfiguration;
import org.opensaml.xmlsec.signature.support.SignatureConstants;

import se.swedenconnect.opensaml.xmlsec.config.AbstractSecurityConfiguration;
import se.swedenconnect.opensaml.xmlsec.config.ExtendedDefaultSecurityConfigurationBootstrap;

/**
 * A security configuration for OpenSAML according to version 1.3 of "eIDAS - Cryptographic requirements for the
 * Interoperability Framework" (and earlier versions).
 *
 * 
 * Note: The people behind the eIDAS crypto requirements SHOULD have looked at what is available in major code
 * frameworks before setting up rigid requirements about bleeding edge cryptos. For example, RSA-PSS on a HSM in a Java
 * environment doesn't work and ECDH key-agreement isn't supported out of the box from OpenSAML (but by
 * https://github.com/swedenconnect/opensaml-security-ext). Security AND interoperability can exist, but IMHO they
 * forgot the latter.
 * 
 * 
 * Anyway. If you configure your OpenSAML application using the algorithms of {@code EidasSecurityConfiguration} you may
 * run into interop issues. Consider using the more relaxed version {@link RelaxedEidasSecurityConfiguration}.
 * 
 *
 * @author Martin Lindström
 */
public class EidasSecurityConfiguration extends AbstractSecurityConfiguration {

  /** {@inheritDoc} */
  @Override
  public String getProfileName() {
    return "eidas";
  }

  /**
   * Creates an encryption configuration for eIDAS according to section 3.2.1 and 3.2.2 of "eIDAS - Cryptographic
   * requirements for the Interoperability Framework version 1.3 and earlier".
   */
  @Override
  protected EncryptionConfiguration createDefaultEncryptionConfiguration() {

    final BasicEncryptionConfiguration config =
        ExtendedDefaultSecurityConfigurationBootstrap.buildDefaultEncryptionConfiguration();

    config.setDataEncryptionAlgorithms(List.of(
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_AES256_GCM,
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_AES128_GCM,
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_AES192_GCM
    ));
    config.setKeyTransportEncryptionAlgorithms(List.of(
        EncryptionConstants.ALGO_ID_KEYTRANSPORT_RSAOAEP,
        EncryptionConstants.ALGO_ID_KEYTRANSPORT_RSAOAEP11,
        EncryptionConstants.ALGO_ID_KEYWRAP_AES256,
        EncryptionConstants.ALGO_ID_KEYWRAP_AES128
    ));
    config.setRSAOAEPParameters(new RSAOAEPParameters(
        SignatureConstants.ALGO_ID_DIGEST_SHA256,
        EncryptionConstants.ALGO_ID_MGF1_SHA1,
        null));
    config.setExcludedAlgorithms(List.of(
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_TRIPLEDES,
        EncryptionConstants.ALGO_ID_KEYTRANSPORT_RSA15,
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_AES128,
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_AES192,
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_AES256
    ));

    return config;
  }

  /**
   * Creates a decryption configuration for eIDAS according to section 3.2.1 and 3.2.2 of "eIDAS - Cryptographic
   * requirements for the Interoperability Framework".
   */
  @Override
  protected DecryptionConfiguration createDefaultDecryptionConfiguration() {

    final BasicDecryptionConfiguration config =
        DefaultSecurityConfigurationBootstrap.buildDefaultDecryptionConfiguration();

    // Whitelist has precedence over blacklist, so we simply add the algorithms listed in
    // "eIDAS - Cryptographic requirements for the Interoperability Framework".
    //
    config.setIncludeExcludePrecedence(Precedence.INCLUDE);
    config.setIncludedAlgorithms(Arrays.asList(
        // Content encryption
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_AES256_GCM,
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_AES192_GCM,
        EncryptionConstants.ALGO_ID_BLOCKCIPHER_AES128_GCM,
        // Key transport
        EncryptionConstants.ALGO_ID_KEYTRANSPORT_RSAOAEP,
        EncryptionConstants.ALGO_ID_KEYTRANSPORT_RSAOAEP11,
        // Key wrapping
        EncryptionConstants.ALGO_ID_KEYWRAP_AES256,
        EncryptionConstants.ALGO_ID_KEYWRAP_AES128,
        // Key agreement
        EncryptionConstants.ALGO_ID_KEYAGREEMENT_ECDH_ES));

    return config;
  }

  /**
   * Creates a signature configuration for eIDAS according to section 3.3 of "eIDAS - Cryptographic requirements for the
   * Interoperability Framework".
   */
  @Override
  protected SignatureSigningConfiguration createDefaultSignatureSigningConfiguration() {

    final BasicSignatureSigningConfiguration config =
        DefaultSecurityConfigurationBootstrap.buildDefaultSignatureSigningConfiguration();

    final List blacklistedAlgorithms = new ArrayList<>(config.getExcludedAlgorithms());
    blacklistedAlgorithms.addAll(Arrays.asList(
        SignatureConstants.ALGO_ID_DIGEST_SHA1,
        SignatureConstants.ALGO_ID_DIGEST_SHA224,
        SignatureConstants.ALGO_ID_DIGEST_RIPEMD160));
    config.setExcludedAlgorithms(blacklistedAlgorithms);

    // Yup. RSA-SHAxxx is not there!
    config.setSignatureAlgorithms(Arrays.asList(
        // ECDSA
        SignatureConstants.ALGO_ID_SIGNATURE_ECDSA_SHA256,
        SignatureConstants.ALGO_ID_SIGNATURE_ECDSA_SHA384,
        SignatureConstants.ALGO_ID_SIGNATURE_ECDSA_SHA512,

        // RSA-PSS
        SignatureConstants.ALGO_ID_SIGNATURE_RSASSA_PSS_SHA256_MGF1,
        SignatureConstants.ALGO_ID_SIGNATURE_RSASSA_PSS_SHA384_MGF1,
        SignatureConstants.ALGO_ID_SIGNATURE_RSASSA_PSS_SHA512_MGF1));

    config.setSignatureReferenceDigestMethods(Arrays.asList(
        SignatureConstants.ALGO_ID_DIGEST_SHA256,
        SignatureConstants.ALGO_ID_DIGEST_SHA384,
        SignatureConstants.ALGO_ID_DIGEST_SHA512));

    return config;
  }

  /**
   * Creates a signature validation configuration for eIDAS according to section 3.3 of "eIDAS - Cryptographic
   * requirements for the Interoperability Framework".
   */
  @Override
  protected SignatureValidationConfiguration createDefaultSignatureValidationConfiguration() {

    final BasicSignatureValidationConfiguration config =
        DefaultSecurityConfigurationBootstrap.buildDefaultSignatureValidationConfiguration();

    // Whitelist has precedence over blacklist, so we simply add the algorithms listed in
    // "eIDAS - Cryptographic requirements for the Interoperability Framework".
    //
    config.setIncludeExcludePrecedence(Precedence.INCLUDE);
    config.setIncludedAlgorithms(Arrays.asList(
        // Digests
        SignatureConstants.ALGO_ID_DIGEST_SHA256,
        SignatureConstants.ALGO_ID_DIGEST_SHA384,
        SignatureConstants.ALGO_ID_DIGEST_SHA512,

        // Signature algorithms (EC-DSA and RSA-PSS)
        SignatureConstants.ALGO_ID_SIGNATURE_ECDSA_SHA256,
        SignatureConstants.ALGO_ID_SIGNATURE_ECDSA_SHA384,
        SignatureConstants.ALGO_ID_SIGNATURE_ECDSA_SHA512,

        SignatureConstants.ALGO_ID_SIGNATURE_RSASSA_PSS_SHA256_MGF1,
        SignatureConstants.ALGO_ID_SIGNATURE_RSASSA_PSS_SHA384_MGF1,
        SignatureConstants.ALGO_ID_SIGNATURE_RSASSA_PSS_SHA512_MGF1));

    return config;
  }

}