Product Documentation

A user with special permission can perform various SKCE EncryptionEngine operations, such as encryption, decryption, ping and others.

  1. Open a terminal window.

  2. Change directory where skceclient.jar is present.

    shell> cd /usr/local/topaz/
  3. Execute sample client to view usage by using the following command:
    shell> java -cp skceclient.jar EncryptionEngine

    Output

    $ example:~/topaz> java -cp skceclient.jar EncryptionEngine
    NOTE: Picked up JDK_JAVA_OPTIONS: --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.base/java.io=ALL-UNNAMED --add-opens java.management/javax.management.openmbean=ALL-UNNAMED --add-opens java.management/javax.management=ALL-UNNAMED --add-opens java.base/sun.security.provider=ALL-UNNAMED

    skceclient.jar 4.0 (Build 116)
    Copyright (c) 2001-2025 StrongAuth, Inc. All rights reserved.

    Missing arguments..

    Usage: java -cp skceclient.jar EncryptionEngine https://<host:port> <did> <svcusername> <svcpassword> E  <sourcefile> [-dn <ldapdn>] -lu <ldapuser> -lg <ldapgroups> -wp <ws-protocol> [-ra <requiredauth>] [-u <uniquekey>] [-a <algorithm>] [-s <keysize>] [-t <targetlocation>] [-n <notes>]
           java -cp skceclient.jar EncryptionEngine https://<host:port> <did> <svcusername> <svcpassword> CE <sourcefile> -wp <ws-protocol> [-dn <ldapdn>] -lu <ldapuser> -lg <ldapgroups> [-ra <requiredauth>] [-u <uniquekey>] [-a <algorithm>] [-s <keysize>] -f <propertiesfile> [-n <notes>]
           java -cp skceclient.jar EncryptionEngine https://<host:port> <did> <svcusername> <svcpassword> D  <sourcefile> -wp <ws-protocol> [-dn <ldapdn>] -lu <ldapuser> [-t <targetlocation>]
           java -cp skceclient.jar EncryptionEngine https://<host:port> <did> <svcusername> <svcpassword> CD <sourcefile> -wp <ws-protocol> [-dn <ldapdn>] -lu <ldapuser> -f <propertiesfile> [-t <targetlocation>]
           java -cp skceclient.jar EncryptionEngine https://<host:port> <did> <svcusername> <svcpassword> P -wp <ws-protocol> 

    Acceptable values are as follows:
      hostport       : host url where skce service is listening;
                         format  : https://<FQDN>:<ssl-portnumber>
                         example : https://fidodemo.strongauth.com:8181

      did            : Unique domain identifier that belongs to SKCE
      svcusername    : Service credentials; username
      svcpassword    : Service credentials; password
      command        : E (encrypt) | CL (cloudencrypt) | D (decrypt) | CD (clouddecrypt) | P (ping)
      sourcefile     : Full pathname of file to be encrypted or decrypted
      ldapdn         : The full LDAP DN of the user (optional)
      ldapuser       : LDAP user to determine authorization for operation
      ws-protocol    : Web SErvice protocol to be used for this operation. Allowed values are SOAP | REST
      ldapgroups     : List of LDAP groups to determine authorization for decryption (hyphen (-) separated list)
      origin         : Origin to be used by the FIDO client simulator
      authcounter    : Auth Counter to be used by the FIDO client simulator
      requiredauth   : (Optional) Integer number ranging from 0 to 3; to indicate the level of authorization
                         needed to be able to decrypt the file. Default value is 0; meaning no additional
                         authorization is needed
      payload        : (Optional) Data related to transaction authorization. In most of the cases, it is the
                         response from a FIDO Authenticator. This parameter is optional.
      targetlocation : (Optional) Target destination path to store output file
      notes          : (Optional) notes for the operation
      uniquekey      : (Optional) Generate a unique encryption key for encrypt operation?  [true | false]
      algorithm      : (Optional) Encryption-key algorithm AES | TDEA
      keysize        : (Optional) Encryption-key size (if a new key is to be generated)
                         AES  : 128 | 192 | 256
                         TDEA : 112 | 168
      propertiesfile : full directory path to properties file with following cloud configuration
                         skceclient.property.cloudtype=
                         skceclient.property.cloudcontainer=
                         skceclient.property.cloudname=
                         skceclient.property.accesskey=
                         skceclient.property.secretkey=
                         skceclient.property.cloudcredentialid=

 

Here is a brief description of each argument used with skceclient EncryptionEngine:

Value

Explanation

did

Unique domain identifier that belongs to SKCE.

https://<host:port>

The host URL where SKCE service is listening 

Example: https://skce.strongauth.com:8181

svcusername

Service credentials: username

svcpassword

Service credentials: password

command

E (encrypt) | CL (cloudencrypt) | D (decrypt) | CD (clouddecrypt) | P (ping)

sourcefile

Full pathname of file to be encrypted or decrypted

ldapdn

The full LDAP DN of the user (optional)

ldapuser

The type of key to be stored in the KA.

ws-protocol

Web Service protocol to be used for this operation. Allowed values are SOAP | REST

ldapgroups

List of LDAP groups to determine authorization for decryption (hyphen (-) separated list)

origin

Origin to be used by the FIDO client simulator

authcounter

Auth Counter to be used by the FIDO client simulator

requiredauth

(Optional) Integer number ranging from 0 to 3; to indicate the level of authorization needed to be able to decrypt the file. Default value is 0; meaning no additional authorization is needed

payload

(Optional) Data related to transaction authorization. In most of the cases, it is the response from a FIDO Authenticator.

targetlocation

(Optional) Target destination path to store output file

notes

(Optional) notes for the operation

uniquekey

(Optional) Generate a unique encryption key for encrypt operation?  [true | false]

algorithm

(Optional) Encryption-key algorithm AES | TDEA

keysize

(Optional) Encryption-key size (if a new key is to be generated)
                     
AES  : 128 | 192 | 256
TDEA : 112 | 168

propertiesfile

Full directory path to properties file with following cloud configuration:
                     
skceclient.property.cloudtype=
skceclient.property.cloudcontainer=
skceclient.property.cloudname=
skceclient.property.accesskey=
skceclient.property.secretkey=
skceclient.property.cloudcredentialid=