Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Display feature availability
StartingFromRelease2.7.12

Usage

When defining the job either:

...

  • specify the JITL job class and com.sos.jitl.jobs.encrypt.EncryptJob Java class name.


Example:

Download (upload .json) The workflow configuration can be downloaded from here: encryptionValue.workflow.json

This example workflow includes 3 jobs

  • job_encrypt: For encrypting a value. The certificate is assigned directly as a string value. The value for the certificate can also be provided by a job resource.
  • job_result: to display the result of the encryption.
  • decrypt_secret: to decrypt the encrypted value. Decryption is performed with the script js7_decrypt.sh. Please refere to https://kb.sos-berlin.com/x/Qx1SC


Image Added


To create the job job_encrypt you can use the job wizzard like this.


Image Added


Explanation:

  • Add an empty job from the instruction panel.
  • Specify a name and a label for the job.
  • Select an Agent.

In a next step invoke the job wizard that you find in the upper right corner of the job property editor. The wizard brings up the following popup window:

Image Added


Explanation:

  • From the list of available job templates select the EncryptJob.

...

Then hit the Next button to make the job wizard display available arguments:

Image Added


When hitting the Submit button the wizard adds the required arguments to the job which should look like this:

Image Added

Documentation

The EncryptJob class accepts the following arguments:


NameDescription
encipherment_certificate

The CA signed or self-signed X.509 certificate. Alternatively the public key can be specified. This variable is normally provided via a job resource that is managed with the certificate management.

in

Specifies the input value that should be encrypted, typically a secret. One of the options 'in' or 'infile' has to be specified.

infile

Specifies the path to a file that should be encrypted. One of the options 'in' or 'infile' has to be specified. This option requires use of the 'outfile' .

outfile

Specifies the path to the output file that will be created holding the encrypted content of the input file. The option is used if 'infile' is specified.


Return Values

NameDescription
js7EncryptedValue

When infile is specified the value contains

  • the encrypted symmetric key
  • the initialization vector
  • the path to encrypted file separated by space.

When infile is not specified. 

  • the encrypted symmetric key
  • the initialization vector
  • the encrypted value  

The value is needed for decoding:

  • The encrypted symmetric key is decrypted with the private key
  • The encrypted file is decrypted using the decrypted symmetric key and the initialisation vector.
in

Specifies the input value that should be encrypted, typically a secret. One of the options 'in' or 'infile' has to be specified.

infile

Specifies the path to a file that should be encrypted. One of the options 'in' or 'infile' has to be specified. This option requires use of the 'outfile' .

outfile

Specifies the path to the output file that will be created holding the encrypted content of the input file. The option is used if 'infile' is specified.


Further Resources