Class Pki

java.lang.Object
codes.grow.packages.vault.Pki

public final class Pki extends Object
PKI engine on one mount: client.pki() (mount pki).

 IssuedCertificate cert = client.pki().issueCertificate("web", "app.example.test");
 
  • Method Details

    • mount

      public String mount()
      Returns the mount.
      Returns:
      the mount path
    • issueCertificate

      public IssuedCertificate issueCertificate(String role, String commonName)
      Issues a certificate and private key for a role.
      Parameters:
      role - role name
      commonName - common name
      Returns:
      the certificate and key
    • issueCertificate

      public IssuedCertificate issueCertificate(String role, String commonName, IssueOptions options)
      Issues a certificate and private key: POST <mount>/issue/<role>. A name the role does not allow raises ValidationException.
      Parameters:
      role - role name
      commonName - common name
      options - SANs, TTL, format
      Returns:
      the certificate and key
    • issueCertificateAsync

      public CompletableFuture<IssuedCertificate> issueCertificateAsync(String role, String commonName, IssueOptions o)
      Parameters:
      role - role name
      commonName - common name
      o - options
      Returns:
      a future with the certificate and key
    • signCsr

      public SignedCertificate signCsr(String role, String csr)
      Signs a PEM CSR for a role.
      Parameters:
      role - role name
      csr - PEM certificate signing request
      Returns:
      the certificate
    • signCsr

      public SignedCertificate signCsr(String role, String csr, IssueOptions options)
      Signs a PEM CSR: POST <mount>/sign/<role>. Invalid CSRs raise ValidationException.
      Parameters:
      role - role name
      csr - PEM CSR
      options - common name, SANs, TTL, format
      Returns:
      the certificate
    • signCsrAsync

      public CompletableFuture<SignedCertificate> signCsrAsync(String role, String csr, IssueOptions o)
      Parameters:
      role - role name
      csr - PEM CSR
      o - options
      Returns:
      a future with the certificate
    • revokeCertificate

      public RevocationInfo revokeCertificate(String serial)
      Revokes a certificate by serial (aa:bb:...); unknown serials raise ValidationException.
      Parameters:
      serial - serial number
      Returns:
      the revocation info
    • revokeCertificateAsync

      public CompletableFuture<RevocationInfo> revokeCertificateAsync(String serial)
      Parameters:
      serial - serial number
      Returns:
      a future with the revocation info
    • readCaChain

      public String readCaChain()
      The CA chain as PEM text (GET <mount>/ca_chain, raw PEM).
      Returns:
      PEM text
    • readCaChainAsync

      public CompletableFuture<String> readCaChainAsync()
      Asynchronous readCaChain().
      Returns:
      a future with the PEM text
    • readCertificate

      public CertificateInfo readCertificate(String serial)
      A certificate by serial; NotFoundException when unknown.
      Parameters:
      serial - serial number
      Returns:
      the certificate
    • readCertificateAsync

      public CompletableFuture<CertificateInfo> readCertificateAsync(String serial)
      Parameters:
      serial - serial number
      Returns:
      a future with the certificate
    • listCertificates

      public List<String> listCertificates()
      Serials of all stored certificates; empty when there is none.
      Returns:
      the serials
    • listCertificatesAsync

      public CompletableFuture<List<String>> listCertificatesAsync()
      Asynchronous listCertificates().
      Returns:
      a future with the serials
    • tidyStatus

      public TidyStatus tidyStatus()
      Current tidy progress: GET <mount>/tidy-status.
      Returns:
      the status
    • tidyStatusAsync

      public CompletableFuture<TidyStatus> tidyStatusAsync()
      Asynchronous tidyStatus().
      Returns:
      a future with the status
    • tidy

      public TidyStatus tidy()
      Starts a tidy run and waits until it is done (defaults).
      Returns:
      the last status
    • tidy

      public TidyStatus tidy(TidyOptions options)
      Starts a tidy run (POST <mount>/tidy, 202) and, unless await(false), polls tidy-status until it is Finished, Error or Cancelled.
      Parameters:
      options - options
      Returns:
      the last status
    • tidyAsync

      public CompletableFuture<TidyStatus> tidyAsync(TidyOptions o)
      Asynchronous tidy(TidyOptions).
      Parameters:
      o - options
      Returns:
      a future with the last status
    • toString

      public String toString()
      Overrides:
      toString in class Object