Record Class KeygenPolicy

java.lang.Object
java.lang.Record
zeroecho.pki.server.est.KeygenPolicy
Record Components:
enabled - true iff POST /serverkeygen is allowed on this endpoint
permittedAlgorithms - JCA key algorithm names permitted for generation (e.g. "RSA", "EC")
maximumKeySizeBits - upper bound on key size in bits; protects against memory exhaustion during generation
storeGeneratedKeys - if true, the generated private key is written to the CA's keyring (escrow)
public record KeygenPolicy(boolean enabled, List<String> permittedAlgorithms, int maximumKeySizeBits, boolean storeGeneratedKeys) extends Record
Controls server-keygen eligibility for an EST endpoint.

Server-generated key pairs are ephemeral by default (storeGeneratedKeys = false): the server never retains a copy after the response is delivered. The operation requires explicit enablement per label because it exposes private key material on the wire.

Since:
1.0

  • Field Details

    • DISABLED

      public static final KeygenPolicy DISABLED
      Sentinel policy for endpoints where server-side key generation is disabled.

  • Constructor Details

    • KeygenPolicy

      public KeygenPolicy(boolean enabled, List<String> permittedAlgorithms, int maximumKeySizeBits, boolean storeGeneratedKeys)
      Validates and defensively copies all mutable fields.

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • enabled

      public boolean enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component

    • permittedAlgorithms

      public List<String> permittedAlgorithms()
      Returns the value of the permittedAlgorithms record component.
      Returns:
      the value of the permittedAlgorithms record component

    • maximumKeySizeBits

      public int maximumKeySizeBits()
      Returns the value of the maximumKeySizeBits record component.
      Returns:
      the value of the maximumKeySizeBits record component

    • storeGeneratedKeys

      public boolean storeGeneratedKeys()
      Returns the value of the storeGeneratedKeys record component.
      Returns:
      the value of the storeGeneratedKeys record component