com.bettercloud.vault.api.mounts.Mounts Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vault-java-driver Show documentation
Zero-dependency Java client for HashiCorp's Vault
The newest version!
package com.bettercloud.vault.api.mounts;

import com.bettercloud.vault.VaultConfig;
import com.bettercloud.vault.VaultException;
import com.bettercloud.vault.response.MountResponse;
import com.bettercloud.vault.rest.Rest;
import com.bettercloud.vault.rest.RestResponse;
import java.nio.charset.StandardCharsets;

/**
 * The implementing class for operations on Vault's /v1/sys/mounts/* REST endpoints.
 *
 * This class is not intended to be constructed directly.  Rather, it is meant to used by way of Vault
 * in a DSL-style builder pattern.  See the Javadoc comments of each public method for usage examples.
 */
public class Mounts {
    private final VaultConfig config;

    public Mounts(final VaultConfig config) {
        this.config = config;
    }

    /**
     * Operation to list all the mounted secrets engines.  Relies on an authentication token being present in
     * the VaultConfig instance.
     *
     * The list of mount points information will be populated in the mounts field of the MountResponse
     * return value in the Map<String, Mount> format.  Example usage:
     *
     * 
     * {@code
     * final VaultConfig config = new VaultConfig.address(...).token(...).build();
     * final Vault vault = new Vault(config);
     *
     * final MountResponse response = vault.mounts().list();
     * final Map mounts = response.getMounts();
     * }
     * 
     *
     * @return A container for the information returned by Vault
     *
     * @throws VaultException If any error occurs or unexpected response is received from Vault
     */
    public MountResponse list() throws VaultException {
        int retryCount = 0;

        while (true) {
            try {
                final RestResponse restResponse = new Rest()//NOPMD
                        .url(String.format("%s/v1/sys/mounts", config.getAddress()))
                        .header("X-Vault-Token", config.getToken())
                        .connectTimeoutSeconds(config.getOpenTimeout())
                        .readTimeoutSeconds(config.getReadTimeout())
                        .sslVerification(config.getSslConfig().isVerify())
                        .sslContext(config.getSslConfig().getSslContext())
                        .get();

                // Validate restResponse
                if (restResponse.getStatus() != 200) {
                    String body = restResponse.getBody() != null ? new String(restResponse.getBody()) : "(no body)";
                    throw new VaultException("Vault responded with HTTP status code: " + restResponse.getStatus() + " " + body, restResponse.getStatus());
                }

                return new MountResponse(restResponse, retryCount, true);
            } catch (Exception e) {
                // If there are retries to perform, then pause for the configured interval and then execute the loop again...
                if (retryCount < config.getMaxRetries()) {
                    retryCount++;
                    try {
                        final int retryIntervalMilliseconds = config.getRetryIntervalMilliseconds();
                        Thread.sleep(retryIntervalMilliseconds);
                    } catch (InterruptedException e1) {
                        e1.printStackTrace();
                    }
                } else if (e instanceof VaultException) {
                    // ... otherwise, give up
                    throw (VaultException)e;
                } else {
                    throw new VaultException(e);
                }
            }
        }
    }

    /**
     * Operation to enable secrets engine at given path.  Relies on an authentication token being present in
     * the VaultConfig instance.
     *
     * This method accepts a MountConfig parameter,   containing optional settings for the mount
     * creation operation. Example usage:
     *
     * A successful operation will return a 204 HTTP status.  A VaultException will be thrown if
     * mount point already exists, or if any other problem occurs.  Example usage:
     *
     * 
     * {@code
     * final VaultConfig config = new VaultConfig.address(...).token(...).build();
     * final Vault vault = new Vault(config);
     *
     * final MountPayload payload = new MountPayload()
     *                                       .defaultLeaseTtl(TimeToLive.of(86400, TimeUnit.SECONDS))
     *                                       .maxLeaseTtl(TimeToLive.of(86400, TimeUnit.SECONDS))
     *                                       .description("description for pki engine");
     *
     * final MountResponse response = vault.mounts().enable("pki/mount/point/path", MountType.PKI, payload);
     *
     * assertEquals(204, response.getRestResponse().getStatus();
     * }
     * 
     *
     * @param path The path to enable secret engine on.
     * @param type The type of secret engine to enable.
     * @param payload The MountPayload instance to use to create secret engine.
     *
     * @return A container for the information returned by Vault
     *
     * @throws VaultException If any error occurs or unexpected response is received from Vault
     */
    public MountResponse enable(final String path, final MountType type, final MountPayload payload) throws VaultException {
        int retryCount = 0;

        while (true) {
            try {
                if (type == null) {
                    throw new VaultException("Mount type is missing");
                }

                if (payload == null) {
                    throw new VaultException("MountPayload is missing");
                }

                final String requestJson = payload.toEnableJson(type).toString();

                final RestResponse restResponse = new Rest()//NOPMD
                        .url(String.format("%s/v1/sys/mounts/%s", config.getAddress(), path))
                        .header("X-Vault-Token", config.getToken())
                        .body(requestJson.getBytes(StandardCharsets.UTF_8))
                        .connectTimeoutSeconds(config.getOpenTimeout())
                        .readTimeoutSeconds(config.getReadTimeout())
                        .sslVerification(config.getSslConfig().isVerify())
                        .sslContext(config.getSslConfig().getSslContext())
                        .post();

                // Validate restResponse
                if (restResponse.getStatus() != 204) {
                    String body = restResponse.getBody() != null ? new String(restResponse.getBody()) : "(no body)";
                    throw new VaultException("Vault responded with HTTP status code: " + restResponse.getStatus() + " " + body, restResponse.getStatus());
                }

                return new MountResponse(restResponse, retryCount, false);
            } catch (Exception e) {
                // If there are retries to perform, then pause for the configured interval and then execute the loop again...
                if (retryCount < config.getMaxRetries()) {
                    retryCount++;

                    try {
                        final int retryIntervalMilliseconds = config.getRetryIntervalMilliseconds();
                        Thread.sleep(retryIntervalMilliseconds);
                    } catch (InterruptedException e1) {
                        e1.printStackTrace();
                    }
                } else if (e instanceof VaultException) {
                    // ... otherwise, give up.
                    throw (VaultException)e;
                } else {
                    throw new VaultException(e);
                }
            }
        }
    }

    /**
     * Operation to disable secrets engine mount point of given path.  Relies on an authentication token being
     * present in the VaultConfig instance.
     *
     * A successful operation will return a 204 HTTP status.  A VaultException will be thrown if
     * the mount point not exist, or if any other problem occurs.  Example usage:
     *
     * 
     * {@code
     * final VaultConfig config = new VaultConfig.address(...).token(...).build();
     * final Vault vault = new Vault(config);
     *
     * final MountResponse response = vault.mounts().disable("pki/mount/point/path");
     *
     * assertEquals(204, response.getRestResponse().getStatus();
     * }
     * 
     *
     * @param path The path to disable secret engine on.
     *
     * @return A container for the information returned by Vault
     *
     * @throws VaultException If any error occurs or unexpected response is received from Vault
     */
    public MountResponse disable(final String path) throws VaultException {
        int retryCount = 0;

        while (true) {
            try {
                final RestResponse restResponse = new Rest()//NOPMD
                        .url(String.format("%s/v1/sys/mounts/%s", config.getAddress(), path))
                        .header("X-Vault-Token", config.getToken())
                        .connectTimeoutSeconds(config.getOpenTimeout())
                        .readTimeoutSeconds(config.getReadTimeout())
                        .sslVerification(config.getSslConfig().isVerify())
                        .sslContext(config.getSslConfig().getSslContext())
                        .delete();

                // Validate restResponse
                if (restResponse.getStatus() != 204) {
                    String body = restResponse.getBody() != null ? new String(restResponse.getBody()) : "(no body)";
                    throw new VaultException("Vault responded with HTTP status code: " + restResponse.getStatus() + " " + body, restResponse.getStatus());
                }

                return new MountResponse(restResponse, retryCount, false);
            } catch (Exception e) {
                // If there are retries to perform, then pause for the configured interval and then execute the loop again...
                if (retryCount < config.getMaxRetries()) {
                    retryCount++;

                    try {
                        final int retryIntervalMilliseconds = config.getRetryIntervalMilliseconds();
                        Thread.sleep(retryIntervalMilliseconds);
                    } catch (InterruptedException e1) {
                        e1.printStackTrace();
                    }
                } else if (e instanceof VaultException) {
                    // ... otherwise, give up.
                    throw (VaultException)e;
                } else {
                    throw new VaultException(e);
                }
            }
        }
    }

    /**
     * Operation to read secrets engine mount point's configuration of given path.  Relies on an authentication
     * token being present in the VaultConfig instance.
     *
     * The mount point information will be populated in the mount field of the MountResponse
     * return value.  Example usage:
     *
     * 
     * {@code
     * final VaultConfig config = new VaultConfig.address(...).token(...).build();
     * final Vault vault = new Vault(config);
     *
     * final MountResponse response = vault.mounts().read("pki/mount/point/path");
     * final Mount mount = response.getMount();
     * final MountConfig mountConfig = mount.getConfig();
     * }
     * 
     *
     * @param path The path to read secret engine's configuration from.
     *
     * @return A container for the information returned by Vault
     *
     * @throws VaultException If any error occurs or unexpected response is received from Vault
     */
    public MountResponse read(final String path) throws VaultException {
        int retryCount = 0;

        while (true) {
            try {
                final RestResponse restResponse = new Rest()//NOPMD
                        .url(String.format("%s/v1/sys/mounts/%s/tune", config.getAddress(), path))
                        .header("X-Vault-Token", config.getToken())
                        .connectTimeoutSeconds(config.getOpenTimeout())
                        .readTimeoutSeconds(config.getReadTimeout())
                        .sslVerification(config.getSslConfig().isVerify())
                        .sslContext(config.getSslConfig().getSslContext())
                        .get();

                // Validate restResponse
                if (restResponse.getStatus() != 200 && restResponse.getStatus() != 404) {
                    String body = restResponse.getBody() != null ? new String(restResponse.getBody()) : "(no body)";
                    throw new VaultException("Vault responded with HTTP status code: " + restResponse.getStatus() + " " + body, restResponse.getStatus());
                }

                return new MountResponse(restResponse, retryCount, false);
            } catch (Exception e) {
                // If there are retries to perform, then pause for the configured interval and then execute the loop again...
                if (retryCount < config.getMaxRetries()) {
                    retryCount++;

                    try {
                        final int retryIntervalMilliseconds = config.getRetryIntervalMilliseconds();
                        Thread.sleep(retryIntervalMilliseconds);
                    } catch (InterruptedException e1) {
                        e1.printStackTrace();
                    }
                } else if (e instanceof VaultException) {
                    // ... otherwise, give up.
                    throw (VaultException)e;
                } else {
                    throw new VaultException(e);
                }
            }
        }
    }

    /**
     * Operation to tune secrets engine mount point's configuration of given path.  Relies on an authentication
     * token being present in the VaultConfig instance.
     *
     * This the method accepts a MountConfig parameter, containing optional settings for the  mount
     * tune operation.  Example usage:
     *
     * A successful operation will return a 204 HTTP status.  A VaultException will be thrown if
     * the mount point not exist, or if any other problem occurs.  Example usage:
     *
     * 
     * {@code
     * final VaultConfig config = new VaultConfig.address(...).token(...).build();
     * final Vault vault = new Vault(config);
     *
     * final MountPayload payload = new MountPayload()
     *                                   .defaultLeaseTtl(TimeToLive.of(12, TimeUnit.HOURS))
     *                                   .maxLeaseTtl(TimeToLive.of(12, TimeUnit.HOURS))
     *                                   .description("description of pki");
     *
     * final MountResponse response = vault.mounts().tune("pki/mount/point/path", configs);
     *
     * assertEquals(204, response.getRestResponse().getStatus();
     * }
     * 
     *
     * @param path The path to tune secret engine's configuration on.
     * @param payload The MountPayload instance to use to tune secret engine.
     *
     * @return A container for the information returned by Vault
     *
     * @throws VaultException If any error occurs or unexpected response is received from Vault
     */
    public MountResponse tune(final String path, final MountPayload payload) throws VaultException {
        int retryCount = 0;

        while (true) {
            try {
                if (payload == null) {
                    throw new VaultException("MountPayload is missing");
                }

                final String requestJson = payload.toTuneJson().toString();

                final RestResponse restResponse = new Rest()//NOPMD
                        .url(String.format("%s/v1/sys/mounts/%s/tune", config.getAddress(), path))
                        .header("X-Vault-Token", config.getToken())
                        .body(requestJson.getBytes(StandardCharsets.UTF_8))
                        .connectTimeoutSeconds(config.getOpenTimeout())
                        .readTimeoutSeconds(config.getReadTimeout())
                        .sslVerification(config.getSslConfig().isVerify())
                        .sslContext(config.getSslConfig().getSslContext())
                        .post();

                // Validate restResponse
                if (restResponse.getStatus() != 204) {
                    String body = restResponse.getBody() != null ? new String(restResponse.getBody()) : "(no body)";
                    throw new VaultException("Vault responded with HTTP status code: " + restResponse.getStatus() + " " + body, restResponse.getStatus());
                }

                return new MountResponse(restResponse, retryCount, false);
            } catch (Exception e) {
                // If there are retries to perform, then pause for the configured interval and then execute the loop again...
                if (retryCount < config.getMaxRetries()) {
                    retryCount++;

                    try {
                        final int retryIntervalMilliseconds = config.getRetryIntervalMilliseconds();
                        Thread.sleep(retryIntervalMilliseconds);
                    } catch (InterruptedException e1) {
                        e1.printStackTrace();
                    }
                } else if (e instanceof VaultException) {
                    // ... otherwise, give up.
                    throw (VaultException)e;
                } else {
                    throw new VaultException(e);
                }
            }
        }
    }
}