io.vertx.core.net.PemTrustOptions.java Source code

Introduction

Here is the source code for io.vertx.core.net.PemTrustOptions.java

Source

/*
 * Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.net;

import io.vertx.codegen.annotations.DataObject;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.impl.Arguments;
import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;

import java.util.ArrayList;
import java.util.Base64;
import java.util.List;
import java.util.Objects;

/**
 * Certificate Authority options configuring certificates based on
 * <i>Privacy-enhanced Electronic Email</i> (PEM) files. The options is configured with a list of
 * validating certificates.
 * <p>
 * Validating certificates must contain X.509 certificates wrapped in a PEM block:<p>
 *
 * <pre>
 * -----BEGIN CERTIFICATE-----
 * MIIDezCCAmOgAwIBAgIEVmLkwTANBgkqhkiG9w0BAQsFADBuMRAwDgYDVQQGEwdV
 * ...
 * z5+DuODBJUQst141Jmgq8bS543IU/5apcKQeGNxEyQ==
 * -----END CERTIFICATE-----
 * </pre>
 *
 * The certificates can either be loaded by Vert.x from the filesystem:
 * <p>
 * <pre>
 * HttpServerOptions options = new HttpServerOptions();
 * options.setPemTrustOptions(new PemTrustOptions().addCertPath("/cert.pem"));
 * </pre>
 *
 * Or directly provided as a buffer:
 * <p>
 *
 * <pre>
 * Buffer cert = vertx.fileSystem().readFileSync("/cert.pem");
 * HttpServerOptions options = new HttpServerOptions();
 * options.setPemTrustOptions(new PemTrustOptions().addCertValue(cert));
 * </pre>
 *
 * @author <a href="mailto:julien@julienviet.com">Julien Viet</a>
 * @author <a href="http://tfox.org">Tim Fox</a>
 */
@DataObject(generateConverter = true, publicConverter = false)
public class PemTrustOptions implements TrustOptions, Cloneable {

    private ArrayList<String> certPaths;
    private ArrayList<Buffer> certValues;

    /**
     * Default constructor
     */
    public PemTrustOptions() {
        super();
        this.certPaths = new ArrayList<>();
        this.certValues = new ArrayList<>();
    }

    /**
     * Copy constructor
     *
     * @param other  the options to copy
     */
    public PemTrustOptions(PemTrustOptions other) {
        super();
        this.certPaths = new ArrayList<>(other.getCertPaths());
        this.certValues = new ArrayList<>(other.getCertValues());
    }

    /**
     * Create options from JSON
     *
     * @param json  the JSON
     */
    public PemTrustOptions(JsonObject json) {
        this();
        PemTrustOptionsConverter.fromJson(json, this);
    }

    /**
     * Convert to JSON
     *
     * @return the JSON
     */
    public JsonObject toJson() {
        JsonObject json = new JsonObject();
        PemTrustOptionsConverter.toJson(this, json);
        return json;
    }

    /**
     * @return  the certificate paths used to locate certificates
     */
    public List<String> getCertPaths() {
        return certPaths;
    }

    /**
     * Add a certificate path
     *
     * @param certPath  the path to add
     * @return a reference to this, so the API can be used fluently
     * @throws NullPointerException
     */
    public PemTrustOptions addCertPath(String certPath) throws NullPointerException {
        Objects.requireNonNull(certPath, "No null certificate accepted");
        Arguments.require(!certPath.isEmpty(), "No empty certificate path accepted");
        certPaths.add(certPath);
        return this;
    }

    /**
     *
     * @return the certificate values
     */
    public List<Buffer> getCertValues() {
        return certValues;
    }

    /**
     * Add a certificate value
     *
     * @param certValue  the value to add
     * @return a reference to this, so the API can be used fluently
     * @throws NullPointerException
     */
    public PemTrustOptions addCertValue(Buffer certValue) throws NullPointerException {
        Objects.requireNonNull(certValue, "No null certificate accepted");
        certValues.add(certValue);
        return this;
    }

    @Override
    public PemTrustOptions copy() {
        return new PemTrustOptions(this);
    }

}