com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONClientCertificateAccessLogMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation

The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use Java API for communicating with LDAP directory servers and performing related tasks like reading and writing LDIF, encoding and decoding data using base64 and ASN.1 BER, and performing secure communication. This package contains the Standard Edition of the LDAP SDK, which is a complete, general-purpose library for communicating with LDAPv3 directory servers.

The newest version!

/*
 * Copyright 2022-2024 Ping Identity Corporation
 * All Rights Reserved.
 */
/*
 * Copyright 2022-2024 Ping Identity Corporation
 *
 * 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.
 */
/*
 * Copyright (C) 2022-2024 Ping Identity Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License (GPLv2 only)
 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
 * as published by the Free Software Foundation.
 *
 * 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 .
 */
package com.unboundid.ldap.sdk.unboundidds.logs.v2.json;



import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType;
import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
import com.unboundid.ldap.sdk.unboundidds.logs.v2.
            ClientCertificateAccessLogMessage;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.json.JSONObject;
import com.unboundid.util.json.JSONValue;



/**
 * This class provides a data structure that holds information about a
 * JSON-formatted client certificate access log message.
 * 

 * 
 *   NOTE:  This class, and other classes within the
 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
 *   supported for use against Ping Identity, UnboundID, and
 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
 *   for proprietary functionality or for external specifications that are not
 *   considered stable or mature enough to be guaranteed to work in an
 *   interoperable way with other types of LDAP servers.
 * 
 */
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class JSONClientCertificateAccessLogMessage
       extends JSONAccessLogMessage
       implements ClientCertificateAccessLogMessage
{
  /**
   * The serial version UID for this serializable class.
   */
  private static final long serialVersionUID = -7815846275883142789L;



  // The peer certificate chain for this log message.
  @NotNull private final List peerCertificateChain;

  // The auto-authenticated as DN for this log message.
  @Nullable private final String autoAuthenticatedAsDN;



  /**
   * Creates a new JSON client certificate access log message from the provided
   * JSON object.
   *
   * @param  jsonObject  The JSON object that contains an encoded representation
   *                     of this log message.  It must not be {@code null}.
   *
   * @throws  LogException  If the provided JSON object cannot be parsed as a
   *                        valid log message.
   */
  public JSONClientCertificateAccessLogMessage(
              @NotNull final JSONObject jsonObject)
         throws LogException
  {
    super(jsonObject);

    autoAuthenticatedAsDN =
         getString(JSONFormattedAccessLogFields.AUTO_AUTHENTICATED_AS);

    final List certValues = jsonObject.getFieldAsArray(
         JSONFormattedAccessLogFields.PEER_CERTIFICATE_CHAIN.getFieldName());
    if (certValues == null)
    {
      peerCertificateChain = Collections.emptyList();
    }
    else
    {
      final List certList = new ArrayList<>(certValues.size());
      for (final JSONValue v : certValues)
      {
        if (v instanceof JSONObject)
        {
          certList.add(new JSONCertificate((JSONObject) v));
        }
        else
        {
          certList.clear();
          break;
        }
      }

      peerCertificateChain = Collections.unmodifiableList(certList);
    }
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @NotNull()
  public AccessLogMessageType getMessageType()
  {
    return AccessLogMessageType.CLIENT_CERTIFICATE;
  }



  /**
   * Retrieves the peer certificate chain for this log message.
   *
   * @return  The peer certificate chain for this log message, or {@code null}
   *          if it is not included in the log message.
   */
  @NotNull()
  public List getPeerCertificateChain()
  {
    return peerCertificateChain;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getPeerSubjectDN()
  {
    if (peerCertificateChain.isEmpty())
    {
      return null;
    }
    else
    {
      return peerCertificateChain.get(0).getSubjectDN();
    }
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @NotNull()
  public List getIssuerSubjectDNs()
  {
    final List issuerSubjectDNs = new ArrayList<>();
    for (final JSONCertificate c : peerCertificateChain)
    {
      final String issuerSubjectDN = c.getIssuerSubjectDN();
      if (issuerSubjectDN == null)
      {
        issuerSubjectDNs.clear();
        break;
      }

      if (! issuerSubjectDNs.contains(issuerSubjectDN))
      {
        issuerSubjectDNs.add(issuerSubjectDN);
      }
    }

    return Collections.unmodifiableList(issuerSubjectDNs);
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  @Nullable()
  public String getAutoAuthenticatedAsDN()
  {
    return autoAuthenticatedAsDN;
  }
}