Package org.webpki.sks

Interface SecureKeyStore

public interface SecureKeyStore
SKS (Secure Key Store) API. All calls may throw the unchecked SKSException

  • Field Details

  • Method Details

    • createProvisioningSession

      ProvisioningSession createProvisioningSession(String sessionKeyAlgorithm, boolean privacyEnabled, String serverSessionId, ECPublicKey serverEphemeralKey, String issuerUri, PublicKey keyManagementKey, int clientTime, short sessionLifeTime, short sessionKeyLimit, byte[] serverCertificate)

    • closeProvisioningSession

      byte[] closeProvisioningSession(int provisioningHandle, byte[] nonce, byte[] mac)

    • enumerateProvisioningSessions

      EnumeratedProvisioningSession enumerateProvisioningSessions(int provisioningHandle, boolean provisioningState)

    • createKeyEntry

      KeyData createKeyEntry(int provisioningHandle, String id, String keyEntryAlgorithm, byte[] serverSeed, boolean devicePinProtection, int pinPolicyHandle, byte[] pinValue, boolean enablePinCaching, byte biometricProtection, byte exportProtection, byte deleteProtection, byte appUsage, String friendlyName, String keyAlgorithm, byte[] keyParameters, String[] endorsedAlgorithms, byte[] mac)

    • getKeyHandle

      int getKeyHandle(int provisioningHandle, String id)

    • abortProvisioningSession

      void abortProvisioningSession(int provisioningHandle)

    • setCertificatePath

      void setCertificatePath(int keyHandle, X509Certificate[] certificatePath, byte[] mac)

    • addExtension

      void addExtension(int keyHandle, String type, byte subType, String qualifier, byte[] extensionData, byte[] mac)

    • importSymmetricKey

      void importSymmetricKey(int keyHandle, byte[] encryptedKey, byte[] mac)

    • importPrivateKey

      void importPrivateKey(int keyHandle, byte[] encryptedKey, byte[] mac)

    • createPinPolicy

      int createPinPolicy(int provisioningHandle, String id, int pukPolicyHandle, boolean userDefined, boolean userModifiable, byte format, short retryLimit, byte grouping, byte patternRestrictions, short minLength, short maxLength, byte inputMethod, byte[] mac)

    • createPukPolicy

      int createPukPolicy(int provisioningHandle, String id, byte[] pukValue, byte format, short retryLimit, byte[] mac)

    • updateKeyManagementKey

      void updateKeyManagementKey(int provisioningHandle, PublicKey keyManagementKey, byte[] authorization)

    • postDeleteKey

      void postDeleteKey(int provisioningHandle, int targetKeyHandle, byte[] authorization, byte[] mac)

    • postUnlockKey

      void postUnlockKey(int provisioningHandle, int targetKeyHandle, byte[] authorization, byte[] mac)

    • postUpdateKey

      void postUpdateKey(int keyHandle, int targetKeyHandle, byte[] authorization, byte[] mac)

    • postCloneKeyProtection

      void postCloneKeyProtection(int keyHandle, int targetKeyHandle, byte[] authorization, byte[] mac)

    • signData

      byte[] signData(int keyHandle, String algorithm, byte[] parameters, boolean biometricAuth, byte[] authorization, byte[] data)

    • performHmac

      byte[] performHmac(int keyHandle, String algorithm, byte[] parameters, boolean biometricAuth, byte[] authorization, byte[] data)

    • symmetricKeyEncrypt

      byte[] symmetricKeyEncrypt(int keyHandle, String algorithm, boolean mode, byte[] parameters, boolean biometricAuth, byte[] authorization, byte[] data)

    • asymmetricKeyDecrypt

      byte[] asymmetricKeyDecrypt(int keyHandle, String algorithm, byte[] parameters, boolean biometricAuth, byte[] authorization, byte[] data)

    • keyAgreement

      byte[] keyAgreement(int keyHandle, String algorithm, byte[] parameters, boolean biometricAuth, byte[] authorization, ECPublicKey publicKey)

    • getKeyAttributes

      KeyAttributes getKeyAttributes(int keyHandle)

    • enumerateKeys

      EnumeratedKey enumerateKeys(int keyHandle)

    • deleteKey

      void deleteKey(int keyHandle, byte[] authorization)

    • getDeviceInfo

      DeviceInfo getDeviceInfo()

    • getExtension

      Extension getExtension(int keyHandle, String type)

    • getKeyProtectionInfo

      KeyProtectionInfo getKeyProtectionInfo(int keyHandle)

    • setProperty

      void setProperty(int keyHandle, String type, String name, String value)

    • unlockKey

      void unlockKey(int keyHandle, byte[] authorization)

    • changePin

      void changePin(int keyHandle, byte[] authorization, byte[] newPin)

    • setPin

      void setPin(int keyHandle, byte[] authorization, byte[] newPin)

    • exportKey

      byte[] exportKey(int keyHandle, byte[] authorization)

    • updateFirmware

      String updateFirmware(byte[] chunk)