se.swedenconnect.cert.extensions.BiometricInfo 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) 2020. 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;

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

import org.bouncycastle.asn1.ASN1EncodableVector;
import org.bouncycastle.asn1.ASN1Object;
import org.bouncycastle.asn1.ASN1ObjectIdentifier;
import org.bouncycastle.asn1.ASN1Primitive;
import org.bouncycastle.asn1.ASN1Sequence;
import org.bouncycastle.asn1.DERSequence;
import org.bouncycastle.asn1.x509.Extensions;
import org.bouncycastle.asn1.x509.qualified.BiometricData;
import org.bouncycastle.asn1.x509.qualified.TypeOfBiometricData;
import org.bouncycastle.util.encoders.Hex;

import lombok.Getter;

/**
 * BiometricInfo X.509 extension implementation for extending Bouncycastle.
 *
 * @author Martin Lindström ([email protected])
 * @author Stefan Santesson ([email protected])
 */
public class BiometricInfo extends ASN1Object {

  public static final ASN1ObjectIdentifier OID = new ASN1ObjectIdentifier("1.3.6.1.5.5.7.1.2");

  @Getter
  private List biometricDataList = new ArrayList<>();

  /**
   * Creates BiometricInfo extension object
   *
   * @param obj
   *          object holding extension data
   * @return BiometricInfo extension
   */
  public static BiometricInfo getInstance(final Object obj) {
    if (obj instanceof BiometricInfo) {
      return (BiometricInfo) obj;
    }
    if (obj != null) {
      return new BiometricInfo(ASN1Sequence.getInstance(obj));
    }
    return null;
  }

  /**
   * Creates BiometricInfo extension object
   *
   * @param extensions
   *          BiometricInfo extension
   * @return BiometricInfo extension
   */
  public static BiometricInfo fromExtensions(final Extensions extensions) {
    return BiometricInfo.getInstance(extensions.getExtensionParsedValue(OID));
  }

  /**
   * Internal Constructor
   *
   * Parse the content of ASN1 sequence to populate set values
   *
   * @param seq
   */
  private BiometricInfo(final ASN1Sequence seq) {
    this.biometricDataList = new ArrayList<>();
    try {
      for (int i = 0; i < seq.size(); i++) {
        final BiometricData biometricData = BiometricData.getInstance(seq.getObjectAt(i));
        this.biometricDataList.add(biometricData);
      }
    }
    catch (final Exception e) {
      throw new IllegalArgumentException("Bad extension content");
    }
  }

  /**
   * Constructor
   *
   * @param biometricDataList
   *          List of biometric data
   */
  public BiometricInfo(final List biometricDataList) {
    this.biometricDataList = biometricDataList;
  }

  /**
   * Produce an object suitable for an ASN1OutputStream.
   *
   *    * AuthenticationContexts ::= SEQUENCE SIZE (1..MAX) OF
   *                            AuthenticationContext
   *
   * AuthenticationContext ::= SEQUENCE {
   *     contextType     UTF8String,
   *     contextInfo     UTF8String OPTIONAL
   * }
   * 
   *
   * @return ASN.1 object of the extension
   */
  @Override
  public ASN1Primitive toASN1Primitive() {
    final ASN1EncodableVector biometricInfo = new ASN1EncodableVector();
    for (final BiometricData bd : this.biometricDataList) {
      biometricInfo.add(bd.toASN1Primitive());
    }
    return new DERSequence(biometricInfo);
  }

  /** {@inheritDoc} */
  @Override
  public String toString() {
    final StringBuilder b = new StringBuilder();
    b.append("Biometric Data:").append(System.lineSeparator());
    for (final BiometricData biometricData : this.biometricDataList) {
      b.append("    Data Type: ")
        .append(getTypeString(biometricData.getTypeOfBiometricData())).append(System.lineSeparator());
      b.append("    Hash algorithm: ")
        .append(biometricData.getHashAlgorithm().getAlgorithm().getId()).append(System.lineSeparator());
      b.append("    Biometric hash: ")
        .append(Hex.toHexString(biometricData.getBiometricDataHash().getOctets())).append(System.lineSeparator());
      if (biometricData.getSourceDataUriIA5() != null) {
        b.append("    Source URI: ")
          .append(biometricData.getSourceDataUriIA5().getString()).append(System.lineSeparator());
      }
    }
    return b.toString();
  }

  /**
   * Get a string representing the type of biometric data
   *
   * @param typeOfBiometricData
   *          type of biomentric data
   * @return presentation string representing type
   */
  public static String getTypeString(final TypeOfBiometricData typeOfBiometricData) {
    if (typeOfBiometricData.isPredefined()) {
      switch (typeOfBiometricData.getPredefinedBiometricType()) {
      case 0:
        return "Picture";
      case 1:
        return "Handwritten signature";
      default:
        return String.valueOf(typeOfBiometricData.getPredefinedBiometricType());
      }
    }
    return typeOfBiometricData.getBiometricDataOid().getId();
  }
}