Package co.ankatech.ankasecure.sdk.model

Class ImportKeySpec

Object
ImportKeySpec
public class ImportKeySpec extends Object

ImportKeySpec is a streamlined model for clients to import an existing cryptographic key (public or private material, or both), without exposing the entire internal OpenAPI KeyImportRequest class. This helps maintain decoupling and a simpler public API surface.

This class includes the minimal fields required for importing a key, such as kid, kty, alg, publicKey, privateKey, keyOps, etc. Expiration fields (expiresAt and softLimitExpiration) are represented as ZonedDateTime objects, avoiding the need for manual ISO-8601 formatting. The SDK will handle serialization when calling the underlying service.

Example usage: 


 ImportKeySpec spec = new ImportKeySpec();
 spec.setKid("myImportedKey");
 spec.setKty("RSA");
 spec.setAlg("RSA-2048");
 spec.setPublicKey("BASE64-OR-PEM-PUBLIC");

 // Optionally, set privateKey if you have it
 spec.setPrivateKey("BASE64-OR-PEM-PRIVATE");

 // Timestamps as ZonedDateTime for absolute expiration
 spec.setExpiresAt(ZonedDateTime.parse("2030-06-30T23:59:59Z"));
 spec.setSoftLimitExpiration(ZonedDateTime.parse("2029-12-31T23:59:59Z"));

 // Usage limits, if needed
 spec.setMaxUsageLimit(50000);
 spec.setSoftUsageLimit(40000);

 mySdk.importKey(spec);

Example JSON (if this object were serialized directly): 


 {
   "modelVersion": "v1.0",
   "kid": "myImportedKey",
   "kty": "RSA",
   "alg": "RSA-2048",
   "publicKey": "BASE64-OR-PEM-PUBLIC",
   "privateKey": "BASE64-OR-PEM-PRIVATE",
   "keyOps": ["encrypt","decrypt","sign","verify"],
   "exportable": true,
   "expiresAt": "2030-06-30T23:59:59Z",
   "softLimitExpiration": "2029-12-31T23:59:59Z",
   "maxUsageLimit": 50000,
   "softUsageLimit": 40000
 }

  • Constructor Details

    • ImportKeySpec

      public ImportKeySpec()
      No-args constructor.

  • Method Details

    • getModelVersion

      public String getModelVersion()
      Gets the modelVersion if any was provided (e.g., "v1.0").
      Returns:
      the modelVersion string

    • setModelVersion

      public void setModelVersion(String modelVersion)
      Sets the modelVersion if provided. It's optional and unused otherwise.
      Parameters:
      modelVersion - the version string from export

    • getKid

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

    • setKid

      public void setKid(String kid)
      Sets the key identifier (kid). Must be non-null.
      Parameters:
      kid - the unique key identifier

    • getKty

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

    • setKty

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

    • getAlg

      public String getAlg()
      Gets the algorithm name.
      Returns:
      alg

    • setAlg

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

    • getPublicKey

      public String getPublicKey()
      Gets the public key content (Base64 or PEM).
      Returns:
      publicKey

    • setPublicKey

      public void setPublicKey(String publicKey)
      Sets the public key content (Base64 or PEM). For symmetric keys, this can be null.
      Parameters:
      publicKey - the public key in Base64 or PEM

    • getPrivateKey

      public String getPrivateKey()
      Gets the private key content (Base64 or PEM).
      Returns:
      privateKey

    • setPrivateKey

      public void setPrivateKey(String privateKey)
      Sets the private key (Base64 or PEM). For symmetric keys (kty=oct), this may contain the entire secret.
      Parameters:
      privateKey - the private or secret key material

    • getKeyOps

      public List<String> getKeyOps()
      Gets the permitted key operations.
      Returns:
      keyOps

    • setKeyOps

      public void setKeyOps(List<String> keyOps)
      Sets a list of permitted operations on this key, e.g. ["encrypt","decrypt"].
      Parameters:
      keyOps - a list of key operations

    • 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. If you set this, the key may become invalid after this time.
      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. Once reached, the system may issue warnings, but the key might still be usable until expiresAt.
      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, which triggers warnings before reaching maxUsageLimit.
      Returns:
      softUsageLimit

    • setSoftUsageLimit

      public void setSoftUsageLimit(Integer softUsageLimit)
      Sets the soft usage limit for this key. If null, the system may default it to maxUsageLimit.
      Parameters:
      softUsageLimit - the soft limit