src.main.java.com.github.toolarium.security.certificate.ICertificateConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of toolarium-security Show documentation

Defines the security library to cover common patterns.

There is a newer version: 1.1.3

/*
 * ICertificateConverter.java
 *
 * Copyright by toolarium, all rights reserved.
 */
package com.github.toolarium.security.certificate;

import java.io.File;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.security.cert.Certificate;
import java.security.cert.CertificateEncodingException;
import java.security.cert.X509Certificate;


/**
 * Defines the certificate converter interface.
 *  
 * @author patrick
 */
public interface ICertificateConverter {
    
    /**
     * Reads a PKCS#7 (with base64 encoded) X509 certificates from a file, which are each bounded at the beginning by
     * -----BEGIN CERTIFICATE-----, and bounded at the end by -----END CERTIFICATE-----.
     *
     * @param file the file to read
     * @return the read certificates
     * @throws GeneralSecurityException in case of error
     * @throws IOException in case of error
     */
    X509Certificate[] getX509Certificates(File file) throws GeneralSecurityException, IOException;

    
    /**
     * Read a PKCS#7 (with base64 encoded) X509 certificates from the given buffer, which are each bounded at the beginning by
     * -----BEGIN CERTIFICATE-----, and bounded at the end by -----END CERTIFICATE-----.
     *
     * @param content the content
     * @return the read certificates
     * @throws GeneralSecurityException in case of error
     */
    X509Certificate[] getX509Certificates(String content) throws GeneralSecurityException;
    
    
    /**
     * Combine two certificate arrays
     *
     * @param certs the certificate
     * @param caCerts the ca certificate(s)
     * @return the combined certificates
     */
    X509Certificate[] combineCertificates(X509Certificate[] certs, X509Certificate[] caCerts);
    
    
    /**
     * Formats a raw base64 encoded X509 certificates to a well formated X509 certificate (PEM format), which are each bounded at the beginning by
     * -----BEGIN CERTIFICATE-----, and bounded at the end by -----END CERTIFICATE-----.
     *
     * @param content the raw certificate to format
     * @return the well formed certificate
     */
    String formatPKCS7(String content);
    
    
    /**
     * Create certificate chain into a well formed string representation
     *
     * @param certificateChain the certificate chain
     * @return the string representation
     * @throws CertificateEncodingException In case of a certificate error
     */
    String formatPKCS7(X509Certificate[] certificateChain) throws CertificateEncodingException;

    
    /**
     * Formats a certificate to a well formated X509 certificate (PEM format), which are each bounded at the beginning by
     * -----BEGIN CERTIFICATE-----, and bounded at the end by -----END CERTIFICATE-----.
     *
     * @param certificate the certificate to format in PEM format
     * @return the well formed certificate
     * @throws CertificateEncodingException In case of a certificate error
     */
    String formatPKCS7(Certificate certificate) throws CertificateEncodingException;
}