se.swedenconnect.cert.extensions.data.saci.AuthContextInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cert-extensions Show documentation
X.509 Certificate extensions library extending BouncyCastle ASN.1
The newest version!
/*
 * Copyright (c) 2023.  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.cert.extensions.data.saci;

import java.security.cert.CertificateException;
import java.time.Instant;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * AuthContextInfo element dom implementation
 */
@NoArgsConstructor
public class AuthContextInfo extends AbstractDomData {

  /** AuthContextInfo element name */
  public static final String AUTH_CONTEXT_INFO_ELEMENT = "AuthContextInfo";
  /** IdentityProvider element name */
  public static final String IDENTITY_PROVIDER = "IdentityProvider";
  /** AuthenticationInstant element name */
  public static final String AUTHENTICATION_INSTANT = "AuthenticationInstant";
  /** AuthnContextClassRef element name */
  public static final String AUTHN_CONTEXT_CLASS_REF = "AuthnContextClassRef";
  /** AssertionRef element name */
  public static final String ASSERTION_REF = "AssertionRef";
  /** ServiceID element name */
  public static final String SERVICE_ID = "ServiceID";

  /** Identity provider name */
  @Setter
  @Getter
  private String identityProvider;

  /** Authentication instant */
  @Setter
  @Getter
  private Instant authenticationInstant;

  /** Authentication LOA URI */
  @Setter
  @Getter
  private String authnContextClassRef;

  /** Assertion reference */
  @Setter
  @Getter
  private String assertionRef;

  /** Service identifier */
  @Setter
  @Getter
  private String serviceID;

  /** List of additional elements */
  @Setter
  private List anyList;

  /**
   * Constructs an AuthContextInfo object from an XML element
   *
   * @param element the input AuthContextInfo xml element
   * @param strictMode true to strictly enforce content requirement rules
   * @throws CertificateException content validation error
   */
  public AuthContextInfo(Element element, boolean strictMode) throws CertificateException {
    super(element, strictMode);
  }

  /** {@inheritDoc} */
  @Override protected void validate() throws CertificateException {
    try {
      Objects.requireNonNull(identityProvider, "IdentityProvider attribute must be present");
      Objects.requireNonNull(authenticationInstant, "AuthenticationInstant attribute must be present");
      Objects.requireNonNull(authnContextClassRef, "AuthnContextClassRef attribute must be present");
    }
    catch (Exception ex) {
      throw new CertificateException(ex);
    }
  }

  /**
   * Get the list of additional elements. If this list is absent, a new list will be created
   *
   * @return the list of additional elements
   */
  public List getAnyList() {
    if (anyList == null) {
      anyList = new ArrayList<>();
    }
    return anyList;
  }

  /** {@inheritDoc} */
  @Override public Element getElement(Document document) {
    Element authContextInfo = document.createElementNS(SACI_NS, AUTH_CONTEXT_INFO_ELEMENT);
    setAttribute(authContextInfo, IDENTITY_PROVIDER, identityProvider);
    setAttribute(authContextInfo, AUTHENTICATION_INSTANT, instantToString(authenticationInstant));
    setAttribute(authContextInfo, AUTHN_CONTEXT_CLASS_REF, authnContextClassRef);
    setAttribute(authContextInfo, ASSERTION_REF, assertionRef);
    setAttribute(authContextInfo, SERVICE_ID, serviceID);
    adoptElements(authContextInfo, document, anyList);
    return authContextInfo;
  }

  /** {@inheritDoc} */
  @Override protected void setValuesFromElement(Element element) throws CertificateException {
    this.identityProvider = getAttributeValue(element, IDENTITY_PROVIDER);
    this.authenticationInstant = parseTime(getAttributeValue(element, AUTHENTICATION_INSTANT));
    this.authnContextClassRef = getAttributeValue(element, AUTHN_CONTEXT_CLASS_REF);
    this.assertionRef = getAttributeValue(element, ASSERTION_REF);
    this.serviceID = getAttributeValue(element, SERVICE_ID);

    anyList = new ArrayList<>();
    NodeList childNodes = element.getChildNodes();
    for (int i = 0; i < childNodes.getLength(); i++) {
      Node node = childNodes.item(i);
      if (node instanceof Element) {
        anyList.add((Element) node);
      }
    }
  }

}