Class SealdSSKSTmrPlugin

  • All Implemented Interfaces:

    
    public final class SealdSSKSTmrPlugin
    
                        

    The SealdSSKSTmrPlugin class allows to use the SSKS key storage service to store Seald identities easily and securely, encrypted by a key stored on your back-end server.

    • Constructor Detail

      • SealdSSKSTmrPlugin

        SealdSSKSTmrPlugin(String apiURL, String appId)
        Parameters:
        apiURL - The Seald server for this instance to use.
        appId - The ID given by the Seald server to your app.
    • Method Detail

      • saveIdentity

         final Unit saveIdentity(String sessionId, AuthFactor authFactor, String challenge, ByteArray rawTMRSymKey, ByteArray identity)

        Save the Seald account to SSKS.

        Parameters:
        sessionId - Session ID given by SSKS to your app's server.
        authFactor - Authentication method of this user, to which SSKS has sent a challenge at the request of your app's server.
        challenge - The challenge sent by SSKS to the user's authentication method.
        rawTMRSymKey - The raw encryption key used to encrypt / decrypt the stored identity keys.
        identity - The identity to save.
      • saveIdentityAsync

         final Unit saveIdentityAsync(String sessionId, AuthFactor authFactor, String challenge, ByteArray rawTMRSymKey, ByteArray identity)

        Save the Seald account to SSKS.

        Parameters:
        sessionId - Session ID given by SSKS to your app's server.
        authFactor - Authentication method of this user, to which SSKS has sent a challenge at the request of your app's server.
        challenge - The challenge sent by SSKS to the user's authentication method.
        rawTMRSymKey - The raw encryption key used to encrypt / decrypt the stored identity keys.
        identity - The identity to save.
      • retrieveIdentity

         final RetrieveIdentityResponse retrieveIdentity(String sessionId, AuthFactor authFactor, String challenge, ByteArray rawTMRSymKey)

        Retrieve the Seald account previously saved with SealdSSKSTmrPlugin.saveIdentity.

        Parameters:
        sessionId - Session ID given by SSKS to your app's server.
        authFactor - Authentication method of this user, to which SSKS has sent a challenge at the request of your app's server.
        challenge - The challenge sent by SSKS to the user's authentication method.
        rawTMRSymKey - The raw encryption key used to encrypt / decrypt the stored identity keys.
      • retrieveIdentityAsync

         final RetrieveIdentityResponse retrieveIdentityAsync(String sessionId, AuthFactor authFactor, String challenge, ByteArray rawTMRSymKey)

        Retrieve the Seald account previously saved with SealdSSKSTmrPlugin.saveIdentity.

        Parameters:
        sessionId - Session ID given by SSKS to your app's server.
        authFactor - Authentication method of this user, to which SSKS has sent a challenge at the request of your app's server.
        challenge - The challenge sent by SSKS to the user's authentication method.
        rawTMRSymKey - The raw encryption key used to encrypt / decrypt the stored identity keys.