Package co.ankatech.ankasecure.sdk.model

Class GenerateKeySpec

Object
GenerateKeySpec
public class GenerateKeySpec extends Object

GenerateKeySpec is a streamlined model for clients to request generation of a new cryptographic key, without exposing all fields of internal classes. It supports classical, post-quantum, and symmetric algorithms, depending on the kty and alg you specify.

Clients can provide timestamps as ZonedDateTime objects (e.g., expiresAt for the hard expiration), and the SDK will handle converting them to ISO-8601 before sending to the server. This removes the burden of date/time formatting from the client application.

Example usage: 


 GenerateKeySpec spec = new GenerateKeySpec();
 spec.setKid("myNewKey");
 spec.setKty("ML-KEM");
 spec.setAlg("ML-KEM-512");

 // Set expiration in UTC
 spec.setExpiresAt(ZonedDateTime.parse("2030-06-30T23:59:59Z"));
 spec.setSoftLimitExpiration(ZonedDateTime.parse("2029-12-31T23:59:59Z"));

 // Optionally set usage limits
 spec.setMaxUsageLimit(50000);
 spec.setSoftUsageLimit(40000);

 sdk.generateKey(spec);

Example JSON (if this object were serialized directly): 


 {
   "kid": "myNewKey",
   "kty": "ML-KEM",
   "alg": "ML-KEM-512",
   "keyOps": ["encrypt","decrypt"],
   "exportable": true,
   "expiresAt": "2030-06-30T23:59:59Z",
   "softLimitExpiration": "2029-12-31T23:59:59Z",
   "maxUsageLimit": 50000,
   "softUsageLimit": 40000
 }

  • Constructor Details

    • GenerateKeySpec

      public GenerateKeySpec()
      No-args constructor.

  • Method Details

    • getKid

      public String getKid()
      Gets the key identifier (kid).
      Returns:
      kid

    • setKid

      public void setKid(String kid)
      Sets the key identifier (kid).
      Parameters:
      kid - the key identifier

    • getKty

      public String getKty()
      Gets the key type (kty).
      Returns:
      kty

    • setKty

      public void setKty(String kty)
      Sets the key type (kty).
      Parameters:
      kty - the key type (e.g. "RSA", "ML-KEM")

    • getAlg

      public String getAlg()
      Gets the algorithm name, e.g. "ML-KEM-512", "RSA-2048".
      Returns:
      alg

    • setAlg

      public void setAlg(String alg)
      Sets the algorithm name (e.g. "ML-KEM-512", "AES-256").
      Parameters:
      alg - the algorithm

    • getKeyOps

      public List<String> getKeyOps()
      Gets the permitted key operations, e.g. ["encrypt","decrypt"].
      Returns:
      a list of key operations

    • setKeyOps

      public void setKeyOps(List<String> keyOps)
      Sets the permitted key operations.
      Parameters:
      keyOps - a list of key ops

    • getExportable

      public Boolean getExportable()
      Indicates if this key is exportable from the secure store.
      Returns:
      true if exportable, false if not, or null if unspecified

    • setExportable

      public void setExportable(Boolean exportable)
      Sets whether this key is exportable.
      Parameters:
      exportable - true if exportable, false otherwise

    • getExpiresAt

      public ZonedDateTime getExpiresAt()
      Gets the absolute expiration date/time in UTC.
      Returns:
      expiresAt or null

    • setExpiresAt

      public void setExpiresAt(ZonedDateTime expiresAt)
      Sets the absolute expiration date/time in UTC.
      Parameters:
      expiresAt - a ZonedDateTime in UTC

    • getSoftLimitExpiration

      public ZonedDateTime getSoftLimitExpiration()
      Gets the soft-limit expiration date/time in UTC.
      Returns:
      softLimitExpiration or null

    • setSoftLimitExpiration

      public void setSoftLimitExpiration(ZonedDateTime softLimitExpiration)
      Sets the soft-limit expiration date/time in UTC. This can help indicate a warning threshold before the final expiration date.
      Parameters:
      softLimitExpiration - a ZonedDateTime in UTC

    • getMaxUsageLimit

      public Integer getMaxUsageLimit()
      Gets the maximum usage limit for this key (0 or null = unlimited).
      Returns:
      maxUsageLimit

    • setMaxUsageLimit

      public void setMaxUsageLimit(Integer maxUsageLimit)
      Sets the maximum usage limit for this key. 0 or null = unlimited.
      Parameters:
      maxUsageLimit - the limit

    • getSoftUsageLimit

      public Integer getSoftUsageLimit()
      Gets the soft usage limit, triggering warnings before reaching maxUsageLimit.
      Returns:
      softUsageLimit

    • setSoftUsageLimit

      public void setSoftUsageLimit(Integer softUsageLimit)
      Sets the soft usage limit for this key.
      Parameters:
      softUsageLimit - the soft limit